DatabaseSystemLanguageRows.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\Form\FormDataProvider;

/*
 * 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\Backend\Form\FormDataProviderInterface;
use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Database\DatabaseConnection;
use TYPO3\CMS\Core\Messaging\FlashMessage;
use TYPO3\CMS\Core\Messaging\FlashMessageService;
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Lang\LanguageService;

class DatabaseSystemLanguageRows implements FormDataProviderInterface
{
    public function addData(array $result)
    {
        $database = $this->getDatabase();
        $languageService = $this->getLanguageService();

        $pageTs = $result['pageTsConfig'];
        $defaultLanguageLabel = $languageService->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:defaultLanguage');
        if (isset($pageTs['mod.']['SHARED.']['defaultLanguageLabel'])) {
            $defaultLanguageLabel = $pageTs['mod.']['SHARED.']['defaultLanguageLabel'] . ' (' . $languageService->sL($defaultLanguageLabel) . ')';
        }
        $defaultLanguageFlag = 'empty-empty';
        if (isset($pageTs['mod.']['SHARED.']['defaultLanguageFlag'])) {
            $defaultLanguageFlag = 'flags-' . $pageTs['mod.']['SHARED.']['defaultLanguageFlag'];
        }

        $languageRows = [
            -1 => [
                // -1: "All" languages
                'uid' => -1,
                'title' => $languageService->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:multipleLanguages'),
                // Same as for 0, but iso is used in flex form context only and duplication handled there
                // @todo: Maybe drop this if flex form language handling is extracted?
                'iso' => 'DEF',
                'flagIconIdentifier' => 'flags-multiple',
            ],
            0 => [
                // 0: "Default" language
                'uid' => 0,
                'title' => $defaultLanguageLabel,
                // Default "DEF" is a fallback preparation for flex form iso codes "lDEF"
                // @todo: Maybe drop this if flex form language handling is extracted?
                'iso' => 'DEF',
                'flagIconIdentifier' => $defaultLanguageFlag,
            ],
        ];

        $dbRows = $database->exec_SELECTgetRows(
            'uid,title,language_isocode,static_lang_isocode,flag',
            'sys_language',
            'pid=0'
        );

        if ($dbRows === null) {
            throw new \UnexpectedValueException(
                'Database query error ' . $database->sql_error(),
                1438170741
            );
        }

        $isStaticInfoTablesLoaded = ExtensionManagementUtility::isLoaded('static_info_tables');
        foreach ($dbRows as $dbRow) {
            $uid = $dbRow['uid'];
            $languageRows[$uid] = [
                'uid' => $uid,
                'title' => $dbRow['title'],
                'flagIconIdentifier' => 'flags-' . $dbRow['flag'],
            ];
            if (!empty($dbRow['language_isocode'])) {
                $languageRows[$uid]['iso'] = $dbRow['language_isocode'];
            } elseif ($isStaticInfoTablesLoaded && !empty($dbRow['static_lang_isocode'])) {
                GeneralUtility::deprecationLog(
                    'Usage of the field "static_lang_isocode" is discouraged, and will stop working with CMS 8. Use the built-in'
                    . ' language field "language_isocode" in your sys_language records.'
                );
                $lg_iso_2 = BackendUtility::getRecord('static_languages', $dbRow['static_lang_isocode'], 'lg_iso_2');
                if ($lg_iso_2['lg_iso_2']) {
                    $languageRows[$uid]['iso'] = $lg_iso_2['lg_iso_2'];
                }
            } else {
                // No iso code could be found. This is currently possible in the system but discouraged.
                // So, code within FormEngine has to be suited to work with an empty iso code. However,
                // it may impact certain multi language scenarios, so we add a flash message hinting for
                // incomplete configuration here.
                // It might be possible to convert this to a non-catchable exception later if
                // it iso code is enforced on a different layer of the system (tca required + migration wizard).
                // @todo: This could be relaxed again if flex form language handling is extracted,
                // @todo: since the rest of the FormEngine code does not rely on iso code?
                $message = sprintf(
                    $languageService->sL('LLL:EXT:lang/locallang_core.xlf:error.missingLanguageIsocode'),
                    $dbRow['title'],
                    $uid
                );
                $flashMessage = GeneralUtility::makeInstance(
                        FlashMessage::class,
                        $message,
                        '',
                        FlashMessage::ERROR
                );
                $flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);
                $defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();
                $defaultFlashMessageQueue->enqueue($flashMessage);
                $languageRows[$uid]['iso'] = '';
            }
        }

        $result['systemLanguageRows'] = $languageRows;

        return $result;
    }

    protected function getDatabase()
    {
        return $GLOBALS['TYPO3_DB'];
    }

    protected function getLanguageService()
    {
        return $GLOBALS['LANG'];
    }
}