Overview

Namespaces

  • Charcoal
    • Admin
      • Widget
        • Cms
    • Cms
      • Config
      • Mixin
        • Traits
      • Route
      • Section
      • Service
        • Loader
        • Manager
      • ServiceProvider
      • Support
        • Helpers
        • Interfaces
        • Traits
    • Property

Traits

  • DateHelperAwareTrait
  • EventManagerAwareTrait
  • NewsManagerAwareTrait
  • SectionLoaderAwareTrait
  • Overview
  • Namespace
  • Class

Trait EventManagerAwareTrait

Namespace: Charcoal\Cms\Support\Traits
Located at Charcoal/Cms/Support/Traits/EventManagerAwareTrait.php
Methods summary
public Generator|
# eventsList( )

Formatted event list Return the entries for the current page

Formatted event list Return the entries for the current page

Returns

Generator|
public Generator|
# eventArchiveList( )

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

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

Returns

Generator|
public array
# currentEvent( )

Current event.

Current event.

Returns

array
The properties of the current event.
public mixed
# featEvents( )

Returns

mixed
public array
# nextEvent( )

Next event in list.

Next event in list.

Returns

array
The next event properties.
public array
# prevEvent( )

Next event in list.

Next event in list.

Returns

array
The next event properties.
public integer
# numEvent( )

Amount of events (total)

Amount of events (total)

Returns

integer
How many events?
public float
# numEventPages( )

Returns

float
public boolean
# eventHasPager( )

Returns

boolean
public Generator
# eventCategoryList( )

Returns

Generator
protected Charcoal\Object\CategoryInterface
# eventCategory( Charcoal\Cms\EventInterface $event )

Parameters

$event
Charcoal\Cms\EventInterface.

Returns

Charcoal\Object\CategoryInterface
protected string
# getEventStartDateFormat( Charcoal\Cms\EventInterface $event )

Parameters

$event
Charcoal\Cms\EventInterface.

Returns

string
protected string
# getEventEndDateFormat( Charcoal\Cms\EventInterface $event )

Parameters

$event
Charcoal\Cms\EventInterface.

Returns

string
protected string
# getEventDateFormat( Charcoal\Cms\EventInterface $event )

Parameters

$event
Charcoal\Cms\EventInterface.

Returns

string
protected string
# getEventTimeFormat( Charcoal\Cms\EventInterface $event )

Parameters

$event
Charcoal\Cms\EventInterface.

Returns

string
protected array
# eventFormatShort( Charcoal\Cms\EventInterface $event )

Formatting expected in templates

Formatting expected in templates

Parameters

$event
Charcoal\Cms\EventInterface.

Returns

array
The needed event properties.
protected array
# eventFormatNav( Charcoal\Cms\EventInterface $event )

Formatting expected in templates

Formatting expected in templates

Parameters

$event
Charcoal\Cms\EventInterface.

Returns

array
The needed event properties.
protected array
# eventFormatFull( Charcoal\Cms\EventInterface $event )

Parameters

$event
The current event.

Returns

array
The needed properties.
protected array
# eventFormatCategory( Charcoal\Object\CategoryInterface $category )

Parameters

$category
The category item.

Returns

array
The formatted category item.
protected Charcoal\Cms\Service\Manager\EventManager
# eventManager( )

Returns

Charcoal\Cms\Service\Manager\EventManager

Throws

Slim\Exception\ContainerException
When dependency is missing.
protected Charcoal\Cms\Support\Traits\EventManagerAwareTrait
# setEventManager( Charcoal\Cms\Service\Manager\EventManager $eventManager )

Parameters

$eventManager
The event Manager class.

Returns

Charcoal\Cms\Support\Traits\EventManagerAwareTrait
abstract protected mixed
# dateHelper( )

dateHelperAwareTrait dependency

dateHelperAwareTrait dependency

Returns

mixed
API documentation generated by ApiGen