* This file is part of the Symfony package.
* (c) Fabien Potencier <fabien@symfony.com>
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
namespace Symfony\Component\EventDispatcher;
* Event encapsulation class.
* Encapsulates events thus decoupling the observer from the subject they encapsulate.
* @author Drak <drak@zikula.org>
class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
* Encapsulate an event with $subject and $args.
* @param mixed $subject The subject of the event, usually an object or a callable
* @param array $arguments Arguments to store in the event
public function __construct($subject = null, array $arguments = array())
$this->subject = $subject;
$this->arguments = $arguments;
* Getter for subject property.
* @return mixed The observer subject
public function getSubject()
* @return mixed Contents of array key
* @throws \InvalidArgumentException if key is not found
public function getArgument($key)
if ($this->hasArgument($key)) {
return $this->arguments[$key];
throw new \InvalidArgumentException(sprintf('Argument "%s" not found.', $key));
* @param string $key Argument name
* @param mixed $value Value
public function setArgument($key, $value)
$this->arguments[$key] = $value;
* Getter for all arguments.
public function getArguments()
* @param array $args Arguments
public function setArguments(array $args = array())
$this->arguments = $args;
* @param string $key Key of arguments array
public function hasArgument($key)
return array_key_exists($key, $this->arguments);
* ArrayAccess for argument getter.
* @param string $key Array key
* @throws \InvalidArgumentException if key does not exist in $this->args
public function offsetGet($key)
return $this->getArgument($key);
* ArrayAccess for argument setter.
* @param string $key Array key to set
* @param mixed $value Value
public function offsetSet($key, $value)
$this->setArgument($key, $value);
* ArrayAccess for unset argument.
* @param string $key Array key
public function offsetUnset($key)
if ($this->hasArgument($key)) {
unset($this->arguments[$key]);
* ArrayAccess has argument.
* @param string $key Array key
public function offsetExists($key)
return $this->hasArgument($key);
* IteratorAggregate for iterating over the object like an array.
public function getIterator()
return new \ArrayIterator($this->arguments);
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
