\Charcoal\CmsEvent

__construct()

__construct(array  $data = null) 

Section constructor.

Parameters

verifyDates()

verifyDates() : void

Some dates cannot be null

adminDateFilter()

adminDateFilter() : string

Returns

The date filtered for admin dual select input and others.

setTitle()

setTitle(mixed  $title) : self

Parameters

Returns

title()

title() : \Charcoal\Translator\Translation|string|null

Returns

setSubtitle()

setSubtitle(mixed  $subtitle) : self

Parameters

Returns

subtitle()

subtitle() : \Charcoal\Translator\Translation|string|null

Returns

setSummary()

setSummary(mixed  $summary) : self

Parameters

Returns

summary()

summary() : \Charcoal\Translator\Translation|string|null

Returns

setContent()

setContent(mixed  $content) : self

Parameters

Returns

content()

content() : \Charcoal\Translator\Translation|string|null

Returns

setImage()

setImage(mixed  $image) : self

Parameters

Returns

image()

image() : \Charcoal\Translator\Translation|string|null

Returns

setStartDate()

setStartDate(string|\DateTimeInterface  $startDate) : self

Parameters

Throws

\InvalidArgumentException

If the timestamp is invalid.

Returns

startDate()

startDate() : \DateTimeInterface|null

Returns

setEndDate()

setEndDate(string|\DateTimeInterface  $endDate) : self

Parameters

Throws

\InvalidArgumentException

If the timestamp is invalid.

Returns

endDate()

endDate() : \DateTimeInterface|null

Returns

canonicalUrl()

canonicalUrl() : string

MetatagTrait > canonical_url

Returns

defaultMetaTitle()

defaultMetaTitle() : \Charcoal\Translator\Translation|string|null

Returns

defaultMetaDescription()

defaultMetaDescription() : \Charcoal\Translator\Translation|string|null

Returns

defaultMetaImage()

defaultMetaImage() : \Charcoal\Translator\Translation|string|null

Returns

keywords()

keywords() : array<mixed,string>

Retrieve the object's keywords.

Returns

preSave()

preSave() : boolean

{@inheritdoc}

Returns

preUpdate()

preUpdate(array  $properties = null) : boolean

{@inheritdoc}

Parameters

Returns

postSave()

postSave() : boolean

Returns

Parent postSave().

postUpdate()

postUpdate(array|null  $properties = null) : boolean

Parameters

Returns

isActiveRoute()

isActiveRoute() : boolean

GenericRoute checks if the route is active.

Default in RoutableTrait.

Returns

setMetaTitle()

setMetaTitle(mixed  $title) : self

Parameters

Returns

metaTitle()

metaTitle() : \Charcoal\Translator\Translation|string|null

Returns

setMetaDescription()

setMetaDescription(mixed  $description) : self

Parameters

Returns

metaDescription()

metaDescription() : \Charcoal\Translator\Translation|string|null

Returns

setMetaImage()

setMetaImage(mixed  $image) : self

Parameters

Returns

metaImage()

metaImage() : \Charcoal\Translator\Translation|string|null

Returns

setMetaAuthor()

setMetaAuthor(mixed  $author) : self

Parameters

Returns

metaAuthor()

metaAuthor() : \Charcoal\Translator\Translation|string|null

Returns

metaTags()

metaTags() : string

Returns

setFacebookAppId()

setFacebookAppId(string  $appId) : self

Parameters

Returns

facebookAppId()

facebookAppId() : string

Returns

setOpengraphTitle()

setOpengraphTitle(mixed  $title) : self

Parameters

Returns

opengraphTitle()

opengraphTitle() : \Charcoal\Translator\Translation|string|null

Get the opengraph title.

If not expilicitely defined, use the meta title as opengraph title.

Returns

setOpengraphSiteName()

setOpengraphSiteName(mixed  $siteName) : self

Parameters

Returns

opengraphSiteName()

opengraphSiteName() : \Charcoal\Translator\Translation|string|null

Returns

setOpengraphDescription()

setOpengraphDescription(mixed  $description) : self

Parameters

Returns

opengraphDescription()

opengraphDescription() : \Charcoal\Translator\Translation|string|null

Returns

setOpengraphType()

setOpengraphType(string  $type) : self

Parameters

Returns

opengraphType()

opengraphType() : string

Returns

setOpengraphImage()

setOpengraphImage(mixed  $image) : self

Parameters

Returns

opengraphImage()

opengraphImage() : \Charcoal\Translator\Translation|string|null

Returns

setOpengraphAuthor()

setOpengraphAuthor(mixed  $author) : self

Parameters

Returns

opengraphAuthor()

opengraphAuthor() : \Charcoal\Translator\Translation|string|null

Returns

setOpengraphPulisher()

setOpengraphPulisher(mixed  $publisher) : self

Parameters

Returns

opengraphPublisher()

opengraphPublisher() : \Charcoal\Translator\Translation|string|null

Returns

opengraphTags()

opengraphTags() : string

Returns

generateDefaultMetaTags()

generateDefaultMetaTags() : self

Generates the default metatags for the current object.

Prevents some problem where the defaultMetaTag method content isn't set at the moment of setting the meta. Should be called on preSave and preUpdate of the object.

Returns

$this.

isEmptyMeta()

isEmptyMeta(mixed  $meta) : boolean

Check if the meta is empty. Method exists because at this point we don't really know what's in the meta.

Possible param type:

• [ lang => value, lang => value ]
• Translation
• null

Parameters

Returns

Empty or not.

setSearchProperties()

setSearchProperties(array  $properties) : self

Parameters

Returns

searchProperties()

searchProperties() : array

Returns

setSearchKeywords()

setSearchKeywords(mixed  $keywords) : self

Parameters

Returns

searchKeywords()

searchKeywords() : \Charcoal\Translator\Translation|string|null

Returns

setTemplateIdent()

setTemplateIdent(mixed  $template) : self

Set the renderable object's template identifier.

Parameters

Returns

templateIdent()

templateIdent() : mixed

Retrieve the renderable object's template identifier.

Returns

setControllerIdent()

setControllerIdent(mixed  $ident) : self

Set the renderable object's template controller identifier.

Parameters

Returns

controllerIdent()

controllerIdent() : mixed

Retrieve the renderable object's template controller identifier.

Returns

setTemplateOptions()

setTemplateOptions(mixed  $options) : self

Customize the template's options.

Parameters

Returns

templateOptions()

templateOptions() : array

Retrieve the template's customized options.

Returns

categoryType()

categoryType() : string

CategorizableTrait > category_type()

Returns

translator()

translator() : \Charcoal\Translator\Translator

Returns