Copied!

TimelineEvent

TimelineEvent.php : 15
Extends Event

Event is the base class for classes containing event data.

This class contains no event data. It is used by events that do not pass state information to an event handler when an event is raised.

You can call the method stopPropagation() to abort the execution of further listeners in your event listener.

Methods

public__construct()

TimelineEvent.php : 27
public __construct(WorkflowMetadata $workflowMetadata[, array<string|int, AbstractEntry$entries = [] ])

Parameters

Name Type Default value Description
$workflowMetadata WorkflowMetadata - -
$entries array<string|int, AbstractEntry> [] -

publicaddEntries()

TimelineEvent.php : 70
public addEntries(array<string|int, AbstractEntry$entries) : void

Parameters

Name Type Default value Description
$entries array<string|int, AbstractEntry> - -

publicaddEntry()

TimelineEvent.php : 62
public addEntry(AbstractEntry $entry) : void

Parameters

Name Type Default value Description
$entry AbstractEntry - -

publicgetEntries()

TimelineEvent.php : 46
public getEntries() : array<string|int, AbstractEntry>

Return values

array<string|int, AbstractEntry>

publicgetWorkflowMetadata()

TimelineEvent.php : 38
public getWorkflowMetadata() : WorkflowMetadata

Return values

WorkflowMetadata

publicisPropagationStopped()

Event.php : 38
public isPropagationStopped() : bool

Return values

bool

publicsetEntries()

TimelineEvent.php : 54
public setEntries(array<string|int, AbstractEntry$entries) : void

Parameters

Name Type Default value Description
$entries array<string|int, AbstractEntry> - -

publicstopPropagation()

Event.php : 50

Stops the propagation of the event to further event listeners.

public stopPropagation() : void

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().