BeforeUpdateSegmentEvent

BeforeUpdateSegmentEvent.php : 16 Copy path

Extends BeforeEvent

Event emitted before action execution.

Methods¶

BeforeUpdateSegmentEvent.php : 24 Copy path

    
                        public __construct(Segment $segment, SegmentUpdateStruct $updateStruct[, Segment|null $segmentResult = null ])

Name	Type	Default value	Description
$segment	Segment	-	-
$updateStruct	SegmentUpdateStruct	-	-
$segmentResult	Segment\|null	null	-

BeforeUpdateSegmentEvent.php : 31 Copy path

public getSegment() : Segment

Segment

BeforeUpdateSegmentEvent.php : 41 Copy path

public getSegmentResult() : Segment

Segment

BeforeUpdateSegmentEvent.php : 36 Copy path

public getUpdateStruct() : SegmentUpdateStruct

SegmentUpdateStruct

BeforeUpdateSegmentEvent.php : 57 Copy path

public hasSegmentResult() : bool

bool

Event.php : 38 Copy path

public isPropagationStopped() : bool

bool

BeforeUpdateSegmentEvent.php : 52 Copy path

public setSegmentResult(Segment|null $segmentResult) : void

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

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