Yiisoft\Yii\Widgets\Helper\Normalizer

Complexity

Total Complexity

63

Size/Duplication

Total Lines	223
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	dropdown()	0	34	5
A	toggleAttributes()	0	4	3
A	visible()	0	3	3
A	menu()	0	42	5
A	link()	0	3	3
A	headerAttributes()	0	5	3
A	iconContainerAttributes()	0	4	3
A	label()	0	18	6
A	iconClass()	0	3	3
A	icon()	0	3	3
A	active()	0	7	3
A	renderLabel()	0	23	6
A	iconAttributes()	0	4	3
A	itemContainerAttributes()	0	4	3
A	enclose()	0	3	3
A	linkAttributes()	0	4	3
A	isItemActive()	0	3	2
A	disabled()	0	3	3

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Widgets\Helper;

use InvalidArgumentException;
use Yiisoft\Html\Html;
use Yiisoft\Html\Tag\I;
use Yiisoft\Html\Tag\Span;

final class Normalizer
{
    /**
     * Normalize the given array of items for the dropdown.
     */
    public static function dropdown(array $items): array
    {
        /**
         * @psalm-var array[] $items
         * @psalm-suppress RedundantConditionGivenDocblockType
         */
        foreach ($items as $i => $child) {
            if (is_array($child)) {
                $items[$i]['label'] = self::renderLabel(
                    self::label($child),
                    self::icon($child),
                    self::iconAttributes($child),
                    self::iconClass($child),
                    self::iconContainerAttributes($child),
                );
                $items[$i]['active'] = self::active($child, '', '', false);
                $items[$i]['disabled'] = self::disabled($child);
                $items[$i]['enclose'] = self::enclose($child);
                $items[$i]['headerAttributes'] = self::headerAttributes($child);
                $items[$i]['itemContainerAttributes'] = self::itemContainerAttributes($child);
                $items[$i]['link'] = self::link($child, '/');
                $items[$i]['linkAttributes'] = self::linkAttributes($child);
                $items[$i]['toggleAttributes'] = self::toggleAttributes($child);
                $items[$i]['visible'] = self::visible($child);

                if (isset($child['items']) && is_array($child['items'])) {
                    $items[$i]['items'] = self::dropdown($child['items']);
                } else {
                    $items[$i]['items'] = [];
                }
            }
        }

        return $items;
    }

    /**
     * Normalize the given array of items for the menu.
     */
    public static function menu(
        array $items,
        string $currentPath,
        bool $activateItems,
        array $iconContainerAttributes = []
    ): array {
        /**
         * @psalm-var array[] $items
         * @psalm-suppress RedundantConditionGivenDocblockType
         */
        foreach ($items as $i => $child) {
            if (is_array($child)) {
                if (isset($child['items']) && is_array($child['items'])) {
                    $items[$i]['items'] = self::menu(
                        $child['items'],
                        $currentPath,
                        $activateItems,
                        $iconContainerAttributes,
                    );
                } else {
                    $items[$i]['link'] = self::link($child);
                    $items[$i]['linkAttributes'] = self::linkAttributes($child);
                    $items[$i]['active'] = self::active(
                        $child,
                        $items[$i]['link'],
                        $currentPath,
                        $activateItems
                    );
                    $items[$i]['disabled'] = self::disabled($child);
                    $items[$i]['visible'] = self::visible($child);
                    $items[$i]['label'] = self::renderLabel(
                        self::label($child),
                        self::icon($child),
                        self::iconAttributes($child),
                        self::iconClass($child),
                        self::iconContainerAttributes($child, $iconContainerAttributes),
                    );
                }
            }
        }

        return $items;
    }

    private static function active(array $item, string $link, string $currentPath, bool $activateItems): bool
    {
        if (!array_key_exists('active', $item)) {
            return self::isItemActive($link, $currentPath, $activateItems);
        }

        return is_bool($item['active']) ? $item['active'] : false;
    }

