Events

Full name: \boundstate\events\services\Events
Parent class: Component

Constants¶

Constant	Visibility	Type	Value
`EVENT_REGISTER_SOURCE_TYPES`	public		'registerSourceTypes'
`EVENT_REGISTER_SOURCES`	public		'registerSources'

Methods¶

findDateField¶

public findDateField(\craft\base\ElementInterface|\craft\base\FieldLayoutProviderInterface $type): ?\boundstate\events\fields\EventDate

Parameters:

Parameter	Type	Description
`$type`	\craft\base\ElementInterface\|\craft\base\FieldLayoutProviderInterface

getSourceTypes¶

public getSourceTypes(): class-string<\boundstate\events\models\EventSource>[]

getSources¶

public getSources(): array<string,\boundstate\events\models\EventSource>

findSourceByKey¶

public findSourceByKey(string $key): \boundstate\events\models\EventSource

Parameters:

Parameter	Type	Description
`$key`	string

getEvents¶

public getEvents(mixed $date = null, ?array $extraCriteria = null, string[]|null $sourceKeys = null, \craft\elements\User|null $user = null): array<string,\craft\base\ElementInterface[]>

Parameters:

Parameter	Type	Description
`$date`	mixed
`$extraCriteria`	?array
`$sourceKeys`	string[]\|null
`$user`	\craft\elements\User\|null	only return events the user can access

updateICalendarSequence¶

public updateICalendarSequence(int $elementId): void

Parameters:

Parameter	Type	Description
`$elementId`	int