Yiisoft\Yii\Widgets\Breadcrumbs

Complexity

Total Complexity

23

Size/Duplication

Total Lines	246
Duplicated Lines	0 %

Test Coverage

Coverage

98.48%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	tag()	0	5	1
A	itemTemplate()	0	5	1
A	items()	0	5	1
A	withoutEncodeLabels()	0	5	1
A	withoutHomeItem()	0	5	1
A	homeItem()	0	5	1
A	options()	0	5	1
A	activeItemTemplate()	0	5	1
B	run()	0	30	8
A	renderHomeLink()	0	7	2
A	renderItem()	0	22	5

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Widgets;

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

use function array_key_exists;
use function implode;
use function is_array;
use function strtr;

/**
 * Breadcrumbs displays a list of links indicating the position of the current page in the whole site hierarchy.
 *
 * For example, breadcrumbs like "Home / Sample Post / Edit" means the user is viewing an edit page for the
 * "Sample Post". He can click on "Sample Post" to view that page, or he can click on "Home" to return to the homepage.
 *
 * To use Breadcrumbs, you need to configure its {@see Breadcrumbs::items()} method,
 * which specifies the links to be displayed. For example:
 *
 * ```php
 * // $this is the view object currently being used
 * echo Breadcrumbs::widget()
 *     -> itemTemplate() => "<li><i>{link}</i></li>\n", // template for all links
 *     -> links() => [
 *         [
 *             'label' => 'Post Category',
 *             'url' => 'post-category/view?id=10',
 *             'template' => "<li><b>{link}</b></li>\n", // template for this link only
 *         ],
 *         ['label' => 'Sample Post', 'url' => 'post/edit?id=1',
 *         'Edit',
 *     ];
 * ```
 *
 * Because breadcrumbs usually appears in nearly every page of a website, you may consider placing it in a layout view.
 * You can use a view common parameter (e.g. `$this->getCommonParameter('breadcrumbs')`) to configure the links in
 * different views. In the layout view, you assign this view parameter to the {@see Breadcrumbs::items()} method
 * like the following:
 *
 * ```php
 * // $this is the view object currently being used
 * echo Breadcrumbs::widget()
 *     ->links($this->hasCommonParameter('breadcrumbs') ? $this->getCommonParameter('breadcrumbs') : []);
 * ```
 */
final class Breadcrumbs extends Widget
{
    private string $tag = 'ul';
    private array $options = ['class' => 'breadcrumb'];
    private bool $encodeLabels = true;
    private bool $withoutHomeItem = false;
    private array $homeItem = [];
    private array $items = [];
    private string $itemTemplate = "<li>{link}</li>\n";
    private string $activeItemTemplate = "<li class=\"active\">{link}</li>\n";

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

    /**
     * Disables encoding for labels and returns a new instance..
     *
     * @return self Whether the labels for menu items should be HTML-encoded.
     */
    public function withoutEncodeLabels(): self
    {
        $new = clone $this;
        $new->encodeLabels = false;
        return $new;
    }

    /**
     * Disables rendering of the home item and returns a new instance.
     *
     * @return self
     */
    public function withoutHomeItem(): self
    {
        $new = clone $this;
        $new->withoutHomeItem = true;
        return $new;
    }

