InputSlugElement::getPrefix() - Code Metrics - Inspection of "[FEATURE] Allow flexible base url for slug fields..." - TYPO3/TYPO3.CMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 76a0e0...7a82fc )

unknown

created 2020-04-13 21:14 UTC

InputSlugElement::getPrefix() A

↳ Parent: Project

Complexity

Conditions	6
Paths	12

Size

Total Lines	15
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	10
nc	12
nop	2
dl	0
loc	15
rs	9.2222
c	0
b	0
f	0

<?php
declare(strict_types=1);
namespace TYPO3\CMS\Backend\Form\Element;

/*
 * 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\Backend\Controller\FormSlugAjaxController;
use TYPO3\CMS\Core\Imaging\Icon;
use TYPO3\CMS\Core\Localization\LanguageService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;
use TYPO3\CMS\Core\Utility\StringUtility;

/**
 * General type=input element for TCA Type=Slug with some additional value.
 */
class InputSlugElement extends AbstractFormElement
{

    /**
     * Default field information enabled for this element.
     *
     * @var array
     */
    protected $defaultFieldInformation = [
        'tcaDescription' => [
            'renderType' => 'tcaDescription',
        ],
    ];

    /**
     * Default field wizards enabled for this element.
     *
     * @var array
     */
    protected $defaultFieldWizard = [
        'localizationStateSelector' => [
            'renderType' => 'localizationStateSelector',
        ],
        'otherLanguageContent' => [
            'renderType' => 'otherLanguageContent',
            'after' => [
                'localizationStateSelector'
            ],
        ],
        'defaultLanguageDifferences' => [
            'renderType' => 'defaultLanguageDifferences',
            'after' => [
                'otherLanguageContent',
            ],
        ],
    ];

