\Charcoal\Cms\Support\TraitsNewsManagerAwareTrait

Summary

Methods

Properties

Constants

newsList()
newsArchiveList()
currentNews()
featNews()
nextNews()
prevNews()
numNews()
numNewsPages()
newsHasPager()
newsCategoryList()
newsCategory()

No public properties found

No constants found

getNewsDateFormat()
newsFormatShort()
newsFormatNav()
newsFormatFull()
newsFormatCategory()
newsManager()
setNewsManager()
dateHelper()

No protected properties found

N/A

No private methods found

$currentNews
$newsManager

N/A

File: Cms/Support/Traits/NewsManagerAwareTrait.php
Package: Default
Class hierarchy: \Charcoal\Cms\Support\Traits\NewsManagerAwareTrait

Properties

$currentNews

$currentNews : array

Currently displayed news.

Type

array — City/Object/News

$newsManager

$newsManager : \Charcoal\Cms\Service\Manager\NewsManager

Type

\Charcoal\Cms\Service\Manager\NewsManager

Methods

newsList()

newsList() : \Generator|void

Formatted news list Returns the entries for the current page.

Returns

\Generator|void

newsArchiveList()

newsArchiveList() : \Generator|void

Formatted news archive list Returns the entries for the current page.

Returns

\Generator|void

currentNews()

currentNews() : array

Current news.

Returns

array —

The properties of the current news

featNews()

featNews() : \Generator

Returns

\Generator

nextNews()

nextNews() : array

Next news in list.

Returns

array —

The next news properties.

prevNews()

prevNews() : array

Next news in list.

Returns

array —

The next news properties.

numNews()

numNews() : integer

Amount of news (total)

Returns

integer —

How many news?

numNewsPages()

numNewsPages() : float

Returns

float

newsHasPager()

newsHasPager() : boolean

Returns

boolean

newsCategoryList()

newsCategoryList() : \Generator

Returns

\Generator

newsCategory()

newsCategory(\Charcoal\Cms\NewsInterface  $news) : \Charcoal\Object\CategoryInterface

Parameters

\Charcoal\Cms\NewsInterface

$news

Charcoal\Cms\NewsInterface.

Returns

\Charcoal\Object\CategoryInterface

getNewsDateFormat()

getNewsDateFormat(\Charcoal\Cms\NewsInterface  $news) : string

Parameters

\Charcoal\Cms\NewsInterface

$news

Charcoal\Cms\NewsInterface.

Returns

string

newsFormatShort()

newsFormatShort(\Charcoal\Cms\NewsInterface  $news) : array

Formatting expected in templates

Parameters

\Charcoal\Cms\NewsInterface

$news

A single news.

Returns

array —

The needed news properties.

newsFormatNav()

newsFormatNav(\Charcoal\Cms\NewsInterface  $news) : array

Formatting expected in templates

Parameters

\Charcoal\Cms\NewsInterface

$news

A single news.

Returns

array —

The needed news properties.

newsFormatFull()

newsFormatFull(\Charcoal\Cms\NewsInterface  $news) : array

Parameters

\Charcoal\Cms\NewsInterface

$news

The current news.

Returns

array —

The needed properties.

newsFormatCategory()

newsFormatCategory(\Charcoal\Object\CategoryInterface  $category) : array

Parameters

\Charcoal\Object\CategoryInterface

$category

The category item.

Returns

array —

The formatted category item.

newsManager()

newsManager() : \Charcoal\Cms\Service\Manager\NewsManager

Throws

\Slim\Exception\ContainerException: When dependency is missing.

Returns

\Charcoal\Cms\Service\Manager\NewsManager

setNewsManager()

setNewsManager(\Charcoal\Cms\Service\Manager\NewsManager  $newsManager) : self

Parameters

\Charcoal\Cms\Service\Manager\NewsManager

$newsManager

The news Manager class.

Returns

self

dateHelper()

dateHelper() : mixed

dateHelperAwareTrait dependency

Returns

mixed