Copied!

CalendarServiceInterface

CalendarServiceInterface.php : 13

Constants

publicGROUP_BY_DAY

CalendarServiceInterface.php : 15 
public mixed GROUP_BY_DAY = 'P1D'

publicGROUP_BY_WEEK

CalendarServiceInterface.php : 16 
public mixed GROUP_BY_WEEK = 'P7D'

Methods

publicexecuteAction()

CalendarServiceInterface.php : 23

Executes action.

 
public executeAction(EventActionContext $context) : void

Parameters

Name Type Default value Description
$context EventActionContext - -
Tags
Throws
UnsupportedActionException

publicgetEvents()

CalendarServiceInterface.php : 35

Get events matching given criteria.

 
public getEvents(EventQuery $query) : EventList

Parameters

Name Type Default value Description
$query EventQuery - -

Return values

EventList

publicgetGroupedEvents()

CalendarServiceInterface.php : 40

Get and group events matching given criteria.

 
public getGroupedEvents(EventQuery $query[, string $groupBy = self::GROUP_BY_DAY ]) : EventGroupList

Parameters

Name Type Default value Description
$query EventQuery - -
$groupBy string CalendarServiceInterface::GROUP_BY_DAY -

Return values

EventGroupList

publicloadEvents()

CalendarServiceInterface.php : 30

Bulk-load Events with given id's. Erroneous events will be skipped.

 
public loadEvents(array<string|int, string> $eventsIds) : EventCollection

Parameters

Name Type Default value Description
$eventsIds array<string|int, string> - -

Return values

EventCollection