Deprecation: #95200 - RequireJS callbacks as inline JavaScript¶

Description¶

Custom FormEngine components allowed to load RequireJS modules with arbitrary inline JavaScript to initialize those modules. In favor of introducing content security policy headers, the amount of inline JavaScript shall be reduced and replaced by corresponding declarations.

Using callback functions has been marked as deprecated and shall be replaced by new TYPO3\CMS\Core\Page\JavaScriptModuleInstruction declarations. In FormEngine, loading RequireJS module via arrays has been marked as deprecated and has to be migrated as well.

Impact¶

Using $resultArray['requireJsModules'] with scalar string values will trigger a PHP E_USER_DEPRECATED error.

Affected Installations¶

Installations implementing custom FormEngine components and loading RequireJS modules via $resultArray['requireJsModules'] are affected.

Migration¶

New JavaScriptModuleInstruction allows to declare the following aspects when loading RequireJS modules:

• $instruction = JavaScriptModuleInstruction::forRequireJS('TYPO3/CMS/Module') creates corresponding loading instruction that can be enriched with following declarations
• $instruction->assign(['key' => 'value']) allows to assign key-value pairs directly to the loaded RequireJS module object or instance
• $instruction->invoke('method', 'value-a', 'value-b') allows to invoke a particular method of the loaded RequireJS instance with given argument values
• $instruction->instance('value-a', 'value-b') allows to invoke the constructor of the loaded RequireJS class with given argument values

Initializations other than the provided aspects have to be implemented in custom module implementations, for example triggered by corresponding on-ready handlers.

$resultArray['requireJsModules'][] = ['TYPO3/CMS/Backend/FormEngine/Element/InputDateTimeElement' => '
    function(InputDateTimeElement) {
        new InputDateTimeElement(' . GeneralUtility::quoteJSvalue($fieldId) . ');
    }'
];

// use use TYPO3\CMS\Core\Page\JavaScriptModuleInstruction;
$resultArray['requireJsModules'][] = JavaScriptModuleInstruction::forRequireJS(
    'TYPO3/CMS/Backend/FormEngine/Element/InputDateTimeElement'
)->instance($fieldId);