SiteFinder.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Site;
 
use ‪TYPO3\CMS\Core\Configuration\SiteConfiguration;
use ‪TYPO3\CMS\Core\Exception\Page\PageNotFoundException;
use ‪TYPO3\CMS\Core\Exception\SiteNotFoundException;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\RootlineUtility;
 
class ‪SiteFinder
{
    protected ‪$sites = [];
 
    protected ‪$mappingRootPageIdToIdentifier = [];
 
    protected ‪$siteConfiguration;
 
    public function ‪__construct(‪SiteConfiguration ‪$siteConfiguration = null)
    {
        $this->siteConfiguration = ‪$siteConfiguration ?? GeneralUtility::makeInstance(SiteConfiguration::class);
        $this->‪fetchAllSites();
    }
 
    public function ‪getAllSites(bool $useCache = true): array
    {
        if ($useCache === false) {
            $this->‪fetchAllSites($useCache);
        }
        return ‪$this->sites;
    }
 
    public function ‪getSiteByRootPageId(int $rootPageId): ‪Site
    {
        if (isset($this->mappingRootPageIdToIdentifier[$rootPageId])) {
            return $this->sites[$this->mappingRootPageIdToIdentifier[$rootPageId]];
        }
        throw new ‪SiteNotFoundException('No site found for root page id ' . $rootPageId, 1521668882);
    }
 
    public function ‪getSiteByIdentifier(string $identifier): ‪Site
    {
        if (isset($this->sites[$identifier])) {
            return $this->sites[$identifier];
        }
        throw new ‪SiteNotFoundException('No site found for identifier ' . $identifier, 1521716628);
    }
 
    public function ‪getSiteByPageId(int $pageId, array $rootLine = null, string $mountPointParameter = null): ‪Site
    {
        if ($pageId === 0) {
            // page uid 0 has no root line. We don't need to ask the root line resolver to know that.
            $rootLine = [];
        }
        if (!is_array($rootLine)) {
            try {
                $rootLine = GeneralUtility::makeInstance(RootlineUtility::class, $pageId, $mountPointParameter)->get();
            } catch (‪PageNotFoundException $e) {
                // Usually when a page was hidden or disconnected
                // This could be improved by handing in a Context object and decide whether hidden pages
                // Should be linkable too
                $rootLine = [];
            }
        }
        foreach ($rootLine as $pageInRootLine) {
            if (isset($this->mappingRootPageIdToIdentifier[(int)$pageInRootLine['uid']])) {
                return $this->sites[$this->mappingRootPageIdToIdentifier[(int)$pageInRootLine['uid']]];
            }
        }
        throw new ‪SiteNotFoundException('No site found in root line of page ' . $pageId, 1521716622);
    }
 
    protected function ‪fetchAllSites(bool $useCache = true): void
    {
        $this->sites = $this->siteConfiguration->getAllExistingSites($useCache);
        foreach ($this->sites as $identifier => $site) {
            $this->mappingRootPageIdToIdentifier[$site->getRootPageId()] = $identifier;
        }
    }
}