Skip to content

Class Events

Extends Component

Constants

EVENT_REGISTER_SOURCE_TYPES

See RegisterEventSourceTypesEvent

EVENT_REGISTER_SOURCES

See RegisterEventSourcesEvent

Methods

findDateField

public findDateField(ElementInterface|FieldLayoutProviderInterface $type): ?EventDate
$type ElementInterface|FieldLayoutProviderInterface
return ?EventDate

getSourceTypes

public getSourceTypes(): class-string<EventSource>[]
return class-string<EventSource>[]

getSources

public getSources(): array<string,EventSource>
return array<string,EventSource>

findSourceByKey

public findSourceByKey(string $key): EventSource
$key string
return EventSource

getEvents

public getEvents(mixed $date = null, ?array $extraCriteria = null, string[]|null $sourceKeys = null, User|null $user = null): array<string,ElementInterface[]>
$date mixed
$extraCriteria ?array
$sourceKeys string[]|null
$user User|null only return events the user can access
return array<string,ElementInterface[]>

updateICalendarSequence

public updateICalendarSequence(int $elementId): void
$elementId int