\Guzzle\CommonEvent

Default event for Guzzle notifications

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.

Summary

Methods
Properties
Constants
isPropagationStopped()
stopPropagation()
setDispatcher()
getDispatcher()
getName()
setName()
__construct()
getIterator()
offsetGet()
offsetSet()
offsetExists()
offsetUnset()
toArray()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$propagationStopped
$dispatcher
$name
$context
N/A

Properties

$propagationStopped

$propagationStopped : boolean

Type

boolean — Whether no further event listeners should be triggered

$name

$name : string

Type

string — This event's name

$context

$context : array

Type

array

Methods

isPropagationStopped()

isPropagationStopped() : boolean

Returns whether further event listeners should be triggered.

Returns

boolean —

Whether propagation was already stopped for this event

stopPropagation()

stopPropagation() 

Stops the propagation of the event to further event listeners.

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

getName()

getName() : string

Gets the event's name.

Returns

string

setName()

setName(string  $name) 

Sets the event's name property.

Parameters

string $name

The event name

__construct()

__construct(array  $context = array()) 

Parameters

array $context

Contextual information

getIterator()

getIterator() 

offsetGet()

offsetGet(  $offset) 

Parameters

$offset

offsetSet()

offsetSet(  $offset,   $value) 

Parameters

$offset
$value

offsetExists()

offsetExists(  $offset) 

Parameters

$offset

offsetUnset()

offsetUnset(  $offset) 

Parameters

$offset

toArray()

toArray() : array

Get the array representation of an object

Returns

array