Copied!

EventGroup

EventGroup.php : 14
Extends EventList

Group of events within given date range e.g. today's agenda.

Methods

public__construct()

EventList.php : 36
public __construct(EventQuery $query, EventCollection $events[, int $totalCount = 0 ])

Parameters

Name Type Default value Description
$query EventQuery -

Query used to fetch events.

$events EventCollection -

List of events.

$totalCount int 0

Total number of events matching query.

publiccreateEmpty()

EventList.php : 93

Creates empty event list.

public static createEmpty(EventQuery $query) : self

Parameters

Name Type Default value Description
$query EventQuery - -

Return values

self

publicfromEventList()

EventGroup.php : 21
public static fromEventList(EventList $eventList) : self

Parameters

Name Type Default value Description
$eventList EventList - -

Return values

self

publicgetEvents()

EventList.php : 43
public getEvents() : EventCollection

Return values

EventCollection

publicgetGroupKey()

EventGroup.php : 16
public getGroupKey() : DateRange

Return values

DateRange

publicgetIterator()

EventList.php : 64
public getIterator() : Iterator

Return values

Iterator

publicgetNextPageQuery()

EventList.php : 72

Returns next page query or null if no more events.

public getNextPageQuery() : EventQuery|null

Return values

EventQuery|null

publicgetQuery()

EventList.php : 59

Returns query used to fetch events.

public getQuery() : EventQuery

Return values

EventQuery

publicgetTotalCount()

EventList.php : 51

Returns total number of events matching query.

public getTotalCount() : int

Return values

int