T3editorElement.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\T3editor\Form\Element;
 
use ‪TYPO3\CMS\Backend\Form\Element\AbstractFormElement;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\MathUtility;
use ‪TYPO3\CMS\T3editor\Exception\InvalidModeException;
use ‪TYPO3\CMS\T3editor\Mode;
use ‪TYPO3\CMS\T3editor\Registry\AddonRegistry;
use ‪TYPO3\CMS\T3editor\Registry\ModeRegistry;
use ‪TYPO3\CMS\T3editor\T3editor;
 
class ‪T3editorElement extends ‪AbstractFormElement
{
    protected ‪$resultArray;
 
    protected ‪$mode = '';
 
    protected ‪$defaultFieldInformation = [
        'tcaDescription' => [
            'renderType' => 'tcaDescription',
        ],
    ];
 
    protected ‪$defaultFieldWizard = [
        'localizationStateSelector' => [
            'renderType' => 'localizationStateSelector',
        ],
        'otherLanguageContent' => [
            'renderType' => 'otherLanguageContent',
            'after' => [
                'localizationStateSelector',
            ],
        ],
        'defaultLanguageDifferences' => [
            'renderType' => 'defaultLanguageDifferences',
            'after' => [
                'otherLanguageContent',
            ],
        ],
    ];
 
    public function ‪render(): array
    {
        $this->resultArray = $this->‪initializeResultArray();
        $this->resultArray['stylesheetFiles'][] = 'EXT:t3editor/Resources/Public/JavaScript/Contrib/cm/lib/codemirror.css';
        $this->resultArray['stylesheetFiles'][] = 'EXT:t3editor/Resources/Public/Css/t3editor.css';
        $this->resultArray['requireJsModules'][] = [
            'TYPO3/CMS/T3editor/T3editor' => 'function(T3editor) {T3editor.observeEditorCandidates()}'
        ];
 
        // Compile and register t3editor configuration
        GeneralUtility::makeInstance(T3editor::class)->registerConfiguration();
 
        $registeredAddons = ‪AddonRegistry::getInstance()->getForMode($this->‪getMode()->getFormatCode());
        foreach ($registeredAddons as $addon) {
            foreach ($addon->getCssFiles() as $cssFile) {
                $this->resultArray['stylesheetFiles'][] = $cssFile;
            }
        }
 
        $parameterArray = $this->data['parameterArray'];
 
        $attributes = [];
        if (isset($parameterArray['fieldConf']['config']['rows']) && ‪MathUtility::canBeInterpretedAsInteger($parameterArray['fieldConf']['config']['rows'])) {
            $attributes['rows'] = $parameterArray['fieldConf']['config']['rows'];
        }
 
        $attributes['wrap'] = 'off';
        $attributes['style'] = 'width:100%;';
        $attributes['onchange'] = GeneralUtility::quoteJSvalue($parameterArray['fieldChangeFunc']['TBE_EDITOR_fieldChanged']);
 
        $attributeString = GeneralUtility::implodeAttributes($attributes, true);
        $editorHtml = $this->‪getHTMLCodeForEditor(
            $parameterArray['itemFormElName'],
            'text-monospace enable-tab',
            $parameterArray['itemFormElValue'],
            $attributeString,
            $this->data['tableName'] . ' > ' . $this->data['fieldName'],
            [
                'target' => 0,
                'effectivePid' => $this->data['effectivePid']
            ]
        );
 
        $fieldInformationResult = $this->‪renderFieldInformation();
        $fieldInformationHtml = $fieldInformationResult['html'];
        $this->resultArray = $this->‪mergeChildReturnIntoExistingResult($this->resultArray, $fieldInformationResult, false);
 
        $fieldControlResult = $this->‪renderFieldControl();
        $fieldControlHtml = $fieldControlResult['html'];
        $this->resultArray = $this->‪mergeChildReturnIntoExistingResult($this->resultArray, $fieldControlResult, false);
 
        $fieldWizardResult = $this->‪renderFieldWizard();
        $fieldWizardHtml = $fieldWizardResult['html'];
        $this->resultArray = $this->‪mergeChildReturnIntoExistingResult($this->resultArray, $fieldWizardResult, false);
 
        $html = [];
        $html[] = '<div class="formengine-field-item t3js-formengine-field-item">';
        $html[] =   $fieldInformationHtml;
        $html[] =   '<div class="form-control-wrap">';
        $html[] =       '<div class="form-wizards-wrap">';
        $html[] =           '<div class="form-wizards-element">';
        $html[] =               '<div class="t3editor-wrapper">';
        $html[] =                   $editorHtml;
        $html[] =               '</div>';
        $html[] =           '</div>';
        if (!empty($fieldControlHtml)) {
            $html[] =           '<div class="form-wizards-items-aside">';
            $html[] =               '<div class="btn-group">';
            $html[] =                   $fieldControlHtml;
            $html[] =               '</div>';
            $html[] =           '</div>';
        }
        if (!empty($fieldWizardHtml)) {
            $html[] = '<div class="form-wizards-items-bottom">';
            $html[] = $fieldWizardHtml;
            $html[] = '</div>';
        }
        $html[] =       '</div>';
        $html[] =   '</div>';
        $html[] = '</div>';
 
        $this->resultArray['html'] = implode(LF, $html);
 
        return ‪$this->resultArray;
    }
 
    protected function ‪getHTMLCodeForEditor(
        string $name,
        string $class = '',
        string $content = '',
        string $additionalParams = '',
        string $label = '',
        array $hiddenfields = []
    ): string {
        $code = [];
        $attributes = [];
        ‪$mode = $this->‪getMode();
        $registeredAddons = ‪AddonRegistry::getInstance()->getForMode(‪$mode->getFormatCode());
 
        $attributes['class'] = $class . ' t3editor';
        $attributes['id'] = 't3editor_' . md5($name);
        $attributes['name'] = $name;
 
        $settings = ‪AddonRegistry::getInstance()->compileSettings($registeredAddons);
        $addons = [];
        foreach ($registeredAddons as $addon) {
            $addons[] = $addon->getIdentifier();
        }
 
        $attributes['data-codemirror-config'] = json_encode([
            'mode' => ‪$mode->getIdentifier(),
            'label' => $label,
            'addons' => json_encode($addons),
            'options' => json_encode($settings)
        ]);
 
        $attributesString = '';
        foreach ($attributes as $attribute => $value) {
            $attributesString .= $attribute . '="' . htmlspecialchars((string)$value) . '" ';
        }
        $attributesString .= $additionalParams;
 
        $code[] = '<textarea ' . $attributesString . '>' . htmlspecialchars($content) . '</textarea>';
 
        if (!empty($hiddenfields)) {
            foreach ($hiddenfields as $attributeName => $value) {
                $code[] = '<input type="hidden" name="' . htmlspecialchars((string)$attributeName) . '" value="' . htmlspecialchars((string)$value) . '" />';
            }
        }
        return implode(LF, $code);
    }
 
    protected function ‪getMode(): ‪Mode
    {
        $config = $this->data['parameterArray']['fieldConf']['config'];
 
        if (!isset($config['format'])) {
            return ‪ModeRegistry::getInstance()->getDefaultMode();
        }
 
        $identifier = $config['format'];
        if (strpos($config['format'], '/') !== false) {
            $parts = explode('/', $config['format']);
            $identifier = end($parts);
        }
 
        return ‪ModeRegistry::getInstance()->getByFormatCode($identifier);
    }
}