NullSite.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\Entity;
 
use Psr\Http\Message\UriInterface;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Error\PageErrorHandler\PageErrorHandlerInterface;
use ‪TYPO3\CMS\Core\Http\Uri;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪NullSite implements ‪SiteInterface
{
    protected int ‪$rootPageId = 0;
 
    protected array ‪$languages;
 
    public function ‪__construct(array ‪$languages = null, ‪Uri $baseEntryPoint = null)
    {
        if (empty(‪$languages)) {
            // Create the default language if no language configuration is given
            $this->languages[0] = new ‪SiteLanguage(
                0,
                '',
                new ‪Uri('/'),
                ['enabled' => true]
            );
        } else {
            foreach (‪$languages as $languageConfiguration) {
                $languageUid = (int)$languageConfiguration['languageId'];
                // Language configuration does not have a base defined
                // So the main site base is used (usually done for default languages)
                $this->languages[$languageUid] = new ‪SiteLanguage(
                    $languageUid,
                    $languageConfiguration['locale'] ?? '',
                    $baseEntryPoint ?: new ‪Uri('/'),
                    $languageConfiguration
                );
            }
        }
    }
 
    public function ‪getIdentifier(): string
    {
        return '#NULL';
    }
 
    public function ‪getBase(): UriInterface
    {
        return new ‪Uri('/');
    }
 
    public function ‪getRootPageId(): int
    {
        return 0;
    }
 
    public function ‪getLanguages(): array
    {
        return ‪$this->languages;
    }
 
    public function ‪getLanguageById(int $languageId): ‪SiteLanguage
    {
        if (isset($this->languages[$languageId])) {
            return $this->languages[$languageId];
        }
        throw new \InvalidArgumentException(
            'Language ' . $languageId . ' does not exist on site ' . $this->‪getIdentifier() . '.',
            1522965188
        );
    }
 
    public function ‪getDefaultLanguage(): ‪SiteLanguage
    {
        return reset($this->languages);
    }
 
    public function ‪getAvailableLanguages(‪BackendUserAuthentication $user, bool $includeAllLanguagesFlag = false, int $pageId = null): array
    {
        $availableLanguages = [];
 
        // Check if we need to add language "-1"
        if ($includeAllLanguagesFlag && $user->‪checkLanguageAccess(-1)) {
            $availableLanguages[-1] = new ‪SiteLanguage(-1, '', $this->‪getBase(), [
                'title' => $this->‪getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:multipleLanguages'),
                'flag' => 'flags-multiple',
            ]);
        }
        $pageTs = BackendUtility::getPagesTSconfig((int)$pageId);
        $pageTs = $pageTs['mod.']['SHARED.'] ?? [];
 
        $disabledLanguages = ‪GeneralUtility::intExplode(',', (string)($pageTs['disableLanguages'] ?? ''), true);
        // Do not add the ones that are not allowed by the user
        foreach ($this->languages as $language) {
            if ($user->‪checkLanguageAccess($language) && !in_array($language->getLanguageId(), $disabledLanguages, true)) {
                if ($language->getLanguageId() === 0) {
                    // 0: "Default" language
                    $defaultLanguageLabel = 'LLL:EXT:core/Resources/Private/Language/locallang_mod_web_list.xlf:defaultLanguage';
                    $defaultLanguageLabel = $this->‪getLanguageService()->sL($defaultLanguageLabel);
                    if (isset($pageTs['defaultLanguageLabel'])) {
                        $defaultLanguageLabel = $pageTs['defaultLanguageLabel'] . ' (' . $defaultLanguageLabel . ')';
                    }
                    $defaultLanguageFlag = '';
                    if (isset($pageTs['defaultLanguageFlag'])) {
                        $defaultLanguageFlag = 'flags-' . $pageTs['defaultLanguageFlag'];
                    }
                    $language = new ‪SiteLanguage(0, '', $language->getBase(), [
                        'title' => $defaultLanguageLabel,
                        'flag' => $defaultLanguageFlag,
                    ]);
                }
                $availableLanguages[$language->getLanguageId()] = $language;
            }
        }
 
        return $availableLanguages;
    }
 
    public function ‪getErrorHandler(int ‪$statusCode): ‪PageErrorHandlerInterface
    {
        throw new \RuntimeException('No error handler given for the status code "' . ‪$statusCode . '".', 1522495102);
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
}