Yiisoft\Yii\Bulma\NavBar

Complexity

Total Complexity

31

Size/Duplication

Total Lines	372
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	brandImage()	0	5	1
A	autoIdPrefix()	0	5	1
A	brandAttributes()	0	5	1
A	render()	0	3	1
A	renderNavBarBurger()	0	26	2
A	buttonLinkAriaLabelText()	0	5	1
A	buttonLinkAriaExpanded()	0	5	1
A	buttonLinkContent()	0	5	1
A	brandTextAttributes()	0	5	1
A	brandImageAttributes()	0	5	1
A	itemCssClass()	0	5	1
A	buttonLinkRole()	0	5	1
A	begin()	0	4	1
A	burgerAttributes()	0	5	1
A	role()	0	5	1
A	renderNavBar()	0	13	2
A	id()	0	5	1
A	ariaLabel()	0	5	1
A	brandUrl()	0	5	1
A	cssClass()	0	5	1
A	burgerCssClass()	0	5	1
A	attributes()	0	5	1
A	renderNavBarBrand()	0	49	5
A	brandText()	0	5	1
A	brandCssClass()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Bulma;

use Yiisoft\Html\Html;
use Yiisoft\Html\Tag\A;
use Yiisoft\Html\Tag\Div;
use Yiisoft\Html\Tag\Img;
use Yiisoft\Html\Tag\Span;
use Yiisoft\Widget\Widget;

/**
 * NavBar renders a navbar HTML component.
 *
 * Any content enclosed between the {@see begin()} and {@see end()} calls of NavBar is treated as the content of the
 * navbar. You may use widgets such as {@see Nav} to build up such content. For example,
 *
 * @link https://bulma.io/documentation/components/navbar/
 */
final class NavBar extends Widget
{
    private string $ariaLabel = 'main navigation';
    private array $attributes = [];
    private string $autoIdPrefix = 'w';
    private array $brandAttributes = [];
    private string $brandImage = '';
    private array $brandImageAttributes = [];
    private string $brandText = '';
    private array $brandTextAttributes = [];
    private string $brandUrl = '/';
    private string $brandCssClass = 'navbar-brand';
    private array $burgerAttributes = [];
    private string $burgerCssClass = 'navbar-burger';
    private string $buttonLinkAriaExpanded = 'false';
    private string $buttonLinkAriaLabelText = 'menu';
    private string $buttonLinkContent = '';
    private string $buttonLinkRole = 'button';
    private string $cssClass = 'navbar';
    private string $itemCssClass = 'navbar-item';
    private string $role = 'navigation';

    /**
     * Returns a new instance with the specified `aria-label` attribute for the current element.
     */
    public function ariaLabel(string $value): self
    {
        $new = clone $this;
        $new->ariaLabel = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified HTML attributes for widget.
     *
     * @param array $values Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} For details on how attributes are being rendered.
     */
    public function attributes(array $values): self
    {
        $new = clone $this;
        $new->attributes = $values;
        return $new;
    }

    /**
     * Returns a new instance with the specified prefix to the automatically generated widget IDs.
     *
     * @param string $value The prefix to the automatically generated widget IDs.
     */
    public function autoIdPrefix(string $value): self
    {
        $new = clone $this;
        $new->autoIdPrefix = $value;
        return $new;
    }

    public function begin(): string
    {
        parent::begin();
        return $this->renderNavBar();
    }

    /**
     * Returns a new instance with the specified HTML attributes for the navbar brand.
     *
     * @param array $values Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} For details on how attributes are being rendered.
     */
    public function brandAttributes(array $values): self
    {
        $new = clone $this;
        $new->brandAttributes = $values;
        return $new;
    }

