TableManualRepository.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\Backend\Domain\Repository;
 
use ‪TYPO3\CMS\Backend\Controller\HelpController;
use ‪TYPO3\CMS\Backend\Module\ModuleLoader;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Type\File\ImageInfo;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
class ‪TableManualRepository
{
    public function ‪getTableManual($table)
    {
        $parts = [];
 
        // Load descriptions for table $table
        $this->‪getLanguageService()->loadSingleTableDescription($table);
        if (is_array(‪$GLOBALS['TCA_DESCR'][$table]['columns'] ?? null) && $this->‪checkAccess('tables_select', $table)) {
            // Reserved for header of table
            $parts[0] = '';
            // Traverse table columns as listed in TCA_DESCR
            foreach (‪$GLOBALS['TCA_DESCR'][$table]['columns'] as $field => $_) {
                if (!$this->‪isExcludableField($table, $field) || $this->‪checkAccess('non_exclude_fields', $table . ':' . $field)) {
                    if (!$field) {
                        // Header
                        $parts[0] = $this->‪getItem($table, '', true);
                    } else {
                        // Field
                        $parts[] = $this->‪getItem($table, $field, true);
                    }
                }
            }
            if (!$parts[0]) {
                unset($parts[0]);
            }
        }
        return $parts;
    }
 
    public function ‪getSingleManual($table, $field)
    {
        $this->‪getLanguageService()->loadSingleTableDescription($table);
        return $this->‪getItem($table, $field);
    }
 
    public function ‪getSections($mode)
    {
        // Initialize
        $cshKeys = array_flip(array_keys(‪$GLOBALS['TCA_DESCR']));
        $tcaKeys = array_keys(‪$GLOBALS['TCA']);
        $outputSections = [];
        $tocArray = [];
        // TYPO3 Core Features
        $lang = $this->‪getLanguageService();
        $lang->loadSingleTableDescription('xMOD_csh_corebe');
        $this->‪renderTableOfContentItem($mode, 'xMOD_csh_corebe', 'core', $outputSections, $tocArray, $cshKeys);
        // Backend Modules
        $loadModules = GeneralUtility::makeInstance(ModuleLoader::class);
        $loadModules->load(‪$GLOBALS['TBE_MODULES']);
        foreach ($loadModules->getModules() as $mainMod => $info) {
            $cshKey = '_MOD_' . $mainMod;
            if ($cshKeys[$cshKey] ?? '') {
                $lang->loadSingleTableDescription($cshKey);
                $this->‪renderTableOfContentItem($mode, $cshKey, 'modules', $outputSections, $tocArray, $cshKeys);
            }
            if (is_array($info['sub'] ?? null)) {
                foreach ($info['sub'] as $subMod => $subInfo) {
                    $cshKey = '_MOD_' . $mainMod . '_' . $subMod;
                    if ($cshKeys[$cshKey] ?? '') {
                        $lang->loadSingleTableDescription($cshKey);
                        $this->‪renderTableOfContentItem($mode, $cshKey, 'modules', $outputSections, $tocArray, $cshKeys);
                    }
                }
            }
        }
        // Database Tables
        foreach ($tcaKeys as $table) {
            // Load descriptions for table $table
            $lang->loadSingleTableDescription($table);
            if (is_array(‪$GLOBALS['TCA_DESCR'][$table]['columns'] ?? null) && $this->‪checkAccess('tables_select', $table)) {
                $this->‪renderTableOfContentItem($mode, $table, 'tables', $outputSections, $tocArray, $cshKeys);
            }
        }
        foreach ($cshKeys as $cshKey => $value) {
            // Extensions
            if (str_starts_with($cshKey, 'xEXT_') && !isset(‪$GLOBALS['TCA'][$cshKey])) {
                $lang->loadSingleTableDescription($cshKey);
                $this->‪renderTableOfContentItem($mode, $cshKey, 'extensions', $outputSections, $tocArray, $cshKeys);
            }
            // Other
            if (!str_starts_with($cshKey, '_MOD_') && !isset(‪$GLOBALS['TCA'][$cshKey])) {
                $lang->loadSingleTableDescription($cshKey);
                $this->‪renderTableOfContentItem($mode, $cshKey, 'other', $outputSections, $tocArray, $cshKeys);
            }
        }
 
        if ($mode === ‪HelpController::TOC_ONLY) {
            return $tocArray;
        }
 
        return [
            'toc' => $tocArray,
            'content' => $outputSections,
        ];
    }
 
