AbstractMenuTwigExtension::renderNode() - Code Metrics - Inspection of "Update CHANGELOG" - webeweb/adminbsb-material-design-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e8b3d8...d74459 )

by WEBEWEB

created 2021-02-09 17:26 UTC

AbstractMenuTwigExtension::renderNode() A

↳ Parent: AbstractMenuTwigExtension

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	16
rs	9.7333
c	0
b	0
f	0
cc	4
nc	4
nop	2

<?php

/*
 * This file is part of the adminbsb-material-design-bundle package.
 *
 * (c) 2018 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Bundle\AdminBSBBundle\Twig\Extension\Menu;

use Twig\Environment;
use WBW\Bundle\AdminBSBBundle\Twig\Extension\AbstractTwigExtension;
use WBW\Bundle\AdminBSBBundle\Twig\Extension\RendererTwigExtension;
use WBW\Bundle\CoreBundle\Component\Translation\BaseTranslatorInterface;
use WBW\Bundle\CoreBundle\Navigation\AbstractNavigationNode;
use WBW\Bundle\CoreBundle\Navigation\HeaderNode;
use WBW\Bundle\CoreBundle\Navigation\NavigationNode;
use WBW\Bundle\CoreBundle\Navigation\NavigationTree;
use WBW\Bundle\CoreBundle\Service\TranslatorTrait;

/**
 * Abstract multi level menu Twig extension.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Bundle\AdminBSBBundle\Twig\Extension\Menu
 * @abstract
 */
abstract class AbstractMenuTwigExtension extends AbstractTwigExtension {

    use TranslatorTrait;

    /**
     * Constructor.
     *
     * @param Environment $twigEnvironment The Twig environment.
     * @param BaseTranslatorInterface $translator The translator.
     */
    public function __construct(Environment $twigEnvironment, $translator) {
        parent::__construct($twigEnvironment);
        $this->setTranslator($translator);
    }

    /**
     * Displays an AdminBSB  menu.
     *
     * @param NavigationTree $tree The navigation tree.
     * @return string Returns the Admin BSB menu.
     */
    protected function adminBSBMenu(NavigationTree $tree): string {

        $templates = [];

        foreach ($tree->getNodes() as $current) {
            $templates[] = $this->renderNode($current);
        }

        return implode("\n", $templates);
    }

    /**
     * Determines if a node is a menu toggle.
     *
     * @param NavigationNode $node
     * @return bool Returns true in case of success, false otherwise.
     */
    protected function isMenuToggle(NavigationNode $node): bool {

        foreach ($node->getNodes() as $current) {

            if (true === ($current instanceof NavigationNode) && true === $current->isDisplayable()) {
                return true;
            }
        }

        return false;
    }

    /**
     * Render an anchor.
     *
     * @param NavigationNode $node The navigation node.
     * @return string Returns the rendered anchor.
     */
    private function renderAnchor(NavigationNode $node): string {

        $attributes = [
            "href"   => $node->getUri(),
            "target" => $node->getTarget(),
        ];

        if ($this->isMenuToggle($node)) {
            $attributes["class"] = "menu-toggle";
        }

        $icon = $this->renderIcon($node);
        $span = $this->renderSpan($node);

        return static::coreHTMLElement("a", "\n${icon}{$span}", $attributes) . "\n";
    }

    /**
     * Render a dropdown.
     *
     * @param NavigationNode $node The navigation node.
     * @param array $items The items.
     * @return string Returns the rendered dropdown.
     */
    private function renderDropdown(NavigationNode $node, array $items): string {


        $innerHTML = implode("\n", $items);

        $dropdown = static::coreHTMLElement("ul", "\n{$innerHTML}", ["class" => "ml-menu"]);

        return "{$dropdown}\n";
    }

    /**
     * Render an header node.
     *
     * @param HeaderNode $node The header node.
     * @return string Returns the rendered header node.
     */
    private function renderHeader(HeaderNode $node): string {
        return static::coreHTMLElement("li", $node->getLabel(), ["class" => "header"]);
    }

