\Charcoal\CmsSection

__construct()

__construct(array  $data = null) 

Section constructor.

Parameters

isDeletable()

isDeletable() : boolean

Determine if the object can be deleted.

Returns

hierarchicalLabel()

hierarchicalLabel() : string

Retrieve the object's title.

Returns

loadChildren()

loadChildren() : \ArrayAccess|\Traversable

HierarchicalTrait > loadChildren

Returns

setSectionType()

setSectionType(string  $type) : self

Set the section's type.

Parameters

Throws

\InvalidArgumentException

If the section type is not a string or not a valid section type.

Returns

setInMenu()

setInMenu(string|array<mixed,string>  $menu) : self

Set the menus this object belongs to.

Parameters

Returns

setKeywords()

setKeywords(string|array<mixed,string>  $keywords) : self

Set the object's keywords.

Parameters

Returns

setSummary()

setSummary(\Charcoal\Translator\Translation|string|null  $summary) : self

Parameters

Returns

setExternalUrl()

setExternalUrl(\Charcoal\Translator\Translation|string|null  $externalUrl) : self

Parameters

Returns

setLocked()

setLocked(boolean  $locked) : self

Section is locked when you can't change the URL

Parameters

Returns

setTitle()

setTitle(\Charcoal\Translator\Translation|string|null  $title) : self

Parameters

Returns

setSubtitle()

setSubtitle(\Charcoal\Translator\Translation|string|null  $subtitle) : self

Parameters

Returns

setContent()

setContent(\Charcoal\Translator\Translation|string|null  $content) : self

Parameters

Returns

setImage()

setImage(mixed  $image) : self

Parameters

Returns

sectionType()

sectionType() : string

Retrieve the section's type.

Returns

title()

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

Returns

subtitle()

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

Returns

content()

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

Returns

image()

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

Returns

inMenu()

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

Retrieve the menus this object belongs to.

Returns

keywords()

keywords() : array<mixed,string>

Retrieve the object's keywords.

Returns

summary()

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

HierarchicalTrait > loadChildren

Returns

externalUrl()

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

Returns

locked()

locked() : boolean

Returns

Or Null.

canonicalUrl()

canonicalUrl() : string

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

parseAsMultiple()

parseAsMultiple(mixed  $value, string|\Charcoal\Cms\PropertyInterface  $separator = ',') : array

Parse the property value as a "multiple" value type.

Parameters

Returns

postSave()

postSave() : boolean

Route generated on postSave in case it contains the ID of the section, which you only get once you have save

Returns

postUpdate()

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

Check whatever before the update.

Parameters

Returns

preSave()

preSave() : boolean

{@inheritdoc}

Returns

preUpdate()

preUpdate(array  $properties = null) : boolean

{@inheritdoc}

Parameters

Returns

preDelete()

preDelete() : boolean

Event called before _deleting_ the object.

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

translator()

translator() : \Charcoal\Translator\Translator

Returns