9.5/_database_row_initialize_new_8php_source.html

<?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;

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


class ‪DatabaseRowInitializeNew implements ‪FormDataProviderInterface

{

    public function ‪addData(array $result)

    {

        if ($result['command'] !== 'new') {

            return $result;

        }

        if (!is_array($result['databaseRow'])) {

            throw new \UnexpectedValueException(

                'databaseRow of table ' . $result['tableName'] . ' is not an array',

                1444431128

            );

        }


        $result = $this->‪setDefaultsFromUserTsConfig($result);

        $result = $this->‪setDefaultsFromPageTsConfig($result);

        $result = $this->‪setDefaultsFromNeighborRow($result);

        $result = $this->‪setDefaultsFromDefaultValues($result);

        $result = $this->‪setDefaultsFromInlineRelations($result);

        $result = $this->‪setDefaultsFromInlineParentLanguage($result);

        $result = $this->‪setDefaultsFromInlineParentUid($result);

        $result = $this->‪setPid($result);


        return $result;

    }


    protected function ‪setDefaultsFromUserTsConfig(array $result)

    {

        $tableNameWithDot = $result['tableName'] . '.';

        // Apply default values from user typo script "TCAdefaults" if any

        if (isset($result['userTsConfig']['TCAdefaults.'][$tableNameWithDot])

            && is_array($result['userTsConfig']['TCAdefaults.'][$tableNameWithDot])

        ) {

            foreach ($result['userTsConfig']['TCAdefaults.'][$tableNameWithDot] as $fieldName => $fieldValue) {

                if (isset($result['processedTca']['columns'][$fieldName])) {

                    $result['databaseRow'][$fieldName] = $fieldValue;

                }

            }

        }

        return $result;

    }


    protected function ‪setDefaultsFromPageTsConfig(array $result)

    {

        $tableNameWithDot = $result['tableName'] . '.';

        if (isset($result['pageTsConfig']['TCAdefaults.'][$tableNameWithDot])

            && is_array($result['pageTsConfig']['TCAdefaults.'][$tableNameWithDot])

        ) {

            foreach ($result['pageTsConfig']['TCAdefaults.'][$tableNameWithDot] as $fieldName => $fieldValue) {

                if (isset($result['processedTca']['columns'][$fieldName])) {

                    $result['databaseRow'][$fieldName] = $fieldValue;

                }

            }

        }

        return $result;

    }


    protected function ‪setDefaultsFromNeighborRow(array $result)

    {

        if (is_array($result['neighborRow'])

            && !empty($result['processedTca']['ctrl']['useColumnsForDefaultValues'])

        ) {

            $defaultColumns = GeneralUtility::trimExplode(',', $result['processedTca']['ctrl']['useColumnsForDefaultValues'], true);

            foreach ($defaultColumns as $fieldName) {

                if (isset($result['processedTca']['columns'][$fieldName])

                    && isset($result['neighborRow'][$fieldName])

                ) {

                    $result['databaseRow'][$fieldName] = $result['neighborRow'][$fieldName];

                }

            }

        }

        return $result;

    }


    protected function ‪setDefaultsFromDefaultValues(array $result)

    {

        $result = $this->‪setDefaultValuesFromGetPost($result);

        $tableName = $result['tableName'];

        $defaultValues = $result['defaultValues'] ?? [];

        if (isset($defaultValues[$tableName]) && is_array($defaultValues[$tableName])) {

            foreach ($defaultValues[$tableName] as $fieldName => $fieldValue) {

                if (isset($result['processedTca']['columns'][$fieldName])) {

                    $result['databaseRow'][$fieldName] = $fieldValue;

                }

            }

        }

        return $result;

    }


    protected function ‪setDefaultValuesFromGetPost(array $result)

    {

        if (!empty($result['defaultValues'])) {

            return $result;

        }


        $defaultValues = GeneralUtility::_GP('defVals');

        if (!empty($defaultValues)) {

            trigger_error(

                'Default values for new database rows should be set from controller context. Applying default values'

                . ' via GET/POST parameters is deprecated since 9.2 and will be removed in version 10',

                E_USER_DEPRECATED

            );

            $result['defaultValues'] = $defaultValues;

        }


        return $result;

    }


