Symfony\Component\EventDispatcher\GenericEvent Class Reference

Inheritance diagram for Symfony\Component\EventDispatcher\GenericEvent:

Public Member Functions
	__construct ($subject=null, array $arguments=array())
	__construct ($subject=null, array $arguments=array())
	getArgument ($key)
	getArgument ($key)
	getArguments ()
	getArguments ()
	getIterator ()
	getIterator ()
	getSubject ()
	getSubject ()
	hasArgument ($key)
	hasArgument ($key)
	offsetExists ($key)
	offsetExists ($key)
	offsetGet ($key)
	offsetGet ($key)
	offsetSet ($key, $value)
	offsetSet ($key, $value)
	offsetUnset ($key)
	offsetUnset ($key)
	setArgument ($key, $value)
	setArgument ($key, $value)
	setArguments (array $args=array())
	setArguments (array $args=array())
Public Member Functions inherited from Symfony\Component\EventDispatcher\Event
	getDispatcher ()
	getDispatcher ()
	getName ()
	getName ()
	isPropagationStopped ()
	isPropagationStopped ()
	setDispatcher (EventDispatcherInterface $dispatcher)
	setDispatcher (EventDispatcherInterface $dispatcher)
	setName ($name)
	setName ($name)
	stopPropagation ()
	stopPropagation ()

Protected Attributes
	$arguments
	$subject

Detailed Description

Event encapsulation class.

Encapsulates events thus decoupling the observer from the subject they encapsulate.

Author

Drak drak@.nosp@m.ziku.nosp@m.la.or.nosp@m.g

Definition at line 21 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

Constructor & Destructor Documentation

__construct() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::__construct	(		$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

Definition at line 32 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\$arguments, and Symfony\Component\EventDispatcher\GenericEvent\$subject.

__construct() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::__construct	(		$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

Definition at line 32 of file vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\$arguments, and Symfony\Component\EventDispatcher\GenericEvent\$subject.

Member Function Documentation

getArgument() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::getArgument

(

$key

)

Get argument by key.

Parameters

string

$key

Key

Returns

mixed Contents of array key

Exceptions

Definition at line 57 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\hasArgument().

Referenced by Symfony\Component\EventDispatcher\GenericEvent\offsetGet().

getArgument() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::getArgument

(

$key

)

Get argument by key.

Parameters

string

$key

Key

Returns

mixed Contents of array key

Exceptions

Definition at line 57 of file vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\hasArgument().

getArguments() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::getArguments

(

)

Getter for all arguments.

Returns

array

Definition at line 86 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\$arguments.

getArguments() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::getArguments

(

)

Getter for all arguments.

Returns

array

Definition at line 86 of file vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\$arguments.

getIterator() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::getIterator

(

)

IteratorAggregate for iterating over the object like an array.

Returns

\ArrayIterator

Definition at line 171 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

getIterator() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::getIterator

(

)

IteratorAggregate for iterating over the object like an array.

Returns

\ArrayIterator

Definition at line 171 of file vendor/symfony/event-dispatcher/GenericEvent.php.

getSubject() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::getSubject

(

)

Getter for subject property.

Returns

mixed The observer subject

Definition at line 43 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\$subject.

getSubject() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::getSubject

(

)

Getter for subject property.

Returns

mixed The observer subject

Definition at line 43 of file vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\$subject.

hasArgument() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::hasArgument

(

$key

)

Has argument.

Parameters

string

$key

Key of arguments array

Returns

bool

Definition at line 112 of file vendor/symfony/event-dispatcher/GenericEvent.php.

hasArgument() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::hasArgument

(

$key

)

Has argument.

Parameters

string

$key

Key of arguments array

Returns

bool

Definition at line 112 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

Referenced by Symfony\Component\EventDispatcher\GenericEvent\getArgument(), Symfony\Component\EventDispatcher\GenericEvent\offsetExists(), and Symfony\Component\EventDispatcher\GenericEvent\offsetUnset().

offsetExists() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::offsetExists

(

$key

)

ArrayAccess has argument.

Parameters

string

$key

Array key

Returns

bool

Definition at line 161 of file vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\hasArgument().

offsetExists() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::offsetExists

(

$key

)

ArrayAccess has argument.

Parameters

string

$key

Array key

Returns

bool

Definition at line 161 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\hasArgument().

offsetGet() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::offsetGet

(

$key

)

ArrayAccess for argument getter.

Parameters

string

$key

Array key

Returns

mixed

Exceptions

Definition at line 126 of file vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\getArgument().

offsetGet() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::offsetGet

(

$key

)

ArrayAccess for argument getter.

Parameters

string

$key

Array key

Returns

mixed

Exceptions

Definition at line 126 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\getArgument().

offsetSet() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::offsetSet	(		$key,
			$value
	)

ArrayAccess for argument setter.

Parameters

string	$key	Array key to set
mixed	$value	Value

Definition at line 137 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\setArgument().

offsetSet() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::offsetSet	(		$key,
			$value
	)

ArrayAccess for argument setter.

Parameters

string	$key	Array key to set
mixed	$value	Value

Definition at line 137 of file vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\setArgument().

offsetUnset() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::offsetUnset

(

$key

)

ArrayAccess for unset argument.

Parameters

string

$key

Array key

Definition at line 147 of file vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\hasArgument().

offsetUnset() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::offsetUnset

(

$key

)

ArrayAccess for unset argument.

Parameters

string

$key

Array key

Definition at line 147 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

References Symfony\Component\EventDispatcher\GenericEvent\hasArgument().

setArgument() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::setArgument	(		$key,
			$value
	)

Add argument to event.

Parameters

string	$key	Argument name
mixed	$value	Value

Returns

$this

Definition at line 74 of file vendor/symfony/event-dispatcher/GenericEvent.php.

setArgument() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::setArgument	(		$key,
			$value
	)

Add argument to event.

Parameters

string	$key	Argument name
mixed	$value	Value

Returns

$this

Definition at line 74 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

Referenced by Symfony\Component\EventDispatcher\GenericEvent\offsetSet().

setArguments() [1/2]

Symfony\Component\EventDispatcher\GenericEvent::setArguments

(

array

$args = array()

)

Set args property.

Parameters

array

$args

Arguments

Returns

$this

Definition at line 98 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

setArguments() [2/2]

Symfony\Component\EventDispatcher\GenericEvent::setArguments

(

array

$args = array()

)

Set args property.

Parameters

array

$args

Arguments

Returns

$this

Definition at line 98 of file vendor/symfony/event-dispatcher/GenericEvent.php.

Field Documentation

$arguments

Symfony\Component\EventDispatcher\GenericEvent::$arguments

protected

Definition at line 24 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

Referenced by Symfony\Component\EventDispatcher\GenericEvent\__construct(), and Symfony\Component\EventDispatcher\GenericEvent\getArguments().

$subject

Symfony\Component\EventDispatcher\GenericEvent::$subject

protected

Definition at line 23 of file lib/vendor/symfony/event-dispatcher/GenericEvent.php.

Referenced by Symfony\Component\EventDispatcher\GenericEvent\__construct(), and Symfony\Component\EventDispatcher\GenericEvent\getSubject().

---

The documentation for this class was generated from the following file:

• lib/vendor/symfony/event-dispatcher/GenericEvent.php