Phalcon\Html\Breadcrumbs

Complexity

Total Complexity

10

Size/Duplication

Total Lines	164
Duplicated Lines	0 %

Test Coverage

Coverage

97.37%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	render()	0	26	3
A	add()	0	5	1
A	toArray()	0	3	1
A	getSeparator()	0	3	1
A	setSeparator()	0	5	1
A	getLink()	0	12	1
A	remove()	0	7	1
A	clear()	0	3	1

<?php

/**
 * This file is part of the Phalcon Framework.
 *
 * (c) Phalcon Team <team@phalcon.io>
 *
 * For the full copyright and license information, please view the LICENSE.txt
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Phalcon\Html;

use function array_keys;
use function end;
use function implode;
use function str_replace;

/**
 * Phalcon\Html\Breadcrumbs
 *
 * This component offers an easy way to create breadcrumbs for your application.
 * The resulting HTML when calling `render()` will have each breadcrumb enclosed
 * in `<dt>` tags, while the whole string is enclosed in `<dl>` tags.
 *
 * @property array  $elements
 * @property string $separator
 * @property string $template
 */
class Breadcrumbs
{
    /**
     * Keeps all the breadcrumbs
     *
     * @var array
     */
    private $elements = [];

    /**
     * Crumb separator
     *
     * @var string
     */
    private $separator = " / ";

    /**
     * The HTML template to use to render the breadcrumbs.
     *
     * @var string
     */
    private $template = "<dt><a href=\"{link}\">{label}</a></dt>";

    /**
     * Adds a new crumb.
     *
     * ```php
     * // Adding a crumb with a link
     * $breadcrumbs->add("Home", "/");
     *
     * // Adding a crumb without a link (normally the last one)
     * $breadcrumbs->add("Users");
     * ```
     *
     * @param string $label
     * @param string $link
     *
     * @return Breadcrumbs
     */
    public function add(string $label, string $link = ""): Breadcrumbs
    {
        $this->elements[$link] = $label;

        return $this;
    }

    /**
     * Clears the crumbs
     *
     * ```php
     * $breadcrumbs->clear()
     * ```
     */
    public function clear(): void
    {
        $this->elements = [];
    }

    /**
     * Returns the separator
     *
     * @return string
     */
    public function getSeparator(): string
    {
        return $this->separator;
    }

    /**
     * Removes crumb by url.
     *
     * ```php
     * $breadcrumbs->remove("/admin/user/create");
     *
     * // remove a crumb without an url (last link)
     * $breadcrumbs->remove();
     * ```
     *
     * @param string $link
     */
    public function remove(string $link): void
    {
        $elements = $this->elements;

        unset($elements[$link]);

        $this->elements = $elements;
    }

    /**
     * Renders and outputs breadcrumbs based on previously set template.
     *
     * ```php
     * echo $breadcrumbs->render();
     * ```
     */
    public function render(): string
    {
        $output    = [];
        $elements  = $this->elements;
        $urls      = array_keys($elements);
        $lastUrl   = end($urls);
        $lastLabel = $elements[$lastUrl];

        unset($elements[$lastUrl]);

        foreach ($elements as $url => $element) {
            $output[] = $this->getLink($element, $url);
        }

        /**
         * Check if this is the "Home" element i.e. count() = 0
         */
        if (0 !== count($elements)) {
            $output[] = "<dt>" . $lastLabel . "</dt>";
        } else {
            $output[] = $this->getLink($lastLabel, $lastUrl);
        }

        return "<dl>"
            . implode("<dt>" . $this->separator . "</dt>", $output)
            . "</dl>";
    }

    /**
     * Set the separator
     *
     * @param string $separator
     *
     * @return Breadcrumbs
     */
    public function setSeparator(string $separator): Breadcrumbs
    {
        $this->separator = $separator;

        return $this;
    }

    /**
     * Returns the internal breadcrumbs array
     */
    public function toArray(): array
    {
        return $this->elements;
    }

    /**
     * @param string $label
     * @param string $url
     *
     * @return string
     */
    private function getLink(string $label, string $url): string
    {
        return str_replace(
            [
                "{label}",
                "{link}"
            ],
            [
                $label,
                $url
            ],
            $this->template
        );
    }
}