    /**
     * This will render a single-line input form field, possibly with various control/validation features
     *
     * @return array As defined in initializeResultArray() of AbstractNode
     */
    public function render()
    {
        $table = $this->data['tableName'];
        $row = $this->data['databaseRow'];
        $parameterArray = $this->data['parameterArray'];
        $resultArray = $this->initializeResultArray();

        $languageId = 0;
        if (isset($GLOBALS['TCA'][$table]['ctrl']['languageField']) && !empty($GLOBALS['TCA'][$table]['ctrl']['languageField'])) {
            $languageField = $GLOBALS['TCA'][$table]['ctrl']['languageField'];
            $languageId = (int)((is_array($row[$languageField]) ? $row[$languageField][0] : $row[$languageField]) ?? 0);
        }

        $itemValue = $parameterArray['itemFormElValue'];
        $config = $parameterArray['fieldConf']['config'];
        $evalList = GeneralUtility::trimExplode(',', $config['eval'], true);
        $size = MathUtility::forceIntegerInRange($config['size'] ?? $this->defaultInputWidth, $this->minimumInputWidth, $this->maxInputWidth);
        $width = (int)$this->formMaxWidth($size);
        $baseUrl = $this->data['customData'][$this->data['fieldName']]['slugPrefix'] ?? '';

        // Convert UTF-8 characters back (that is important, see Slug class when sanitizing)
        $itemValue = rawurldecode($itemValue);

        $fieldInformationResult = $this->renderFieldInformation();
        $fieldInformationHtml = $fieldInformationResult['html'];
        $resultArray = $this->mergeChildReturnIntoExistingResult($resultArray, $fieldInformationResult, false);

        $fieldControlResult = $this->renderFieldControl();
        $fieldControlHtml = $fieldControlResult['html'];
        $resultArray = $this->mergeChildReturnIntoExistingResult($resultArray, $fieldControlResult, false);

        $fieldWizardResult = $this->renderFieldWizard();
        $fieldWizardHtml = $fieldWizardResult['html'];
        $resultArray = $this->mergeChildReturnIntoExistingResult($resultArray, $fieldWizardResult, false);
        $toggleButtonTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:buttons.toggleSlugExplanation');
        $recreateButtonTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:buttons.recreateSlugExplanation');

        $successMessage = sprintf($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:slugCreation.success.' . ($table === 'pages' ? 'page' : 'record')), $baseUrl);
        $errorMessage = sprintf($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:slugCreation.error'), $baseUrl);

        $thisSlugId = 't3js-form-field-slug-id' . StringUtility::getUniqueId();
        $mainFieldHtml = [];
        $mainFieldHtml[] = '<div class="formengine-field-item t3js-formengine-field-item">';
        $mainFieldHtml[] =  $fieldInformationHtml;
        $mainFieldHtml[] =  '<div class="form-control-wrap" style="max-width: ' . $width . 'px" id="' . htmlspecialchars($thisSlugId) . '">';
        $mainFieldHtml[] =      '<div class="form-wizards-wrap">';
        $mainFieldHtml[] =          '<div class="form-wizards-element">';
        $mainFieldHtml[] =              '<div class="input-group">';
        $mainFieldHtml[] =                  ($baseUrl ? '<span class="input-group-addon">' . htmlspecialchars($baseUrl) . '</span>' : '');
        // We deal with 3 fields here: a readonly field for current / default values, an input
        // field to manipulate the value, and the final hidden field used to send the value
        $mainFieldHtml[] =                  '<input';
        $mainFieldHtml[] =                      ' class="form-control t3js-form-field-slug-readonly"';
        $mainFieldHtml[] =                      ' data-toggle="tooltip"';
        $mainFieldHtml[] =                      ' data-title="' . htmlspecialchars($itemValue) . '"';
        $mainFieldHtml[] =                      ' value="' . htmlspecialchars($itemValue) . '"';
        $mainFieldHtml[] =                      ' readonly';
        $mainFieldHtml[] =                  ' />';
        $mainFieldHtml[] =                  '<input type="text"';
        $mainFieldHtml[] =                      ' id="' . htmlspecialchars(StringUtility::getUniqueId('formengine-input-')) . '"';
        $mainFieldHtml[] =                      ' class="form-control t3js-form-field-slug-input hidden"';
        $mainFieldHtml[] =                      ' placeholder="' . htmlspecialchars($row['slug'] ?? '/') . '"';
        $mainFieldHtml[] =                      ' data-formengine-validation-rules="' . htmlspecialchars($this->getValidationDataAsJsonString($config)) . '"';
        $mainFieldHtml[] =                      ' data-formengine-input-params="' . htmlspecialchars(json_encode(['field' => $parameterArray['itemFormElName'], 'evalList' => implode(',', $evalList)])) . '"';
        $mainFieldHtml[] =                      ' data-formengine-input-name="' . htmlspecialchars($parameterArray['itemFormElName']) . '"';
        $mainFieldHtml[] =                  ' />';
        $mainFieldHtml[] =                  '<span class="input-group-btn">';
        $mainFieldHtml[] =                      '<button class="btn btn-default t3js-form-field-slug-toggle" type="button" title="' . htmlspecialchars($toggleButtonTitle) . '">';
        $mainFieldHtml[] =                          $this->iconFactory->getIcon('actions-version-workspaces-preview-link', Icon::SIZE_SMALL)->render();
        $mainFieldHtml[] =                      '</button>';
        $mainFieldHtml[] =                      '<button class="btn btn-default t3js-form-field-slug-recreate" type="button" title="' . htmlspecialchars($recreateButtonTitle) . '">';
        $mainFieldHtml[] =                          $this->iconFactory->getIcon('actions-refresh', Icon::SIZE_SMALL)->render();
        $mainFieldHtml[] =                      '</button>';
        $mainFieldHtml[] =                  '</span>';
        $mainFieldHtml[] =                  '<input type="hidden"';
        $mainFieldHtml[] =                      ' class="t3js-form-field-slug-hidden"';
        $mainFieldHtml[] =                      ' name="' . htmlspecialchars($parameterArray['itemFormElName']) . '"';
        $mainFieldHtml[] =                      ' value="' . htmlspecialchars($itemValue) . '"';
        $mainFieldHtml[] =                  ' />';
        $mainFieldHtml[] =              '</div>';
        $mainFieldHtml[] =          '</div>';
        if (!empty($fieldControlHtml)) {
            $mainFieldHtml[] =      '<div class="form-wizards-items-aside">';
            $mainFieldHtml[] =          '<div class="btn-group">';
            $mainFieldHtml[] =              $fieldControlHtml;
            $mainFieldHtml[] =          '</div>';
            $mainFieldHtml[] =      '</div>';
        }
        $mainFieldHtml[] =          '<div class="form-wizards-items-bottom">';
        $mainFieldHtml[] =              '<span class="t3js-form-proposal-accepted hidden label label-success">' . htmlspecialchars($successMessage) . '<span>/abc/</span></span>';
        $mainFieldHtml[] =              '<span class="t3js-form-proposal-different hidden label label-warning">' . htmlspecialchars($errorMessage) . '<span>/abc/</span></span>';
        $mainFieldHtml[] =              $fieldWizardHtml;
        $mainFieldHtml[] =          '</div>';
        $mainFieldHtml[] =      '</div>';
        $mainFieldHtml[] =  '</div>';
        $mainFieldHtml[] = '</div>';

        $resultArray['html'] = implode(LF, $mainFieldHtml);

        [$commonElementPrefix] = GeneralUtility::revExplode('[', $parameterArray['itemFormElName'], 2);
        $validInputNamesToListenTo = [];
        $includeUidInValues = false;
        foreach ($config['generatorOptions']['fields'] ?? [] as $fieldNameParts) {
            if (is_string($fieldNameParts)) {
                $fieldNameParts = GeneralUtility::trimExplode(',', $fieldNameParts);
            }
            foreach ($fieldNameParts as $listenerFieldName) {
                if ($listenerFieldName === 'uid') {
                    $includeUidInValues = true;
                    continue;
                }
                $validInputNamesToListenTo[$listenerFieldName] = $commonElementPrefix . '[' . htmlspecialchars($listenerFieldName) . ']';
            }
        }
        $parentPageId = $this->data['parentPageRow']['uid'] ?? 0;
        $signature = GeneralUtility::hmac(
            implode(
                '',
                [
                    $table,
                    $this->data['effectivePid'],
                    $row['uid'],
                    $languageId,
                    $this->data['fieldName'],
                    $this->data['command'],
                    $parentPageId
                ]
            ),
            FormSlugAjaxController::class
        );
        $optionsForModule = [
            'pageId' => $this->data['effectivePid'],
            'recordId' => $row['uid'],
            'tableName' => $table,
            'fieldName' => $this->data['fieldName'],
            'config' => $config,
            'listenerFieldNames' => $validInputNamesToListenTo,
            'language' => $languageId,
            'originalValue' => $itemValue,
            'signature' => $signature,
            'command' => $this->data['command'],
            'parentPageId' => $parentPageId,
            'includeUidInValues' => $includeUidInValues,
        ];
        $resultArray['requireJsModules'][] = ['TYPO3/CMS/Backend/FormEngine/Element/SlugElement' => '
            function(SlugElement) {
                new SlugElement(' . GeneralUtility::quoteJSvalue('#' . $thisSlugId) . ', ' . json_encode($optionsForModule) . ');
            }'
        ];
        return $resultArray;
    }

    /**
     * @return LanguageService
     */
    protected function getLanguageService(): LanguageService
    {
        return $GLOBALS['LANG'];
    }
}


1			<?php
2			declare(strict_types=1);
3			namespace TYPO3\CMS\Backend\Form\Element;
4
5			/*
6			* This file is part of the TYPO3 CMS project.
7			*
8			* It is free software; you can redistribute it and/or modify it under
9			* the terms of the GNU General Public License, either version 2
10			* of the License, or any later version.
11			*
12			* For the full copyright and license information, please read the
13			* LICENSE.txt file that was distributed with this source code.
14			*
15			* The TYPO3 project - inspiring people to share!
16			*/
17
18			use TYPO3\CMS\Backend\Controller\FormSlugAjaxController;
19			use TYPO3\CMS\Core\Imaging\Icon;
20			use TYPO3\CMS\Core\Localization\LanguageService;
21			use TYPO3\CMS\Core\Utility\GeneralUtility;
22			use TYPO3\CMS\Core\Utility\MathUtility;
23			use TYPO3\CMS\Core\Utility\StringUtility;
24
25			/**
26			* General type=input element for TCA Type=Slug with some additional value.
27			*/
28			class InputSlugElement extends AbstractFormElement
29			{
30
31			/**
32			* Default field information enabled for this element.
33			*
34			* @var array
35			*/
36			protected $defaultFieldInformation = [
37			'tcaDescription' => [
38			'renderType' => 'tcaDescription',
39			],
40			];
41
42			/**
43			* Default field wizards enabled for this element.
44			*
45			* @var array
46			*/
47			protected $defaultFieldWizard = [
48			'localizationStateSelector' => [
49			'renderType' => 'localizationStateSelector',
50			],
51			'otherLanguageContent' => [
52			'renderType' => 'otherLanguageContent',
53			'after' => [
54			'localizationStateSelector'
55			],
56			],
57			'defaultLanguageDifferences' => [
58			'renderType' => 'defaultLanguageDifferences',
59			'after' => [
60			'otherLanguageContent',
61			],
62			],
63			];
64
65			/**
66			* This will render a single-line input form field, possibly with various control/validation features
67			*
68			* @return array As defined in initializeResultArray() of AbstractNode
69			*/
70			public function render()
71			{
72			$table = $this->data['tableName'];
73			$row = $this->data['databaseRow'];
74			$parameterArray = $this->data['parameterArray'];
75			$resultArray = $this->initializeResultArray();
76
77			$languageId = 0;
78			if (isset($GLOBALS['TCA'][$table]['ctrl']['languageField']) && !empty($GLOBALS['TCA'][$table]['ctrl']['languageField'])) {
79			$languageField = $GLOBALS['TCA'][$table]['ctrl']['languageField'];
80			$languageId = (int)((is_array($row[$languageField]) ? $row[$languageField][0] : $row[$languageField]) ?? 0);
81			}
82
83			$itemValue = $parameterArray['itemFormElValue'];
84			$config = $parameterArray['fieldConf']['config'];
85			$evalList = GeneralUtility::trimExplode(',', $config['eval'], true);
86			$size = MathUtility::forceIntegerInRange($config['size'] ?? $this->defaultInputWidth, $this->minimumInputWidth, $this->maxInputWidth);
87			$width = (int)$this->formMaxWidth($size);
88			$baseUrl = $this->data['customData'][$this->data['fieldName']]['slugPrefix'] ?? '';
89
90			// Convert UTF-8 characters back (that is important, see Slug class when sanitizing)
91			$itemValue = rawurldecode($itemValue);
92
93			$fieldInformationResult = $this->renderFieldInformation();
94			$fieldInformationHtml = $fieldInformationResult['html'];
95			$resultArray = $this->mergeChildReturnIntoExistingResult($resultArray, $fieldInformationResult, false);
96
97			$fieldControlResult = $this->renderFieldControl();
98			$fieldControlHtml = $fieldControlResult['html'];
99			$resultArray = $this->mergeChildReturnIntoExistingResult($resultArray, $fieldControlResult, false);
100
101			$fieldWizardResult = $this->renderFieldWizard();
102			$fieldWizardHtml = $fieldWizardResult['html'];
103			$resultArray = $this->mergeChildReturnIntoExistingResult($resultArray, $fieldWizardResult, false);
104			$toggleButtonTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:buttons.toggleSlugExplanation');
105			$recreateButtonTitle = $this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:buttons.recreateSlugExplanation');
106
107			$successMessage = sprintf($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:slugCreation.success.' . ($table === 'pages' ? 'page' : 'record')), $baseUrl);
108			$errorMessage = sprintf($this->getLanguageService()->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:slugCreation.error'), $baseUrl);
109
110			$thisSlugId = 't3js-form-field-slug-id' . StringUtility::getUniqueId();
111			$mainFieldHtml = [];
112			$mainFieldHtml[] = '<div class="formengine-field-item t3js-formengine-field-item">';
113			$mainFieldHtml[] = $fieldInformationHtml;
114			$mainFieldHtml[] = '<div class="form-control-wrap" style="max-width: ' . $width . 'px" id="' . htmlspecialchars($thisSlugId) . '">';
115			$mainFieldHtml[] = '<div class="form-wizards-wrap">';
116			$mainFieldHtml[] = '<div class="form-wizards-element">';
117			$mainFieldHtml[] = '<div class="input-group">';
118			$mainFieldHtml[] = ($baseUrl ? '<span class="input-group-addon">' . htmlspecialchars($baseUrl) . '</span>' : '');
119			// We deal with 3 fields here: a readonly field for current / default values, an input
120			// field to manipulate the value, and the final hidden field used to send the value
121			$mainFieldHtml[] = '<input';
122			$mainFieldHtml[] = ' class="form-control t3js-form-field-slug-readonly"';
123			$mainFieldHtml[] = ' data-toggle="tooltip"';
124			$mainFieldHtml[] = ' data-title="' . htmlspecialchars($itemValue) . '"';
125			$mainFieldHtml[] = ' value="' . htmlspecialchars($itemValue) . '"';
126			$mainFieldHtml[] = ' readonly';
127			$mainFieldHtml[] = ' />';
128			$mainFieldHtml[] = '<input type="text"';
129			$mainFieldHtml[] = ' id="' . htmlspecialchars(StringUtility::getUniqueId('formengine-input-')) . '"';
130			$mainFieldHtml[] = ' class="form-control t3js-form-field-slug-input hidden"';
131			$mainFieldHtml[] = ' placeholder="' . htmlspecialchars($row['slug'] ?? '/') . '"';
132			$mainFieldHtml[] = ' data-formengine-validation-rules="' . htmlspecialchars($this->getValidationDataAsJsonString($config)) . '"';
133			$mainFieldHtml[] = ' data-formengine-input-params="' . htmlspecialchars(json_encode(['field' => $parameterArray['itemFormElName'], 'evalList' => implode(',', $evalList)])) . '"';
134			$mainFieldHtml[] = ' data-formengine-input-name="' . htmlspecialchars($parameterArray['itemFormElName']) . '"';
135			$mainFieldHtml[] = ' />';
136			$mainFieldHtml[] = '<span class="input-group-btn">';
137			$mainFieldHtml[] = '<button class="btn btn-default t3js-form-field-slug-toggle" type="button" title="' . htmlspecialchars($toggleButtonTitle) . '">';
138			$mainFieldHtml[] = $this->iconFactory->getIcon('actions-version-workspaces-preview-link', Icon::SIZE_SMALL)->render();
139			$mainFieldHtml[] = '</button>';
140			$mainFieldHtml[] = '<button class="btn btn-default t3js-form-field-slug-recreate" type="button" title="' . htmlspecialchars($recreateButtonTitle) . '">';
141			$mainFieldHtml[] = $this->iconFactory->getIcon('actions-refresh', Icon::SIZE_SMALL)->render();
142			$mainFieldHtml[] = '</button>';
143			$mainFieldHtml[] = '</span>';
144			$mainFieldHtml[] = '<input type="hidden"';
145			$mainFieldHtml[] = ' class="t3js-form-field-slug-hidden"';
146			$mainFieldHtml[] = ' name="' . htmlspecialchars($parameterArray['itemFormElName']) . '"';
147			$mainFieldHtml[] = ' value="' . htmlspecialchars($itemValue) . '"';
148			$mainFieldHtml[] = ' />';
149			$mainFieldHtml[] = '</div>';
150			$mainFieldHtml[] = '</div>';
151			if (!empty($fieldControlHtml)) {
152			$mainFieldHtml[] = '<div class="form-wizards-items-aside">';
153			$mainFieldHtml[] = '<div class="btn-group">';
154			$mainFieldHtml[] = $fieldControlHtml;
155			$mainFieldHtml[] = '</div>';
156			$mainFieldHtml[] = '</div>';
157			}
158			$mainFieldHtml[] = '<div class="form-wizards-items-bottom">';
159			$mainFieldHtml[] = '<span class="t3js-form-proposal-accepted hidden label label-success">' . htmlspecialchars($successMessage) . '<span>/abc/</span></span>';
160			$mainFieldHtml[] = '<span class="t3js-form-proposal-different hidden label label-warning">' . htmlspecialchars($errorMessage) . '<span>/abc/</span></span>';
161			$mainFieldHtml[] = $fieldWizardHtml;
162			$mainFieldHtml[] = '</div>';
163			$mainFieldHtml[] = '</div>';
164			$mainFieldHtml[] = '</div>';
165			$mainFieldHtml[] = '</div>';
166
167			$resultArray['html'] = implode(LF, $mainFieldHtml);
168
169			[$commonElementPrefix] = GeneralUtility::revExplode('[', $parameterArray['itemFormElName'], 2);
170			$validInputNamesToListenTo = [];
171			$includeUidInValues = false;
172			foreach ($config['generatorOptions']['fields'] ?? [] as $fieldNameParts) {
173			if (is_string($fieldNameParts)) {
174			$fieldNameParts = GeneralUtility::trimExplode(',', $fieldNameParts);
175			}
176			foreach ($fieldNameParts as $listenerFieldName) {
177			if ($listenerFieldName === 'uid') {
178			$includeUidInValues = true;
179			continue;
180			}
181			$validInputNamesToListenTo[$listenerFieldName] = $commonElementPrefix . '[' . htmlspecialchars($listenerFieldName) . ']';
182			}
183			}
184			$parentPageId = $this->data['parentPageRow']['uid'] ?? 0;
185			$signature = GeneralUtility::hmac(
186			implode(
187			'',
188			[
189			$table,
190			$this->data['effectivePid'],
191			$row['uid'],
192			$languageId,
193			$this->data['fieldName'],
194			$this->data['command'],
195			$parentPageId
196			]
197			),
198			FormSlugAjaxController::class
199			);
200			$optionsForModule = [
201			'pageId' => $this->data['effectivePid'],
202			'recordId' => $row['uid'],
203			'tableName' => $table,
204			'fieldName' => $this->data['fieldName'],
205			'config' => $config,
206			'listenerFieldNames' => $validInputNamesToListenTo,
207			'language' => $languageId,
208			'originalValue' => $itemValue,
209			'signature' => $signature,
210			'command' => $this->data['command'],
211			'parentPageId' => $parentPageId,
212			'includeUidInValues' => $includeUidInValues,
213			];
214			$resultArray['requireJsModules'][] = ['TYPO3/CMS/Backend/FormEngine/Element/SlugElement' => '
215			function(SlugElement) {
216			new SlugElement(' . GeneralUtility::quoteJSvalue('#' . $thisSlugId) . ', ' . json_encode($optionsForModule) . ');
217			}'
218			];
219			return $resultArray;
220			}
221
222			/**
223			* @return LanguageService
224			*/
225			protected function getLanguageService(): LanguageService
226			{
227			return $GLOBALS['LANG'];
228			}
229			}
230

TYPO3 / TYPO3.CMS

Push — master ( 76a0e0...7a82fc )

InputSlugElement::getPrefix() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like