TcaColumnsProcessShowitem.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\Core\Utility\GeneralUtility;

class TcaColumnsProcessShowitem implements FormDataProviderInterface
{
    public function addData(array $result)
    {
        $recordTypeValue = $result['recordTypeValue'];

        if (!isset($result['processedTca']['types'][$recordTypeValue]['showitem'])
            || !is_string($result['processedTca']['types'][$recordTypeValue]['showitem'])
        ) {
            throw new \UnexpectedValueException(
                'No or invalid showitem definition in TCA table ' . $result['tableName'] . ' for type ' . $recordTypeValue,
                1438614542
            );
        }

        if (empty($result['processedTca']['columns'])) {
            // We are sure this is an array by InitializeProcessedTca data provider
            return $result;
        }

        $addShowItemFieldsToColumnsToProcess = true;
        if ($result['isInlineChild']) {
            // If the record is an inline child that is not expanded, it is not necessary to calculate all fields
            $isExistingRecord = $result['command'] === 'edit';
            $inlineConfig = $result['inlineParentConfig'];
            $collapseAll = isset($inlineConfig['appearance']['collapseAll']) && $inlineConfig['appearance']['collapseAll'];
            $expandCollapseStateArray = $result['inlineExpandCollapseStateArray'];
            $foreignTable = $result['inlineParentConfig']['foreign_table'];
            $isExpandedByUcState = isset($expandCollapseStateArray[$foreignTable])
                    && is_array($expandCollapseStateArray[$foreignTable])
                    && in_array($result['databaseRow']['uid'], $expandCollapseStateArray[$foreignTable]) !== false;
            if ($isExistingRecord && ($collapseAll || !$isExpandedByUcState) && !$result['isInlineAjaxOpeningContext']) {
                $addShowItemFieldsToColumnsToProcess = false;
            }
        }

        if (!$addShowItemFieldsToColumnsToProcess) {
            return $result;
        }

        $showItemFieldString = $result['processedTca']['types'][$recordTypeValue]['showitem'];
        $showItemFieldArray = GeneralUtility::trimExplode(',', $showItemFieldString, true);

        foreach ($showItemFieldArray as $fieldConfigurationString) {
            $fieldConfigurationArray = GeneralUtility::trimExplode(';', $fieldConfigurationString);
            $fieldName = $fieldConfigurationArray[0];
            if ($fieldName === '--div--') {
                continue;
            }
            if ($fieldName === '--palette--') {
                if (isset($fieldConfigurationArray[2])) {
                    $paletteName = $fieldConfigurationArray[2];
                    if (!empty($result['processedTca']['palettes'][$paletteName]['showitem'])) {
                        $paletteFields = GeneralUtility::trimExplode(',', $result['processedTca']['palettes'][$paletteName]['showitem'], true);
                        foreach ($paletteFields as $paletteFieldConfiguration) {
                            $paletteFieldConfigurationArray = GeneralUtility::trimExplode(';', $paletteFieldConfiguration);
                            $result['columnsToProcess'][] = $paletteFieldConfigurationArray[0];
                        }
                    }
                }
            } else {
                $result['columnsToProcess'][] = $fieldName;
            }
        }

        return $result;
    }
}