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 AbstractNews

News

Charcoal\Object\Content
Extended by Charcoal\Cms\AbstractNews implements Charcoal\Object\CategorizableInterface, Charcoal\Cms\MetatagInterface, Charcoal\Cms\NewsInterface, 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\News
Abstract
Namespace: Charcoal\Cms
Located at Charcoal/Cms/AbstractNews.php
Methods summary
public
# __construct( array $data = null )

Section constructor.

Section constructor.

Parameters

$data
The data.
public string
# dateTimeDate( )

In the datetime attribute of the tag

In the datetime attribute of the tag

Returns

string
The datetime attribute formatted.
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\AbstractNews
# setTitle( mixed $title )

Parameters

$title
The news title (localized).

Returns

Charcoal\Cms\AbstractNews

Implementation of

Charcoal\Cms\NewsInterface::setTitle()
public Charcoal\Cms\AbstractNews
# setSubtitle( mixed $subtitle )

Parameters

$subtitle
The news subtitle (localized).

Returns

Charcoal\Cms\AbstractNews

Implementation of

Charcoal\Cms\NewsInterface::setSubtitle()
public Charcoal\Cms\AbstractNews
# setSummary( mixed $summary )

Parameters

$summary
The news summary (localized).

Returns

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

Parameters

$content
The news content (localized).

Returns

Charcoal\Cms\AbstractNews

Implementation of

Charcoal\Cms\NewsInterface::setContent()
public Charcoal\Cms\AbstractNews
# setImage( mixed $image )

Parameters

$image
The section main image (localized).

Returns

Charcoal\Cms\AbstractNews
public Charcoal\Cms\AbstractNews
# setInfoUrl( mixed $url )

Parameters

$url
The info URL (news source or where to find more information; localized).

Returns

Charcoal\Cms\AbstractNews

Implementation of

Charcoal\Cms\NewsInterface::setInfoUrl()
public Charcoal\Cms\AbstractNews
# setNewsDate( string|DateTimeInterface $newsDate )

Parameters

$newsDate
The news date.

Returns

Charcoal\Cms\AbstractNews

Throws

InvalidArgumentException
If the timestamp is invalid.

Implementation of

Charcoal\Cms\NewsInterface::setNewsDate()
public Charcoal\Cms\AbstractNews
# setKeywords( string|string[] $keywords )

Set the object's keywords.

Set the object's keywords.

Parameters

$keywords
One or more entries.

Returns

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

Returns

Charcoal\Translator\Translation|string|null

Implementation of

Charcoal\Cms\NewsInterface::title()
public Charcoal\Translator\Translation|string|null
# subtitle( )

Returns

Charcoal\Translator\Translation|string|null

Implementation of

Charcoal\Cms\NewsInterface::subtitle()
public Charcoal\Translator\Translation|string|null
# summary( )

Returns

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

Returns

Charcoal\Translator\Translation|string|null

Implementation of

Charcoal\Cms\NewsInterface::infoUrl()
public DateTimeInterface|null
# newsDate( )

Returns

DateTimeInterface|null

Implementation of

Charcoal\Cms\NewsInterface::newsDate()
public Charcoal\Translator\Translation|string|null
# content( )

Returns

Charcoal\Translator\Translation|string|null

Implementation of

Charcoal\Cms\NewsInterface::content()
public Charcoal\Translator\Translation|string|null
# image( )

Returns

Charcoal\Translator\Translation|string|null
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 array
# parseAsMultiple( mixed $value, string|PropertyInterface $separator = ',' )

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

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

Parameters

$value
The value being converted to an array.
$separator
The boundary string.

Returns

array
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