Yiisoft\Yii\Bulma\Panel

Complexity

Total Complexity

32

Size/Duplication

Total Lines	298
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	run()	0	12	1
A	heading()	0	6	1
A	template()	0	6	1
A	tabs()	0	6	1
A	tabsOptions()	0	6	1
A	color()	0	11	2
A	headingOptions()	0	6	1
A	options()	0	6	1
B	renderTab()	0	42	8
A	renderTabs()	0	14	3
A	buildOptions()	0	12	3
A	renderHeading()	0	8	2
A	isActive()	0	3	1
A	renderItem()	0	34	6

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Bulma;

use InvalidArgumentException;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Html\Html;

final class Panel extends Widget
{
    public const COLOR_PRIMARY = 'is-primary';
    public const COLOR_LINK = 'is-link';
    public const COLOR_INFO = 'is-info';
    public const COLOR_SUCCESS = 'is-success';
    public const COLOR_WARNING = 'is-warning';
    public const COLOR_DANGER = 'is-danger';
    private const COLOR_ALL = [
        self::COLOR_PRIMARY,
        self::COLOR_LINK,
        self::COLOR_INFO,
        self::COLOR_SUCCESS,
        self::COLOR_WARNING,
        self::COLOR_DANGER,
    ];

    private array $options = [];
    private array $headingOptions = [];
    private ?string $heading = null;
    private string $color = '';
    private array $tabs = [];
    private array $tabsOptions = [];
    private bool $encodeLabels = true;
    private bool $encodeTags = false;
    private string $template = '{panelBegin}{panelHeading}{panelTabs}{panelItems}{panelEnd}';
    private array $tabItems = [];

    protected function run(): string
    {
        $this->buildOptions();

        $tag = ArrayHelper::getValue($this->options, 'tag', 'nav');

        return strtr($this->template, [
            '{panelBegin}' => Html::beginTag($tag, $this->options),

It seems like $this->options can also be of type object; however, parameter $options of Yiisoft\Html\Html::beginTag() does only seem to accept array, maybe add an additional type check?

            '{panelHeading}' => $this->renderHeading(),
            '{panelTabs}' => $this->renderTabs(),
            '{panelItems}' => implode("\n", $this->tabItems),
            '{panelEnd}' => Html::endTag($tag),
        ]);
    }

    /**
     * String the template for rendering panel.
     *
     * - `{panelBegin}`: _string_, which will render the panel container begin.
     * - `{panelHeading}`: _string_, which will render the panel heading.
     * - `{panelTabs}`: _string_, which will render the panel tabs.
     * - `{panelItems}`: _string_, which will render the panel items.
     * - `{panelEnd}`: _string_, which will render the panel container end.
     *
     * @param string $value
     *
     * @return self
     */
    public function template(string $value): self
    {
        $new = clone $this;
        $new->template = $value;

        return $new;
    }

    /**
     * @param array $value
     *
     * @return self
     */
    public function options(array $value): self
    {
        $new = clone $this;
        $new->options = $value;

        return $new;
    }

    /**
     * @param string $value
     *
     * @return self
     */
    public function heading(string $value): self
    {
        $new = clone $this;
        $new->heading = $value;

        return $new;
    }

    /**
     * @param array $value
     *
     * @return self
     */
    public function headingOptions(array $value): self
    {
        $new = clone $this;
        $new->headingOptions = $value;

        return $new;
    }

    /**
     * Set progress bar color.
     *
     * @var string $value Color class.
     *
     * @return self
     */
    public function color(string $value): self
    {
        if (!in_array($value, self::COLOR_ALL, true)) {
            $values = implode('", "', self::COLOR_ALL);
            throw new InvalidArgumentException("Invalid color. Valid values are: \"$values\".");
        }

        $new = clone $this;
        $new->color = $value;

        return $new;
    }

    /**
     * @param array $value
     *
     * @return self
     */
    public function tabs(array $value): self
    {
        $new = clone $this;
        $new->tabs = $value;

        return $new;
    }

    /**
     * @param array $value
     *
     * @return self
     */
    public function tabsOptions(array $value): self
    {
        $new = clone $this;
        $new->tabsOptions = $value;

        return $new;
    }

