296 lines
12 KiB
PHP
296 lines
12 KiB
PHP
<?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\Container;
|
|
|
|
use TYPO3\CMS\Core\Localization\LanguageService;
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
|
|
|
/**
|
|
* Handle palettes and single fields.
|
|
*
|
|
* This container is called by TabsContainer, NoTabsContainer and ListOfFieldsContainer.
|
|
*
|
|
* This container mostly operates on TCA showItem of a specific type - the value is
|
|
* coming in from upper containers as "fieldArray". It handles palettes with all its
|
|
* different options and prepares rendering of single fields for the SingleFieldContainer.
|
|
*/
|
|
class PaletteAndSingleContainer extends AbstractContainer
|
|
{
|
|
/**
|
|
* Final result array accumulating results from children and final HTML
|
|
*/
|
|
protected array $resultArray = [];
|
|
|
|
/**
|
|
* Entry method
|
|
*
|
|
* @return array As defined in initializeResultArray() of AbstractNode
|
|
*/
|
|
public function render(): array
|
|
{
|
|
$languageService = $this->getLanguageService();
|
|
|
|
/*
|
|
* The first code block creates a target structure array to later create the final
|
|
* HTML string. The single fields and sub containers are rendered here already and
|
|
* other parts of the return array from children except html are accumulated in
|
|
* $this->resultArray
|
|
*
|
|
$targetStructure = [
|
|
0 => [
|
|
'type' => 'palette',
|
|
'fieldName' => 'palette1',
|
|
'paletteLegend' => 'palette1',
|
|
'paletteDescription' => 'palette1Description',
|
|
'elements' => [
|
|
0 => [
|
|
'type' => 'single',
|
|
'fieldName' => 'paletteName',
|
|
'fieldHtml' => 'element1',
|
|
),
|
|
1 => [
|
|
'type' => 'linebreak',
|
|
),
|
|
2 => [
|
|
'type' => 'single',
|
|
'fieldName' => 'paletteName',
|
|
'fieldHtml' => 'element2',
|
|
],
|
|
],
|
|
],
|
|
1 => [
|
|
'type' => 'single',
|
|
'fieldName' => 'element3',
|
|
'fieldHtml' => 'element3',
|
|
],
|
|
2 => [
|
|
'type' => 'palette',
|
|
'fieldName' => 'palette2',
|
|
'paletteLegend' => '', // Palette label is optional
|
|
'paletteDescription' => '', // Palette description is optional
|
|
'elements' => [
|
|
0 => [
|
|
'type' => 'single',
|
|
'fieldName' => 'element4',
|
|
'fieldHtml' => 'element4',
|
|
],
|
|
1 => [
|
|
'type' => 'linebreak',
|
|
],
|
|
2 => [
|
|
'type' => 'single',
|
|
'fieldName' => 'element5',
|
|
'fieldHtml' => 'element5',
|
|
],
|
|
],
|
|
],
|
|
);
|
|
*/
|
|
|
|
// Create an intermediate structure of rendered sub elements and elements nested in palettes
|
|
$targetStructure = [];
|
|
$mainStructureCounter = -1;
|
|
$fieldsArray = $this->data['fieldsArray'];
|
|
$this->resultArray = $this->initializeResultArray();
|
|
foreach ($fieldsArray as $fieldString) {
|
|
$fieldConfiguration = $this->explodeSingleFieldShowItemConfiguration($fieldString);
|
|
$fieldName = $fieldConfiguration['fieldName'];
|
|
if ($fieldName === '--palette--') {
|
|
$paletteElementArray = $this->createPaletteContentArray($fieldConfiguration['paletteName'] ?? '');
|
|
if (!empty($paletteElementArray)) {
|
|
$mainStructureCounter++;
|
|
// If there is no label in ['types']['aType']['showitem'] for this palette: "--palette--;;aPalette",
|
|
// then use ['palettes']['aPalette']['label'] if given.
|
|
$paletteLegend = $fieldConfiguration['fieldLabel'];
|
|
if ($paletteLegend === null && !empty($this->data['processedTca']['palettes'][$fieldConfiguration['paletteName']]['label'])) {
|
|
$paletteLegend = $this->data['processedTca']['palettes'][$fieldConfiguration['paletteName']]['label'];
|
|
}
|
|
// Get description of palette.
|
|
$paletteDescription = $this->data['processedTca']['palettes'][$fieldConfiguration['paletteName']]['description'] ?? '';
|
|
$targetStructure[$mainStructureCounter] = [
|
|
'type' => 'palette',
|
|
'fieldName' => $fieldConfiguration['paletteName'],
|
|
'paletteLegend' => $languageService->sL($paletteLegend),
|
|
'paletteDescription' => $languageService->sL($paletteDescription),
|
|
'elements' => $paletteElementArray,
|
|
];
|
|
}
|
|
} else {
|
|
if (!is_array($this->data['processedTca']['columns'][$fieldName] ?? null)) {
|
|
continue;
|
|
}
|
|
$options = $this->data;
|
|
$options['fieldName'] = $fieldName;
|
|
$options['renderType'] = 'singleFieldContainer';
|
|
$childResultArray = $this->nodeFactory->create($options)->render();
|
|
if (!empty($childResultArray['html'])) {
|
|
$mainStructureCounter++;
|
|
$targetStructure[$mainStructureCounter] = [
|
|
'type' => 'single',
|
|
'fieldName' => $fieldConfiguration['fieldName'],
|
|
'fieldHtml' => $childResultArray['html'],
|
|
];
|
|
}
|
|
$this->resultArray = $this->mergeChildReturnIntoExistingResult($this->resultArray, $childResultArray, false);
|
|
}
|
|
}
|
|
|
|
// Compile final content
|
|
$content = [];
|
|
foreach ($targetStructure as $element) {
|
|
if ($element['type'] === 'palette') {
|
|
$paletteName = $element['fieldName'];
|
|
$isHiddenPalette = !empty($this->data['processedTca']['palettes'][$paletteName]['isHiddenPalette']);
|
|
$html = [];
|
|
$html[] = '<fieldset class="form-section' . ($isHiddenPalette ? ' hide' : '') . '">';
|
|
if (!empty($element['paletteLegend'])) {
|
|
$html[] = '<h3 class="form-section-headline">' . htmlspecialchars($element['paletteLegend']) . '</h3>';
|
|
}
|
|
if (!empty($element['paletteDescription'])) {
|
|
$html[] = '<p class="form-section-description">' . nl2br(htmlspecialchars($element['paletteDescription'])) . '</p>';
|
|
}
|
|
$html[] = $this->renderInnerPaletteContent($element);
|
|
$html[] = '</fieldset>';
|
|
$content[] = implode(LF, $html);
|
|
} else {
|
|
$html = [];
|
|
$html[] = '<fieldset class="form-section">';
|
|
$html[] = '<div class="form-group t3js-formengine-validation-marker t3js-formengine-palette-field">';
|
|
$html[] = $element['fieldHtml'];
|
|
$html[] = '</div>';
|
|
$html[] = '</fieldset>';
|
|
$content[] = implode(LF, $html);
|
|
}
|
|
}
|
|
|
|
$finalResultArray = $this->resultArray;
|
|
$finalResultArray['html'] = implode(LF, $content);
|
|
return $finalResultArray;
|
|
}
|
|
|
|
/**
|
|
* Render single fields of a given palette
|
|
*
|
|
* @param string $paletteName The palette to render
|
|
*/
|
|
protected function createPaletteContentArray(string $paletteName): array
|
|
{
|
|
// palette needs a palette name reference, otherwise it does not make sense to try rendering of it
|
|
if (empty($paletteName) || empty($this->data['processedTca']['palettes'][$paletteName]['showitem'])) {
|
|
return [];
|
|
}
|
|
$resultStructure = [];
|
|
$foundRealElement = false; // Set to true if not only line breaks were rendered
|
|
$fieldsArray = GeneralUtility::trimExplode(',', $this->data['processedTca']['palettes'][$paletteName]['showitem'], true);
|
|
foreach ($fieldsArray as $fieldString) {
|
|
$fieldArray = $this->explodeSingleFieldShowItemConfiguration($fieldString);
|
|
$fieldName = $fieldArray['fieldName'];
|
|
if ($fieldName === '--linebreak--') {
|
|
$resultStructure[] = [
|
|
'type' => 'linebreak',
|
|
];
|
|
} else {
|
|
if (!is_array($this->data['processedTca']['columns'][$fieldName] ?? null)) {
|
|
continue;
|
|
}
|
|
$options = $this->data;
|
|
$options['fieldName'] = $fieldName;
|
|
$options['renderType'] = 'singleFieldContainer';
|
|
$singleFieldContentArray = $this->nodeFactory->create($options)->render();
|
|
if (!empty($singleFieldContentArray['html'])) {
|
|
$foundRealElement = true;
|
|
$resultStructure[] = [
|
|
'type' => 'single',
|
|
'fieldName' => $fieldName,
|
|
'fieldHtml' => $singleFieldContentArray['html'],
|
|
];
|
|
}
|
|
$this->resultArray = $this->mergeChildReturnIntoExistingResult($this->resultArray, $singleFieldContentArray, false);
|
|
}
|
|
}
|
|
if ($foundRealElement) {
|
|
return $resultStructure;
|
|
}
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* Renders inner content of single elements of a palette and wrap it as needed
|
|
*
|
|
* @param array $elementArray Array of elements
|
|
* @return string Wrapped content
|
|
*/
|
|
protected function renderInnerPaletteContent(array $elementArray): string
|
|
{
|
|
$result = [];
|
|
$currentGroup = [];
|
|
|
|
foreach ($elementArray['elements'] as $element) {
|
|
if ($element['type'] === 'linebreak') {
|
|
// Render current group before linebreak
|
|
if (!empty($currentGroup)) {
|
|
$result[] = $this->renderFieldGroup($currentGroup);
|
|
$currentGroup = [];
|
|
}
|
|
} else {
|
|
$currentGroup[] = $element;
|
|
}
|
|
}
|
|
|
|
// Render remaining group
|
|
if (!empty($currentGroup)) {
|
|
$result[] = $this->renderFieldGroup($currentGroup);
|
|
}
|
|
|
|
return implode(LF, $result);
|
|
}
|
|
|
|
/**
|
|
* Renders a group of fields within a form-grid container
|
|
*
|
|
* @param array $fields Array of field elements
|
|
* @return string Rendered HTML
|
|
*/
|
|
protected function renderFieldGroup(array $fields): string
|
|
{
|
|
$numberOfItems = count($fields);
|
|
$result = [];
|
|
|
|
if ($numberOfItems > 1) {
|
|
$result[] = '<div class="form-grid" style="--typo3-form-grid-columns: ' . $numberOfItems . '">';
|
|
}
|
|
|
|
foreach ($fields as $element) {
|
|
$result[] = '<div class="form-group t3js-formengine-validation-marker t3js-formengine-palette-field">';
|
|
$result[] = $element['fieldHtml'];
|
|
$result[] = '</div>';
|
|
}
|
|
|
|
if ($numberOfItems > 1) {
|
|
$result[] = '</div>';
|
|
}
|
|
|
|
return implode(LF, $result);
|
|
}
|
|
|
|
protected function getLanguageService(): LanguageService
|
|
{
|
|
return $GLOBALS['LANG'];
|
|
}
|
|
}
|