9.5/_language_service_8php_source.html

<?php

namespace ‪TYPO3\CMS\Core\Localization;


/*

 * 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!

 */


use ‪TYPO3\CMS\Core\Utility\ArrayUtility;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;


class ‪LanguageService

{

    public ‪$lang = 'default';


    public ‪$debugKey = false;


    public ‪$LL_files_cache = [];


    public ‪$LL_labels_cache = [];


    protected ‪$languageDependencies = [];


    protected ‪$languageFileCache = [];


    public function ‪__construct()

    {

        $this->debugKey = (bool)‪$GLOBALS['TYPO3_CONF_VARS']['BE']['languageDebug'];

    }


    public function ‪init($languageKey)

    {

        // Find the requested language in this list based on the $languageKey

        ‪$locales = GeneralUtility::makeInstance(Locales::class);

        // Language is found. Configure it:

        if (in_array($languageKey, ‪$locales->getLocales())) {

            // The current language key

            $this->lang = $languageKey;

            $this->languageDependencies[] = $languageKey;

            foreach (‪$locales->getLocaleDependencies($languageKey) as $language) {

                $this->languageDependencies[] = $language;

            }

        }

    }


    public function ‪debugLL($value)

    {

        return $this->debugKey ? '[' . $value . ']' : '';

    }


    public function ‪getLL($index)

    {

        return $this->‪getLLL($index, ‪$GLOBALS['LOCAL_LANG']);

    }


    public function ‪getLLL($index, $localLanguage)

    {

        // Get Local Language. Special handling for all extensions that

        // read PHP LL files and pass arrays here directly.

        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 . $this->‪debugLL($index);

    }


    public function ‪sL($input)

    {

        $identifier = $input . '_' . (int)$this->debugKey;

        if (isset($this->LL_labels_cache[$this->lang][$identifier])) {

            return $this->LL_labels_cache[‪$this->lang][$identifier];

        }

        if (strpos($input, 'LLL:') === 0) {

            $restStr = trim(substr($input, 4));

            $extPrfx = '';

            // ll-file referred to is found in an extension.

            if (strpos($restStr, 'EXT:') === 0) {

                $restStr = trim(substr($restStr, 4));

                $extPrfx = 'EXT:';

            }

            $parts = explode(':', $restStr);

            $parts[0] = $extPrfx . $parts[0];

            // Getting data if not cached

            if (!isset($this->LL_files_cache[$parts[0]])) {

                $this->LL_files_cache[$parts[0]] = $this->‪readLLfile($parts[0]);

            }

            ‪$output = $this->‪getLLL($parts[1], $this->LL_files_cache[$parts[0]]);

        } else {

            // Use a constant non-localizable label

            ‪$output = $input;

        }

        ‪$output .= $this->‪debugLL($input);

        $this->LL_labels_cache[‪$this->lang][$identifier] = ‪$output;

        return ‪$output;

    }


    public function ‪loadSingleTableDescription($table)

    {

        // First the 'table' cannot already be loaded in [columns]

        // and secondly there must be a references to locallang files available in [refs]

        if (is_array(‪$GLOBALS['TCA_DESCR'][$table]) && !isset(‪$GLOBALS['TCA_DESCR'][$table]['columns']) && is_array(‪$GLOBALS['TCA_DESCR'][$table]['refs'])) {

            // Init $TCA_DESCR for $table-key

            ‪$GLOBALS['TCA_DESCR'][$table]['columns'] = [];

            // Get local-lang for each file in $TCA_DESCR[$table]['refs'] as they are ordered.

            foreach (‪$GLOBALS['TCA_DESCR'][$table]['refs'] as $llfile) {

                $localLanguage = $this->‪includeLLFile($llfile, false, true);

                // Traverse all keys

                if (is_array($localLanguage['default'])) {

                    foreach ($localLanguage['default'] as $lkey => $lVal) {

                        // Exploding by '.':

                        // 0-n => fieldname,

                        // n+1 => type from (alttitle, description, details, syntax, image_descr,image,seeAlso),

                        // n+2 => special instruction, if any

                        $keyParts = explode('.', $lkey);

                        $keyPartsCount = count($keyParts);

                        // Check if last part is special instruction

                        // Only "+" is currently supported

                        $specialInstruction = $keyParts[$keyPartsCount - 1] === '+';

                        if ($specialInstruction) {

                            array_pop($keyParts);

                        }

                        // If there are more than 2 parts, get the type from the last part

                        // and merge back the other parts with a dot (.)

                        // Otherwise just get type and field name straightaway

                        if ($keyPartsCount > 2) {

                            $type = array_pop($keyParts);

                            $fieldName = implode('.', $keyParts);

                        } else {

                            $fieldName = $keyParts[0];

                            $type = $keyParts[1];

                        }

                        // Detecting 'hidden' labels, converting to normal fieldname

                        if ($fieldName === '_') {

                            $fieldName = '';

                        }

                        if ($fieldName !== '' && $fieldName[0] === '_') {

                            $fieldName = substr($fieldName, 1);

                        }

                        // Append label

                        $label = $lVal[0]['target'] ?: $lVal[0]['source'];

                        if ($specialInstruction) {

                            ‪$GLOBALS['TCA_DESCR'][$table]['columns'][$fieldName][$type] .= LF . $label;

                        } else {

                            // Substitute label

                            ‪$GLOBALS['TCA_DESCR'][$table]['columns'][$fieldName][$type] = $label;

                        }

                    }

                }

            }

        }

    }


