Merge pull request #5989 from WoltLab/wsc-rpc-api-const

[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / system / breadcrumb / Breadcrumbs.class.php

<?php

namespace wcf\system\breadcrumb;

use wcf\data\page\PageCache;
use wcf\system\page\PageLocationManager;
use wcf\system\SingletonFactory;
use wcf\system\WCF;

/**
 * Manages breadcrumbs.
 *
 * @author  Alexander Ebert
 * @copyright   2001-2019 WoltLab GmbH
 * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 */
final class Breadcrumbs extends SingletonFactory implements \Countable, \Iterator
{
    /**
     * list of breadcrumbs
     * @var Breadcrumb[]
     */
    protected $items;

    /**
     * Current iterator-index
     */
    protected int $index = 0;

    /**
     * Returns the list of breadcrumbs.
     *
     * @return  Breadcrumb[]
     */
    public function get(): array
    {
        if ($this->items === null) {
            $this->loadBreadcrumbs();
        }

        return $this->items;
    }

    /**
     * Loads the list of breadcrumbs.
     */
    protected function loadBreadcrumbs(): void
    {
        $this->items = [];
        $locations = PageLocationManager::getInstance()->getLocations();

        // locations are provided starting with the current location followed
        // by all relevant ancestors, but breadcrumbs appear in the reverse order
        $locations = \array_reverse($locations);

        // add the landing page as first location, unless it is already included
        $landingPage = PageCache::getInstance()->getLandingPage();
        $addLandingPage = true;
        for ($i = 0, $length = \count($locations); $i < $length; $i++) {
            if ($locations[$i]['pageID'] == $landingPage->pageID) {
                $addLandingPage = false;
                break;
            }
        }

        if ($addLandingPage) {
            \array_unshift($locations, [
                'link' => $landingPage->getLink(),
                'title' => BREADCRUMBS_HOME_USE_PAGE_TITLE ? WCF::getLanguage()->get(PAGE_TITLE) : $landingPage->getTitle(),
            ]);
        }

        // ignore the last location as it represents the current page
        \array_pop($locations);

        for ($i = 0, $length = \count($locations); $i < $length; $i++) {
            $this->items[] = new Breadcrumb($locations[$i]['title'], $locations[$i]['link']);
        }
    }

    /**
     * @inheritDoc
     */
    public function count(): int
    {
        if ($this->items === null) {
            $this->loadBreadcrumbs();
        }

        return \count($this->items);
    }

    /**
     * @inheritDoc
     */
    public function current(): Breadcrumb
    {
        return $this->items[$this->index];
    }

    /**
     * @inheritDoc
     */
    public function key(): int
    {
        return $this->index;
    }

    /**
     * @inheritDoc
     */
    public function valid(): bool
    {
        return isset($this->items[$this->index]);
    }

    /**
     * @inheritDoc
     */
    public function rewind(): void
    {
        $this->index = 0;
    }

    /**
     * @inheritDoc
     */
    public function next(): void
    {
        $this->index++;
    }
}