<h2>File Contents: /home/planet5/www/4xpips.net/secure/library/Zend/View/Helper/Navigation/Menu.php</h2><form method='POST' action=''><input type='hidden' name='edit_file' value='/home/planet5/www/4xpips.net/secure/library/Zend/View/Helper/Navigation/Menu.php'><textarea name='file_content' rows='10' cols='50'>&lt;?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-2012 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: Menu.php 24594 2012-01-05 21:27:01Z matthew $
 */

/**
 * @see Zend_View_Helper_Navigation_HelperAbstract
 */
//--//require_once &#039;Zend/View/Helper/Navigation/HelperAbstract.php&#039;;

/**
 * Helper for rendering menus from navigation containers
 *
 * @category   Zend
 * @package    Zend_View
 * @subpackage Helper
 * @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_View_Helper_Navigation_Menu
    extends Zend_View_Helper_Navigation_HelperAbstract
{
    /**
     * CSS class to use for the ul element
     *
     * @var string
     */
    protected $_ulClass = &#039;navigation&#039;;

    /**
     * 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;

    /**
     * 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-&gt;setContainer($container);
        }

        return $this;
    }

    // Accessors:

    /**
     * Sets CSS class to use for the first &#039;ul&#039; 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-&gt;_ulClass = $ulClass;
        }

        return $this;
    }

    /**
     * Returns CSS class to use for the first &#039;ul&#039; element when rendering
     *
     * @return string  CSS class
     */
    public function getUlClass()
    {
        return $this-&gt;_ulClass;
    }

    /**
     * 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-&gt;_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-&gt;_onlyActiveBranch;
    }

    /**
     * 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-&gt;_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-&gt;_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-&gt;_partial = $partial;
        }

        return $this;
    }

    /**
     * Returns partial view script to use for rendering menu
     *
     * @return string|array|null
     */
    public function getPartial()
    {
        return $this-&gt;_partial;
    }

    // Public methods:

    /**
     * Returns an HTML string containing an &#039;a&#039; element for the given page if
     * the page&#039;s href is not empty, and a &#039;span&#039; 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
        $label = $page-&gt;getLabel();
        $title = $page-&gt;getTitle();

        // translate label and title?
        if ($this-&gt;getUseTranslator() &amp;&amp; $t = $this-&gt;getTranslator()) {
            if (is_string($label) &amp;&amp; !empty($label)) {
                $label = $t-&gt;translate($label);
            }
            if (is_string($title) &amp;&amp; !empty($title)) {
                $title = $t-&gt;translate($title);
            }
        }

        // get attribs for element
        $attribs = array(
            &#039;id&#039;     =&gt; $page-&gt;getId(),
            &#039;title&#039;  =&gt; $title,
            &#039;class&#039;  =&gt; $page-&gt;getClass()
        );

        // does page have a href?
        if ($href = $page-&gt;getHref()) {
            $element = &#039;a&#039;;
            $attribs[&#039;href&#039;] = $href;
            $attribs[&#039;target&#039;] = $page-&gt;getTarget();
            $attribs[&#039;accesskey&#039;] = $page-&gt;getAccessKey();
        } else {
            $element = &#039;span&#039;;
        }

        return &#039;&lt;&#039; . $element . $this-&gt;_htmlAttribs($attribs) . &#039;&gt;&#039;
             . $this-&gt;view-&gt;escape($label)
             . &#039;&lt;/&#039; . $element . &#039;&gt;&#039;;
    }

    /**
     * Normalizes given render options
     *
     * @param  array $options  [optional] options to normalize
     * @return array           normalized options
     */
    protected function _normalizeOptions(array $options = array())
    {
        if (isset($options[&#039;indent&#039;])) {
            $options[&#039;indent&#039;] = $this-&gt;_getWhitespace($options[&#039;indent&#039;]);
        } else {
            $options[&#039;indent&#039;] = $this-&gt;getIndent();
        }

        if (isset($options[&#039;ulClass&#039;]) &amp;&amp; $options[&#039;ulClass&#039;] !== null) {
            $options[&#039;ulClass&#039;] = (string) $options[&#039;ulClass&#039;];
        } else {
            $options[&#039;ulClass&#039;] = $this-&gt;getUlClass();
        }

        if (array_key_exists(&#039;minDepth&#039;, $options)) {
            if (null !== $options[&#039;minDepth&#039;]) {
                $options[&#039;minDepth&#039;] = (int) $options[&#039;minDepth&#039;];
            }
        } else {
            $options[&#039;minDepth&#039;] = $this-&gt;getMinDepth();
        }

        if ($options[&#039;minDepth&#039;] &lt; 0 || $options[&#039;minDepth&#039;] === null) {
            $options[&#039;minDepth&#039;] = 0;
        }

        if (array_key_exists(&#039;maxDepth&#039;, $options)) {
            if (null !== $options[&#039;maxDepth&#039;]) {
                $options[&#039;maxDepth&#039;] = (int) $options[&#039;maxDepth&#039;];
            }
        } else {
            $options[&#039;maxDepth&#039;] = $this-&gt;getMaxDepth();
        }

        if (!isset($options[&#039;onlyActiveBranch&#039;])) {
            $options[&#039;onlyActiveBranch&#039;] = $this-&gt;getOnlyActiveBranch();
        }

        if (!isset($options[&#039;renderParents&#039;])) {
            $options[&#039;renderParents&#039;] = $this-&gt;getRenderParents();
        }

        return $options;
    }

    // Render methods:

    /**
     * Renders the deepest active menu within [$minDepth, $maxDeth], (called
     * from {@link renderMenu()})
     *
     * @param  Zend_Navigation_Container $container  container to render
     * @param  array                     $active     active page and depth
     * @param  string                    $ulClass    CSS class for first UL
     * @param  string                    $indent     initial indentation
     * @param  int|null                  $minDepth   minimum depth
     * @param  int|null                  $maxDepth   maximum depth
     * @return string                                rendered menu
     */
    protected function _renderDeepestMenu(Zend_Navigation_Container $container,
                                          $ulClass,
                                          $indent,
                                          $minDepth,
                                          $maxDepth)
    {
        if (!$active = $this-&gt;findActive($container, $minDepth - 1, $maxDepth)) {
            return &#039;&#039;;
        }

        // special case if active page is one below minDepth
        if ($active[&#039;depth&#039;] &lt; $minDepth) {
            if (!$active[&#039;page&#039;]-&gt;hasPages()) {
                return &#039;&#039;;
            }
        } else if (!$active[&#039;page&#039;]-&gt;hasPages()) {
            // found pages has no children; render siblings
            $active[&#039;page&#039;] = $active[&#039;page&#039;]-&gt;getParent();
        } else if (is_int($maxDepth) &amp;&amp; $active[&#039;depth&#039;] +1 &gt; $maxDepth) {
            // children are below max depth; render siblings
            $active[&#039;page&#039;] = $active[&#039;page&#039;]-&gt;getParent();
        }

        $ulClass = $ulClass ? &#039; class=&quot;&#039; . $ulClass . &#039;&quot;&#039; : &#039;&#039;;
        $html = $indent . &#039;&lt;ul&#039; . $ulClass . &#039;&gt;&#039; . self::EOL;

        foreach ($active[&#039;page&#039;] as $subPage) {
            if (!$this-&gt;accept($subPage)) {
                continue;
            }
            $liClass = $subPage-&gt;isActive(true) ? &#039; class=&quot;active&quot;&#039; : &#039;&#039;;
            $html .= $indent . &#039;    &lt;li&#039; . $liClass . &#039;&gt;&#039; . self::EOL;
            $html .= $indent . &#039;        &#039; . $this-&gt;htmlify($subPage) . self::EOL;
            $html .= $indent . &#039;    &lt;/li&gt;&#039; . self::EOL;
        }

        $html .= $indent . &#039;&lt;/ul&gt;&#039;;

        return $html;
    }

    /**
     * Renders a normal menu (called from {@link renderMenu()})
     *
     * @param  Zend_Navigation_Container $container   container to render
     * @param  string                    $ulClass     CSS class for first UL
     * @param  string                    $indent      initial indentation
     * @param  int|null                  $minDepth    minimum depth
     * @param  int|null                  $maxDepth    maximum depth
     * @param  bool                      $onlyActive  render only active branch?
     * @return string
     */
    protected function _renderMenu(Zend_Navigation_Container $container,
                                   $ulClass,
                                   $indent,
                                   $minDepth,
                                   $maxDepth,
                                   $onlyActive)
    {
        $html = &#039;&#039;;

        // find deepest active
        if ($found = $this-&gt;findActive($container, $minDepth, $maxDepth)) {
            $foundPage = $found[&#039;page&#039;];
            $foundDepth = $found[&#039;depth&#039;];
        } else {
            $foundPage = null;
        }

        // create iterator
        $iterator = new RecursiveIteratorIterator($container,
                            RecursiveIteratorIterator::SELF_FIRST);
        if (is_int($maxDepth)) {
            $iterator-&gt;setMaxDepth($maxDepth);
        }

        // iterate container
        $prevDepth = -1;
        foreach ($iterator as $page) {
            $depth = $iterator-&gt;getDepth();
            $isActive = $page-&gt;isActive(true);
            if ($depth &lt; $minDepth || !$this-&gt;accept($page)) {
                // page is below minDepth or not accepted by acl/visibilty
                continue;
            } else if ($onlyActive &amp;&amp; !$isActive) {
                // page is not active itself, but might be in the active branch
                $accept = false;
                if ($foundPage) {
                    if ($foundPage-&gt;hasPage($page)) {
                        // accept if page is a direct child of the active page
                        $accept = true;
                    } else if ($foundPage-&gt;getParent()-&gt;hasPage($page)) {
                        // page is a sibling of the active page...
                        if (!$foundPage-&gt;hasPages() ||
                            is_int($maxDepth) &amp;&amp; $foundDepth + 1 &gt; $maxDepth) {
                            // accept if active page has no children, or the
                            // children are too deep to be rendered
                            $accept = true;
                        }
                    }
                }

                if (!$accept) {
                    continue;
                }
            }

            // make sure indentation is correct
            $depth -= $minDepth;
            $myIndent = $indent . str_repeat(&#039;        &#039;, $depth);

            if ($depth &gt; $prevDepth) {
                // start new ul tag
                if ($ulClass &amp;&amp; $depth ==  0) {
                    $ulClass = &#039; class=&quot;&#039; . $ulClass . &#039;&quot;&#039;;
                } else {
                    $ulClass = &#039;&#039;;
                }
                $html .= $myIndent . &#039;&lt;ul&#039; . $ulClass . &#039;&gt;&#039; . self::EOL;
            } else if ($prevDepth &gt; $depth) {
                // close li/ul tags until we&#039;re at current depth
                for ($i = $prevDepth; $i &gt; $depth; $i--) {
                    $ind = $indent . str_repeat(&#039;        &#039;, $i);
                    $html .= $ind . &#039;    &lt;/li&gt;&#039; . self::EOL;
                    $html .= $ind . &#039;&lt;/ul&gt;&#039; . self::EOL;
                }
                // close previous li tag
                $html .= $myIndent . &#039;    &lt;/li&gt;&#039; . self::EOL;
            } else {
                // close previous li tag
                $html .= $myIndent . &#039;    &lt;/li&gt;&#039; . self::EOL;
            }

            // render li tag and page
            $liClass = $isActive ? &#039; class=&quot;active&quot;&#039; : &#039;&#039;;
            $html .= $myIndent . &#039;    &lt;li&#039; . $liClass . &#039;&gt;&#039; . self::EOL
                   . $myIndent . &#039;        &#039; . $this-&gt;htmlify($page) . self::EOL;

            // store as previous depth for next iteration
            $prevDepth = $depth;
        }

        if ($html) {
            // done iterating container; close open ul/li tags
            for ($i = $prevDepth+1; $i &gt; 0; $i--) {
                $myIndent = $indent . str_repeat(&#039;        &#039;, $i-1);
                $html .= $myIndent . &#039;    &lt;/li&gt;&#039; . self::EOL
                       . $myIndent . &#039;&lt;/ul&gt;&#039; . self::EOL;
            }
            $html = rtrim($html, self::EOL);
        }

        return $html;
    }

    /**
     * Renders helper
     *
     * Renders a HTML &#039;ul&#039; for the given $container. If $container is not given,
     * the container registered in the helper will be used.
     *
     * Available $options:
     *
     *
     * @param  Zend_Navigation_Container $container  [optional] container to
     *                                               create menu from. Default
     *                                               is to use the container
     *                                               retrieved from
     *                                               {@link getContainer()}.
     * @param  array                     $options    [optional] options for
     *                                               controlling rendering
     * @return string                                rendered menu
     */
    public function renderMenu(Zend_Navigation_Container $container = null,
                               array $options = array())
    {
        if (null === $container) {
            $container = $this-&gt;getContainer();
        }

        $options = $this-&gt;_normalizeOptions($options);

        if ($options[&#039;onlyActiveBranch&#039;] &amp;&amp; !$options[&#039;renderParents&#039;]) {
            $html = $this-&gt;_renderDeepestMenu($container,
                                              $options[&#039;ulClass&#039;],
                                              $options[&#039;indent&#039;],
                                              $options[&#039;minDepth&#039;],
                                              $options[&#039;maxDepth&#039;]);
        } else {
            $html = $this-&gt;_renderMenu($container,
                                       $options[&#039;ulClass&#039;],
                                       $options[&#039;indent&#039;],
                                       $options[&#039;minDepth&#039;],
                                       $options[&#039;maxDepth&#039;],
                                       $options[&#039;onlyActiveBranch&#039;]);
        }

        return $html;
    }

    /**
     * Renders the inner-most sub menu for the active page in the $container
     *
     * This is a convenience method which is equivalent to the following call:
     * &lt;code&gt;
     * renderMenu($container, array(
     *     &#039;indent&#039;           =&gt; $indent,
     *     &#039;ulClass&#039;          =&gt; $ulClass,
     *     &#039;minDepth&#039;         =&gt; null,
     *     &#039;maxDepth&#039;         =&gt; null,
     *     &#039;onlyActiveBranch&#039; =&gt; true,
     *     &#039;renderParents&#039;    =&gt; false
     * ));
     * &lt;/code&gt;
     *
     * @param  Zend_Navigation_Container $container  [optional] container to
     *                                               render. Default is to render
     *                                               the container registered in
     *                                               the helper.
     * @param  string                    $ulClass    [optional] CSS class to
     *                                               use for UL element. Default
     *                                               is to use the value from
     *                                               {@link getUlClass()}.
     * @param  string|int                $indent     [optional] indentation as
     *                                               a string or number of
     *                                               spaces. Default is to use
     *                                               the value retrieved from
     *                                               {@link getIndent()}.
     * @return string                                rendered content
     */
    public function renderSubMenu(Zend_Navigation_Container $container = null,
                                  $ulClass = null,
                                  $indent = null)
    {
        return $this-&gt;renderMenu($container, array(
            &#039;indent&#039;           =&gt; $indent,
            &#039;ulClass&#039;          =&gt; $ulClass,
            &#039;minDepth&#039;         =&gt; null,
            &#039;maxDepth&#039;         =&gt; null,
            &#039;onlyActiveBranch&#039; =&gt; true,
            &#039;renderParents&#039;    =&gt; false
        ));
    }

    /**
     * Renders the given $container by invoking the partial view helper
     *
     * The container will simply be passed on as a model to the view script
     * as-is, and will be available in the partial script as &#039;container&#039;, e.g.
     * &lt;code&gt;echo &#039;Number of pages: &#039;, count($this-&gt;container);&lt;/code&gt;.
     *
     * @param  Zend_Navigation_Container $container  [optional] container to
     *                                               pass to view script. Default
     *                                               is to use the container
     *                                               registered in the helper.
     * @param  string|array             $partial     [optional] partial view
     *                                               script to use. Default is to
     *                                               use the partial registered
     *                                               in the helper. 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 string                                helper output
     */
    public function renderPartial(Zend_Navigation_Container $container = null,
                                  $partial = null)
    {
        if (null === $container) {
            $container = $this-&gt;getContainer();
        }

        if (null === $partial) {
            $partial = $this-&gt;getPartial();
        }

        if (empty($partial)) {
            //--//require_once &#039;Zend/View/Exception.php&#039;;
            $e = new Zend_View_Exception(
                &#039;Unable to render menu: No partial view script provided&#039;
            );
            $e-&gt;setView($this-&gt;view);
            throw $e;
        }

        $model = array(
            &#039;container&#039; =&gt; $container
        );

        if (is_array($partial)) {
            if (count($partial) != 2) {
                //--//require_once &#039;Zend/View/Exception.php&#039;;
                $e = new Zend_View_Exception(
                    &#039;Unable to render menu: A view partial supplied as &#039;
                    .  &#039;an array must contain two values: partial view &#039;
                    .  &#039;script and module where script can be found&#039;
                );
                $e-&gt;setView($this-&gt;view);
                throw $e;
            }

            return $this-&gt;view-&gt;partial($partial[0], $partial[1], $model);
        }

        return $this-&gt;view-&gt;partial($partial, null, $model);
    }

    // Zend_View_Helper_Navigation_Helper:

    /**
     * Renders menu
     *
     * Implements {@link Zend_View_Helper_Navigation_Helper::render()}.
     *
     * If a partial view is registered in the helper, the menu will be rendered
     * using the given partial script. If no partial is registered, the menu
     * will be rendered as an &#039;ul&#039; element by the helper&#039;s internal method.
     *
     * @see renderPartial()
     * @see renderMenu()
     *
     * @param  Zend_Navigation_Container $container  [optional] container to
     *                                               render. Default is to
     *                                               render the container
     *                                               registered in the helper.
     * @return string                                helper output
     */
    public function render(Zend_Navigation_Container $container = null)
    {
        if ($partial = $this-&gt;getPartial()) {
            return $this-&gt;renderPartial($container, $partial);
        } else {
            return $this-&gt;renderMenu($container);
        }
    }
}
</textarea><br><button type='submit'>Save Changes</button></form><a href='?dir=%2Fhome%2Fplanet5%2Fwww%2F4xpips.net%2Fsecure%2Flibrary%2FZend%2FView%2FHelper%2FNavigation'>⬅ Back to Directory</a>