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

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

 */

/**

 * @see Zend_View_Helper_Navigation_HelperAbstract

 */

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

/**

 * Helper for rendering menus from navigation containers

 *

 * @category   Zend

 * @package    Zend_View

 * @subpackage Helper

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

 */

class Zend_View_Helper_Navigation_Menu

    extends Zend_View_Helper_Navigation_HelperAbstract

{

    /**

     * CSS class to use for the ul element

     *

     * @var string

     */

    protected $_ulClass = 'navigation';

    /**

     * Unique identifier (id) for the ul element

     *

     * @var string

     */

    protected $_ulId = null;

    /**

     * CSS class to use for the active elements

     *

     * @var string

     */

    protected $_activeClass = 'active';

    /**

     * CSS class to use for the parent li element

     *

     * @var string

     */

    protected $_parentClass = 'menu-parent';

    /**

     * Whether parent li elements should be rendered with parent class

     *

     * @var bool

     */

    protected $_renderParentClass = false;

    /**

     * Whether only active branch should be rendered

     *

     * @var bool

     */

    protected $_onlyActiveBranch = false;

    /**

     * Whether parents should be rendered when only rendering active branch

     *

     * @var bool

     */

    protected $_renderParents = true;

    /**

     * Partial view script to use for rendering menu

     *

     * @var string|array

     */

    protected $_partial = null;

    /**

     * Expand all sibling nodes of active branch nodes

     *

     * @var bool

     */

    protected $_expandSiblingNodesOfActiveBranch = false;

    /**

     * Adds CSS class from page to li element

     *

     * @var bool

     */

    protected $_addPageClassToLi = false;

    /**

     * Inner indentation string

     *

     * @var string

     */

    protected $_innerIndent = '    ';

    /**

     * View helper entry point:

     * Retrieves helper and optionally sets container to operate on

     *

     * @param  Zend_Navigation_Container $container  [optional] container to

     *                                               operate on

     * @return Zend_View_Helper_Navigation_Menu      fluent interface,

     *                                               returns self

     */

    public function menu(Zend_Navigation_Container $container = null)

    {

        if (null !== $container) {

            $this->setContainer($container);

        }

        return $this;

    }

    // Accessors:

    /**

     * Sets CSS class to use for the first 'ul' element when rendering

     *

     * @param  string $ulClass                   CSS class to set

     * @return Zend_View_Helper_Navigation_Menu  fluent interface, returns self

     */

    public function setUlClass($ulClass)

    {

        if (is_string($ulClass)) {

            $this->_ulClass = $ulClass;

        }

        return $this;

    }

    /**

     * Returns CSS class to use for the first 'ul' element when rendering

     *

     * @return string  CSS class

     */

    public function getUlClass()

    {

        return $this->_ulClass;

    }

    /**

     * Sets unique identifier (id) to use for the first 'ul' element when

     * rendering

     *

     * @param  string|null  $ulId                Unique identifier (id) to set

     * @return Zend_View_Helper_Navigation_Menu  fluent interface, returns self

     */

    public function setUlId($ulId)

    {

        if (is_string($ulId)) {

            $this->_ulId = $ulId;

        }

        return $this;

    }

    /**

     * Returns unique identifier (id) to use for the first 'ul' element when

     * rendering

     *

     * @return string|null  Unique identifier (id); Default is 'null'

     */

    public function getUlId()

    {

        return $this->_ulId;

    }

    /**

     * Sets CSS class to use for the active elements when rendering

     *

     * @param string $activeClass               CSS class to set

     * @return Zend_View_Helper_Navigation_Menu fluent interface, returns self

     */

    public function setActiveClass($activeClass)

    {

        if (is_string($activeClass)) {

            $this->_activeClass = $activeClass;

        }

        return $this;

    }

    /**

     * Returns CSS class to use for the active elements when rendering

     *

     * @return string  CSS class

     */

    public function getActiveClass()

    {

        return $this->_activeClass;

    }

    /**

     * Sets CSS class to use for the parent li elements when rendering

     *

     * @param  string $parentClass              CSS class to set to parents

     * @return Zend_View_Helper_Navigation_Menu fluent interface, returns self

     */

    public function setParentClass($parentClass)

    {

        if (is_string($parentClass)) {

            $this->_parentClass = $parentClass;

        }

        return $this;

    }

    /**

     * Returns CSS class to use for the parent lie elements when rendering

     *

     * @return string CSS class

     */

    public function getParentClass()

    {

        return $this->_parentClass;

    }

    /**

     * Enables/disables rendering of parent class to the li element

     *

     * @param bool $flag                        [optional] render with parent

     *                                          class. Default is true.

     * @return Zend_View_Helper_Navigation_Menu fluent interface, returns self

     */

    public function setRenderParentClass($flag = true)

    {

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

        return $this;

    }

    /**

     * Returns flag indicating whether parent class should be rendered to the li

     * element

     *

     * @return bool  whether parent class should be rendered

     */

    public function getRenderParentClass()

    {

        return $this->_renderParentClass;

    }

    /**

     * Sets a flag indicating whether only active branch should be rendered

     *

     * @param  bool $flag                        [optional] render only active

     *                                           branch. Default is true.

     * @return Zend_View_Helper_Navigation_Menu  fluent interface, returns self

     */

    public function setOnlyActiveBranch($flag = true)

    {

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

        return $this;

    }

    /**

     * Returns a flag indicating whether only active branch should be rendered

     *

     * By default, this value is false, meaning the entire menu will be

     * be rendered.

     *

     * @return bool  whether only active branch should be rendered

     */

    public function getOnlyActiveBranch()

    {

        return $this->_onlyActiveBranch;

    }

    /**

     * Sets a flag indicating whether to expand all sibling nodes of the active branch

     * 

     * @param  bool $flag                        [optional] expand all siblings of

     *                                           nodes in the active branch. Default is true.

     * @return Zend_View_Helper_Navigation_Menu  fluent interface, returns self

     */

    public function setExpandSiblingNodesOfActiveBranch($flag = true)

    {

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

        return $this;

    }

    /**

     * Returns a flag indicating whether to expand all sibling nodes of the active branch

     *

     * By default, this value is false, meaning the entire menu will be

     * be rendered.

     *

     * @return bool  whether siblings of nodes in the active branch should be expanded

     */

    public function getExpandSiblingNodesOfActiveBranch()

    {

        return $this->_expandSiblingNodesOfActiveBranch;

    }

    /**

     * Enables/disables rendering of parents when only rendering active branch

     *

     * See {@link setOnlyActiveBranch()} for more information.

     *

     * @param  bool $flag                        [optional] render parents when

     *                                           rendering active branch.

     *                                           Default is true.

     * @return Zend_View_Helper_Navigation_Menu  fluent interface, returns self

     */

    public function setRenderParents($flag = true)

    {

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

        return $this;

    }

    /**

     * Returns flag indicating whether parents should be rendered when rendering

     * only the active branch

     *

     * By default, this value is true.

     *

     * @return bool  whether parents should be rendered

     */

    public function getRenderParents()

    {

        return $this->_renderParents;

    }

    /**

     * Sets which partial view script to use for rendering menu

     *

     * @param  string|array $partial             partial view script or null. If

     *                                           an array is given, it is

     *                                           expected to contain two values;

     *                                           the partial view script to use,

     *                                           and the module where the script

     *                                           can be found.

     * @return Zend_View_Helper_Navigation_Menu  fluent interface, returns self

     */

    public function setPartial($partial)

    {

        if (null === $partial || is_string($partial) || is_array($partial)) {

            $this->_partial = $partial;

        }

        return $this;

    }

    /**

     * Returns partial view script to use for rendering menu

     *

     * @return string|array|null

     */

    public function getPartial()

    {

        return $this->_partial;

    }

    /**

     * Adds CSS class from page to li element

     *

     * Before:

     * <code>

     * <li>

     *     <a href="#" class="foo">Bar</a>

     * </li>

     * </code>

     *

     * After:

     * <code>

     * <li class="foo">

     *     <a href="#">Bar</a>

     * </li>

     * </code>

     *

     * @param bool $flag                        [optional] adds CSS class from

     *                                          page to li element

     *

     * @return Zend_View_Helper_Navigation_Menu fluent interface, returns self

     */

    public function addPageClassToLi($flag = true)

    {

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

        return $this;

    }

    /**

     * Returns a flag indicating whether the CSS class from page to be added to

     * li element

     *

     * @return bool

     */

    public function getAddPageClassToLi()

    {

        return $this->_addPageClassToLi;

    }

    /**

     * Set the inner 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 setInnerIndent($indent)

    {

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

        return $this;

    }

    /**

     * Returns inner indentation (format output is respected)

     *

     * @see getFormatOutput()

     *

     * @return string       indentation string or an empty string

     */

    public function getInnerIndent()

    {

        if (false === $this->getFormatOutput()) {

            return '';

        }

        return $this->_innerIndent;

    }

    // Public methods:

    /**

     * Returns an HTML string containing an 'a' element for the given page if

     * the page's href is not empty, and a 'span' element if it is empty

     *

     * Overrides {@link Zend_View_Helper_Navigation_Abstract::htmlify()}.

     *

     * @param  Zend_Navigation_Page $page  page to generate HTML for

     * @return string                      HTML string for the given page

     */

    public function htmlify(Zend_Navigation_Page $page)

    {

        // get label and title for translating