isPropagationStopped()
stopPropagation()
setDispatcher()
getDispatcher()
getName()
setName()
__construct()
getSubject()
getArgument()
setArgument()
getArguments()
setArguments()
hasArgument()
offsetGet()
offsetSet()
offsetUnset()
offsetExists()
getIterator()

No public properties found

No constants found

No protected methods found

$subject
$arguments

N/A

No private methods found

$propagationStopped
$dispatcher
$name

N/A

File: vendor/symfony/event-dispatcher/GenericEvent.php
Package: Default
Class hierarchy: \Symfony\Component\EventDispatcher\Event

\Symfony\Component\EventDispatcher\GenericEvent
Implements

Properties

$subject

$subject :

Type

$arguments

$arguments :

Type

$propagationStopped

$propagationStopped : boolean

Type

boolean — Whether no further event listeners should be triggered

$dispatcher

$dispatcher : \Symfony\Component\EventDispatcher\EventDispatcherInterface

Type

\Symfony\Component\EventDispatcher\EventDispatcherInterface — Dispatcher that dispatched this event

$name

$name : string

Type

string — This event's name

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

setDispatcher()

setDispatcher(\Symfony\Component\EventDispatcher\EventDispatcherInterface  $dispatcher)

Stores the EventDispatcher that dispatches this Event.

Parameters

\Symfony\Component\EventDispatcher\EventDispatcherInterface

$dispatcher

getDispatcher()

getDispatcher() : \Symfony\Component\EventDispatcher\EventDispatcherInterface

Returns the EventDispatcher that dispatches this Event.

Returns

\Symfony\Component\EventDispatcher\EventDispatcherInterface

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(mixed  $subject = null, array  $arguments = array())

Encapsulate an event with $subject and $args.

Parameters

mixed	$subject	The subject of the event, usually an object or a callable
array	$arguments	Arguments to store in the event

getSubject()

getSubject() : mixed

Getter for subject property.

Returns

mixed —

The observer subject

getArgument()

getArgument(string  $key) : mixed

Get argument by key.

Parameters

string

$key

Key

Throws

\InvalidArgumentException: if key is not found

Returns

mixed —

Contents of array key

setArgument()

setArgument(string  $key, mixed  $value) : $this

Add argument to event.

Parameters

string	$key	Argument name
mixed	$value	Value

Returns

$this

getArguments()

getArguments() : array

Getter for all arguments.

Returns

array

setArguments()

setArguments(array  $args = array()) : $this

Set args property.

Parameters

array

$args

Arguments

Returns

$this

hasArgument()

hasArgument(string  $key) : boolean

Has argument.

Parameters

string

$key

Key of arguments array

Returns

boolean

offsetGet()

offsetGet(string  $key) : mixed

ArrayAccess for argument getter.

Parameters

string

$key

Array key

Throws

\InvalidArgumentException: if key does not exist in $this->args

Returns

mixed

offsetSet()

offsetSet(string  $key, mixed  $value)

ArrayAccess for argument setter.

Parameters

string	$key	Array key to set
mixed	$value	Value

offsetUnset()

offsetUnset(string  $key)

ArrayAccess for unset argument.

Parameters

string

$key

Array key

offsetExists()

offsetExists(string  $key) : boolean

ArrayAccess has argument.

Parameters

string

$key

Array key

Returns

boolean

getIterator()

getIterator() : \ArrayIterator

IteratorAggregate for iterating over the object like an array.

Returns

\ArrayIterator