7b867fd43bfba2978c019cf6ad3b4184ac4e616f
[Packages/TYPO3.CMS.git] / typo3 / sysext / backend / Classes / Form / NodeFactory.php
1 <?php
2 namespace TYPO3\CMS\Backend\Form;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Core\Utility\GeneralUtility;
18
19 /**
20 * Create an element object depending on renderType.
21 *
22 * This is the main factory to instantiate any node within the render
23 * chain of FormEngine. All nodes must implement NodeInterface.
24 *
25 * Nodes are "container" classes of the render chain, "element" classes that
26 * render single elements, as well as "fieldWizard", "fieldInformation" and
27 * "fieldControl" classes which are called by single elements to enrich them.
28 *
29 * This factory gets a string "renderType" and then looks up in a list which
30 * specific class should handle this renderType. This list can be extended with
31 * own renderTypes by extensions, existing renderTypes can be overridden, and
32 * - for complex cases - it is possible to register own resolver classes for single
33 * renderTypes that can return a node class name to override the default lookup list.
34 */
35 class NodeFactory
36 {
37 /**
38 * Node resolver classes
39 * Nested array with nodeName as key, (sorted) priority as sub key and class as value
40 *
41 * @var array
42 */
43 protected $nodeResolver = [];
44
45 /**
46 * Default registry of node name to handling class
47 *
48 * @var array
49 */
50 protected $nodeTypes = [
51 // Default container classes
52 'flex' => Container\FlexFormEntryContainer::class,
53 'flexFormContainerContainer' => Container\FlexFormContainerContainer::class,
54 'flexFormElementContainer' => Container\FlexFormElementContainer::class,
55 'flexFormNoTabsContainer' => Container\FlexFormNoTabsContainer::class,
56 'flexFormSectionContainer' => Container\FlexFormSectionContainer::class,
57 'flexFormTabsContainer' => Container\FlexFormTabsContainer::class,
58 'fullRecordContainer' => Container\FullRecordContainer::class,
59 'inline' => Container\InlineControlContainer::class,
60 'inlineRecordContainer' => Container\InlineRecordContainer::class,
61 'listOfFieldsContainer' => Container\ListOfFieldsContainer::class,
62 'noTabsContainer' => Container\NoTabsContainer::class,
63 'outerWrapContainer' => Container\OuterWrapContainer::class,
64 'paletteAndSingleContainer' => Container\PaletteAndSingleContainer::class,
65 'singleFieldContainer' => Container\SingleFieldContainer::class,
66 'tabsContainer' => Container\TabsContainer::class,
67
68 // Default single element classes
69 'check' => Element\CheckboxElement::class,
70 'checkboxToggle' => Element\CheckboxToggleElement::class,
71 'checkboxLabeledToggle' => Element\CheckboxLabeledToggleElement::class,
72 'group' => Element\GroupElement::class,
73 'input' => Element\InputTextElement::class,
74 'inputDateTime' => Element\InputDateTimeElement::class,
75 'inputLink' => Element\InputLinkElement::class,
76 'hidden' => Element\InputHiddenElement::class,
77 // rsaInput is defined with a fallback so extensions can use it even if ext:rsaauth is not loaded
78 'rsaInput' => Element\InputTextElement::class,
79 'imageManipulation' => Element\ImageManipulationElement::class,
80 'none' => Element\NoneElement::class,
81 'radio' => Element\RadioElement::class,
82 'selectCheckBox' => Element\SelectCheckBoxElement::class,
83 'selectMultipleSideBySide' => Element\SelectMultipleSideBySideElement::class,
84 'selectTree' => Element\SelectTreeElement::class,
85 'selectSingle' => Element\SelectSingleElement::class,
86 'selectSingleBox' => Element\SelectSingleBoxElement::class,
87 'colorpicker' => Element\InputColorPickerElement::class,
88 // t3editor is defined with a fallback so extensions can use it even if ext:t3editor is not loaded
89 't3editor' => Element\TextElement::class,
90 'text' => Element\TextElement::class,
91 'textTable' => Element\TextTableElement::class,
92 'unknown' => Element\UnknownElement::class,
93 'user' => Element\UserElement::class,
94 'fileInfo' => Element\FileInfoElement::class,
95
96 // Default classes to enrich single elements
97 'fieldControl' => NodeExpansion\FieldControl::class,
98 'fieldInformation' => NodeExpansion\FieldInformation::class,
99 'fieldWizard' => NodeExpansion\FieldWizard::class,
100
101 // Element information
102 'tcaDescription' => FieldInformation\TcaDescription::class,
103
104 // Element wizards
105 'defaultLanguageDifferences' => FieldWizard\DefaultLanguageDifferences::class,
106 'fileThumbnails' => FieldWizard\FileThumbnails::class,
107 'fileTypeList' => FieldWizard\FileTypeList::class,
108 'fileUpload' => FieldWizard\FileUpload::class,
109 'localizationStateSelector' => FieldWizard\LocalizationStateSelector::class,
110 'otherLanguageContent' => FieldWizard\OtherLanguageContent::class,
111 'recordsOverview' => FieldWizard\RecordsOverview::class,
112 'selectIcons' => FieldWizard\SelectIcons::class,
113 'tableList' => FieldWizard\TableList::class,
114
115 // Element controls
116 'addRecord' => FieldControl\AddRecord::class,
117 'editPopup' => FieldControl\EditPopup::class,
118 'elementBrowser' => FieldControl\ElementBrowser::class,
119 'insertClipboard' => FieldControl\InsertClipboard::class,
120 'linkPopup' => FieldControl\LinkPopup::class,
121 'listModule' => FieldControl\ListModule::class,
122 'resetSelection' => FieldControl\ResetSelection::class,
123 'tableWizard' => FieldControl\TableWizard::class,
124 ];
125
126 /**
127 * Set up factory. Initialize additionally registered nodes.
128 */
129 public function __construct()
130 {
131 $this->registerAdditionalNodeTypesFromConfiguration();
132 $this->initializeNodeResolver();
133 }
134
135 /**
136 * Create a node depending on type
137 *
138 * @param array $data All information to decide which class should be instantiated and given down to sub nodes
139 * @return AbstractNode
140 * @throws Exception
141 */
142 public function create(array $data)
143 {
144 if (empty($data['renderType'])) {
145 throw new Exception(
146 'Missing "renderType" in TCA of field "[' . ($data['tableName'] ?? 'unknown') . '][' . ($data['fieldName'] ?? 'unknown') . ']".',
147 1431452406
148 );
149 }
150 $type = $data['renderType'];
151
152 $className = $this->nodeTypes[$type] ?? $this->nodeTypes['unknown'];
153
154 if (!empty($this->nodeResolver[$type])) {
155 // Resolver with highest priority is called first. If it returns with a new class name,
156 // it will be taken and loop is aborted, otherwise resolver with next lower priority is called.
157 foreach ($this->nodeResolver[$type] as $priority => $resolverClassName) {
158 /** @var NodeResolverInterface $resolver */
159 $resolver = $this->instantiate($resolverClassName, $data);
160 if (!$resolver instanceof NodeResolverInterface) {
161 throw new Exception(
162 'Node resolver for type ' . $type . ' at priority ' . $priority . ' must implement NodeResolverInterface',
163 1433157422
164 );
165 }
166 // Resolver classes do NOT receive the name of the already resolved class. Single
167 // resolvers should not have dependencies to each other or the default implementation,
168 // so they also shouldn't know the output of a different resolving class.
169 // Additionally, the globalOptions array is NOT given by reference here, changing config is a
170 // task of container classes alone and must not be abused here.
171 $newClassName = $resolver->resolve();
172 if ($newClassName !== null) {
173 $className = $newClassName;
174 break;
175 }
176 }
177 }
178
179 /** @var AbstractNode $nodeInstance */
180 $nodeInstance = $this->instantiate($className, $data);
181 if (!$nodeInstance instanceof NodeInterface) {
182 throw new Exception('Node of type ' . get_class($nodeInstance) . ' must implement NodeInterface', 1431872546);
183 }
184 return $nodeInstance;
185 }
186
187 /**
188 * Add node types from nodeRegistry to $this->nodeTypes.
189 * This can be used to add new render types or to overwrite existing node types. The registered class must
190 * implement the NodeInterface and will be called if a node with this renderType is rendered.
191 *
192 * @throws Exception if configuration is incomplete or two nodes with identical priorities are registered
193 */
194 protected function registerAdditionalNodeTypesFromConfiguration()
195 {
196 // List of additional or override nodes
197 $registeredTypeOverrides = $GLOBALS['TYPO3_CONF_VARS']['SYS']['formEngine']['nodeRegistry'];
198 // Sanitize input array
199 $registeredPrioritiesForNodeNames = [];
200 foreach ($registeredTypeOverrides as $override) {
201 if (!isset($override['nodeName']) || !isset($override['class']) || !isset($override['priority'])) {
202 throw new Exception(
203 'Key class, nodeName or priority missing for an entry in $GLOBALS[\'TYPO3_CONF_VARS\'][\'SYS\'][\'formEngine\'][\'nodeRegistry\']',
204 1432207533
205 );
206 }
207 if ($override['priority'] < 0 || $override['priority'] > 100) {
208 throw new Exception(
209 'Priority of element ' . $override['nodeName'] . ' with class ' . $override['class'] . ' is ' . $override['priority'] . ', but must between 0 and 100',
210 1432223531
211 );
212 }
213 if (isset($registeredPrioritiesForNodeNames[$override['nodeName']][$override['priority']])) {
214 throw new Exception(
215 'Element ' . $override['nodeName'] . ' already has an override registered with priority ' . $override['priority'],
216 1432223893
217 );
218 }
219 $registeredPrioritiesForNodeNames[$override['nodeName']][$override['priority']] = '';
220 }
221 // Add element with highest priority to registry
222 $highestPriority = [];
223 foreach ($registeredTypeOverrides as $override) {
224 if (!isset($highestPriority[$override['nodeName']]) || $override['priority'] > $highestPriority[$override['nodeName']]) {
225 $highestPriority[$override['nodeName']] = $override['priority'];
226 $this->nodeTypes[$override['nodeName']] = $override['class'];
227 }
228 }
229 }
230
231 /**
232 * Add resolver and add them sorted to a local property.
233 * This can be used to manipulate the nodeName to class resolution with own code.
234 *
235 * @throws Exception if configuration is incomplete or two resolver with identical priorities are registered
236 */
237 protected function initializeNodeResolver()
238 {
239 // List of node resolver
240 $registeredNodeResolvers = $GLOBALS['TYPO3_CONF_VARS']['SYS']['formEngine']['nodeResolver'];
241 $resolversByType = [];
242 foreach ($registeredNodeResolvers as $nodeResolver) {
243 if (!isset($nodeResolver['nodeName']) || !isset($nodeResolver['class']) || !isset($nodeResolver['priority'])) {
244 throw new Exception(
245 'Key class, nodeName or priority missing for an entry in $GLOBALS[\'TYPO3_CONF_VARS\'][\'SYS\'][\'formEngine\'][\'nodeResolver\']',
246 1433155522
247 );
248 }
249 if ($nodeResolver['priority'] < 0 || $nodeResolver['priority'] > 100) {
250 throw new Exception(
251 'Priority of element ' . $nodeResolver['nodeName'] . ' with class ' . $nodeResolver['class'] . ' is ' . $nodeResolver['priority'] . ', but must between 0 and 100',
252 1433155563
253 );
254 }
255 if (isset($resolversByType[$nodeResolver['nodeName']][$nodeResolver['priority']])) {
256 throw new Exception(
257 'Element ' . $nodeResolver['nodeName'] . ' already has a resolver registered with priority ' . $nodeResolver['priority'],
258 1433155705
259 );
260 }
261 $resolversByType[$nodeResolver['nodeName']][$nodeResolver['priority']] = $nodeResolver['class'];
262 }
263 $sortedResolversByType = [];
264 foreach ($resolversByType as $nodeName => $prioritiesAndClasses) {
265 krsort($prioritiesAndClasses);
266 $sortedResolversByType[$nodeName] = $prioritiesAndClasses;
267 }
268 $this->nodeResolver = $sortedResolversByType;
269 }
270
271 /**
272 * Instantiate given class name
273 *
274 * @param string $className Given class name
275 * @param array $data Main data array
276 * @return object
277 */
278 protected function instantiate($className, array $data)
279 {
280 return GeneralUtility::makeInstance($className, $this, $data);
281 }
282 }