    /**
     * Returns a new instance with the specified first item in the breadcrumbs (called home link).
     *
     * @param array $value Please refer to {@see items()} on the format.
     *
     * @return self
     */
    public function homeItem(array $value): self
    {
        $new = clone $this;
        $new->homeItem = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified list of items.
     *
     * @param array $value List of items to appear in the breadcrumbs. If this property is empty, the widget will not
     * render anything. Each array element represents a single link in the breadcrumbs with the following structure:
     *
     * ```php
     * [
     *     'label' => 'label of the link',  // required
     *     'url' => 'url of the link',      // optional
     *     'template' => 'own template of the item', // optional, if not set $this->itemTemplate will be used
     * ]
     * ```
     *
     * If a link is active, you only need to specify its "label", and instead of writing `['label' => $label]`, you may
     * simply use `$label`.
     *
     * Additional array elements for each link will be treated as the HTML attributes for the hyperlink tag.
     * For example, the following link specification will generate a hyperlink with CSS class `external`:
     *
     * ```php
     * [
     *     'label' => 'demo',
     *     'url' => 'http://example.com',
     *     'class' => 'external',
     * ]
     * ```
     *
     * Each individual link can override global {@see encodeLabels} param like the following:
     *
     * ```php
     * [
     *     'label' => '<strong>Hello!</strong>',
     *     'encode' => false,
     * ]
     * ```
     *
     * @return self
     */
    public function items(array $value): self
    {
        $new = clone $this;
        $new->items = $value;
        return $new;
    }

    /**
     * @param array $value The HTML attributes for the menu's container tag. The following special options are
     * recognized:
     *
     * - tag: string, defaults to "ul", the tag name of the item container tags. Set to false to disable container tag.
     *   See also {@see \Yiisoft\Html\Html::tag()}.
     *
     * {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
     *
     * @return self
     */
    public function options(array $value): self
    {
        $new = clone $this;
        $new->options = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified item template.
     *
     * @param string $value The template used to render each inactive item in the breadcrumbs.
     * The token `{link}` will be replaced with the actual HTML link for each inactive item.
     *
     * @return self
     */
    public function itemTemplate(string $value): self
    {
        $new = clone $this;
        $new->itemTemplate = $value;
        return $new;
    }

    /**
     * Returns a new instance with the specified active item template.
     *
     * @param string $value The template used to render each active item in the breadcrumbs.
     * The token `{link}` will be replaced with the actual HTML link for each active item.
     *
     * @return self
     */
    public function activeItemTemplate(string $value): self
    {
        $new = clone $this;
        $new->activeItemTemplate = $value;
        return $new;
    }

    /**
     * Renders the widget.
     *
     * @throws JsonException
     *
     * @return string The result of widget execution to be outputted.
     */
    protected function run(): string
    {
        if (empty($this->items)) {
            return '';
        }

        $items = [];

        if ($this->withoutHomeItem === false) {
            $items[] = $this->renderHomeLink();
        }

        foreach ($this->items as $item) {
            if (!is_array($item)) {
                $item = ['label' => $item];
            }

            if (!empty($item)) {
                $items[] = $this->renderItem(
                    $item,
                    isset($item['url']) ? $this->itemTemplate : $this->activeItemTemplate
                );
            }
        }

        $body = implode('', $items);

        return empty($this->tag)
            ? $body
            : Html::tag($this->tag, $body, $this->options)->encode(false)->render()
            ;
    }

    /**
     * Renders a single breadcrumb item.
     *
     * @param array $item The item to be rendered. It must contain the "label" element. The "url" element is optional.
     * @param string $template the template to be used to rendered the link. The token "{link}" will be replaced by the
     * link.
     *
     * @throws InvalidArgumentException|JsonException if `$item` does not have "label" element.
     *
     * @return string The rendering result.
     */
    private function renderItem(array $item, string $template): string
    {
        if (!array_key_exists('label', $item)) {
            throw new InvalidArgumentException('The "label" element is required for each link.');
        }

        $encodeLabel = ArrayHelper::remove($item, 'encode', $this->encodeLabels);
        $label = $encodeLabel ? Html::encode($item['label']) : $item['label'];

        if (isset($item['template'])) {
            $template = $item['template'];
        }

        if (isset($item['url'])) {
            $options = $item;
            unset($options['template'], $options['label'], $options['url']);
            $item = Html::a($label, $item['url'], $options);
        } else {
            $item = $label;
        }

        return strtr($template, ['{link}' => $item]);
    }

    /**
     * Renders a home item.
     *
     * @throws JsonException
     *
     * @return string The rendering result.
     */
    private function renderHomeLink(): string
    {
        if ($this->homeItem === []) {
            $this->homeItem = ['label' => 'Home', 'url' => '/'];
        }

        return $this->renderItem($this->homeItem, $this->itemTemplate);
    }
}