LanguageService.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Localization;
 
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
class ‪LanguageService
{
    public string ‪$lang = 'default';
 
    protected ?‪Locale ‪$locale = null;
 
    protected array ‪$labels = [];
 
    protected array ‪$overrideLabels = [];
 
    protected ‪Locales ‪$locales;
    protected ‪LocalizationFactory ‪$localizationFactory;
    protected ‪FrontendInterface ‪$runtimeCache;
 
    public function ‪__construct(‪Locales ‪$locales, ‪LocalizationFactory ‪$localizationFactory, ‪FrontendInterface ‪$runtimeCache)
    {
        $this->locales = ‪$locales;
        $this->localizationFactory = ‪$localizationFactory;
        $this->runtimeCache = ‪$runtimeCache;
    }
 
    public function ‪init(‪Locale|string $languageKey): void
    {
        if ($languageKey instanceof ‪Locale) {
            $this->locale = $languageKey;
        } else {
            $this->locale = $this->locales->createLocale($languageKey);
        }
        $this->lang = $this->‪getTypo3LanguageKey();
    }
 
    protected function ‪getLLL(string $index, array $localLanguage): string
    {
        if (isset($localLanguage[$this->lang][$index])) {
            $value = is_string($localLanguage[$this->lang][$index])
                ? $localLanguage[‪$this->lang][$index]
                : $localLanguage[‪$this->lang][$index][0]['target'];
        } elseif (isset($localLanguage['default'][$index])) {
            $value = is_string($localLanguage['default'][$index])
                ? $localLanguage['default'][$index]
                : $localLanguage['default'][$index][0]['target'];
        } else {
            $value = '';
        }
        return $value;
    }
 
    public function ‪sL($input): string
    {
        $input = (string)$input;
        // early return for empty input to avoid cache and language file reading on first hit.
        if ($input === '') {
            return $input;
        }
        // Use a constant non-localizable label
        if (!str_starts_with(trim($input), 'LLL:')) {
            return $input;
        }
 
        $cacheIdentifier = 'labels_' . (string)$this->locale . '_' . md5($input);
        $cacheEntry = $this->runtimeCache->get($cacheIdentifier);
        if ($cacheEntry !== false) {
            return $cacheEntry;
        }
        // Remove the LLL: prefix
        $restStr = substr(trim($input), 4);
        $extensionPrefix = '';
        // ll-file referred to is found in an extension
        if (‪PathUtility::isExtensionPath(trim($restStr))) {
            $restStr = substr(trim($restStr), 4);
            $extensionPrefix = 'EXT:';
        }
        $parts = explode(':', trim($restStr));
        $parts[0] = $extensionPrefix . $parts[0];
        $labelsFromFile = $this->‪readLLfile($parts[0]);
        if (is_array($this->‪overrideLabels[$parts[0]] ?? null)) {
            $labelsFromFile = array_replace_recursive($labelsFromFile, $this->‪overrideLabels[$parts[0]]);
        }
        ‪$output = $this->‪getLLL($parts[1] ?? '', $labelsFromFile);
        $this->runtimeCache->set($cacheIdentifier, ‪$output);
        return ‪$output;
    }
 
    public function ‪includeLLFile(string $fileRef): array
    {
        $localLanguage = $this->‪readLLfile($fileRef);
        if (!empty($localLanguage)) {
            $this->labels = array_replace_recursive($this->labels, $localLanguage);
        }
        return $localLanguage;
    }
 
    public function ‪translateLabel(array|string $input, string $fallback): string
    {
        if (is_array($input) && isset($input[$this->lang])) {
            return $this->‪sL((string)$input[$this->lang]);
        }
        if (is_string($input)) {
            return $this->‪sL($input);
        }
        return $this->‪sL($fallback);
    }
 
    public function getLabelsFromResource(string $fileRef): array
    {
        ‪$labelArray = [];
        $labelsFromFile = $this->‪readLLfile($fileRef);
        foreach ($labelsFromFile['default'] as $key => $value) {
            ‪$labelArray[$key] = $this->‪getLLL($key, $labelsFromFile);
        }
        return ‪$labelArray;
    }
 
    protected function ‪readLLfile(string $fileRef): array
    {
        $cacheIdentifier = 'labels_file_' . md5($fileRef . (string)$this->locale);
        $cacheEntry = $this->runtimeCache->get($cacheIdentifier);
        if (is_array($cacheEntry)) {
            return $cacheEntry;
        }
 
        $mainLanguageKey = $this->‪getTypo3LanguageKey();
        $localLanguage = [];
        $allLocales = array_merge([$mainLanguageKey], $this->locale->getDependencies());
        $allLocales = array_reverse($allLocales);
        foreach ($allLocales as ‪$locale) {
            $tempLL = $this->localizationFactory->getParsedData($fileRef, ‪$locale);
            $localLanguage['default'] = $tempLL['default'];
            if (!isset($localLanguage[$mainLanguageKey])) {
                $localLanguage[$mainLanguageKey] = $localLanguage['default'];
            }
            if ($mainLanguageKey !== 'default') {
                // Fallback as long as TYPO3 supports "da_DK" and "da-DK"
                if ((!isset($tempLL[‪$locale]) || $tempLL[‪$locale] === []) && str_contains(‪$locale, '-')) {
                    $underscoredLocale = str_replace('-', '_', ‪$locale);
                    $tempLL = $this->localizationFactory->getParsedData($fileRef, $underscoredLocale);
                    if (isset($tempLL[$underscoredLocale])) {
                        $tempLL[‪$locale] = $tempLL[$underscoredLocale];
                    }
                }
                if (isset($tempLL[‪$locale])) {
                    // Merge current language labels onto labels from previous language
                    // This way we have a labels with fall back applied
                    ArrayUtility::mergeRecursiveWithOverrule($localLanguage[$mainLanguageKey], $tempLL[‪$locale], true, false);
                }
            }
        }
 
        $this->runtimeCache->set($cacheIdentifier, $localLanguage);
        return $localLanguage;
    }
 
    public function ‪overrideLabels(string $fileRef, array ‪$labels): void
    {
        $localLanguage = [
            'default' => ‪$labels['default'] ?? [],
        ];
        $mainLanguageKey = $this->‪getTypo3LanguageKey();
        if ($mainLanguageKey !== 'default') {
            $allLocales = array_merge([$mainLanguageKey], $this->locale->getDependencies());
            $allLocales = array_reverse($allLocales);
            foreach ($allLocales as $language) {
                // Populate the initial values with default, if no labels for the current language are given
                if (!isset($localLanguage[$mainLanguageKey])) {
                    $localLanguage[$mainLanguageKey] = $localLanguage['default'];
                }
                if (isset(‪$labels[$language])) {
                    $localLanguage[$mainLanguageKey] = array_replace_recursive($localLanguage[$mainLanguageKey], ‪$labels[$language]);
                }
            }
        }
        $this->‪overrideLabels[$fileRef] = $localLanguage;
    }
 
    public function ‪getLocale(): ?‪Locale
    {
        return ‪$this->locale;
    }
 
    private function ‪getTypo3LanguageKey(): string
    {
        if ($this->locale === null) {
            return 'default';
        }
        if ($this->locale->getName() === 'en') {
            return 'default';
        }
        return $this->locale->getName();
    }
}