9.5/_form_engine_utility_8php_source.html

<?php

namespace ‪TYPO3\CMS\Backend\Form\Utility;


/*

 * 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\Utility\BackendUtility;

use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

use ‪TYPO3\CMS\Core\Cache\CacheManager;

use ‪TYPO3\CMS\Core\Imaging\Icon;

use ‪TYPO3\CMS\Core\Imaging\IconFactory;

use ‪TYPO3\CMS\Core\Utility\ArrayUtility;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Core\Utility\PathUtility;


class ‪FormEngineUtility

{

    protected static ‪$allowOverrideMatrix = [

        'input' => ['size', 'max', 'readOnly'],

        'text' => ['cols', 'rows', 'wrap', 'max', 'readOnly'],

        'check' => ['cols', 'readOnly'],

        'select' => ['size', 'autoSizeMax', 'maxitems', 'minitems', 'readOnly', 'treeConfig'],

        'group' => ['size', 'autoSizeMax', 'max_size', 'maxitems', 'minitems', 'readOnly'],

        'inline' => ['appearance', 'behaviour', 'foreign_label', 'foreign_selector', 'foreign_unique', 'maxitems', 'minitems', 'size', 'autoSizeMax', 'symmetric_label', 'readOnly'],

        'imageManipulation' => ['ratios', 'cropVariants']

    ];


    public static function ‪overrideFieldConf($fieldConfig, $TSconfig)

    {

        if (is_array($TSconfig)) {

            $TSconfig = GeneralUtility::removeDotsFromTS($TSconfig);

            $type = $fieldConfig['type'] ?? '';

            if (isset($TSconfig['config']) && is_array($TSconfig['config']) && is_array(static::$allowOverrideMatrix[$type])) {

                // Check if the keys in TSconfig['config'] are allowed to override TCA field config:

                foreach ($TSconfig['config'] as $key => $_) {

                    if (!in_array($key, static::$allowOverrideMatrix[$type], true)) {

                        unset($TSconfig['config'][$key]);

                    }

                }

                // Override $GLOBALS['TCA'] field config by remaining TSconfig['config']:

                if (!empty($TSconfig['config'])) {

                    ‪ArrayUtility::mergeRecursiveWithOverrule($fieldConfig, $TSconfig['config']);

                }

            }

        }

        return $fieldConfig;

    }


    public static function ‪getTSconfigForTableRow($table, $row, $field = '')

    {

        $runtimeCache = GeneralUtility::makeInstance(CacheManager::class)->getCache('cache_runtime');

        $cache = $runtimeCache->get('formEngineUtilityTsConfigForTableRow') ?: [];

        $cacheIdentifier = $table . ':' . $row['uid'];

        if (!isset($cache[$cacheIdentifier])) {

            $cache[$cacheIdentifier] = ‪BackendUtility::getTCEFORM_TSconfig($table, $row);

            $runtimeCache->set('formEngineUtilityTsConfigForTableRow', $cache);

        }

        if ($field && isset($cache[$cacheIdentifier][$field])) {

            return $cache[$cacheIdentifier][$field];

        }

        return $cache[$cacheIdentifier];

    }


    public static function ‪getIconHtml($icon, $alt = '', $title = '')

    {

        $icon = (string)$icon;

        $absoluteFilePath = GeneralUtility::getFileAbsFileName($icon);

        if (!empty($absoluteFilePath) && is_file($absoluteFilePath)) {

            return '<img'

                . ' src="' . htmlspecialchars(‪PathUtility::getAbsoluteWebPath($absoluteFilePath)) . '"'

                . ' alt="' . htmlspecialchars($alt) . '" '

                . ($title ? 'title="' . htmlspecialchars($title) . '"' : '')

                . ' />';

        }


        $iconFactory = GeneralUtility::makeInstance(IconFactory::class);

        return '<span title="' . htmlspecialchars($title) . '">'

            . $iconFactory->getIcon($icon, ‪Icon::SIZE_SMALL)->render()

            . '</span>';

    }


    public static function ‪updateInlineView(&$uc, $tce)

    {

        $backendUser = static::getBackendUserAuthentication();

        if (isset($uc['inlineView']) && is_array($uc['inlineView'])) {

            $inlineView = (array)unserialize($backendUser->uc['inlineView'], ['allowed_classes' => false]);

            foreach ($uc['inlineView'] as $topTable => $topRecords) {

                foreach ($topRecords as $topUid => $childElements) {

                    foreach ($childElements as $childTable => $childRecords) {

                        $uids = array_keys($tce->substNEWwithIDs_table, $childTable);

                        if (!empty($uids)) {

                            $newExpandedChildren = [];

                            foreach ($childRecords as $childUid => $state) {

                                if ($state && in_array($childUid, $uids)) {

                                    $newChildUid = $tce->substNEWwithIDs[$childUid];

                                    $newExpandedChildren[] = $newChildUid;

                                }

                            }

                            // Add new expanded child records to UC (if any):

                            if (!empty($newExpandedChildren)) {

                                $inlineViewCurrent = &$inlineView[$topTable][$topUid][$childTable];

                                if (is_array($inlineViewCurrent)) {

                                    $inlineViewCurrent = array_unique(array_merge($inlineViewCurrent, $newExpandedChildren));

                                } else {

                                    $inlineViewCurrent = $newExpandedChildren;

                                }

                            }

                        }

                    }

                }

            }

            $backendUser->uc['inlineView'] = serialize($inlineView);

            $backendUser->writeUC();

        }

    }


    public static function ‪databaseRowCompatibility(array $row)

    {

        $newRow = [];

        foreach ($row as $fieldName => $fieldValue) {

            if (!is_array($fieldValue)) {

                $newRow[$fieldName] = $fieldValue;

            } else {

                $newElementValue = [];

                foreach ($fieldValue as $itemNumber => $itemValue) {

                    if (is_array($itemValue) && array_key_exists(1, $itemValue)) {

                        $newElementValue[] = $itemValue[1];

                    } else {

                        $newElementValue[] = $itemValue;

                    }

                }

                $newRow[$fieldName] = implode(',', $newElementValue);

            }

        }

        return $newRow;

    }


    protected static function ‪getBackendUserAuthentication()

    {

        return ‪$GLOBALS['BE_USER'];

    }

}