Event

Event.php : 22 Copy path

Abstract

Base class for calendar events.

See documentation

Methods¶

__construct() ¶

Event.php : 33 Copy path

public __construct(EventTypeInterface $type, string $id, DateTimeInterface $dateTime)

Parameters

Name	Type	Default value	Description
$type	EventTypeInterface	-	-
$id	string	-	-
$dateTime	DateTimeInterface	-	-

__toString() ¶

Event.php : 97 Copy path

public __toString() : mixed

compareTo() ¶

Event.php : 92 Copy path

Compares $this with given $event.

public compareTo(Event $event) : int

Parameters

Name	Type	Default value	Description
$event	Event	-	-

Return values

int

getDateTime() ¶

Event.php : 54 Copy path

public getDateTime() : DateTimeInterface

Return values

DateTimeInterface

getId() ¶

Event.php : 49 Copy path

public getId() : string

Return values

string

getName() ¶

Event.php : 62 Copy path

Returns human-readable label of the event. For example: "Birthday of John".

public getName() : string

Return values

string

getType() ¶

Event.php : 44 Copy path

public getType() : EventTypeInterface

Return values

EventTypeInterface

isAfter() ¶

Event.php : 72 Copy path

Returns true if the $this is after given $event.

public isAfter(Event $event) : bool

Parameters

Name	Type	Default value	Description
$event	Event	-	-

Return values

bool

isBefore() ¶

Event.php : 82 Copy path

Returns true if the $this is before given $event.

public isBefore(Event $event) : bool

Parameters

Name	Type	Default value	Description
$event	Event	-	-

Return values

bool

executeAction() ¶

Event.php : 102 Copy path

protected executeAction(EventActionContext $context) : void

Parameters

Name	Type	Default value	Description
$context	EventActionContext	-	-