    protected function ‪renderTableOfContentItem($mode, $table, $tocCat, &$outputSections, &$tocArray, &$CSHkeys)
    {
        $tocArray[$tocCat][$table] = $this->‪getTableFieldLabel($table);
        if (!$mode) {
            // Render full manual right here!
            $outputSections[$table]['content'] = $this->‪getTableManual($table);
            if (!$outputSections[$table]) {
                unset($outputSections[$table]);
            }
        }
 
        // Unset CSH key
        unset($CSHkeys[$table]);
    }
 
    protected function ‪getTableFieldLabel($key, $field = '', $mergeToken = ': ')
    {
        // Get table / field parts
        [$tableName, $fieldName] = $this->‪getTableFieldNames($key, $field);
        // Create label
        return $this->‪getLanguageService()->sL($tableName) . ($field ? $mergeToken . rtrim(trim($this->‪getLanguageService()->sL($fieldName)), ':') : '');
    }
 
    protected function ‪getTableFieldNames($key, $field)
    {
        $this->‪getLanguageService()->loadSingleTableDescription($key);
        // Define the label for the key
        if (!empty(‪$GLOBALS['TCA_DESCR'][$key]['columns']['']['alttitle'])) {
            // If there's an alternative title, use it
            $keyName = ‪$GLOBALS['TCA_DESCR'][$key]['columns']['']['alttitle'];
        } elseif (isset(‪$GLOBALS['TCA'][$key])) {
            // Otherwise, if it's a table, use its title
            $keyName = ‪$GLOBALS['TCA'][$key]['ctrl']['title'];
        } else {
            // If no title was found, make sure to remove any "_MOD_"
            $keyName = preg_replace('/^_MOD_/', '', $key);
        }
        // Define the label for the field
        $fieldName = $field;
        if (!empty(‪$GLOBALS['TCA_DESCR'][$key]['columns'][$field]['alttitle'])) {
            // If there's an alternative title, use it
            $fieldName = ‪$GLOBALS['TCA_DESCR'][$key]['columns'][$field]['alttitle'];
        } elseif (!empty(‪$GLOBALS['TCA'][$key]['columns'][$field])) {
            // Otherwise, if it's a table, use its title
            $fieldName = ‪$GLOBALS['TCA'][$key]['columns'][$field]['label'];
        }
        return [$keyName, $fieldName];
    }
 
    protected function ‪getItem($table, $field, $anchors = false)
    {
        if (!empty($table)) {
            $field = !empty($field) ? $field : '';
            $setup = ‪$GLOBALS['TCA_DESCR'][$table]['columns'][$field];
            return [
                'table' => $table,
                'field' => $field,
                'configuration' => $setup,
                'headerLine' => $this->‪getTableFieldLabel($table, $field),
                'content' => !empty($setup['description']) ? $setup['description'] : '',
                'images' => !empty($setup['image']) ? $this->‪getImages($setup['image'], ($setup['image_descr'] ?? '')) : [],
                'seeAlso' => !empty($setup['seeAlso']) ? $this->‪getSeeAlsoLinks($setup['seeAlso'], $anchors ? $table : '') : '',
            ];
        }
        return [];
    }
 
