SiteLanguage.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\Core\Localization\Locale;
 
class ‪SiteLanguage
{
    protected ‪$languageId;
 
    protected ‪Locale ‪$locale;
 
    protected ‪$base;
 
    protected ‪$title = 'Default';
 
    protected ‪$navigationTitle = '';
 
    protected ‪$websiteTitle = '';
 
    protected ‪$flagIdentifier = '';
 
    protected ‪$twoLetterIsoCode = '';
 
    protected ‪$hreflang = '';
 
    protected ‪$direction = '';
 
    protected ‪$typo3Language = '';
 
    protected ‪$fallbackType = 'strict';
 
    protected ‪$fallbackLanguageIds = [];
 
    protected ‪$enabled = true;
 
    protected ‪$configuration = [];
 
    public function ‪__construct(int ‪$languageId, string ‪$locale, UriInterface ‪$base, array ‪$configuration)
    {
        $this->languageId = ‪$languageId;
        $this->locale = new ‪Locale(‪$locale);
        $this->base = ‪$base;
        $this->configuration = ‪$configuration;
 
        if (!empty(‪$configuration['title'])) {
            $this->title = ‪$configuration['title'];
        }
        if (!empty(‪$configuration['navigationTitle'])) {
            $this->navigationTitle = ‪$configuration['navigationTitle'];
        }
        if (!empty(‪$configuration['websiteTitle'])) {
            $this->websiteTitle = ‪$configuration['websiteTitle'];
        }
        if (!empty(‪$configuration['flag'])) {
            $this->flagIdentifier = ‪$configuration['flag'];
        }
        if (!empty(‪$configuration['typo3Language'])) {
            $this->typo3Language = ‪$configuration['typo3Language'];
        }
        if (!empty(‪$configuration['iso-639-1'])) {
            $this->twoLetterIsoCode = ‪$configuration['iso-639-1'];
        }
        if (!empty(‪$configuration['hreflang'])) {
            $this->hreflang = ‪$configuration['hreflang'];
        }
        if (!empty(‪$configuration['direction'])) {
            $this->direction = ‪$configuration['direction'];
        }
        if (!empty(‪$configuration['fallbackType'])) {
            $this->fallbackType = ‪$configuration['fallbackType'];
        }
        if (isset(‪$configuration['fallbacks'])) {
            ‪$fallbackLanguageIds = ‪$configuration['fallbacks'];
 
            // It is important to distinct between "0" and "" so, empty() should not be used here
            if (is_string(‪$fallbackLanguageIds)) {
                if (‪$fallbackLanguageIds !== '') {
                    ‪$fallbackLanguageIds = explode(',', ‪$fallbackLanguageIds);
                } else {
                    ‪$fallbackLanguageIds = [];
                }
            } elseif (is_scalar(‪$fallbackLanguageIds)) {
                ‪$fallbackLanguageIds = [‪$fallbackLanguageIds];
            }
            $this->fallbackLanguageIds = array_map('intval', ‪$fallbackLanguageIds);
        }
        if (isset(‪$configuration['enabled'])) {
            $this->‪enabled = (bool)‪$configuration['enabled'];
        }
    }
 
    public function ‪toArray(): array
    {
        return array_merge($this->configuration, [
            'languageId' => $this->‪getLanguageId(),
            // kept for backwards-compat for the time being, might change to BGP-47 format
            'locale' => $this->‪getLocale()->posixFormatted(),
            'base' => (string)$this->‪getBase(),
            'title' => $this->‪getTitle(),
            'websiteTitle' => $this->‪getWebsiteTitle(),
            'navigationTitle' => $this->‪getNavigationTitle(),
            // @deprecated will be removed in TYPO3 v13.0
            'twoLetterIsoCode' => $this->twoLetterIsoCode ?: $this->locale->getLanguageCode(),
            'hreflang' => $this->hreflang ?: $this->locale->getName(),
            'direction' => $this->direction ?: ($this->locale->isRightToLeftLanguageDirection() ? 'rtl' : ''),
            'typo3Language' => $this->getTypo3Language(),
            'flagIdentifier' => $this->getFlagIdentifier(),
            'fallbackType' => $this->getFallbackType(),
            'enabled' => $this->enabled(),
            'fallbackLanguageIds' => $this->getFallbackLanguageIds(),
        ]);
    }
 
    public function ‪getLanguageId(): int
    {
        return ‪$this->languageId;
    }
 
    public function ‪getLocale(): ‪Locale
    {
        return ‪$this->locale;
    }
 
    public function ‪getBase(): UriInterface
    {
        return ‪$this->base;
    }
 
    public function ‪getTitle(): string
    {
        return ‪$this->title;
    }
 
    public function ‪getNavigationTitle(): string
    {
        return $this->navigationTitle ?: ‪$this->title;
    }
 
    public function ‪getWebsiteTitle(): string
    {
        return ‪$this->websiteTitle;
    }
 
    public function ‪getFlagIdentifier(): string
    {
        return ‪$this->flagIdentifier;
    }
 
    public function ‪getTypo3Language(): string
    {
        if ($this->typo3Language !== '') {
            return ‪$this->typo3Language;
        }
        // locale is just set to "C" or "en", this should then be mapped to "default"
        if ($this->locale->getLanguageCode() === 'en' && !$this->locale->getCountryCode()) {
            return 'default';
        }
        ‪$typo3Language = $this->locale->getLanguageCode();
        if ($this->locale->getCountryCode()) {
            ‪$typo3Language .= '_' . $this->locale->getCountryCode();
        }
        return ‪$typo3Language;
    }
 
    public function ‪hasCustomTypo3Language(): bool
    {
        return $this->typo3Language !== '';
    }
 
    public function ‪getTwoLetterIsoCode(): string
    {
        trigger_error('SiteLanguage->getTwoLetterIsoCode() will be removed in TYPO3 v13.0. Use SiteLanguage->getLocale()->getLanguageCode() instead.', E_USER_DEPRECATED);
        return $this->twoLetterIsoCode ?: $this->locale->getLanguageCode();
    }
 
    public function ‪getHreflang(bool $isInternalCall = false): string
    {
        if (!$isInternalCall) {
            trigger_error('SiteLanguage->getHreflang() will be removed in TYPO3 v13.0. Use SiteLanguage->getLocale()->getName() instead.', E_USER_DEPRECATED);
        }
        return $this->hreflang ?: $this->locale->getName();
    }
 
    public function ‪getDirection(): string
    {
        trigger_error('SiteLanguage->getDirection() will be removed in TYPO3 v13.0. Use SiteLanguage->getLocale()->isRightToLeftLanguageDirection() instead.', E_USER_DEPRECATED);
        return ‪$this->direction;
    }
 
    public function ‪enabled(): bool
    {
        return ‪$this->enabled;
    }
 
    public function ‪isEnabled(): bool
    {
        return ‪$this->enabled;
    }
 
    public function ‪getFallbackType(): string
    {
        return ‪$this->fallbackType;
    }
 
    public function ‪getFallbackLanguageIds(): array
    {
        return ‪$this->fallbackLanguageIds;
    }
}