TcaColumnsProcessFieldDescriptions.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\Form\FormDataProvider;
 
use ‪TYPO3\CMS\Backend\Form\FormDataProviderInterface;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
 
class ‪TcaColumnsProcessFieldDescriptions implements ‪FormDataProviderInterface
{
    public function ‪addData(array $result): array
    {
        $result = $this->‪setDescriptionFromPageTsConfig($result);
        $result = $this->‪translateDescriptions($result);
        return $result;
    }
 
    protected function ‪setDescriptionFromPageTsConfig(array $result): array
    {
        $languageService = $this->‪getLanguageService();
        $tableName = $result['tableName'];
        foreach ($result['processedTca']['columns'] ?? [] as $fieldName => $fieldConfiguration) {
            $fieldTSconfig = $result['pageTsConfig']['TCEFORM.'][$tableName . '.'][$fieldName . '.'] ?? null;
            if (!is_array($fieldTSconfig)) {
                continue;
            }
            $pageTsConfigDescription = $languageService->translateLabel(
                $fieldTSconfig['description.'] ?? [],
                $fieldTSconfig['description'] ?? ''
            );
            if ($pageTsConfigDescription !== '') {
                $result['processedTca']['columns'][$fieldName]['description'] = $pageTsConfigDescription;
            }
        }
        return $result;
    }
 
    protected function ‪translateDescriptions(array $result): array
    {
        $languageService = $this->‪getLanguageService();
        foreach ($result['processedTca']['columns'] as $fieldName => $fieldConfiguration) {
            if (!isset($fieldConfiguration['description'])) {
                continue;
            }
            $result['processedTca']['columns'][$fieldName]['description'] = $languageService->sL($fieldConfiguration['description']);
        }
        return $result;
    }
 
    protected function ‪getLanguageService(): ‪LanguageService
    {
        return ‪$GLOBALS['LANG'];
    }
}