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 MetatagInterface

Direct known implementers

Charcoal\Cms\AbstractEvent, Charcoal\Cms\AbstractNews, Charcoal\Cms\AbstractSection

Indirect known implementers

Charcoal\Cms\EmptySection, Charcoal\Cms\Event, Charcoal\Cms\ExternalSection, Charcoal\Cms\News, Charcoal\Cms\Section, Charcoal\Cms\Section\BlocksSection, Charcoal\Cms\Section\ContentSection
Namespace: Charcoal\Cms
Located at Charcoal/Cms/MetatagInterface.php
Methods summary
public string
# canonicalUrl( )

Returns

string
public Charcoal\Translator\Translation|string|null
# defaultMetaTitle( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Translator\Translation|string|null
# defaultMetaDescription( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Translator\Translation|string|null
# defaultMetaImage( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\MetatagInterface
# setMetaTitle( mixed $title )

Parameters

$title
The meta title (localized).

Returns

Charcoal\Cms\MetatagInterface
public Charcoal\Translator\Translation|string|null
# metaTitle( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\MetatagInterface
# setMetaDescription( mixed $description )

Parameters

$description
The meta description (localized).

Returns

Charcoal\Cms\MetatagInterface
public Charcoal\Translator\Translation|string|null
# metaDescription( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\MetatagInterface
# setMetaImage( mixed $image )

Parameters

$image
The meta image (localized).

Returns

Charcoal\Cms\MetatagInterface
public Charcoal\Translator\Translation|string|null
# metaImage( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\MetatagInterface
# setMetaAuthor( mixed $author )

Parameters

$author
The meta author (localized).

Returns

Charcoal\Cms\MetatagInterface
public Charcoal\Translator\Translation|string|null
# metaAuthor( )

Returns

Charcoal\Translator\Translation|string|null
public string
# metaTags( )

Returns

string
public Charcoal\Cms\MetatagInterface
# setFacebookAppId( string $appId )

Parameters

$appId
The facebook App ID (numeric string).

Returns

Charcoal\Cms\MetatagInterface
public string
# facebookAppId( )

Returns

string
public Charcoal\Cms\MetatagInterface
# setOpengraphTitle( mixed $title )

Parameters

$title
The opengraph title (localized).

Returns

Charcoal\Cms\MetatagInterface
public Charcoal\Translator\Translation|string|null
# opengraphTitle( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\MetatagInterface
# setOpengraphSiteName( mixed $siteName )

Parameters

$siteName
The opengraph site name (localized).

Returns

Charcoal\Cms\MetatagInterface
public Charcoal\Translator\Translation|string|null
# opengraphSiteName( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\MetatagInterface
# setOpengraphDescription( mixed $description )

Parameters

$description
The opengraph description (localized).

Returns

Charcoal\Cms\MetatagInterface
public Charcoal\Translator\Translation|string|null
# opengraphDescription( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\MetatagInterface
# setOpengraphType( string $type )

Parameters

$type
The opengraph type.

Returns

Charcoal\Cms\MetatagInterface
public string
# opengraphType( )

Returns

string
public Charcoal\Cms\MetatagInterface
# setOpengraphImage( mixed $image )

Parameters

$image
The opengraph image (localized).

Returns

Charcoal\Cms\MetatagInterface
public Charcoal\Translator\Translation|string|null
# opengraphImage( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\MetatagInterface
# setOpengraphAuthor( mixed $author )

Parameters

$author
The opengraph author (localized).

Returns

Charcoal\Cms\MetatagInterface
public Charcoal\Translator\Translation|string|null
# opengraphAuthor( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\MetatagInterface
# setOpengraphPulisher( mixed $publisher )

Parameters

$publisher
The opengraph publisher (localized).

Returns

Charcoal\Cms\MetatagInterface
public Charcoal\Translator\Translation|string|null
# opengraphPublisher( )

Returns

Charcoal\Translator\Translation|string|null
public string
# opengraphTags( )

Returns

string
API documentation generated by ApiGen