    protected function ‪getSeeAlsoLinks($value, $anchorTable = '')
    {
        // Split references by comma or linebreak
        $items = preg_split('/[,' . LF . ']/', $value);
        $lines = [];
        foreach ($items as $itemValue) {
            $itemValue = trim($itemValue);
            if ($itemValue) {
                $reference = ‪GeneralUtility::trimExplode(':', $itemValue);
                $referenceUrl = ‪GeneralUtility::trimExplode('|', $itemValue);
                if (strpos(($referenceUrl[1] ?? ''), 'http') === 0) {
                    // URL reference
                    $lines[] = [
                        'url' => $referenceUrl[1],
                        'title' => $referenceUrl[0],
                        'target' => '_blank',
                    ];
                } elseif (strpos(($referenceUrl[1] ?? ''), 'FILE:') === 0) {
                    // File reference
                    $fileName = GeneralUtility::getFileAbsFileName(substr($referenceUrl[1], 5));
                    if ($fileName && @is_file($fileName)) {
                        $fileName = ‪PathUtility::getAbsoluteWebPath($fileName);
                        $lines[] = [
                            'url' => $fileName,
                            'title' => $referenceUrl[0],
                            'target' => '_blank',
                        ];
                    }
                } else {
                    // Table reference
                    $table = !empty($reference[0]) ? $reference[0] : '';
                    $field = !empty($reference[1]) ? $reference[1] : '';
                    $accessAllowed = true;
                    // Check if table exists and current user can access it
                    if (!empty($table)) {
                        $accessAllowed = !$this->‪getTableSetup($table) || $this->‪checkAccess('tables_select', $table);
                    }
                    // Check if field exists and is excludable or user can access it
                    if ($accessAllowed && !empty($field)) {
                        $accessAllowed = !$this->‪isExcludableField($table, $field) || $this->‪checkAccess('non_exclude_fields', $table . ':' . $field);
                    }
                    // Check read access
                    if ($accessAllowed && isset(‪$GLOBALS['TCA_DESCR'][$table])) {
                        // Make see-also link
                        $label = $this->‪getTableFieldLabel($table, $field, ' / ');
                        if ($anchorTable && $table === $anchorTable) {
                            $lines[] = [
                                'url' => '#' . rawurlencode(implode('.', $reference)),
                                'title' => $label,
                            ];
                        } else {
                            $lines[] = [
                                'internal' => true,
                                'arguments' => [
                                    'table' => $table,
                                    'field' => $field,
                                    'action' => 'detail',
                                ],
                                'title' => $label,
                            ];
                        }
                    }
                }
            }
        }
        return $lines;
    }
 
    protected function ‪isExcludableField($table, $field)
    {
        $fieldSetup = $this->‪getFieldSetup($table, $field);
        if (!empty($fieldSetup)) {
            return !empty($fieldSetup['exclude']);
        }
        return false;
    }
 
    protected function ‪getImages($images, $descriptions)
    {
        $imageData = [];
        // Splitting
        $imgArray = ‪GeneralUtility::trimExplode(',', $images, true);
        if (!empty($imgArray)) {
            $descrArray = explode(LF, $descriptions, count($imgArray));
            foreach ($imgArray as $k => $image) {
                $descriptions = $descrArray[$k] ?? '';
                $absImagePath = GeneralUtility::getFileAbsFileName($image);
                if ($absImagePath && @is_file($absImagePath)) {
                    $imgFile = ‪PathUtility::getAbsoluteWebPath($absImagePath);
                    $imageInfo = GeneralUtility::makeInstance(ImageInfo::class, $absImagePath);
                    if ($imageInfo->getWidth()) {
                        $imageData[] = [
                            'image' => $imgFile,
                            'description' => $descriptions,
                        ];
                    }
                }
            }
        }
        return $imageData;
    }
 
    protected function ‪getTableSetup($table)
    {
        if (!empty($table) && !empty(‪$GLOBALS['TCA'][$table])) {
            return ‪$GLOBALS['TCA'][$table];
        }
        return [];
    }
 
    protected function ‪getFieldSetup($table, $field, $allowEmptyField = false)
    {
        $tableSetup = $this->‪getTableSetup($table);
        if (!empty($tableSetup) && (!empty($field) || $allowEmptyField) && !empty($tableSetup['columns'][$field])) {
            return $tableSetup['columns'][$field];
        }
        return [];
    }
 
    protected function ‪checkAccess($type, $identifier)
    {
        if (!empty($type) && !empty($identifier)) {
            return $this->‪getBackendUser()->‪check($type, $identifier);
        }
        return false;
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
 
    protected function ‪getLanguageService()
    {
        return ‪$GLOBALS['LANG'];
    }
}