\Charcoal\CmsSectionInterface

Summary

Methods

Constants

setSectionType()
sectionType()
setTitle()
title()
setSubtitle()
subtitle()
setInMenu()
setKeywords()
setSummary()
setExternalUrl()
setLocked()
setContent()
setImage()
content()
image()
inMenu()
keywords()
summary()
externalUrl()
locked()
canonicalUrl()
defaultMetaTitle()
defaultMetaDescription()
defaultMetaImage()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

setSectionType()

setSectionType(string  $type) : self

Parameters

string

$type

The section type.

Returns

self

sectionType()

sectionType() : string

Returns

string

setTitle()

setTitle(mixed  $title) : self

Parameters

mixed

$title

Section title (localized).

Returns

self

title()

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

Returns

\Charcoal\Translator\Translation|string|null

setSubtitle()

setSubtitle(mixed  $subtitle) : self

Parameters

mixed

$subtitle

Section subtitle (localized).

Returns

self

subtitle()

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

Returns

\Charcoal\Translator\Translation|string|null

setInMenu()

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

Set the menus this object belongs to.

Parameters

string|array<mixed,string>

$menu

One or more menu identifiers.

Returns

self

setKeywords()

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

Set the object's keywords.

Parameters

string|array<mixed,string>

$keywords

One or more entries.

Returns

self

setSummary()

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

Parameters

\Charcoal\Translator\Translation|string

$summary

The summary.

Returns

self

setExternalUrl()

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

Parameters

\Charcoal\Translator\Translation|string

$externalUrl

The external url.

Returns

self

setLocked()

setLocked(boolean  $locked) : self

Section is locked when you can't change the URL

Parameters

boolean

$locked

Prevent new route creation about that object.

Returns

self

setContent()

setContent(mixed  $content) : self

Parameters

mixed

$content

The section content (localized).

Returns

self

setImage()

setImage(mixed  $image) : self

Parameters

mixed

$image

The section main image (localized).

Returns

self

content()

content() : \Charcoal\Translator\Translation

Returns

\Charcoal\Translator\Translation

image()

image() : \Charcoal\Translator\Translation

Returns

\Charcoal\Translator\Translation

inMenu()

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

Retrieve the menus this object belongs to.

Returns

string|\Charcoal\Translator\Translation

keywords()

keywords() : array<mixed,string>

Retrieve the object's keywords.

Returns

array<mixed,string>

summary()

summary() : \Charcoal\Translator\Translation

Returns

\Charcoal\Translator\Translation

externalUrl()

externalUrl() : string

Returns

string

locked()

locked() : boolean

Returns

boolean —

Or Null.

canonicalUrl()

canonicalUrl() : string

MetatagTrait > canonicalUrl

Returns

string