    /**
     * @throws \JsonException
     *
     * @return string
     */
    private function renderHeading(): string
    {
        if ($this->heading !== null) {
            Html::addCssClass($this->headingOptions, 'panel-heading');
            return "\n" . Html::tag('p', $this->heading, $this->headingOptions) . "\n";
        }

        return '';
    }

    /**
     * @throws \JsonException
     *
     * @return string
     */
    private function renderTabs(): string
    {
        if (!empty($this->tabs)) {
            $tabs = '';
            foreach ($this->tabs as $index => $item) {
                $tabs .= $this->renderTab($index, $item) . "\n";
            }

            Html::addCssClass($this->tabsOptions, 'panel-tabs');

            return "\n" . Html::tag('p', "\n" . $tabs, $this->tabsOptions) . "\n";
        }

        return '';
    }

    private function buildOptions(): void
    {
        Html::addCssClass($this->options, 'panel');

        $this->options['id'] ??= $this->getId() . '-panel';

        if ($this->encodeTags === false) {
            $this->tabsOptions = array_merge($this->tabsOptions, ['encode' => false]);
        }

        if ($this->color !== '') {
            Html::addCssClass($this->options, $this->color);
        }
    }

    /**
     * @param int $index
     * @param array $item
     *
     * @throws \JsonException
     *
     * @return string
     */
    private function renderTab(int $index, array $item): string
    {
        $id = $this->getId() . '-panel-c' . $index;
        $url = ArrayHelper::getValue($item, 'url', '');
        $label = ArrayHelper::getValue($item, 'label', '');
        $encode = ArrayHelper::getValue($item, 'encode', $this->encodeLabels);
        $linkOptions = ArrayHelper::getValue($item, 'linkOptions', []);
        $tabItems = ArrayHelper::getValue($item, 'items', []);
        $tabItemsContainerOptions = ArrayHelper::getValue($item, 'itemsContainerOptions', []);

        if ($url !== '') {
            $linkOptions['href'] = $url;
        }

        if ($label === '') {
            throw new InvalidArgumentException('The "label" option is required.');
        }

        if ($encode === true) {
            $label = Html::encode($label);
        }

        if ($this->isActive($item)) {
            Html::addCssClass($linkOptions, ['active' => 'is-active']);
        }

        if (is_array($tabItems) && !empty($tabItems)) {
            $linkOptions['href'] ??= '#' . $id;
            $tabItemsContainerOptions['id'] ??= $id;

            $tabItemsContainer = Html::beginTag('div', $tabItemsContainerOptions) . "\n";

            foreach ($tabItems as $tabItem) {
                $tabItemsContainer .= $this->renderItem($tabItem) . "\n";
            }

            $tabItemsContainer .= Html::endTag('div');

            $this->tabItems[$index] = $tabItemsContainer;
        }

        return Html::tag('a', $label, $linkOptions);
    }

    private function renderItem(array $item): string
    {
        $options = ArrayHelper::getValue($item, 'options', []);
        $label = ArrayHelper::getValue($item, 'label', '');
        $icon = ArrayHelper::getValue($item, 'icon', '');
        $encode = ArrayHelper::getValue($item, 'encode', $this->encodeLabels);

        if ($label === '') {
            throw new InvalidArgumentException('The "label" option is required.');
        }

        if ($encode === true) {
            $label = Html::encode($label);
        }

        Html::addCssClass($options, 'panel-block');

        if ($this->isActive($item)) {
            Html::addCssClass($options, ['active' => 'is-active']);
        }

        $labelOptions = ['class' => 'panel-icon'];

        if ($this->encodeTags === false) {
            $labelOptions['encode'] = false;
            $options['encode'] = false;
        }

        if ($icon !== '') {
            $icon = "\n" . Html::tag('i', '', ['class' => $icon, 'aria-hidden' => 'true']) . "\n";
            $label = "\n" . Html::tag('span', $icon, $labelOptions) . "\n" . $label . "\n";
        }

        return Html::tag('a', $label, $options);
    }

    /**
     * Checking if active item.
     *
     * @param array $item
     *
     * @return bool
     */
    private function isActive(array $item): bool
    {
        return (bool) ArrayHelper::getValue($item, 'active', false);
    }
}