<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_EventManager

 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

require_once 'Zend/EventManager/EventDescription.php';

/**

 * Representation of an event

 *

 * Encapsulates the target context and parameters passed, and provides some 

 * behavior for interacting with the event manager.

 *

 * @category   Zend

 * @package    Zend_EventManager

 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_EventManager_Event implements Zend_EventManager_EventDescription

{

    /**

     * @var string Event name

     */

    protected $name;

    /**

     * @var string|object The event target

     */

    protected $target;

    /**

     * @var array|ArrayAccess|object The event parameters

     */

    protected $params = array();

    /**

     * @var bool Whether or not to stop propagation

     */

    protected $stopPropagation = false;

    /**

     * Constructor

     *

     * Accept a target and its parameters.

     * 

     * @param  string $name Event name

     * @param  string|object $target 

     * @param  array|ArrayAccess $params 

     * @return void

     */

    public function __construct($name = null, $target = null, $params = null)

    {

        if (null !== $name) {

            $this->setName($name);

        }

        if (null !== $target) {

            $this->setTarget($target);

        }

        if (null !== $params) {

            $this->setParams($params);

        }

    }

    /**

     * Get event name

     * 

     * @return string

     */

    public function getName()

    {

        return $this->name;

    }

    /**

     * Get the event target

     *

     * This may be either an object, or the name of a static method.

     * 

     * @return string|object

     */

    public function getTarget()

    {

        return $this->target;

    }

    /**

     * Set parameters

     *

     * Overwrites parameters

     * 

     * @param  array|ArrayAccess|object $params 

     * @return Event

     */

    public function setParams($params)

    {

        if (!is_array($params) && !is_object($params)) {

            require_once 'Zend/EventManager/Exception/InvalidArgumentException.php';

            throw new Zend_EventManager_Exception_InvalidArgumentException(sprintf(

                'Event parameters must be an array or object; received "%s"',

                (is_object($params) ? get_class($params) : gettype($params))

            ));

        }

        $this->params = $params;

        return $this;

    }

    /**

     * Get all parameters

     * 

     * @return array|object|ArrayAccess

     */

    public function getParams()

    {

        return $this->params;

    }

    /**

     * Get an individual parameter

     *

     * If the parameter does not exist, the $default value will be returned.

     * 

     * @param  string|int $name 

     * @param  mixed $default 

     * @return mixed

     */

    public function getParam($name, $default = null)

    {

        // Check in params that are arrays or implement array access

        if (is_array($this->params) || $this->params instanceof ArrayAccess) {

            if (!isset($this->params[$name])) {

                return $default;

            }

            return $this->params[$name];

        }

        // Check in normal objects

        if (!isset($this->params->{$name})) {

            return $default;

        }

        return $this->params->{$name};

    }

    /**

     * Set the event name

     * 

     * @param  string $name 

     * @return Zend_EventManager_Event

     */

    public function setName($name)

    {

        $this->name = (string) $name;

        return $this;

    }

    /**

     * Set the event target/context

     * 

     * @param  null|string|object $target 

     * @return Zend_EventManager_Event

     */

    public function setTarget($target)

    {

        $this->target = $target;

        return $this;

    }

    /**

     * Set an individual parameter to a value

     * 

     * @param  string|int $name 

     * @param  mixed $value 

     * @return Zend_EventManager_Event

     */

    public function setParam($name, $value)

    {

        if (is_array($this->params) || $this->params instanceof ArrayAccess) {

            // Arrays or objects implementing array access

            $this->params[$name] = $value;

        } else {

            // Objects

            $this->params->{$name} = $value;

        }

        return $this;

    }

    /**

     * Stop further event propagation

     * 

     * @param  bool $flag 

     * @return void

     */

    public function stopPropagation($flag = true)

    {

        $this->stopPropagation = (bool) $flag;

    }

    /**

     * Is propagation stopped?

     * 

     * @return bool

     */

    public function propagationIsStopped()

    {

        return $this->stopPropagation;

    }

}