123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163 |
- <?php
- /*
- * This file is part of the symfony package.
- * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- /**
- * sfEvent.
- *
- * @package symfony
- * @subpackage util
- * @author Fabien Potencier <fabien.potencier@symfony-project.com>
- * @version SVN: $Id: sfEvent.class.php 8698 2008-04-30 16:35:28Z fabien $
- */
- class sfEvent implements ArrayAccess
- {
- protected
- $value = null,
- $processed = false,
- $subject = null,
- $name = '',
- $parameters = null;
- /**
- * Constructs a new sfEvent.
- *
- * @param mixed $subject The subject
- * @param string $name The event name
- * @param array $parameters An array of parameters
- */
- public function __construct($subject, $name, $parameters = array())
- {
- $this->subject = $subject;
- $this->name = $name;
- $this->parameters = $parameters;
- }
- /**
- * Returns the subject.
- *
- * @return mixed The subject
- */
- public function getSubject()
- {
- return $this->subject;
- }
- /**
- * Returns the event name.
- *
- * @return string The event name
- */
- public function getName()
- {
- return $this->name;
- }
- /**
- * Sets the return value for this event.
- *
- * @param mixed $value The return value
- */
- public function setReturnValue($value)
- {
- $this->value = $value;
- }
- /**
- * Returns the return value.
- *
- * @return mixed The return value
- */
- public function getReturnValue()
- {
- return $this->value;
- }
- /**
- * Sets the processed flag.
- *
- * @param Boolean $processed The processed flag value
- */
- public function setProcessed($processed)
- {
- $this->processed = (boolean) $processed;
- }
- /**
- * Returns whether the event has been processed by a listener or not.
- *
- * @return Boolean true if the event has been processed, false otherwise
- */
- public function isProcessed()
- {
- return $this->processed;
- }
- /**
- * Returns the event parameters.
- *
- * @return array The event parameters
- */
- public function getParameters()
- {
- return $this->parameters;
- }
- /**
- * Returns true if the parameter exists (implements the ArrayAccess interface).
- *
- * @param string $name The parameter name
- *
- * @return Boolean true if the parameter exists, false otherwise
- */
- public function offsetExists($name)
- {
- return array_key_exists($name, $this->parameters);
- }
- /**
- * Returns a parameter value (implements the ArrayAccess interface).
- *
- * @param string $name The parameter name
- *
- * @return mixed The parameter value
- */
- public function offsetGet($name)
- {
- if (!array_key_exists($name, $this->parameters))
- {
- throw new InvalidArgumentException(sprintf('The event "%s" has no "%s" parameter.', $this->name, $name));
- }
- return $this->parameters[$name];
- }
- /**
- * Sets a parameter (implements the ArrayAccess interface).
- *
- * @param string $name The parameter name
- * @param mixed $value The parameter value
- */
- public function offsetSet($name, $value)
- {
- $this->parameters[$name] = $value;
- }
- /**
- * Removes a parameter (implements the ArrayAccess interface).
- *
- * @param string $name The parameter name
- */
- public function offsetUnset($name)
- {
- unset($this->parameters[$name]);
- }
- }
|