    public function ‪includeLLFile($fileRef, $setGlobal = true, $mergeLocalOntoDefault = false)

    {

        $globalLanguage = [];

        // Get default file

        $localLanguage = $this->‪readLLfile($fileRef);

        if (is_array($localLanguage) && !empty($localLanguage)) {

            // it depends on, whether we should return the result or set it in the global $LOCAL_LANG array

            if ($setGlobal) {

                $globalLanguage = (array)(‪$GLOBALS['LOCAL_LANG'] ?? []);

                ‪ArrayUtility::mergeRecursiveWithOverrule($globalLanguage, $localLanguage);

            } else {

                $globalLanguage = $localLanguage;

            }

            // Merge local onto default

            if ($mergeLocalOntoDefault && $this->lang !== 'default' && is_array($globalLanguage[$this->lang]) && is_array($globalLanguage['default'])) {

                // array_merge can be used so far the keys are not

                // numeric - which we assume they are not...

                $globalLanguage['default'] = array_merge($globalLanguage['default'], $globalLanguage[$this->lang]);

                unset($globalLanguage[$this->lang]);

            }

        }

        // Return value if not global is set.

        if (!$setGlobal) {

            return $globalLanguage;

        }

        ‪$GLOBALS['LOCAL_LANG'] = $globalLanguage;

        return null;

    }


    protected function ‪readLLfile($fileRef)

    {

        if (isset($this->languageFileCache[$fileRef . $this->lang])) {

            return $this->languageFileCache[$fileRef . ‪$this->lang];

        }


        $languageFactory = GeneralUtility::makeInstance(LocalizationFactory::class);


        if ($this->lang !== 'default') {

            $languages = array_reverse($this->languageDependencies);

        } else {

            $languages = ['default'];

        }

        $localLanguage = [];

        foreach ($languages as $language) {

            $tempLL = $languageFactory->getParsedData($fileRef, $language);

            $localLanguage['default'] = $tempLL['default'];

            if (!isset($localLanguage[$this->lang])) {

                $localLanguage[‪$this->lang] = $localLanguage['default'];

            }

            if ($this->lang !== 'default' && isset($tempLL[$language])) {

                // Merge current language labels onto labels from previous language

                // This way we have a labels with fall back applied

                ‪ArrayUtility::mergeRecursiveWithOverrule($localLanguage[$this->lang], $tempLL[$language], true, false);

            }

        }

        $this->languageFileCache[$fileRef . ‪$this->lang] = $localLanguage;


        return $localLanguage;

    }


    public function ‪getLabelsWithPrefix($prefix, $strip = '')

    {

        $extraction = [];

        $labels = array_merge((array)‪$GLOBALS['LOCAL_LANG']['default'], (array)‪$GLOBALS['LOCAL_LANG'][$this->lang]);

        // Regular expression to strip the selection prefix and possibly something from the label name:

        $labelPattern = '#^' . preg_quote($prefix, '#') . '(' . preg_quote($strip, '#') . ')?#';

        // Iterate through all locallang labels:

        foreach ($labels as $label => $value) {

            if (strpos($label, $prefix) === 0) {

                $key = preg_replace($labelPattern, '', $label);

                $extraction[$key] = $value;

            }

        }

        return $extraction;

    }

}