Overview

Namespaces

  • Charcoal
    • Admin
      • Widget
        • Cms
    • Cms
      • Config
      • Mixin
        • Traits
      • Route
      • Section
      • Service
        • Loader
        • Manager
      • ServiceProvider
      • Support
        • Helpers
        • Interfaces
        • Traits
    • Property

Classes

  • CmsConfig
  • EventConfig
  • NewsConfig
  • SectionConfig
  • Overview
  • Namespace
  • Class

Class CmsConfig

Class Config

Charcoal\Config\AbstractConfig
Extended by Charcoal\Cms\Config\CmsConfig
Namespace: Charcoal\Cms\Config
Located at Charcoal/Cms/Config/CmsConfig.php
Methods summary
public
# addModel( Charcoal\Model\ModelInterface $model )

Parameters

$model
The object model.
public Charcoal\Cms\Config\CmsConfig
# setDefaultFromEmail( mixed $defaultFromEmail )

Parameters

$defaultFromEmail
The default email for contact forms.

Returns

Charcoal\Cms\Config\CmsConfig
public Charcoal\Cms\Config\CmsConfig
# setHomeNews( mixed $homeNews )

Parameters

$homeNews
The news to display on home page.

Returns

Charcoal\Cms\Config\CmsConfig
public Charcoal\Cms\Config\CmsConfig
# setHomeEvents( mixed $homeEvents )

Parameters

$homeEvents
The events to display on home page.

Returns

Charcoal\Cms\Config\CmsConfig
public
# setNews( array $newsConfig )

Parameters

$newsConfig
The news configuration object.

Returns


$this
public
# setEvent( array $eventConfig )

Parameters

$eventConfig
The event configuration object.

Returns


$this
public
# setSection( array $sectionConfig )

Parameters

$sectionConfig
The section configuration object.

Returns


$this
public Charcoal\Cms\Config\CmsConfig
# setContactCategoryObj( string $contactCategory )

Parameters

$contactCategory
Must conform City\Support\Interface\ContactCategoryInterface.

Returns

Charcoal\Cms\Config\CmsConfig
public Charcoal\Cms\Config\CmsConfig
# setContactObj( string $contactObj )

Parameters

$contactObj
Must conform City\Support\Interface\ContactInterface.

Returns

Charcoal\Cms\Config\CmsConfig
public Charcoal\Cms\Config\CmsConfig
# setDefaultContactCategory( string $defaultContactCategory )

Parameters

$defaultContactCategory
The default contact category fallback.

Returns

Charcoal\Cms\Config\CmsConfig
public Charcoal\Cms\Config\CmsConfig
# setDateFormats( array $dateFormats )

Parameters

$dateFormats
Formats for full dates.

Returns

Charcoal\Cms\Config\CmsConfig
public Charcoal\Cms\Config\CmsConfig
# setTimeFormats( array $timeFormats )

Parameters

$timeFormats
Formats for time.

Returns

Charcoal\Cms\Config\CmsConfig
public mixed
# defaultFromEmail( )

Returns

mixed
public mixed
# homeNews( )

Returns

mixed
public mixed
# homeEvents( )

Returns

mixed
public Charcoal\Cms\Config\NewsConfig
# newsConfig( )

Returns

Charcoal\Cms\Config\NewsConfig
public Charcoal\Cms\Config\EventConfig
# eventConfig( )

Returns

Charcoal\Cms\Config\EventConfig
public Charcoal\Cms\Config\SectionConfig
# sectionConfig( )

Returns

Charcoal\Cms\Config\SectionConfig
public string
# contactCategoryObj( )

Returns

string
public string
# contactObj( )

Returns

string
public string
# defaultContactCategory( )

Returns

string
public array
# dateFormats( )

Returns

array
public array
# timeFormats( )

Returns

array
Properties summary
protected string $defaultFromEmail

$defaultFromEmail

$defaultFromEmail

#
protected array $homeNews

$homeNews

$homeNews

#
protected array $homeEvents

$homeEvents

$homeEvents

#
protected Charcoal\Cms\Config\NewsConfig $newsConfig

$newsConfig

$newsConfig

#
protected Charcoal\Cms\Config\EventConfig $eventConfig

$eventConfig

$eventConfig

#
protected Charcoal\Cms\Config\SectionConfig $sectionConfig

$sectionConfig

$sectionConfig

#
protected string $contactCategoryObj

$contactCategoryObj Must conform Cms\Support\Interface\ContactCategoryInterface.

$contactCategoryObj Must conform Cms\Support\Interface\ContactCategoryInterface.

#
protected string $defaultContactCategory

$defaultContactCategory The default contact category to fallback.

$defaultContactCategory The default contact category to fallback.

#
protected string $contactObj

$contactObj Must conform Cms\Support\Interface\ContactInterface.

$contactObj Must conform Cms\Support\Interface\ContactInterface.

#
protected array $dateFormats

$dateFormats

$dateFormats

# []
protected array $timeFormats

$timeFormats

$timeFormats

# []
API documentation generated by ApiGen