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

Class AbstractEvent

Charcoal\Object\Content
Extended by Charcoal\Cms\AbstractEvent implements Charcoal\Object\CategorizableInterface, Charcoal\Cms\EventInterface, Charcoal\Cms\MetatagInterface, Charcoal\Object\PublishableInterface, Charcoal\Object\RoutableInterface, Charcoal\Cms\SearchableInterface, Charcoal\Cms\TemplateableInterface uses Charcoal\Object\CategorizableTrait (not available) Charcoal\Object\PublishableTrait (not available) Charcoal\Cms\MetatagTrait, Charcoal\Object\RoutableTrait (not available) Charcoal\Cms\SearchableTrait, Charcoal\Cms\TemplateableTrait

Direct known subclasses

Charcoal\Cms\Event
Abstract
Namespace: Charcoal\Cms
Located at Charcoal/Cms/AbstractEvent.php
Methods summary
public
# __construct( array $data = null )

Section constructor.

Section constructor.

Parameters

$data
The data.
public
# verifyDates( )

Some dates cannot be null

Some dates cannot be null

public string
# adminDateFilter( )

Returns

string
The date filtered for admin dual select input and others.
public Charcoal\Cms\AbstractEvent
# setTitle( mixed $title )

Parameters

$title
The event title (localized).

Returns

Charcoal\Cms\AbstractEvent

Implementation of

Charcoal\Cms\EventInterface::setTitle()
public Charcoal\Translator\Translation|string|null
# title( )

Returns

Charcoal\Translator\Translation|string|null

Implementation of

Charcoal\Cms\EventInterface::title()
public Charcoal\Cms\AbstractEvent
# setSubtitle( mixed $subtitle )

Parameters

$subtitle
The event subtitle (localized).

Returns

Charcoal\Cms\AbstractEvent

Implementation of

Charcoal\Cms\EventInterface::setSubtitle()
public Charcoal\Translator\Translation|string|null
# subtitle( )

Returns

Charcoal\Translator\Translation|string|null

Implementation of

Charcoal\Cms\EventInterface::subtitle()
public Charcoal\Cms\AbstractEvent
# setSummary( mixed $summary )

Parameters

$summary
The news summary (localized).

Returns

Charcoal\Cms\AbstractEvent
public Charcoal\Translator\Translation|string|null
# summary( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\AbstractEvent
# setContent( mixed $content )

Parameters

$content
The event content (localized).

Returns

Charcoal\Cms\AbstractEvent

Implementation of

Charcoal\Cms\EventInterface::setContent()
public Charcoal\Translator\Translation|string|null
# content( )

Returns

Charcoal\Translator\Translation|string|null

Implementation of

Charcoal\Cms\EventInterface::content()
public Charcoal\Cms\AbstractEvent
# setImage( mixed $image )

Parameters

$image
The section main image (localized).

Returns

Charcoal\Cms\AbstractEvent
public Charcoal\Translator\Translation|string|null
# image( )

Returns

Charcoal\Translator\Translation|string|null
public Charcoal\Cms\AbstractEvent
# setStartDate( string|DateTimeInterface $startDate )

Parameters

$startDate
Event starting date.

Returns

Charcoal\Cms\AbstractEvent

Throws

InvalidArgumentException
If the timestamp is invalid.

Implementation of

Charcoal\Cms\EventInterface::setStartDate()
public DateTimeInterface|null
# startDate( )

Returns

DateTimeInterface|null

Implementation of

Charcoal\Cms\EventInterface::startDate()
public Charcoal\Cms\AbstractEvent
# setEndDate( string|DateTimeInterface $endDate )

Parameters

$endDate
Event end date.

Returns

Charcoal\Cms\AbstractEvent

Throws

InvalidArgumentException
If the timestamp is invalid.

Implementation of

Charcoal\Cms\EventInterface::setEndDate()
public DateTimeInterface|null
# endDate( )

Returns

DateTimeInterface|null

Implementation of

