Documentation

Event extends Event
in package
implements ToArrayInterface, ArrayAccess, IteratorAggregate

Default event for Guzzle notifications

Interfaces, Classes and Traits

ToArrayInterface
An object that can be represented as an array
ArrayAccess
IteratorAggregate

Table of Contents

$context  : array<string|int, mixed>
$propagationStopped  : bool
__construct()  : mixed
getIterator()  : mixed
isPropagationStopped()  : bool
Returns whether further event listeners should be triggered.
offsetExists()  : mixed
offsetGet()  : mixed
offsetSet()  : mixed
offsetUnset()  : mixed
stopPropagation()  : mixed
Stops the propagation of the event to further event listeners.
toArray()  : array<string|int, mixed>
Get the array representation of an object

Properties

$context

private array<string|int, mixed> $context

$propagationStopped

private bool $propagationStopped = false

Whether no further event listeners should be triggered

Methods

__construct()

public __construct([array<string|int, mixed> $context = array() ]) : mixed
Parameters
$context : array<string|int, mixed> = array()

Contextual information

Return values
mixed

getIterator()

public getIterator() : mixed
Return values
mixed

isPropagationStopped()

Returns whether further event listeners should be triggered.

public isPropagationStopped() : bool
Tags
see
Event::stopPropagation()
Return values
bool

Whether propagation was already stopped for this event

offsetExists()

public offsetExists(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetGet()

public offsetGet(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

offsetSet()

public offsetSet(mixed $offset, mixed $value) : mixed
Parameters
$offset : mixed
$value : mixed
Return values
mixed

offsetUnset()

public offsetUnset(mixed $offset) : mixed
Parameters
$offset : mixed
Return values
mixed

stopPropagation()

Stops the propagation of the event to further event listeners.

public stopPropagation() : mixed

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().

Return values
mixed

toArray()

Get the array representation of an object

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

Search results