FormResultCompiler.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Backend\Form;
 
/*
 * 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\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Page\PageRenderer;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪FormResultCompiler
{
    protected ‪$hiddenFieldAccum = [];
 
    protected ‪$doSaveFieldName = '';
 
    protected ‪$inlineData = [];
 
    protected ‪$stylesheetFiles = [];
 
    protected ‪$additionalJavaScriptPost = [];
 
    protected ‪$additionalJavaScriptSubmit = [];
 
    protected ‪$additionalInlineLanguageLabelFiles = [];
 
    protected ‪$requireJsModules = [];
 
    protected ‪$pageRenderer;
 
    public function ‪mergeResult(array $resultArray)
    {
        $this->doSaveFieldName = $resultArray['doSaveFieldName'];
        foreach ($resultArray['additionalJavaScriptPost'] as $element) {
            $this->additionalJavaScriptPost[] = $element;
        }
        foreach ($resultArray['additionalJavaScriptSubmit'] as $element) {
            $this->additionalJavaScriptSubmit[] = $element;
        }
        if (!empty($resultArray['requireJsModules'])) {
            foreach ($resultArray['requireJsModules'] as $module) {
                $moduleName = null;
                $callback = null;
                if (is_string($module)) {
                    // if $module is a string, no callback
                    $moduleName = $module;
                    $callback = null;
                } elseif (is_array($module)) {
                    // if $module is an array, callback is possible
                    foreach ($module as $key => $value) {
                        $moduleName = $key;
                        $callback = $value;
                        break;
                    }
                }
                if ($moduleName !== null) {
                    if (!empty($this->requireJsModules[$moduleName]) && $callback !== null) {
                        $existingValue = $this->requireJsModules[$moduleName];
                        if (!is_array($existingValue)) {
                            $existingValue = [$existingValue];
                        }
                        $existingValue[] = $callback;
                        $this->requireJsModules[$moduleName] = $existingValue;
                    } else {
                        $this->requireJsModules[$moduleName] = $callback;
                    }
                }
            }
        }
 
        foreach ($resultArray['additionalHiddenFields'] as $element) {
            $this->hiddenFieldAccum[] = $element;
        }
        foreach ($resultArray['stylesheetFiles'] as $stylesheetFile) {
            if (!in_array($stylesheetFile, $this->stylesheetFiles)) {
                $this->stylesheetFiles[] = $stylesheetFile;
            }
        }
 
        if (!empty($resultArray['inlineData'])) {
            $resultArrayInlineData = ‪$this->inlineData;
            $resultInlineData = $resultArray['inlineData'];
            ‪ArrayUtility::mergeRecursiveWithOverrule($resultArrayInlineData, $resultInlineData);
            $this->inlineData = $resultArrayInlineData;
        }
 
        if (!empty($resultArray['additionalInlineLanguageLabelFiles'])) {
            foreach ($resultArray['additionalInlineLanguageLabelFiles'] as $additionalInlineLanguageLabelFile) {
                $this->additionalInlineLanguageLabelFiles[] = $additionalInlineLanguageLabelFile;
            }
        }
    }
 
    public function ‪addCssFiles()
    {
        ‪$pageRenderer = $this->‪getPageRenderer();
        foreach ($this->stylesheetFiles as $stylesheetFile) {
            ‪$pageRenderer->‪addCssFile($stylesheetFile);
        }
        return '';
    }
 
    public function ‪printNeededJSFunctions()
    {
        // set variables to be accessible for JS
        ‪$pageRenderer = $this->‪getPageRenderer();
        ‪$pageRenderer->‪addInlineSetting('FormEngine', 'formName', 'editform');
 
        return $this->‪JSbottom();
    }
 
    protected function ‪JSbottom()
    {
        ‪$pageRenderer = $this->‪getPageRenderer();
        $uriBuilder = GeneralUtility::makeInstance(\‪TYPO3\CMS\Backend\Routing\UriBuilder::class);
 
        // @todo: this is messy here - "additional hidden fields" should be handled elsewhere
        $html = implode(LF, $this->hiddenFieldAccum);
        ‪$pageRenderer->‪addJsFile('EXT:backend/Resources/Public/JavaScript/md5.js');
        // load the main module for FormEngine with all important JS functions
        $this->requireJsModules['TYPO3/CMS/Backend/FormEngine'] = 'function(FormEngine) {
            FormEngine.initialize(
                ' . GeneralUtility::quoteJSvalue((string)$uriBuilder->buildUriFromRoute('wizard_element_browser')) . ',
                ' . (‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['USdateFormat'] ? '1' : '0') . '
            );
        }';
        $this->requireJsModules['TYPO3/CMS/Backend/FormEngineReview'] = null;
 
        foreach ($this->requireJsModules as $moduleName => $callbacks) {
            if (!is_array($callbacks)) {
                $callbacks = [$callbacks];
            }
            foreach ($callbacks as $callback) {
                ‪$pageRenderer->‪loadRequireJsModule($moduleName, $callback);
            }
        }
        $backendUser = $this->‪getBackendUserAuthentication();
 
        // define the window size of the element browser etc.
        $popupWindowWidth  = 800;
        $popupWindowHeight = 600;
        $popupWindowSize = trim($backendUser->getTSConfig()['options.']['popupWindowSize'] ?? '');
        if (!empty($popupWindowSize)) {
            list($popupWindowWidth, $popupWindowHeight) = GeneralUtility::intExplode('x', $popupWindowSize);
        }
 
        // define the window size of the popups within the RTE
        $rtePopupWindowSize = trim($backendUser->getTSConfig()['options.']['rte.']['popupWindowSize'] ?? '');
        if (!empty($rtePopupWindowSize)) {
            list($rtePopupWindowWidth, $rtePopupWindowHeight) = GeneralUtility::trimExplode('x', $rtePopupWindowSize);
        }
        $rtePopupWindowWidth  = !empty($rtePopupWindowWidth) ? (int)$rtePopupWindowWidth : $popupWindowWidth;
        $rtePopupWindowHeight = !empty($rtePopupWindowHeight) ? (int)$rtePopupWindowHeight : $popupWindowHeight;
 
        // Make textareas resizable and flexible ("autogrow" in height)
        $textareaSettings = [
            'autosize'  => (bool)$backendUser->uc['resizeTextareas_Flexible'],
            'RTEPopupWindow' => [
                'width' => $rtePopupWindowWidth,
                'height' => $rtePopupWindowHeight
            ]
        ];
        ‪$pageRenderer->‪addInlineSettingArray('Textarea', $textareaSettings);
 
        $popupSettings = [
            'PopupWindow' => [
                'width' => $popupWindowWidth,
                'height' => $popupWindowHeight
            ]
        ];
        ‪$pageRenderer->‪addInlineSettingArray('Popup', $popupSettings);
 
        ‪$pageRenderer->‪addJsFile('EXT:backend/Resources/Public/JavaScript/jsfunc.tbe_editor.js');
        // Needed for FormEngine manipulation (date picker)
        $dateFormat = (‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['USdateFormat'] ? ['MM-DD-YYYY', 'HH:mm MM-DD-YYYY'] : ['DD-MM-YYYY', 'HH:mm DD-MM-YYYY']);
        ‪$pageRenderer->‪addInlineSetting('DateTimePicker', 'DateFormat', $dateFormat);
 
        ‪$pageRenderer->‪loadRequireJsModule('TYPO3/CMS/Filelist/FileListLocalisation');
 
        ‪$pageRenderer->‪addInlineLanguageLabelFile('EXT:core/Resources/Private/Language/locallang_core.xlf', 'file_upload');
        if (!empty($this->additionalInlineLanguageLabelFiles)) {
            foreach ($this->additionalInlineLanguageLabelFiles as $additionalInlineLanguageLabelFile) {
                ‪$pageRenderer->‪addInlineLanguageLabelFile($additionalInlineLanguageLabelFile);
            }
        }
        // @TODO: Refactor jsfunc.inline.js to an AMD module / TypsScript. If this is done, remove loadJquery() call.
        ‪$pageRenderer->‪loadJquery(null, null, ‪PageRenderer::JQUERY_NAMESPACE_NONE, true);
        ‪$pageRenderer->‪addJsFile('EXT:backend/Resources/Public/JavaScript/jsfunc.inline.js');
 
        // todo: change these things in JS
        ‪$pageRenderer->‪addInlineLanguageLabelArray([
            'FormEngine.noRecordTitle'          => $this->‪getLanguageService()->‪sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.no_title'),
            'FormEngine.fieldsChanged'          => $this->‪getLanguageService()->‪sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.fieldsChanged'),
            'FormEngine.fieldsMissing'          => $this->‪getLanguageService()->‪sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.fieldsMissing'),
            'FormEngine.maxItemsAllowed'        => $this->‪getLanguageService()->‪sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.maxItemsAllowed'),
            'FormEngine.refreshRequiredTitle'   => $this->‪getLanguageService()->‪sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:mess.refreshRequired.title'),
            'FormEngine.refreshRequiredContent' => $this->‪getLanguageService()->‪sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:mess.refreshRequired.content'),
            'FormEngine.remainingCharacters'    => $this->‪getLanguageService()->‪sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.remainingCharacters'),
        ]);
 
        $out = LF . 'TBE_EDITOR.doSaveFieldName = "' . ($this->doSaveFieldName ? addslashes($this->doSaveFieldName) : '') . '";';
 
        // Add JS required for inline fields
        if (!empty($this->inlineData)) {
            $out .= LF . 'inline.addToDataArray(' . json_encode($this->inlineData) . ');';
        }
        // $this->additionalJS_submit:
        if ($this->additionalJavaScriptSubmit) {
            $additionalJS_submit = implode('', $this->additionalJavaScriptSubmit);
            $additionalJS_submit = str_replace([CR, LF], '', $additionalJS_submit);
            $out .= 'TBE_EDITOR.addActionChecks("submit", "' . addslashes($additionalJS_submit) . '");';
        }
        $out .= LF . implode(LF, $this->additionalJavaScriptPost);
 
        return $html . LF . "\t" . GeneralUtility::wrapJS($out);
    }
 
    protected function ‪getBackendUserAuthentication()
    {
        return ‪$GLOBALS['BE_USER'];
    }
 
    protected function ‪getLanguageService()
    {
        return ‪$GLOBALS['LANG'];
    }
 
    protected function ‪getPageRenderer()
    {
        if ($this->pageRenderer === null) {
            $this->pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
        }
        return ‪$this->pageRenderer;
    }
}