TranslationConfigurationProvider.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\Backend\Configuration;
 
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\WorkspaceRestriction;
use ‪TYPO3\CMS\Core\Exception\SiteNotFoundException;
use ‪TYPO3\CMS\Core\Site\Entity\NullSite;
use ‪TYPO3\CMS\Core\Site\Entity\SiteInterface;
use ‪TYPO3\CMS\Core\Site\SiteFinder;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪TranslationConfigurationProvider
{
    protected array ‪$systemLanguageCache = [];
 
    public function getSystemLanguages($pageId = 0)
    {
        if (isset($this->‪systemLanguageCache[$pageId])) {
            return $this->‪systemLanguageCache[$pageId];
        }
        ‪$allSystemLanguages = [];
        ‪$siteFinder = GeneralUtility::makeInstance(SiteFinder::class);
        if ($pageId === 0) {
            // Used for e.g. filelist, where there is no site selected
            // This also means that there is no "-1" (All Languages) selectable.
            $sites = ‪$siteFinder->getAllSites();
            foreach ($sites as $site) {
                ‪$allSystemLanguages = $this->‪addSiteLanguagesToConsolidatedList(
                    ‪$allSystemLanguages,
                    $site->getAvailableLanguages($this->getBackendUserAuthentication()),
                    $site,
                    true
                );
            }
        } else {
            try {
                $site = ‪$siteFinder->getSiteByPageId((int)$pageId);
            } catch (SiteNotFoundException $e) {
                $site = new NullSite();
            }
            $siteLanguages = $site->getAvailableLanguages($this->‪getBackendUserAuthentication(), true);
            if (!isset($siteLanguages[0])) {
                $siteLanguages[0] = $site->getDefaultLanguage();
            }
            ‪$allSystemLanguages = $this->‪addSiteLanguagesToConsolidatedList(
                ‪$allSystemLanguages,
                $siteLanguages,
                $site,
                false
            );
        }
        ksort(‪$allSystemLanguages);
        $this->‪systemLanguageCache[$pageId] = ‪$allSystemLanguages;
        return ‪$allSystemLanguages;
    }
 
    protected function ‪addSiteLanguagesToConsolidatedList(array ‪$allSystemLanguages, array $languagesOfSpecificSite, ‪SiteInterface $site, bool $includeSiteSuffix): array
    {
        foreach ($languagesOfSpecificSite as $language) {
            $languageId = $language->getLanguageId();
            if (isset(‪$allSystemLanguages[$languageId])) {
                // Language already provided by another site, just add the label separately
                ‪$allSystemLanguages[$languageId]['title'] .= ', ' . $language->getTitle() . ' [Site: ' . $site->‪getIdentifier() . ']';
            } else {
                ‪$allSystemLanguages[$languageId] = [
                    'uid' => $languageId,
                    'title' => $language->getTitle() . ($includeSiteSuffix ? ' [Site: ' . $site->‪getIdentifier() . ']' : ''),
                    'flagIcon' => $language->getFlagIdentifier(),
                ];
            }
        }
        return ‪$allSystemLanguages;
    }
 
    public function ‪translationInfo($table, ‪$uid, $languageUid = 0, array $row = null, $selFieldList = '')
    {
        if (!‪$GLOBALS['TCA'][$table] || !‪$uid) {
            return 'No table "' . $table . '" or no UID value';
        }
        if ($row === null) {
            $row = BackendUtility::getRecordWSOL($table, ‪$uid);
        }
        if (!is_array($row)) {
            return 'Record "' . $table . '_' . ‪$uid . '" was not found';
        }
        if (!BackendUtility::isTableLocalizable($table)) {
            return 'Translation is not supported for this table!';
        }
        if ($row[‪$GLOBALS['TCA'][$table]['ctrl']['languageField']] > 0) {
            return 'Record "' . $table . '_' . ‪$uid . '" seems to be a translation already (has a language value "' . $row[‪$GLOBALS['TCA'][$table]['ctrl']['languageField']] . '", relation to record "' . $row[‪$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']] . '")';
        }
        if ($row[‪$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']] != 0) {
            return 'Record "' . $table . '_' . ‪$uid . '" seems to be a translation already (has a relation to record "' . $row[‪$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']] . '")';
        }
        // Look for translations of this record, index by language field value:
        if (!empty($selFieldList)) {
            if (is_array($selFieldList)) {
                $selectFields = $selFieldList;
            } else {
                $selectFields = ‪GeneralUtility::trimExplode(',', $selFieldList);
            }
        } else {
            $selectFields = ['uid', ‪$GLOBALS['TCA'][$table]['ctrl']['languageField']];
        }
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($table);
        $queryBuilder->getRestrictions()
            ->removeAll()
            ->add(GeneralUtility::makeInstance(DeletedRestriction::class))
            ->add(GeneralUtility::makeInstance(WorkspaceRestriction::class, $this->‪getBackendUserAuthentication()->workspace));
        $queryBuilder
            ->select(...$selectFields)
            ->from($table)
            ->where(
                $queryBuilder->expr()->eq(
                    ‪$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'],
                    $queryBuilder->createNamedParameter(‪$uid, ‪Connection::PARAM_INT)
                ),
                $queryBuilder->expr()->eq(
                    'pid',
                    $queryBuilder->createNamedParameter(
                        $row['pid'],
                        ‪Connection::PARAM_INT
                    )
                )
            );
        if (!$languageUid) {
            $queryBuilder->andWhere(
                $queryBuilder->expr()->gt(
                    ‪$GLOBALS['TCA'][$table]['ctrl']['languageField'],
                    $queryBuilder->createNamedParameter(0, ‪Connection::PARAM_INT)
                )
            );
        } else {
            $queryBuilder
                ->andWhere(
                    $queryBuilder->expr()->eq(
                        ‪$GLOBALS['TCA'][$table]['ctrl']['languageField'],
                        $queryBuilder->createNamedParameter($languageUid, ‪Connection::PARAM_INT)
                    )
                );
        }
        $translationRecords = $queryBuilder
            ->executeQuery()
            ->fetchAllAssociative();
 
        $translations = [];
        $translationsErrors = [];
        foreach ($translationRecords as $translationRecord) {
            if (!isset($translations[$translationRecord[‪$GLOBALS['TCA'][$table]['ctrl']['languageField']]])) {
                $translations[$translationRecord[‪$GLOBALS['TCA'][$table]['ctrl']['languageField']]] = $translationRecord;
            } else {
                $translationsErrors[$translationRecord[‪$GLOBALS['TCA'][$table]['ctrl']['languageField']]][] = $translationRecord;
            }
        }
        return [
            'table' => $table,
            'uid' => ‪$uid,
            'CType' => $row['CType'] ?? '',
            'sys_language_uid' => $row[‪$GLOBALS['TCA'][$table]['ctrl']['languageField'] ?? null] ?? null,
            'translations' => $translations,
            'excessive_translations' => $translationsErrors,
        ];
    }
 
    protected function ‪getBackendUserAuthentication(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
}