Charcoal\Cms\EventInterface::endDate()
public string
# canonicalUrl( )

MetatagTrait > canonical_url

MetatagTrait > canonical_url

Returns

string

Implementation of

Charcoal\Cms\MetatagInterface::canonicalUrl()
public Charcoal\Translator\Translation|string|null
# defaultMetaTitle( )

Returns

Charcoal\Translator\Translation|string|null

Implementation of

Charcoal\Cms\MetatagInterface::defaultMetaTitle()
public Charcoal\Translator\Translation|string|null
# defaultMetaDescription( )

Returns

Charcoal\Translator\Translation|string|null

Implementation of

Charcoal\Cms\MetatagInterface::defaultMetaDescription()
public Charcoal\Translator\Translation|string|null
# defaultMetaImage( )

Returns

Charcoal\Translator\Translation|string|null

Implementation of

Charcoal\Cms\MetatagInterface::defaultMetaImage()
public string[]
# keywords( )

Retrieve the object's keywords.

Retrieve the object's keywords.

Returns

string[]
public boolean
# preSave( )

Returns

boolean
public boolean
# preUpdate( array $properties = null )

Parameters

$properties
Optional properties to update.

Returns

boolean
public boolean
# postSave( )

Returns

boolean
Parent postSave().
public boolean
# postUpdate( array $properties = null )

Parameters

$properties
Properties.

Returns

boolean
public boolean
# isActiveRoute( )

GenericRoute checks if the route is active. Default in RoutableTrait.

GenericRoute checks if the route is active. Default in RoutableTrait.

Returns

boolean
Methods inherited from Charcoal\Cms\MetatagInterface
facebookAppId(), metaAuthor(), metaDescription(), metaImage(), metaTags(), metaTitle(), opengraphAuthor(), opengraphDescription(), opengraphImage(), opengraphPublisher(), opengraphSiteName(), opengraphTags(), opengraphTitle(), opengraphType(), setFacebookAppId(), setMetaAuthor(), setMetaDescription(), setMetaImage(), setMetaTitle(), setOpengraphAuthor(), setOpengraphDescription(), setOpengraphImage(), setOpengraphPulisher(), setOpengraphSiteName(), setOpengraphTitle(), setOpengraphType()
Methods inherited from Charcoal\Cms\SearchableInterface
searchKeywords(), searchProperties(), setSearchKeywords(), setSearchProperties()
Methods inherited from Charcoal\Cms\TemplateableInterface
controllerIdent(), setControllerIdent(), setTemplateIdent(), setTemplateOptions(), templateIdent(), templateOptions()
Methods used from Charcoal\Cms\MetatagTrait
facebookAppId(), generateDefaultMetaTags(), isEmptyMeta(), metaAuthor(), metaDescription(), metaImage(), metaTags(), metaTitle(), opengraphAuthor(), opengraphDescription(), opengraphImage(), opengraphPublisher(), opengraphSiteName(), opengraphTags(), opengraphTitle(), opengraphType(), setFacebookAppId(), setMetaAuthor(), setMetaDescription(), setMetaImage(), setMetaTitle(), setOpengraphAuthor(), setOpengraphDescription(), setOpengraphImage(), setOpengraphPulisher(), setOpengraphSiteName(), setOpengraphTitle(), setOpengraphType(), translator()
Methods used from Charcoal\Cms\SearchableTrait
searchKeywords(), searchProperties(), setSearchKeywords(), setSearchProperties()
Methods used from Charcoal\Cms\TemplateableTrait
controllerIdent(), setControllerIdent(), setTemplateIdent(), setTemplateOptions(), templateIdent(), templateOptions()
Properties summary
protected array $keywords
#
Properties used from Charcoal\Cms\MetatagTrait
$facebookAppId, $metaAuthor, $metaDescription, $metaImage, $metaTitle, $opengraphAuthor, $opengraphDescription, $opengraphImage, $opengraphPublisher, $opengraphSiteName, $opengraphTitle, $opengraphType
API documentation generated by ApiGen