    /**
     * Render an icon.
     *
     * @param NavigationNode $node The navigation node.
     * @return string Returns the rendered icon.
     */
    private function renderIcon(NavigationNode $node): string {
        if (null === $node->getIcon()) {
            return "";
        }
        return RendererTwigExtension::renderIcon($this->getTwigEnvironment(), $node->getIcon()) . "\n";
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * Render a navigation node.
     *
     * @param NavigationNode $node The navigation node.
     * @param int $level The level.
     * @return string Returns the rendered navigation node.
     */
    private function renderNavigation(NavigationNode $node, int $level = 0): string {

        $anchor = $this->renderAnchor($node);

        $attributes = true === $node->getActive() ? ["class" => "active"] : [];

        if (0 === $node->size()) {
            return static::coreHTMLElement("li", "\n{$anchor}", $attributes);
        }

        $items = [];
        foreach ($node->getNodes() as $current) {
            $items[] = $this->renderNode($current, $level + 1);
        }

        $dropdown = $this->renderDropdown($node, $items);

        return static::coreHTMLElement("li", "\n{$anchor}{$dropdown}", $attributes);
    }

    /**
     * Render a node.
     *
     * @param AbstractNavigationNode $node The node.
     * @param int $level The level.
     * @return string Returns the rendered node.
     */
    private function renderNode(AbstractNavigationNode $node, int $level = 0): string {

        if (false === $node->isDisplayable()) {
            return "";
        }

        if (true === ($node instanceof HeaderNode)) {
            return $this->renderHeader($node);
        }

        if (true === ($node instanceof NavigationNode)) {
            return $this->renderNavigation($node, $level);
        }

        return "";
    }

    /**
     * Render a span.
     *
     * @param NavigationNode $node The navigation node.
     * @return string Returns the rendered span.
     */
    private function renderSpan(NavigationNode $node): string {

        $innerHTML = null !== $node->getId() ? $this->translate($node->getLabel()) : "";

        return static::coreHTMLElement("span", $innerHTML) . "\n";
    }

    /**
     * Translate.
     *
     * @param string $id The translation id.
     * @return string Returns the translation in case of success, id otherwise.
     */
    private function translate(string $id): string {

        $core = $this->getTranslator()->trans($id, [], "WBWCoreBundle");
        if ($id !== $core) {
            return $core;
        }

        $bootstrap = $this->getTranslator()->trans($id, [], "WBWBootstrapBundle");
        if ($id !== $bootstrap) {
            return $bootstrap;
        }

        $adminBSB = $this->getTranslator()->trans($id, [], "WBWAdminBSBBundle");
        if ($id !== $adminBSB) {
            return $adminBSB;
        }

        return $this->getTranslator()->trans($id);
    }
}


1			<?php
2
3			/*
4			* This file is part of the adminbsb-material-design-bundle package.
5			*
6			* (c) 2018 WEBEWEB
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace WBW\Bundle\AdminBSBBundle\Twig\Extension\Menu;
13
14			use Twig\Environment;
15			use WBW\Bundle\AdminBSBBundle\Twig\Extension\AbstractTwigExtension;
16			use WBW\Bundle\AdminBSBBundle\Twig\Extension\RendererTwigExtension;
17			use WBW\Bundle\CoreBundle\Component\Translation\BaseTranslatorInterface;
18			use WBW\Bundle\CoreBundle\Navigation\AbstractNavigationNode;
19			use WBW\Bundle\CoreBundle\Navigation\HeaderNode;
20			use WBW\Bundle\CoreBundle\Navigation\NavigationNode;
21			use WBW\Bundle\CoreBundle\Navigation\NavigationTree;
22			use WBW\Bundle\CoreBundle\Service\TranslatorTrait;
23
24			/**
25			* Abstract multi level menu Twig extension.
26			*
27			* @author webeweb <https://github.com/webeweb/>
28			* @package WBW\Bundle\AdminBSBBundle\Twig\Extension\Menu
29			* @abstract
30			*/
31			abstract class AbstractMenuTwigExtension extends AbstractTwigExtension {
32
33			use TranslatorTrait;
34
35			/**
36			* Constructor.
37			*
38			* @param Environment $twigEnvironment The Twig environment.
39			* @param BaseTranslatorInterface $translator The translator.
40			*/
41			public function __construct(Environment $twigEnvironment, $translator) {
42			parent::__construct($twigEnvironment);
43			$this->setTranslator($translator);
44			}
45
46			/**
47			* Displays an AdminBSB menu.
48			*
49			* @param NavigationTree $tree The navigation tree.
50			* @return string Returns the Admin BSB menu.
51			*/
52			protected function adminBSBMenu(NavigationTree $tree): string {
53
54			$templates = [];
55
56			foreach ($tree->getNodes() as $current) {
57			$templates[] = $this->renderNode($current);
58			}
59
60			return implode("\n", $templates);
61			}
62
63			/**
64			* Determines if a node is a menu toggle.
65			*
66			* @param NavigationNode $node
67			* @return bool Returns true in case of success, false otherwise.
68			*/
69			protected function isMenuToggle(NavigationNode $node): bool {
70
71			foreach ($node->getNodes() as $current) {
72
73			if (true === ($current instanceof NavigationNode) && true === $current->isDisplayable()) {
74			return true;
75			}
76			}
77
78			return false;
79			}
80
81			/**
82			* Render an anchor.
83			*
84			* @param NavigationNode $node The navigation node.
85			* @return string Returns the rendered anchor.
86			*/
87			private function renderAnchor(NavigationNode $node): string {
88
89			$attributes = [
90			"href" => $node->getUri(),
91			"target" => $node->getTarget(),
92			];
93
94			if ($this->isMenuToggle($node)) {
95			$attributes["class"] = "menu-toggle";
96			}
97
98			$icon = $this->renderIcon($node);
99			$span = $this->renderSpan($node);
100
101			return static::coreHTMLElement("a", "\n${icon}{$span}", $attributes) . "\n";
102			}
103
104			/**
105			* Render a dropdown.
106			*
107			* @param NavigationNode $node The navigation node.
108			* @param array $items The items.
109			* @return string Returns the rendered dropdown.
110			*/
111			private function renderDropdown(NavigationNode $node, array $items): string {
			0 ignored issues – show Unused Code introduced 2021-02-09 17:43 UTC by Report Bug Copy Issue Report The parameter `$node` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
112
113			$innerHTML = implode("\n", $items);
114
115			$dropdown = static::coreHTMLElement("ul", "\n{$innerHTML}", ["class" => "ml-menu"]);
116
117			return "{$dropdown}\n";
118			}
119
120			/**
121			* Render an header node.
122			*
123			* @param HeaderNode $node The header node.
124			* @return string Returns the rendered header node.
125			*/
126			private function renderHeader(HeaderNode $node): string {
127			return static::coreHTMLElement("li", $node->getLabel(), ["class" => "header"]);
128			}
129
130			/**
131			* Render an icon.
132			*
133			* @param NavigationNode $node The navigation node.
134			* @return string Returns the rendered icon.
135			*/
136			private function renderIcon(NavigationNode $node): string {
137			if (null === $node->getIcon()) {
138			return "";
139			}
140			return RendererTwigExtension::renderIcon($this->getTwigEnvironment(), $node->getIcon()) . "\n";
			0 ignored issues – show Bug introduced 2021-02-09 17:43 UTC by Report Bug Copy Issue Report It seems like `$this->getTwigEnvironment()` can be `null`; however, `renderIcon()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
141			}
142
143			/**
144			* Render a navigation node.
145			*
146			* @param NavigationNode $node The navigation node.
147			* @param int $level The level.
148			* @return string Returns the rendered navigation node.
149			*/
150			private function renderNavigation(NavigationNode $node, int $level = 0): string {
151
152			$anchor = $this->renderAnchor($node);
153
154			$attributes = true === $node->getActive() ? ["class" => "active"] : [];
155
156			if (0 === $node->size()) {
157			return static::coreHTMLElement("li", "\n{$anchor}", $attributes);
158			}
159
160			$items = [];
161			foreach ($node->getNodes() as $current) {
162			$items[] = $this->renderNode($current, $level + 1);
163			}
164
165			$dropdown = $this->renderDropdown($node, $items);
166
167			return static::coreHTMLElement("li", "\n{$anchor}{$dropdown}", $attributes);
168			}
169
170			/**
171			* Render a node.
172			*
173			* @param AbstractNavigationNode $node The node.
174			* @param int $level The level.
175			* @return string Returns the rendered node.
176			*/
177			private function renderNode(AbstractNavigationNode $node, int $level = 0): string {
178
179			if (false === $node->isDisplayable()) {
180			return "";
181			}
182
183			if (true === ($node instanceof HeaderNode)) {
184			return $this->renderHeader($node);
185			}
186
187			if (true === ($node instanceof NavigationNode)) {
188			return $this->renderNavigation($node, $level);
189			}
190
191			return "";
192			}
193
194			/**
195			* Render a span.
196			*
197			* @param NavigationNode $node The navigation node.
198			* @return string Returns the rendered span.
199			*/
200			private function renderSpan(NavigationNode $node): string {
201
202			$innerHTML = null !== $node->getId() ? $this->translate($node->getLabel()) : "";
203
204			return static::coreHTMLElement("span", $innerHTML) . "\n";
205			}
206
207			/**
208			* Translate.
209			*
210			* @param string $id The translation id.
211			* @return string Returns the translation in case of success, id otherwise.
212			*/
213			private function translate(string $id): string {
214
215			$core = $this->getTranslator()->trans($id, [], "WBWCoreBundle");
216			if ($id !== $core) {
217			return $core;
218			}
219
220			$bootstrap = $this->getTranslator()->trans($id, [], "WBWBootstrapBundle");
221			if ($id !== $bootstrap) {
222			return $bootstrap;
223			}
224
225			$adminBSB = $this->getTranslator()->trans($id, [], "WBWAdminBSBBundle");
226			if ($id !== $adminBSB) {
227			return $adminBSB;
228			}
229
230			return $this->getTranslator()->trans($id);
231			}
232			}
233

webeweb / adminbsb-material-design-bundle

Push — master ( e8b3d8...d74459 )

AbstractMenuTwigExtension::renderNode() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like