Copied!

EventQuery

EventQuery.php : 19

Defines parameters used to fetch events.

Use EventQueryBuilder instead of creating this object directly.

Tags
See
EventQueryBuilder
See
CalendarServiceInterface::getEvents()

Constants

publicDEFAULT_COUNT

EventQuery.php : 21
public mixed DEFAULT_COUNT = 10

Methods

public__construct()

EventQuery.php : 38
public __construct(DateRange $dateRange[, int $count = self::DEFAULT_COUNT ][, array<string|int, mixed>|null $types = null ][, array<string|int, mixed>|null $languages = null ][, Cursor|null $cursor = null ])

Parameters

Name Type Default value Description
$dateRange DateRange - -
$count int EventQuery::DEFAULT_COUNT -
$types array<string|int, mixed>|null null -
$languages array<string|int, mixed>|null null -
$cursor Cursor|null null -

publicgetCount()

EventQuery.php : 63

Returns number of events to fetch.

public getCount() : int

Return values

int

publicgetCursor()

EventQuery.php : 68
public getCursor() : Cursor|null

Return values

Cursor|null

publicgetDateRange()

EventQuery.php : 55

Returns date range to fetch events for.

public getDateRange() : DateRange

Return values

DateRange

publicgetLanguages()

EventQuery.php : 88

Returns languages to fetch events for.

public getLanguages() : array<string|int, Language>|null

Return values

array<string|int, Language>|null

publicgetTypes()

EventQuery.php : 78

Returns event types to fetch events for.

public getTypes() : array<string|int, string>|null

Return values

array<string|int, string>|null

publicmodify()

EventQuery.php : 98

Allows to modify this query using EventQueryBuilder.

public modify() : EventQueryBuilder

Return values

EventQueryBuilder

Tags
See
EventQueryBuilder