Copied!

BeforeCreateSegmentEvent

BeforeCreateSegmentEvent.php : 16
Final
Extends BeforeEvent

Event emitted before action execution.

Methods

public__construct()

BeforeCreateSegmentEvent.php : 22 
public __construct(SegmentCreateStruct $createStruct[, Segment|null $segmentResult = null ])

Parameters

Name Type Default value Description
$createStruct SegmentCreateStruct - -
$segmentResult Segment|null null -

publicgetCreateStruct()

BeforeCreateSegmentEvent.php : 28 
public getCreateStruct() : SegmentCreateStruct

Return values

SegmentCreateStruct

publicgetSegmentResult()

BeforeCreateSegmentEvent.php : 33 
public getSegmentResult() : Segment

Return values

Segment

publichasSegmentResult()

BeforeCreateSegmentEvent.php : 49 
public hasSegmentResult() : bool

Return values

bool

publicisPropagationStopped()

Event.php : 38 
public isPropagationStopped() : bool

Return values

bool

publicsetSegmentResult()

BeforeCreateSegmentEvent.php : 44 
public setSegmentResult(Segment|null $segmentResult) : void

Parameters

Name Type Default value Description
$segmentResult Segment|null - -

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