TYPO3 v15 dev-main snapshot ()
This commit is contained in:
@@ -0,0 +1,238 @@
|
||||
<?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\Backend\Form\Element;
|
||||
|
||||
use TYPO3\CMS\Backend\CodeEditor\CodeEditor;
|
||||
use TYPO3\CMS\Backend\CodeEditor\Exception\InvalidModeException;
|
||||
use TYPO3\CMS\Backend\CodeEditor\Mode;
|
||||
use TYPO3\CMS\Backend\CodeEditor\Registry\AddonRegistry;
|
||||
use TYPO3\CMS\Backend\CodeEditor\Registry\ModeRegistry;
|
||||
use TYPO3\CMS\Core\Page\JavaScriptModuleInstruction;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
use TYPO3\CMS\Core\Utility\MathUtility;
|
||||
|
||||
/**
|
||||
* CodeEditor FormEngine widget
|
||||
* @internal
|
||||
*/
|
||||
class CodeEditorElement extends AbstractFormElement
|
||||
{
|
||||
protected array $resultArray = [];
|
||||
protected string $mode = '';
|
||||
|
||||
/**
|
||||
* Default field wizards enabled for this element.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $defaultFieldWizard = [
|
||||
'localizationStateSelector' => [
|
||||
'renderType' => 'localizationStateSelector',
|
||||
],
|
||||
'otherLanguageContent' => [
|
||||
'renderType' => 'otherLanguageContent',
|
||||
'after' => [
|
||||
'localizationStateSelector',
|
||||
],
|
||||
],
|
||||
'defaultLanguageDifferences' => [
|
||||
'renderType' => 'defaultLanguageDifferences',
|
||||
'after' => [
|
||||
'otherLanguageContent',
|
||||
],
|
||||
],
|
||||
];
|
||||
|
||||
/**
|
||||
* Render code editor element
|
||||
*
|
||||
* @return array As defined in initializeResultArray() of AbstractNode
|
||||
* @throws InvalidModeException
|
||||
* @throws \InvalidArgumentException
|
||||
* @throws \BadFunctionCallException
|
||||
*/
|
||||
public function render(): array
|
||||
{
|
||||
$this->resultArray = $this->initializeResultArray();
|
||||
$this->resultArray['javaScriptModules'][] = JavaScriptModuleInstruction::create('@typo3/backend/code-editor/element/code-mirror-element.js');
|
||||
|
||||
// Compile and register code editor configuration
|
||||
GeneralUtility::makeInstance(CodeEditor::class)->registerConfiguration();
|
||||
|
||||
$addonRegistry = GeneralUtility::makeInstance(AddonRegistry::class);
|
||||
$registeredAddons = $addonRegistry->getAddons();
|
||||
foreach ($registeredAddons as $addon) {
|
||||
foreach ($addon->getCssFiles() as $cssFile) {
|
||||
$this->resultArray['stylesheetFiles'][] = $cssFile;
|
||||
}
|
||||
}
|
||||
|
||||
$parameterArray = $this->data['parameterArray'];
|
||||
|
||||
$attributes = [
|
||||
'wrap' => 'off',
|
||||
'data-formengine-validation-rules' => $this->getValidationDataAsJsonString($parameterArray['fieldConf']['config']),
|
||||
];
|
||||
if (isset($parameterArray['fieldConf']['config']['rows']) && MathUtility::canBeInterpretedAsInteger($parameterArray['fieldConf']['config']['rows'])) {
|
||||
$attributes['rows'] = $parameterArray['fieldConf']['config']['rows'];
|
||||
}
|
||||
|
||||
$settings = [];
|
||||
if ($parameterArray['fieldConf']['config']['readOnly'] ?? false) {
|
||||
$settings['readonly'] = true;
|
||||
}
|
||||
if ($parameterArray['fieldConf']['config']['appearance']['lineWrapping'] ?? false) {
|
||||
$settings['linewrapping'] = true;
|
||||
}
|
||||
|
||||
$editorHtml = $this->getHTMLCodeForEditor(
|
||||
$parameterArray['itemFormElName'],
|
||||
'form-control font-monospace enable-tab',
|
||||
$parameterArray['itemFormElValue'],
|
||||
$attributes,
|
||||
$settings,
|
||||
[
|
||||
'target' => 0,
|
||||
'effectivePid' => $this->data['effectivePid'] ?? 0,
|
||||
]
|
||||
);
|
||||
|
||||
$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-item-element">';
|
||||
$html[] = $editorHtml;
|
||||
$html[] = '</div>';
|
||||
if (!empty($fieldControlHtml)) {
|
||||
$html[] = '<div class="form-wizards-item-aside form-wizards-item-aside--field-control">';
|
||||
$html[] = '<div class="btn-group">';
|
||||
$html[] = $fieldControlHtml;
|
||||
$html[] = '</div>';
|
||||
$html[] = '</div>';
|
||||
}
|
||||
if (!empty($fieldWizardHtml)) {
|
||||
$html[] = '<div class="form-wizards-item-bottom">';
|
||||
$html[] = $fieldWizardHtml;
|
||||
$html[] = '</div>';
|
||||
}
|
||||
$html[] = '</div>';
|
||||
$html[] = '</div>';
|
||||
$html[] = '</div>';
|
||||
|
||||
$this->resultArray['html'] = $this->wrapWithFieldsetAndLegend(implode(LF, $html));
|
||||
|
||||
return $this->resultArray;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates HTML with code editor
|
||||
*
|
||||
* @param string $name Name attribute of HTML tag
|
||||
* @param string $class Class attribute of HTML tag
|
||||
* @param string $content Content of the editor
|
||||
* @param array $attributes Any additional editor parameters
|
||||
*
|
||||
* @return string Generated HTML code for editor
|
||||
* @throws \TYPO3\CMS\Backend\CodeEditor\Exception\InvalidModeException
|
||||
*/
|
||||
protected function getHTMLCodeForEditor(
|
||||
string $name,
|
||||
string $class = '',
|
||||
string $content = '',
|
||||
array $attributes = [],
|
||||
array $settings = [],
|
||||
array $hiddenfields = []
|
||||
): string {
|
||||
$code = [];
|
||||
$mode = $this->getMode();
|
||||
$addonRegistry = GeneralUtility::makeInstance(AddonRegistry::class);
|
||||
$registeredAddons = $addonRegistry->getAddons();
|
||||
|
||||
$attributes['class'] = $class;
|
||||
$attributes['id'] = 't3editor_' . md5($name);
|
||||
$attributes['name'] = $name;
|
||||
|
||||
$settings = array_merge($addonRegistry->compileSettings($registeredAddons), $settings);
|
||||
|
||||
$addons = [];
|
||||
$keymaps = [];
|
||||
foreach ($registeredAddons as $addon) {
|
||||
$module = $addon->getModule();
|
||||
$keymap = $addon->getKeymap();
|
||||
if ($module) {
|
||||
$addons[] = $module;
|
||||
}
|
||||
if ($keymap) {
|
||||
$keymaps[] = $keymap;
|
||||
}
|
||||
}
|
||||
$codeMirrorConfig = array_merge($settings, [
|
||||
'name' => $name,
|
||||
'mode' => GeneralUtility::jsonEncodeForHtmlAttribute($mode->getModule(), false),
|
||||
'addons' => GeneralUtility::jsonEncodeForHtmlAttribute($addons, false),
|
||||
'keymaps' => GeneralUtility::jsonEncodeForHtmlAttribute($keymaps, false),
|
||||
]);
|
||||
|
||||
$code[] = '<typo3-t3editor-codemirror ' . GeneralUtility::implodeAttributes($codeMirrorConfig, true) . '>';
|
||||
$code[] = GeneralUtility::renderTextarea($content, $attributes);
|
||||
|
||||
if (!empty($hiddenfields)) {
|
||||
foreach ($hiddenfields as $attributeName => $value) {
|
||||
$code[] = '<input type="hidden" name="' . htmlspecialchars((string)$attributeName) . '" value="' . htmlspecialchars((string)$value) . '" />';
|
||||
}
|
||||
}
|
||||
$code[] = '</typo3-t3editor-codemirror>';
|
||||
|
||||
return implode(LF, $code);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws InvalidModeException
|
||||
*/
|
||||
protected function getMode(): Mode
|
||||
{
|
||||
$config = $this->data['parameterArray']['fieldConf']['config'];
|
||||
|
||||
$registry = GeneralUtility::makeInstance(ModeRegistry::class);
|
||||
if (!isset($config['format'])) {
|
||||
return $registry->getDefaultMode();
|
||||
}
|
||||
|
||||
$identifier = $config['format'];
|
||||
if (str_contains($config['format'], '/')) {
|
||||
$parts = explode('/', $config['format']);
|
||||
$identifier = end($parts);
|
||||
}
|
||||
|
||||
return $registry->getByFormatCode($identifier);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user