Properties

$modelFactory

$modelFactory : \Charcoal\Factory\FactoryInterface

Store the factory instance for the current class.

Type

\Charcoal\Factory\FactoryInterface

$collectionLoader

$collectionLoader : \Charcoal\Loader\CollectionLoader

Store the collection loader for the current class.

Type

\Charcoal\Loader\CollectionLoader

$objType

$objType : object

Type

object — The object to load.

$proto

$proto : \Charcoal\Cms\Service\Loader\ModelInterface

Event prototype.

Type

\Charcoal\Cms\Service\Loader\ModelInterface

$lifespan

$lifespan : string

Type

string — The lifespan of events.

Methods

__construct()

__construct(array  $data) 

NewsLoader constructor.

Parameters

array $data

The Data.

Throws

\Exception

When there is missing data.

modelFactory()

modelFactory() : \Charcoal\Factory\FactoryInterface

Retrieve the object model factory.

Throws

\RuntimeException

If the model factory was not previously set.

Returns

\Charcoal\Factory\FactoryInterface

collectionLoader()

collectionLoader() : \Charcoal\Loader\CollectionLoader

Retrieve the model collection loader.

Throws

\RuntimeException

If the collection loader was not previously set.

Returns

\Charcoal\Loader\CollectionLoader

proto()

proto() : \Charcoal\Cms\Service\Loader\[type]

[proto description]

Returns

\Charcoal\Cms\Service\Loader\[type] —

[description]

all()

all() : \Charcoal\Loader\CollectionLoader

Returns

\Charcoal\Loader\CollectionLoader

published()

published() : \Charcoal\Loader\CollectionLoader

Returns

\Charcoal\Loader\CollectionLoader

upcoming()

upcoming() : \Charcoal\Loader\CollectionLoader

Fetch upcoming entries based on the lifespan or now.

Returns

\Charcoal\Loader\CollectionLoader

archive()

archive() : \Charcoal\Loader\CollectionLoader

Fetch upcoming entries based on the lifespan or now.

Returns

\Charcoal\Loader\CollectionLoader

since()

since(mixed  $date) : \Charcoal\Loader\CollectionLoader

Parameters

mixed $date

The news date to filter [startDate, endDate] DateTimeInterface string.

Returns

\Charcoal\Loader\CollectionLoader

to()

to(mixed  $date) : \Charcoal\Loader\CollectionLoader

Parameters

mixed $date

The news date to filter [startDate, endDate] DateTimeInterface string.

Returns

\Charcoal\Loader\CollectionLoader

lifespan()

lifespan() : mixed

Returns

mixed

objType()

objType() : object

Returns

object

setLifespan()

setLifespan(string  $lifespan) : self

Parameters

string $lifespan

The lifespan of events.

Returns

self —

Chainable

setObjType()

setObjType(object  $objType) : self

Parameters

object $objType

The object type.

Returns

self —

Chainable

setModelFactory()

setModelFactory(\Charcoal\Factory\FactoryInterface  $factory) : self

Set an object model factory.

Parameters

\Charcoal\Factory\FactoryInterface $factory

The model factory, to create objects.

Returns

self

setCollectionLoader()

setCollectionLoader(\Charcoal\Loader\CollectionLoader  $loader) : self

Set a model collection loader.

Parameters

\Charcoal\Loader\CollectionLoader $loader

The collection loader.

Returns

self

parseAsDate()

parseAsDate(mixed  $date) : \DateTime

Parameters

mixed $date

The date to convert.

Returns

\DateTime