Properties

$currentEvent

$currentEvent : array

Currently displayed event.

Type

array — City/Object/Event

Methods

eventsList()

eventsList() : \Generator|void

Formatted event list Return the entries for the current page

Returns

\Generator|void

eventArchiveList()

eventArchiveList() : \Generator|void

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

Returns

\Generator|void

currentEvent()

currentEvent() : array

Current event.

Returns

array —

The properties of the current event.

featEvents()

featEvents() : mixed

Returns

mixed

nextEvent()

nextEvent() : array

Next event in list.

Returns

array —

The next event properties.

prevEvent()

prevEvent() : array

Next event in list.

Returns

array —

The next event properties.

numEvent()

numEvent() : integer

Amount of events (total)

Returns

integer —

How many events?

numEventPages()

numEventPages() : float

Returns

float

eventHasPager()

eventHasPager() : boolean

Returns

boolean

eventCategoryList()

eventCategoryList() : \Generator

Returns

\Generator

eventCategory()

eventCategory(\Charcoal\Cms\EventInterface  $event) : \Charcoal\Object\CategoryInterface

Parameters

\Charcoal\Cms\EventInterface $event

Charcoal\Cms\EventInterface.

Returns

\Charcoal\Object\CategoryInterface

getEventStartDateFormat()

getEventStartDateFormat(\Charcoal\Cms\EventInterface  $event) : string

Parameters

\Charcoal\Cms\EventInterface $event

Charcoal\Cms\EventInterface.

Returns

string

getEventEndDateFormat()

getEventEndDateFormat(\Charcoal\Cms\EventInterface  $event) : string

Parameters

\Charcoal\Cms\EventInterface $event

Charcoal\Cms\EventInterface.

Returns

string

getEventDateFormat()

getEventDateFormat(\Charcoal\Cms\EventInterface  $event) : string

Parameters

\Charcoal\Cms\EventInterface $event

Charcoal\Cms\EventInterface.

Returns

string

getEventTimeFormat()

getEventTimeFormat(\Charcoal\Cms\EventInterface  $event) : string

Parameters

\Charcoal\Cms\EventInterface $event

Charcoal\Cms\EventInterface.

Returns

string

eventFormatShort()

eventFormatShort(\Charcoal\Cms\EventInterface  $event) : array

Formatting expected in templates

Parameters

\Charcoal\Cms\EventInterface $event

Charcoal\Cms\EventInterface.

Returns

array —

The needed event properties.

eventFormatNav()

eventFormatNav(\Charcoal\Cms\EventInterface  $event) : array

Formatting expected in templates

Parameters

\Charcoal\Cms\EventInterface $event

Charcoal\Cms\EventInterface.

Returns

array —

The needed event properties.

eventFormatFull()

eventFormatFull(\Charcoal\Cms\EventInterface  $event) : array

Parameters

\Charcoal\Cms\EventInterface $event

The current event.

Returns

array —

The needed properties.

eventFormatCategory()

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

Parameters

\Charcoal\Object\CategoryInterface $category

The category item.

Returns

array —

The formatted category item.

dateHelper()

dateHelper() : mixed

dateHelperAwareTrait dependency

Returns

mixed