    /**
     * Returns a new instance with the specified the CSS class of the brand.
     *
     * @param string $value The CSS class.
     */
    public function brandCssClass(string $value): self
    {
        $new = clone $this;
        $new->brandCssClass = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified src of the brand image, empty if it's not used.
     *
     * Note that this param will override `$this->brandText` param.
     *
     * @param string $value The src of the brand image.
     */
    public function brandImage(string $value): self
    {
        $new = clone $this;
        $new->brandImage = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified HTML attributes for the brand image.
     *
     * @param array $values Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} For details on how attributes are being rendered.
     */
    public function brandImageAttributes(array $values): self
    {
        $new = clone $this;
        $new->brandImageAttributes = $values;
        return $new;
    }

    /**
     * Returns a new instance with the specified the text of the brand or empty if it's not used. Note that this is not
     * HTML-encoded.
     *
     * @param string $value The text of the brand.
     */
    public function brandText(string $value): self
    {
        $new = clone $this;
        $new->brandText = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified HTML attributes for the brand text.
     *
     * @param array $values Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} For details on how attributes are being rendered.
     */
    public function brandTextAttributes(array $values): self
    {
        $new = clone $this;
        $new->brandTextAttributes = $values;
        return $new;
    }

    /**
     * Returns a new instance with the specified the URL for the brand's hyperlink tag and will be used for the "href"
     * attribute of the brand link. Default value is "/". You may set it to empty string if you want no link at all.
     */
    public function brandUrl(string $value): self
    {
        $new = clone $this;
        $new->brandUrl = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified HTML attributes for the burger.
     *
     * @param array $values Attribute values indexed by attribute names.
     *
     * {@see Html::renderTagAttributes()} For details on how attributes are being rendered.
     */
    public function burgerAttributes(array $values): self
    {
        $new = clone $this;
        $new->burgerAttributes = $values;
        return $new;
    }

    /**
     * Returns a new instance with the specified the CSS class of the burger.
     *
     * @param string $value The CSS class.
     */
    public function burgerCssClass(string $value): self
    {
        $new = clone $this;
        $new->burgerCssClass = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified the ARIA expanded attribute of the button link.
     */
    public function buttonLinkAriaExpanded(string $value): self
    {
        $new = clone $this;
        $new->buttonLinkAriaExpanded = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified HTML attributes for the ARIA label text of the button link.
     */
    public function buttonLinkAriaLabelText(string $value): self
    {
        $new = clone $this;
        $new->buttonLinkAriaLabelText = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified the content of the button link.
     */
    public function buttonLinkContent(string $value): self
    {
        $new = clone $this;
        $new->buttonLinkContent = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified the role of the button link.
     */
    public function buttonLinkRole(string $value): self
    {
        $new = clone $this;
        $new->buttonLinkRole = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified the CSS class of the navbar.
     *
     * @param string $value The CSS class.
     */
    public function cssClass(string $value): self
    {
        $new = clone $this;
        $new->cssClass = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified ID of the widget.
     *
     * @param string $value The ID of the widget.
     */
    public function id(string $value): self
    {
        $new = clone $this;
        $new->attributes['id'] = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified the CSS class of the items navbar.
     *
     * @param string $value The CSS class.
     */
    public function itemCssClass(string $value): self
    {
        $new = clone $this;
        $new->itemCssClass = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified the role of the navbar.
     */
    public function role(string $value): self
    {
        $new = clone $this;
        $new->role = $value;
        return $new;
    }

    public function render(): string
    {
        return Html::closeTag('nav');
    }

    private function renderNavBar(): string
    {
        $attributes = $this->attributes;
        Html::addCssClass($attributes, $this->cssClass);

        if (!isset($attributes['id'])) {
            $attributes['id'] = Html::generateId($this->autoIdPrefix) . '-navbar';
        }

        $attributes['aria-label'] = $this->ariaLabel;
        $attributes['role'] = $this->role;

        return Html::openTag('nav', $attributes) . PHP_EOL . $this->renderNavBarBrand() . PHP_EOL;
    }

    private function renderNavBarBrand(): string
    {
        $brand = '';
        $brandImage = '';

        if ($this->brandImage !== '') {
            $brandImage = Img::tag()
                ->attributes($this->brandImageAttributes)
                ->url($this->brandImage)
                ->render();
            $brand = PHP_EOL . A::tag()
                ->class($this->itemCssClass)
                ->content($brandImage)
                ->encode(false)
                ->url($this->brandUrl)
                ->render();
        }

        if ($this->brandText !== '') {
            $brandText = $this->brandText;

            if ($brandImage !== '') {
                $brandText = $brandImage . $this->brandText;
            }

            if (empty($this->brandUrl)) {
                $brand = PHP_EOL . Span::tag()
                    ->addAttributes($this->brandTextAttributes)
                    ->addClass($this->itemCssClass)
                    ->content($brandText)
                    ->render();
            } else {
                $brand = PHP_EOL . A::tag()
                    ->addClass($this->itemCssClass)
                    ->content($brandText)
                    ->encode(false)
                    ->url($this->brandUrl)
                    ->render();
            }
        }

        $brand .= $this->renderNavBarBurger();

        return Div::tag()
            ->addAttributes($this->brandAttributes)
            ->addClass($this->brandCssClass)
            ->content($brand)
            ->encode(false)
            ->render();
    }

    /**
     * Renders collapsible toggle button.
     *
     * @return string the rendering navbar burger link button.
     *
     * @link https://bulma.io/documentation/components/navbar/#navbar-burger
     */
    private function renderNavBarBurger(): string
    {
        $burgerAttributes = $this->burgerAttributes;
        if ($this->buttonLinkContent === '') {
            $this->buttonLinkContent = PHP_EOL .
                Span::tag()
                    ->attributes(['aria-hidden' => 'true'])
                    ->render() . PHP_EOL .
                Span::tag()
                    ->attributes(['aria-hidden' => 'true'])
                    ->render() . PHP_EOL .
                Span::tag()
                    ->attributes(['aria-hidden' => 'true'])
                    ->render() . PHP_EOL;
        }

        $burgerAttributes['aria-expanded'] = $this->buttonLinkAriaExpanded;
        $burgerAttributes['aria-label'] = $this->buttonLinkAriaLabelText;
        $burgerAttributes['role'] = $this->buttonLinkRole;

        return PHP_EOL . A::tag()
            ->addAttributes($burgerAttributes)
            ->addClass($this->burgerCssClass)
            ->content($this->buttonLinkContent)
            ->encode(false)
            ->render() . PHP_EOL;
    }
}