    private static function disabled(array $item): bool
    {
        return array_key_exists('disabled', $item) && is_bool($item['disabled']) ? $item['disabled'] : false;
    }

    private static function enclose(array $item): bool
    {
        return array_key_exists('enclose', $item) && is_bool($item['enclose']) ? $item['enclose'] : true;
    }

    private static function headerAttributes(array $item): array
    {
        return array_key_exists('headerAttributes', $item) && is_array($item['headerAttributes'])
            ? $item['headerAttributes']
            : [];
    }

    private static function icon(array $item): string
    {
        return array_key_exists('icon', $item) && is_string($item['icon']) ? $item['icon'] : '';
    }

    private static function iconAttributes(array $item): array
    {
        return array_key_exists('iconAttributes', $item) && is_array($item['iconAttributes'])
            ? $item['iconAttributes'] : [];
    }

    private static function iconClass(array $item): string
    {
        return array_key_exists('iconClass', $item) && is_string($item['iconClass']) ? $item['iconClass'] : '';
    }

    private static function iconContainerAttributes(array $item, array $iconContainerAttributes = []): array
    {
        return array_key_exists('iconContainerAttributes', $item) && is_array($item['iconContainerAttributes'])
            ? $item['iconContainerAttributes'] : $iconContainerAttributes;
    }

    /**
     * Checks whether a menu item is active.
     *
     * This is done by checking match that specified in the `url` option of the menu item.
     *
     * @param string $link The link of the menu item.
     * @param string $currentPath The current path.
     * @param bool $activateItems Whether to activate items having no link.
     *
     * @return bool Whether the menu item is active.
     */
    private static function isItemActive(string $link, string $currentPath, bool $activateItems): bool
    {
        return $link === $currentPath && $activateItems;
    }

    private static function itemContainerAttributes(array $item): array
    {
        return array_key_exists('itemContainerAttributes', $item) && is_array($item['itemContainerAttributes'])
            ? $item['itemContainerAttributes'] : [];
    }

    private static function label(array $item): string
    {
        if (!isset($item['label'])) {
            throw new InvalidArgumentException('The "label" option is required.');
        }

        if (!is_string($item['label'])) {
            throw new InvalidArgumentException('The "label" option must be a string.');
        }

        if ($item['label'] === '' && !isset($item['icon'])) {
            throw new InvalidArgumentException('The "label" cannot be an empty string.');
        }

        /** @var bool */
        $encode = $item['encode'] ?? true;

        return $encode ? Html::encode($item['label']) : $item['label'];
    }

    private static function link(array $item, string $defaultValue = ''): string
    {
        return array_key_exists('link', $item) && is_string($item['link']) ? $item['link'] : $defaultValue;
    }

    private static function linkAttributes(array $item): array
    {
        return array_key_exists('linkAttributes', $item) && is_array($item['linkAttributes'])
            ? $item['linkAttributes'] : [];
    }

    private static function renderLabel(
        string $label,
        string $icon,
        array $iconAttributes,
        string $iconClass,
        array $iconContainerAttributes
    ): string {
        $html = '';

        if ($iconClass !== '') {
            Html::addCssClass($iconAttributes, $iconClass);
        }

        if ($icon !== '' || $iconAttributes !== [] || $iconClass !== '') {
            $i = I::tag()->addAttributes($iconAttributes)->content($icon);
            $html = Span::tag()->addAttributes($iconContainerAttributes)->content($i)->encode(false)->render();
        }

        if ($label !== '') {
            $html .= $label;
        }

        return $html;
    }

    private static function toggleAttributes(array $item): array
    {
        return array_key_exists('toggleAttributes', $item) && is_array($item['toggleAttributes'])
            ? $item['toggleAttributes'] : [];
    }

    private static function visible(array $item): bool
    {
        return array_key_exists('visible', $item) && is_bool($item['visible']) ? $item['visible'] : true;
    }
}