Fork me on Github

Class CalendR\Event\Provider\ Basic

Basic event provider.

Add and retrieve events like with an array.


Implements: ProviderInterface, IteratorAggregate, Countable

Methods

getEvents( DateTime $begin, DateTime $end, array $options = array())

add( EventInterface $event)

Adds an event to the provider

array<EventInterface> all()

Returns all events

Traversable getIterator()

Retrieve an external iterator

int count()

The return value is cast to an integer.

Details

public getEvents( DateTime $begin, DateTime $end, array $options = array())

Parameters
DateTime $begin
DateTime $end
array $options

public add( EventInterface $event)

Adds an event to the provider

Parameters
EventInterface $event

public array<EventInterface> all()

Returns all events

Return Value
array<EventInterface>

public Traversable getIterator()

Retrieve an external iterator

Return Value
Traversable

public int count()

The return value is cast to an integer.

Return Value
int