    protected function ‪setDefaultsFromInlineRelations(array $result)

    {

        if ($result['inlineChildChildUid'] === null) {

            return $result;

        }

        if (!is_int($result['inlineChildChildUid'])) {

            throw new \UnexpectedValueException(

                'An inlineChildChildUid is given for table ' . $result['tableName'] . ', but is not an integer',

                1444434103

            );

        }

        if (!isset($result['inlineParentConfig']['foreign_selector'])) {

            throw new \UnexpectedValueException(

                'An inlineChildChildUid is given for table ' . $result['tableName'] . ', but no foreign_selector in inlineParentConfig',

                1444434102

            );

        }

        $selectorFieldName = $result['inlineParentConfig']['foreign_selector'];

        if (!isset($result['processedTca']['columns'][$selectorFieldName]['config']['type'])

            || (

                $result['processedTca']['columns'][$selectorFieldName]['config']['type'] !== 'select'

                && $result['processedTca']['columns'][$selectorFieldName]['config']['type'] !== 'group'

            )

        ) {

            throw new \UnexpectedValueException(

                $selectorFieldName . ' is target type of a foreign_selector field to table ' . $result['tableName'] . ' and must be either a select or group type field',

                1444434104

            );

        }


        if ($result['inlineChildChildUid']) {

            $result['databaseRow'][$selectorFieldName] = $result['inlineChildChildUid'];

        }


        return $result;

    }


    protected function ‪setDefaultsFromInlineParentLanguage(array $result): array

    {

        if (!isset($result['inlineParentConfig']['inline']['parentSysLanguageUid'])

            || empty($result['processedTca']['ctrl']['languageField'])

            || empty($result['processedTca']['ctrl']['transOrigPointerField'])

        ) {

            return $result;

        }


        if (!‪MathUtility::canBeInterpretedAsInteger($result['inlineParentConfig']['inline']['parentSysLanguageUid'])) {

            throw new \UnexpectedValueException(

                'A sys_language_uid is set from inline parent config but the value is no integer',

                1490360772

            );

        }

        $parentSysLanguageUid = (int)$result['inlineParentConfig']['inline']['parentSysLanguageUid'];

        $languageFieldName = $result['processedTca']['ctrl']['languageField'];

        $result['databaseRow'][$languageFieldName] = $parentSysLanguageUid;


        return $result;

    }


    protected function ‪setDefaultsFromInlineParentUid(array $result): array

    {

        $isInlineChild = $result['isInlineChild'] ?? false;

        $parentField = $result['inlineParentConfig']['foreign_field'] ?? false;


        if ($isInlineChild && $parentField && !empty($result['inlineParentUid'])) {

            $result['databaseRow'][$parentField] = $result['inlineParentUid'];

        }


        return $result;

    }


    protected function ‪setPid(array $result)

    {

        // Set pid to vanillaUid. This can be a negative value

        // if the record is added relative to another record.

        $result['databaseRow']['pid'] = $result['vanillaUid'];


        // In case a new inline record is created, the pid can be set to a different value

        // by pageTsConfig, but not by userTsConfig. This overrides the above pid selection

        // and forces the pid of new inline children.

        $tableNameWithDot = $result['tableName'] . '.';

        if ($result['isInlineChild'] && isset($result['pageTsConfig']['TCAdefaults.'][$tableNameWithDot]['pid'])) {

            if (!‪MathUtility::canBeInterpretedAsInteger($result['pageTsConfig']['TCAdefaults.'][$tableNameWithDot]['pid'])) {

                throw new \UnexpectedValueException(

                    'page TSConfig setting TCAdefaults.' . $tableNameWithDot . 'pid must be a number, but given string '

                    . $result['pageTsConfig']['TCAdefaults.'][$tableNameWithDot]['pid'] . ' can not be interpreted as integer',

                    1461598332

                );

            }

            $result['databaseRow']['pid'] = (int)$result['pageTsConfig']['TCAdefaults.'][$tableNameWithDot]['pid'];

        }


        return $result;

    }

}