Copied!

Event

Event.php : 22
Abstract

Base class for calendar events.

See documentation

Methods

public__construct()

Event.php : 26 
public __construct(EventTypeInterface $type, string $id, DateTimeInterface $dateTime)

Parameters

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

public__toString()

Event.php : 91 
public __toString() : string

Return values

string

publiccompareTo()

Event.php : 86

Compares $this with given $event.

 
public compareTo(Event $event) : int

Parameters

Name Type Default value Description
$event Event - -

Return values

int

publicgetDateTime()

Event.php : 48 
public getDateTime() : DateTimeInterface

Return values

DateTimeInterface

publicgetId()

Event.php : 43 
public getId() : string

Return values

string

publicgetName()

Event.php : 56

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

 
public getName() : string

Return values

string

publicgetType()

Event.php : 38 
public getType() : EventTypeInterface

Return values

EventTypeInterface

publicisAfter()

Event.php : 66

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

publicisBefore()

Event.php : 76

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

protectedexecuteAction()

Event.php : 96 
protected executeAction(EventActionContext $context) : void

Parameters

Name Type Default value Description
$context EventActionContext - -