TimelineEntryRenderEvent

TimelineEntryRenderEvent.php : 16 Copy path

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¶

__construct() ¶

TimelineEntryRenderEvent.php : 40 Copy path

    
                        public __construct(WorkflowMetadata $workflowMetadata, AbstractEntry $entry, TemplateWrapper $template, string $blockName[, array<string|int, mixed> $parameters = [] ])

Parameters

Name	Type	Default value	Description
$workflowMetadata	WorkflowMetadata	-	-
$entry	AbstractEntry	-	-
$template	TemplateWrapper	-	-
$blockName	string	-	-
$parameters	array<string\|int, mixed>	[]	-

getBlockName() ¶

TimelineEntryRenderEvent.php : 89 Copy path

public getBlockName() : string

Return values

string

getEntry() ¶

TimelineEntryRenderEvent.php : 65 Copy path

public getEntry() : AbstractEntry

Return values

AbstractEntry

getParameters() ¶

TimelineEntryRenderEvent.php : 105 Copy path

public getParameters() : array<string|int, mixed>

Return values

array<string|int, mixed>

getTemplate() ¶

TimelineEntryRenderEvent.php : 73 Copy path

public getTemplate() : TemplateWrapper

Return values

TemplateWrapper

getWorkflowMetadata() ¶

TimelineEntryRenderEvent.php : 57 Copy path

public getWorkflowMetadata() : WorkflowMetadata

Return values

WorkflowMetadata

isPropagationStopped() ¶

Event.php : 38 Copy path

public isPropagationStopped() : bool

Return values

bool

setBlockName() ¶

TimelineEntryRenderEvent.php : 97 Copy path

public setBlockName(string $blockName) : void

Parameters

Name	Type	Default value	Description
$blockName	string	-	-

setParameters() ¶

TimelineEntryRenderEvent.php : 113 Copy path

public setParameters(array<string|int, mixed> $parameters) : void

Parameters

Name	Type	Default value	Description
$parameters	array<string\|int, mixed>	-	-

setTemplate() ¶

TimelineEntryRenderEvent.php : 81 Copy path

public setTemplate(TemplateWrapper $template) : void

Parameters

Name	Type	Default value	Description
$template	TemplateWrapper	-	-

stopPropagation() ¶

Event.php : 50 Copy path

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().