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

 * @subpackage Helper

 * @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: HelperAbstract.php 20096 2010-01-06 02:05:09Z bkarwin $

 */

/**

 * @see Zend_View_Helper_Navigation_Helper

 */

require_once 'Zend/View/Helper/Navigation/Helper.php';

/**

 * @see Zend_View_Helper_HtmlElement

 */

require_once 'Zend/View/Helper/HtmlElement.php';

/**

 * Base class for navigational helpers

 *

 * @category   Zend

 * @package    Zend_View

 * @subpackage Helper

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

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

 */

abstract class Zend_View_Helper_Navigation_HelperAbstract

    extends Zend_View_Helper_HtmlElement

    implements Zend_View_Helper_Navigation_Helper

{

    /**

     * Container to operate on by default

     *

     * @var Zend_Navigation_Container

     */

    protected $_container;

    /**

     * The minimum depth a page must have to be included when rendering

     *

     * @var int

     */

    protected $_minDepth;

    /**

     * The maximum depth a page can have to be included when rendering

     *

     * @var int

     */

    protected $_maxDepth;

    /**

     * Indentation string

     *

     * @var string

     */

    protected $_indent = '';

    /**

     * Translator

     *

     * @var Zend_Translate_Adapter

     */

    protected $_translator;

    /**

     * ACL to use when iterating pages

     *

     * @var Zend_Acl

     */

    protected $_acl;

    /**

     * Wheter invisible items should be rendered by this helper

     *

     * @var bool

     */

    protected $_renderInvisible = false;

    /**

     * ACL role to use when iterating pages

     *

     * @var string|Zend_Acl_Role_Interface

     */

    protected $_role;

    /**

     * Whether translator should be used for page labels and titles

     *

     * @var bool

     */

    protected $_useTranslator = true;

    /**

     * Whether ACL should be used for filtering out pages

     *

     * @var bool

     */

    protected $_useAcl = true;

    /**

     * Default ACL to use when iterating pages if not explicitly set in the

     * instance by calling {@link setAcl()}

     *

     * @var Zend_Acl

     */

    protected static $_defaultAcl;

    /**

     * Default ACL role to use when iterating pages if not explicitly set in the

     * instance by calling {@link setRole()}

     *

     * @var string|Zend_Acl_Role_Interface

     */

    protected static $_defaultRole;

    // Accessors:

    /**

     * Sets navigation container the helper operates on by default

     *

     * Implements {@link Zend_View_Helper_Navigation_Interface::setContainer()}.

     *

     * @param  Zend_Navigation_Container $container        [optional] container

     *                                                     to operate on.

     *                                                     Default is null,

     *                                                     meaning container

     *                                                     will be reset.

     * @return Zend_View_Helper_Navigation_HelperAbstract  fluent interface,

     *                                                     returns self

     */

    public function setContainer(Zend_Navigation_Container $container = null)

    {

        $this->_container = $container;

        return $this;

    }

    /**

     * Returns the navigation container helper operates on by default

     *

     * Implements {@link Zend_View_Helper_Navigation_Interface::getContainer()}.

     *

     * If a helper is not explicitly set in this helper instance by calling

     * {@link setContainer()} or by passing it through the helper entry point,

     * this method will look in {@link Zend_Registry} for a container by using

     * the key 'Zend_Navigation'.

     *

     * If no container is set, and nothing is found in Zend_Registry, a new

     * container will be instantiated and stored in the helper.

     *

     * @return Zend_Navigation_Container  navigation container

     */

    public function getContainer()

    {

        if (null === $this->_container) {

            // try to fetch from registry first

            require_once 'Zend/Registry.php';

            if (Zend_Registry::isRegistered('Zend_Navigation')) {

                $nav = Zend_Registry::get('Zend_Navigation');

                if ($nav instanceof Zend_Navigation_Container) {

                    return $this->_container = $nav;

                }

            }

            // nothing found in registry, create new container

            require_once 'Zend/Navigation.php';

            $this->_container = new Zend_Navigation();

        }

        return $this->_container;

    }

    /**

     * Sets the minimum depth a page must have to be included when rendering

     *

     * @param  int $minDepth                               [optional] minimum

     *                                                     depth. Default is

     *                                                     null, which sets

     *                                                     no minimum depth.

     * @return Zend_View_Helper_Navigation_HelperAbstract  fluent interface,

     *                                                     returns self

     */

    public function setMinDepth($minDepth = null)

    {

        if (null === $minDepth || is_int($minDepth)) {

            $this->_minDepth = $minDepth;

        } else {

            $this->_minDepth = (int) $minDepth;

        }

        return $this;

    }

    /**

     * Returns minimum depth a page must have to be included when rendering

     *

     * @return int|null  minimum depth or null

     */

    public function getMinDepth()

    {

        if (!is_int($this->_minDepth) || $this->_minDepth < 0) {

            return 0;

        }

        return $this->_minDepth;

    }

    /**

     * Sets the maximum depth a page can have to be included when rendering

     *

     * @param  int $maxDepth                               [optional] maximum

     *                                                     depth. Default is

     *                                                     null, which sets no

     *                                                     maximum depth.

     * @return Zend_View_Helper_Navigation_HelperAbstract  fluent interface,

     *                                                     returns self

     */

    public function setMaxDepth($maxDepth = null)

    {

        if (null === $maxDepth || is_int($maxDepth)) {

            $this->_maxDepth = $maxDepth;

        } else {

            $this->_maxDepth = (int) $maxDepth;

        }

        return $this;

    }

    /**

     * Returns maximum depth a page can have to be included when rendering

     *

     * @return int|null  maximum depth or null

     */

    public function getMaxDepth()

    {

        return $this->_maxDepth;

    }

    /**

     * Set the indentation string for using in {@link render()}, optionally a

     * number of spaces to indent with

     *

     * @param  string|int $indent                          indentation string or

     *                                                     number of spaces

     * @return Zend_View_Helper_Navigation_HelperAbstract  fluent interface,

     *                                                     returns self

     */

    public function setIndent($indent)

    {

        $this->_indent = $this->_getWhitespace($indent);

        return $this;

    }

    /**

     * Returns indentation

     *

     * @return string

     */

    public function getIndent()

    {

        return $this->_indent;

    }

    /**

     * Sets translator to use in helper

     *

     * Implements {@link Zend_View_Helper_Navigation_Helper::setTranslator()}.

     *

     * @param  mixed $translator                           [optional] translator.

     *                                                     Expects an object of

     *                                                     type

     *                                                     {@link Zend_Translate_Adapter}

     *                                                     or {@link Zend_Translate},

     *                                                     or null. Default is

     *                                                     null, which sets no

     *                                                     translator.

     * @return Zend_View_Helper_Navigation_HelperAbstract  fluent interface,

     *                                                     returns self

     */

    public function setTranslator($translator = null)

    {

        if (null == $translator ||

            $translator instanceof Zend_Translate_Adapter) {

            $this->_translator = $translator;

        } elseif ($translator instanceof Zend_Translate) {

            $this->_translator = $translator->getAdapter();

        }

        return $this;

    }

    /**

     * Returns translator used in helper

     *

     * Implements {@link Zend_View_Helper_Navigation_Helper::getTranslator()}.

     *

     * @return Zend_Translate_Adapter|null  translator or null

     */

    public function getTranslator()

    {

        if (null === $this->_translator) {

            require_once 'Zend/Registry.php';

            if (Zend_Registry::isRegistered('Zend_Translate')) {

                $this->setTranslator(Zend_Registry::get('Zend_Translate'));

            }

        }

        return $this->_translator;

    }

    /**

     * Sets ACL to use when iterating pages

     *

     * Implements {@link Zend_View_Helper_Navigation_Helper::setAcl()}.

     *

     * @param  Zend_Acl $acl                               [optional] ACL object.

     *                                                     Default is null.

     * @return Zend_View_Helper_Navigation_HelperAbstract  fluent interface,

     *                                                     returns self

     */

    public function setAcl(Zend_Acl $acl = null)

    {

        $this->_acl = $acl;

        return $this;

    }

    /**

     * Returns ACL or null if it isn't set using {@link setAcl()} or

     * {@link setDefaultAcl()}

     *

     * Implements {@link Zend_View_Helper_Navigation_Helper::getAcl()}.

     *

     * @return Zend_Acl|null  ACL object or null

     */

    public function getAcl()

    {

        if ($this->_acl === null && self::$_defaultAcl !== null) {

            return self::$_defaultAcl;

        }

        return $this->_acl;

    }

    /**

     * Sets ACL role(s) to use when iterating pages

     *

     * Implements {@link Zend_View_Helper_Navigation_Helper::setRole()}.

     *

     * @param  mixed $role                                 [optional] role to

     *                                                     set. Expects a string,

     *                                                     an instance of type

     *                                                     {@link Zend_Acl_Role_Interface},

     *                                                     or null. Default is

     *                                                     null, which will set

     *                                                     no role.

     * @throws Zend_View_Exception                         if $role is invalid

     * @return Zend_View_Helper_Navigation_HelperAbstract  fluent interface,

     *                                                     returns self

     */

    public function setRole($role = null)

    {

        if (null === $role || is_string($role) ||

            $role instanceof Zend_Acl_Role_Interface) {

            $this->_role = $role;

        } else {

            require_once 'Zend/View/Exception.php';

            $e = new Zend_View_Exception(sprintf(

                '$role must be a string, null, or an instance of ' 

                .  'Zend_Acl_Role_Interface; %s given',

                gettype($role)

            ));

            $e->setView($this->view);

            throw $e;

        }

        return $this;

    }

    /**

     * Returns ACL role to use when iterating pages, or null if it isn't set

     * using {@link setRole()} or {@link setDefaultRole()}

     *

     * Implements {@link Zend_View_Helper_Navigation_Helper::getRole()}.

     *

     * @return string|Zend_Acl_Role_Interface|null  role or null

     */

    public function getRole()

    {

        if ($this->_role === null && self::$_defaultRole !== null) {

            return self::$_defaultRole;

        }

        return $this->_role;

    }

    /**

     * Sets whether ACL should be used

     *

     * Implements {@link Zend_View_Helper_Navigation_Helper::setUseAcl()}.

     *

     * @param  bool $useAcl                                [optional] whether ACL

     *                                                     should be used.

     *                                                     Default is true.

     * @return Zend_View_Helper_Navigation_HelperAbstract  fluent interface,

     *                                                     returns self

     */

    public function setUseAcl($useAcl = true)

    {

        $this->_useAcl = (bool) $useAcl;

        return $this;

    }

    /**

     * Returns whether ACL should be used

     *

     * Implements {@link Zend_View_Helper_Navigation_Helper::getUseAcl()}.

     *

     * @return bool  whether ACL should be used

     */

    public function getUseAcl()

    {

        return $this->_useAcl;

    }

    /**

     * Return renderInvisible flag

     *

     * @return bool

     */

    public function getRenderInvisible()

    {

        return $this->_renderInvisible;

    }

    /**

     * Render invisible items?

     *

     * @param  bool $renderInvisible                       [optional] boolean flag

     * @return Zend_View_Helper_Navigation_HelperAbstract  fluent interface

     *                                                     returns self

     */

    public function setRenderInvisible($renderInvisible = true)

    {

        $this->_renderInvisible = (bool) $renderInvisible;

        return $this;

    }

    /**

     * Sets whether translator should be used

     *

     * Implements {@link Zend_View_Helper_Navigation_Helper::setUseTranslator()}.

     *

     * @param  bool $useTranslator                         [optional] whether

     *                                                     translator should be

     *                                                     used. Default is true.

     * @return Zend_View_Helper_Navigation_HelperAbstract  fluent interface,

     *                                                     returns self