Overview

Namespaces

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

Classes

  • AbstractDocument
  • AbstractEvent
  • AbstractFaq
  • AbstractImage
  • AbstractNews
  • AbstractSection
  • AbstractText
  • AbstractVideo
  • Config
  • Document
  • DocumentCategory
  • EmptySection
  • Event
  • EventCategory
  • ExternalSection
  • Faq
  • FaqCategory
  • Image
  • ImageCategory
  • News
  • NewsCategory
  • Section
  • Tag
  • Text
  • TextCategory
  • Video
  • VideoCategory

Interfaces

  • DocumentInterface
  • EventInterface
  • FaqInterface
  • ImageInterface
  • MetatagInterface
  • NewsInterface
  • SearchableInterface
  • SectionInterface
  • TemplateableInterface
  • TextInterface
  • VideoInterface

Traits

  • MetatagTrait
  • SearchableTrait
  • TemplateableTrait
  • Overview
  • Namespace
  • Class

Interface SectionInterface

Direct known implementers

Charcoal\Cms\AbstractSection

Indirect known implementers

Charcoal\Cms\EmptySection, Charcoal\Cms\ExternalSection, Charcoal\Cms\Section, Charcoal\Cms\Section\BlocksSection, Charcoal\Cms\Section\ContentSection
Namespace: Charcoal\Cms
Located at Charcoal/Cms/SectionInterface.php
Methods summary
public Charcoal\Cms\SectionInterface
# setSectionType( string $type )

Parameters

$type
The section type.

Returns

Charcoal\Cms\SectionInterface
public string
# sectionType( )

Returns

string
public Charcoal\Cms\SectionInterface
# setTitle( mixed $title )

Parameters

$title
Section title (localized).

Returns

Charcoal\Cms\SectionInterface
public Charcoal\Translator\Translation|string|null
# title( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\SectionInterface
# setSubtitle( mixed $subtitle )

Parameters

$subtitle
Section subtitle (localized).

Returns

Charcoal\Cms\SectionInterface
public Charcoal\Translator\Translation|string|null
# subtitle( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\SectionInterface
# setInMenu( string|string[] $menu )

Set the menus this object belongs to.

Set the menus this object belongs to.

Parameters

$menu
One or more menu identifiers.

Returns

Charcoal\Cms\SectionInterface
public Charcoal\Cms\SectionInterface
# setKeywords( string|string[] $keywords )

Set the object's keywords.

Set the object's keywords.

Parameters

$keywords
One or more entries.

Returns

Charcoal\Cms\SectionInterface
public Charcoal\Cms\SectionInterface
# setSummary( Charcoal\Translator\Translation|string $summary )

Parameters

$summary
The summary.

Returns

Charcoal\Cms\SectionInterface
public Charcoal\Cms\SectionInterface
# setExternalUrl( Charcoal\Translator\Translation|string $externalUrl )

Parameters

$externalUrl
The external url.

Returns

Charcoal\Cms\SectionInterface
public Charcoal\Cms\SectionInterface
# setLocked( boolean $locked )

Section is locked when you can't change the URL

Section is locked when you can't change the URL

Parameters

$locked
Prevent new route creation about that object.

Returns

Charcoal\Cms\SectionInterface
public Charcoal\Cms\SectionInterface
# setContent( mixed $content )

Parameters

$content
The section content (localized).

Returns

Charcoal\Cms\SectionInterface
public Charcoal\Cms\SectionInterface
# setImage( mixed $image )

Parameters

$image
The section main image (localized).

Returns

Charcoal\Cms\SectionInterface
public Charcoal\Translator\Translation
# content( )

Returns

Charcoal\Translator\Translation
public Charcoal\Translator\Translation
# image( )

Returns

Charcoal\Translator\Translation
public string|Charcoal\Translator\Translation
# inMenu( )

Retrieve the menus this object belongs to.

Retrieve the menus this object belongs to.

Returns

string|Charcoal\Translator\Translation
public string[]
# keywords( )

Retrieve the object's keywords.

Retrieve the object's keywords.

Returns

string[]
public Charcoal\Translator\Translation
# summary( )

Returns

Charcoal\Translator\Translation
public string
# externalUrl( )

Returns

string
public boolean
# locked( )

Returns

boolean
Or Null.
public string
# canonicalUrl( )

MetatagTrait > canonicalUrl

MetatagTrait > canonicalUrl

Returns

string
public Charcoal\Translator\Translation
# defaultMetaTitle( )

Returns

Charcoal\Translator\Translation
public Charcoal\Translator\Translation
# defaultMetaDescription( )

Returns

Charcoal\Translator\Translation
public Charcoal\Translator\Translation
# defaultMetaImage( )

Returns

Charcoal\Translator\Translation
API documentation generated by ApiGen