Copied!

BrandContextAttributeRenderEvent

BrandContextAttributeRenderEvent.php : 15
Final
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()

BrandContextAttributeRenderEvent.php : 21 
public __construct(array<int, string> $templates, BrandContextAttributeValueInterface $attributeValue[, array<string, mixed> $parameters = [] ])

Parameters

Name Type Default value Description
$templates array<int, string> - -
$attributeValue BrandContextAttributeValueInterface - -
$parameters array<string, mixed> [] -

publicaddTemplateAfter()

BrandContextAttributeRenderEvent.php : 82 
public addTemplateAfter(string $template, string $targetTemplate) : void

Parameters

Name Type Default value Description
$template string - -
$targetTemplate string - -
Tags
Throws
InvalidArgumentException

if the target template is not on the list

publicaddTemplateBefore()

BrandContextAttributeRenderEvent.php : 72 
public addTemplateBefore(string $template, string $targetTemplate) : void

Parameters

Name Type Default value Description
$template string - -
$targetTemplate string - -
Tags
Throws
InvalidArgumentException

if the target template is not on the list

publicappendTemplate()

BrandContextAttributeRenderEvent.php : 59 
public appendTemplate(string $template) : void

Parameters

Name Type Default value Description
$template string - -

publicgetAttributeValue()

BrandContextAttributeRenderEvent.php : 94 
public getAttributeValue() : BrandContextAttributeValueInterface

Return values

BrandContextAttributeValueInterface

publicgetParameters()

BrandContextAttributeRenderEvent.php : 30 
public getParameters() : array<string, mixed>

Return values

array<string, mixed>

publicgetTemplates()

BrandContextAttributeRenderEvent.php : 46 
public getTemplates() : array<int, string>

Return values

array<int, string>

publichasTemplate()

BrandContextAttributeRenderEvent.php : 89 
public hasTemplate(string $template) : bool

Parameters

Name Type Default value Description
$template string - -

Return values

bool

publicisPropagationStopped()

Event.php : 35 
public isPropagationStopped() : bool

Return values

bool

publicprependTemplate()

BrandContextAttributeRenderEvent.php : 64 
public prependTemplate(string $template) : void

Parameters

Name Type Default value Description
$template string - -

publicsetParameters()

BrandContextAttributeRenderEvent.php : 38 
public setParameters(array<string, mixed> $parameters) : void

Parameters

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

publicsetTemplates()

BrandContextAttributeRenderEvent.php : 54 
public setTemplates(array<int, string> $templates) : void

Parameters

Name Type Default value Description
$templates array<int, string> - -

publicstopPropagation()

Event.php : 47

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