Documentation

CloseEvent 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

$_code  : array<string|int, mixed>
$_reason  : mixed
$propagationStopped  : mixed

Methods

__construct()  : mixed
SuccessEvent constructor.
code()  : array<string|int, mixed>
isPropagationStopped()  : bool
Returns whether further event listeners should be triggered.
reason()  : array<string|int, mixed>
stopPropagation()  : void
Stops the propagation of the event to further event listeners.

Properties

$_code

protected array<string|int, mixed> $_code

$propagationStopped

private mixed $propagationStopped = false

Methods

__construct()

SuccessEvent constructor.

public __construct([string $code = null ][, string $reason = null ]) : mixed
Parameters
$code : string = null
$reason : string = null

code()

public code() : array<string|int, mixed>
Return values
array<string|int, mixed>

isPropagationStopped()

Returns whether further event listeners should be triggered.

public isPropagationStopped() : bool
Return values
bool

reason()

public reason() : array<string|int, mixed>
Return values
array<string|int, mixed>

stopPropagation()

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


        
On this page

Search results