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

\Charcoal\Cms\ConfigCmsConfig

Class Config

Summary

Methods
Properties
Constants
addModel()
setDefaultFromEmail()
setHomeNews()
setHomeEvents()
setNews()
setEvent()
setSection()
setContactCategoryObj()
setContactObj()
setDefaultContactCategory()
setDateFormats()
setTimeFormats()
defaultFromEmail()
homeNews()
homeEvents()
newsConfig()
eventConfig()
sectionConfig()
contactCategoryObj()
contactObj()
defaultContactCategory()
dateFormats()
timeFormats()
No public properties found
No constants found
No protected methods found
$defaultFromEmail
$homeNews
$homeEvents
$newsConfig
$eventConfig
$sectionConfig
$contactCategoryObj
$defaultContactCategory
$contactObj
$dateFormats
$timeFormats
N/A
No private methods found
No private properties found
N/A

Properties

$defaultFromEmail

$defaultFromEmail : string

Type

string

$homeNews

$homeNews : array

Type

array

$homeEvents

$homeEvents : array

Type

array

$contactCategoryObj

$contactCategoryObj : string

Type

string — Must conform Cms\\Support\\Interface\\ContactCategoryInterface.

$defaultContactCategory

$defaultContactCategory : string

Type

string — The default contact category to fallback.

$contactObj

$contactObj : string

Type

string — Must conform Cms\\Support\\Interface\\ContactInterface.

$dateFormats

$dateFormats : array

Type

array

$timeFormats

$timeFormats : array

Type

array

Methods

addModel()

addModel(\Charcoal\Model\ModelInterface  $model) : void

Parameters

\Charcoal\Model\ModelInterface $model

The object model.

setDefaultFromEmail()

setDefaultFromEmail(mixed  $defaultFromEmail) : self

Parameters

mixed $defaultFromEmail

The default email for contact forms.

Returns

self

setHomeNews()

setHomeNews(mixed  $homeNews) : self

Parameters

mixed $homeNews

The news to display on home page.

Returns

self

setHomeEvents()

setHomeEvents(mixed  $homeEvents) : self

Parameters

mixed $homeEvents

The events to display on home page.

Returns

self

setNews()

setNews(array  $newsConfig) : $this

Parameters

array $newsConfig

The news configuration object.

Returns

$this

setEvent()

setEvent(array  $eventConfig) : $this

Parameters

array $eventConfig

The event configuration object.

Returns

$this

setSection()

setSection(array  $sectionConfig) : $this

Parameters

array $sectionConfig

The section configuration object.

Returns

$this

setContactCategoryObj()

setContactCategoryObj(string  $contactCategory) : self

Parameters

string $contactCategory

Must conform City\Support\Interface\ContactCategoryInterface.

Returns

self

setContactObj()

setContactObj(string  $contactObj) : self

Parameters

string $contactObj

Must conform City\Support\Interface\ContactInterface.

Returns

self

setDefaultContactCategory()

setDefaultContactCategory(string  $defaultContactCategory) : self

Parameters

string $defaultContactCategory

The default contact category fallback.

Returns

self

setDateFormats()

setDateFormats(array  $dateFormats) : self

Parameters

array $dateFormats

Formats for full dates.

Returns

self

setTimeFormats()

setTimeFormats(array  $timeFormats) : self

Parameters

array $timeFormats

Formats for time.

Returns

self

defaultFromEmail()

defaultFromEmail() : mixed

Returns

mixed

homeNews()

homeNews() : mixed

Returns

mixed

homeEvents()

homeEvents() : mixed

Returns

mixed

contactCategoryObj()

contactCategoryObj() : string

Returns

string

contactObj()

contactObj() : string

Returns

string

defaultContactCategory()

defaultContactCategory() : string

Returns

string

dateFormats()

dateFormats() : array

Returns

array

timeFormats()

timeFormats() : array

Returns

array