<?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_Tool

 * @subpackage Framework

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

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

 * @version    $Id: Repository.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * @see Zend_Tool_Framework_Registry_EnabledInterface

 */

require_once 'Zend/Tool/Framework/Registry/EnabledInterface.php';

/**

 * @category   Zend

 * @package    Zend_Tool

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

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

 */

class Zend_Tool_Framework_Action_Repository

    implements Zend_Tool_Framework_Registry_EnabledInterface, IteratorAggregate, Countable

{

    /**

     * @var Zend_Tool_Framework_Registry_Interface

     */

    protected $_registry = null;

    /**

     * @var array

     */

    protected $_actions = array();

    /**

     * setRegistry()

     *

     * @param Zend_Tool_Framework_Registry_Interface $registry

     */

    public function setRegistry(Zend_Tool_Framework_Registry_Interface $registry)

    {

        $this->_registry = $registry;

    }

    /**

     * addAction()

     *

     * @param Zend_Tool_Framework_Action_Interface $action

     * @return Zend_Tool_Framework_Action_Repository

     */

    public function addAction(Zend_Tool_Framework_Action_Interface $action, $overrideExistingAction = false)

    {

        $actionName = $action->getName();

        if ($actionName == '' || $actionName == 'Base') {

            require_once 'Zend/Tool/Framework/Action/Exception.php';

            throw new Zend_Tool_Framework_Action_Exception('An action name for the provided action could not be determined.');

        }

        if (!$overrideExistingAction && array_key_exists(strtolower($actionName), $this->_actions)) {

            require_once 'Zend/Tool/Framework/Action/Exception.php';

            throw new Zend_Tool_Framework_Action_Exception('An action by the name ' . $actionName

                . ' is already registered and $overrideExistingAction is set to false.');

        }

        $this->_actions[strtolower($actionName)] = $action;

        return $this;

    }

    /**

     * process() - this is called when the client is done constructing (after init())

     *

     * @return unknown

     */

    public function process()

    {

        return null;

    }

    /**

     * getActions() - get all actions in the repository

     *

     * @return array

     */

    public function getActions()

    {

        return $this->_actions;

    }

    /**

     * getAction() - get an action by a specific name

     *

     * @param string $actionName

     * @return Zend_Tool_Framework_Action_Interface

     */

    public function getAction($actionName)

    {

        if (!array_key_exists(strtolower($actionName), $this->_actions)) {

            return null;

        }

        return $this->_actions[strtolower($actionName)];

    }

    /**

     * count() required by the Countable interface

     *

     * @return int

     */

    public function count()

    {

        return count($this->_actions);

    }

    /**

     * getIterator() - get all actions, this supports the IteratorAggregate interface

     *

     * @return array

     */

    public function getIterator()

    {

        return new ArrayIterator($this->_actions);

    }

}