SuccessEvent
extends Event
in package
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.
Table of Contents
Properties
- $_response : ApiResponse
- $propagationStopped : mixed
Methods
- __construct() : mixed
- SuccessEvent constructor.
- apiResponse() : ApiResponse
- isPropagationStopped() : bool
- Returns whether further event listeners should be triggered.
- stopPropagation() : void
- Stops the propagation of the event to further event listeners.
Properties
$_response
protected
ApiResponse
$_response
$propagationStopped
private
mixed
$propagationStopped
= false
Methods
__construct()
SuccessEvent constructor.
public
__construct(ApiResponse $response) : mixed
Parameters
- $response : ApiResponse
apiResponse()
public
apiResponse() : ApiResponse
Return values
ApiResponseisPropagationStopped()
Returns whether further event listeners should be triggered.
public
isPropagationStopped() : bool
Return values
boolstopPropagation()
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().