UIComponents\View\Helper\Components\Toolbar

Complexity

Total Complexity

39

Size/Duplication

Total Lines	212
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__invoke()	0	7	2
F	renderNormalMenu()	0	137	34
A	setTagname()	0	5	2
A	getTagname()	0	2	1

<?php
/**
 * BB's Zend Framework 2 Components
 * 
 * UI Components
 *
 * @package     [MyApplication]
 * @subpackage  BB's Zend Framework 2 Components
 * @subpackage  UI Components
 * @author      Björn Bartels <coding@bjoernbartels.earth>
 * @link        https://gitlab.bjoernbartels.earth/groups/zf2
 * @license     http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
 * @copyright   copyright (c) 2016 Björn Bartels <coding@bjoernbartels.earth>
 */

namespace UIComponents\View\Helper\Components;

use \RecursiveIteratorIterator;

The type \RecursiveIteratorIterator was not found. Maybe you did not declare it correctly or list all dependencies?

use Zend\Navigation\AbstractContainer;

/**
 *
 * Helper for rendering 'Bootstrap' 
 * 
 * @see \UIComponents\View\Helper\Navigation\Menu
 */
class Toolbar extends \UIComponents\View\Helper\Navigation\Menu
{
    
    /**
     * component's tag-name
     *
     * @var string
     */
    protected $tagname = 'div';
    
    /**
     * component's class-names
     *
     * @var string
     */
    protected $classnames = 'toolbar toolbar-default callout small';
    
    /**
     * component's size attributes
     *
     * @var string|array
     */
    protected $size = '';
    
    /**
     * View helper entry point:
     * Retrieves helper and optionally sets container to operate on
     *
     * @param  string|AbstractContainer $container [optional] container to operate on
     * @return self
     */
    public function __invoke($container = 'componentnavigationhelper')
    {
        if (null !== $container) {

The condition null !== $container is always true.

            $this->setContainer($container);
        }

        return (clone $this);
    }
    
    /**
     * Renders a normal menu (called from {@link renderMenu()})
     *
     * @param    AbstractContainer $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?
     * @param    bool                $escapeLabels        Whether or not to escape the labels
     * @param    bool                $addClassToListItem Whether or not page class applied to <li> element
     * @param    string            $liActiveClass        CSS class for active LI
     * @return string
     */
    protected function renderNormalMenu(
        \Zend\Navigation\AbstractContainer $container,
        $ulClass,
        $indent,
        $minDepth,
        $maxDepth,
        $onlyActive,
        $escapeLabels,
        $addClassToListItem,
        $liActiveClass
    ) {
        $html = '';

        // find deepest active
        $found = $this->findActive($container, $minDepth, $maxDepth);
        /* @var $escaper \Zend\View\Helper\EscapeHtmlAttr */
        $escaper = $this->view->plugin('escapeHtmlAttr');

The method plugin() does not exist on Zend\View\Renderer\RendererInterface. It seems like you code against a sub-type of Zend\View\Renderer\RendererInterface such as Zend\View\Renderer\PhpRenderer.

        if ($found) {
            $foundPage    = $found['page'];
            $foundDepth = $found['depth'];
        } else {
            $foundPage = null;
        }

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

        // iterate container
        $prevDepth = -1;
        foreach ($iterator as $page) {
            $depth = $iterator->getDepth();
            $page->set('level', $depth);
            $isActive = $page->isActive(true);
            if ($depth < $minDepth || !$this->accept($page)) {
                // page is below minDepth or not accepted by acl/visibility
                continue;
            } elseif ($onlyActive && !$isActive) {
                // page is not active itself, but might be in the active branch
                $accept = false;
                if ($foundPage) {
                    if ($foundPage->hasPage($page)) {
                        // accept if page is a direct child of the active page
                        $accept = true;
                    } elseif ($foundPage->getParent()->hasPage($page)) {
                        // page is a sibling of the active page...
                        if (!$foundPage->hasPages(!$this->renderInvisible) ||
                            is_int($maxDepth) && $foundDepth + 1 > $maxDepth) {

The variable $foundDepth does not seem to be defined for all execution paths leading up to this point.

                            // 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('    ', $depth);

            if ($depth > $prevDepth) {
                // start new ul tag
                $ulClass = '' . 
                    ($depth == 0 ? $this->getUlClass() : 
                            ($depth == 1 ? $this->getSubUlClassLevel1() : $this->getSubUlClass())
                    ) . 
                    ' level_' . $depth . 
                '';
                if ($ulClass && $depth ==    0) {
                    $ulClass = ' class="' . $escaper($ulClass) . '"';
                } else {
                    $ulClass = ' class="' . $escaper($ulClass) . '"';
                }
                $html .= $myIndent . '<' . $this->getTagname() . $ulClass . '>' . PHP_EOL;
            } elseif ($prevDepth > $depth) {
                // close li/ul tags until we're at current depth
                for ($i = $prevDepth; $i > $depth; $i--) {
                    $ind = $indent . str_repeat('        ', $i);
                    //$html .= $ind . '    </li>' . PHP_EOL;
                    $html .= $ind . '</' . $this->getTagname() . '>' . PHP_EOL;
                }
                // close previous li tag
                //$html .= $myIndent . '    </li>' . PHP_EOL;
            } else {
                // close previous li tag
                //$html .= $myIndent . '    </li>' . PHP_EOL;
            }

            // render li tag and page
            $liClasses = [];
            // Is page active?
            if ($isActive) {
                $liClasses[] = $liActiveClass;
            }
            if (!empty($this->getDefaultLiClass())) {
                $liClasses[] = $this->getDefaultLiClass();
            }
            $isBelowMaxLevel = ($maxDepth > $depth) || ($maxDepth === null) || ($maxDepth === false);
            if (!empty($page->pages) && $isBelowMaxLevel) {
                $liClasses[] = ($depth == 0 ? $this->getSubLiClassLevel0() : $this->getSubLiClass());
            }
            // Add CSS class from page to <li>
            if ($addClassToListItem && $page->getClass()) {
                $liClasses[] = $page->getClass();
            }
            $liClass = empty($liClasses) ? '' : ' class="' . $escaper(implode(' ', $liClasses)) . '"';

The assignment to $liClass is dead and can be removed.

            $html .= /* $myIndent . '    <li' . $liClass . '>' . PHP_EOL
                . */ $myIndent . '        ' . $this->htmlify($page, $escapeLabels, $addClassToListItem, [
                    'data-test' => 'cta-toolbar-' . $this->slugify($page->getLabel()),
                ]) . PHP_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 > 0; $i--) {
                $myIndent = $indent . str_repeat('        ', $i-1);
                $html .= /*$myIndent . '    </li>' . PHP_EOL
                    . */ $myIndent . '</' . $this->getTagname() . '>' . PHP_EOL;
            }
            $html = rtrim($html, PHP_EOL);
        }

        return $html;
    }
    
    //
    // component related getters/setters
    //
    
    /**
     * @return the $tagname

The type UIComponents\View\Helper\Components\the was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function getTagname() {
        return $this->tagname;

The expression return $this->tagname returns the type string which is incompatible with the documented return type UIComponents\View\Helper\Components\the.

    }

    /**
     * @param string $tagname
     */
    public function setTagname($tagname) {
        if ( null !== $tagname ) {

The condition null !== $tagname is always true.

            $this->tagname = $tagname;
        }
        return $this;
    }

}