7438a492f2f9966b547bf1d81fcf7a28726e66ed
[Packages/TYPO3.CMS.git] / typo3 / sysext / backend / Classes / Form / FormDataCompiler.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 /**
18 * Create and return a defined array of data ready to be used by the
19 * container / element render part of FormEngine
20 */
21 class FormDataCompiler
22 {
23 /**
24 * Data group that provides data
25 *
26 * @var FormDataGroupInterface
27 */
28 protected $formDataGroup;
29
30 /**
31 * List of top level array elements to be unset from
32 * result array before final result is returned.
33 *
34 * @var array
35 */
36 protected $removeKeysFromFinalResultArray = [
37 ];
38
39 /**
40 * Get form data group injected
41 *
42 * @param FormDataGroupInterface $formDataGroup
43 */
44 public function __construct(FormDataGroupInterface $formDataGroup)
45 {
46 $this->formDataGroup = $formDataGroup;
47 }
48
49 /**
50 * Main entry method maps given data input array and sanitizes some
51 * crucial input parameters and calls compile on FormDataGroupInterface.
52 *
53 * @param array $initialData Initial set of data to map into result array
54 * @return array Result with data
55 * @throws \InvalidArgumentException
56 * @throws \UnexpectedValueException
57 */
58 public function compile(array $initialData)
59 {
60 $result = $this->initializeResultArray();
61
62 // There must be only keys that actually exist in result data.
63 $keysNotInResult = array_diff(array_keys($initialData), array_keys($result));
64 if (!empty($keysNotInResult)) {
65 throw new \InvalidArgumentException(
66 'Array keys ' . implode(',', $keysNotInResult) . ' do not exist in result array and can not be set',
67 1440601540
68 );
69 }
70
71 foreach ($initialData as $dataKey => $dataValue) {
72 if ($dataKey === 'command') {
73 // Sanitize $command
74 if ($dataValue !== 'edit' && $dataValue !== 'new') {
75 throw new \InvalidArgumentException('Command must be either "edit" or "new"', 1437653136);
76 }
77 }
78 if ($dataKey === 'tableName') {
79 // Sanitize $tableName
80 if (empty($dataValue)) {
81 throw new \InvalidArgumentException('No $tableName given', 1437654409);
82 }
83 }
84 if ($dataKey === 'vanillaUid') {
85 if (!is_int($dataValue)) {
86 throw new \InvalidArgumentException('$vanillaUid is not an integer', 1437654247);
87 }
88 if (isset($initialData['command']) && $initialData['command'] === 'edit' && $dataValue < 0) {
89 throw new \InvalidArgumentException('Negative $vanillaUid is not supported with $command="edit', 1437654332);
90 }
91 }
92 $result[$dataKey] = $dataValue;
93 }
94
95 // Call the data group provider but take care it does not add or remove result keys
96 // This is basically a safety measure against data providers colliding with our array "contract"
97 $resultKeysBeforeFormDataGroup = array_keys($result);
98
99 $result = $this->formDataGroup->compile($result);
100
101 $resultKeysAfterFormDataGroup = array_keys($result);
102
103 if ($resultKeysAfterFormDataGroup !== $resultKeysBeforeFormDataGroup) {
104 throw new \UnexpectedValueException(
105 'Data group provider must not change result key list',
106 1438079402
107 );
108 }
109
110 // Remove some data elements form result that are data provider internal and should
111 // not be exposed to calling object.
112 foreach ($this->removeKeysFromFinalResultArray as $key) {
113 unset($result[$key]);
114 }
115
116 return $result;
117 }
118
119 /**
120 * @return array
121 */
122 protected function initializeResultArray()
123 {
124 return [
125 // Either "edit" or "new"
126 'command' => '',
127 // Table name of the handled row
128 'tableName' => '',
129 // Forced integer of otherwise not changed uid of the record, meaning of value depends on context (new / edit)
130 // * If $command is "edit"
131 // ** $vanillaUid is a positive integer > 0 pointing to the record in the table
132 // * If $command is "new":
133 // ** If $vanillaUid > 0, it is the uid of a page the record should be added at
134 // ** If $vanillaUid < 0, it is the uid of a record in the same table after which the new record should be added
135 // ** If $vanillaUid = 0, a new record is added on page 0
136 'vanillaUid' => 0,
137 // Url to return to
138 'returnUrl' => null,
139 // Title of the handled record.
140 'recordTitle' => '',
141 // Parent page record is either the full row of the parent page the record is located at or should
142 // be added to, or it is NULL, if a record is added or edited below the root page node.
143 'parentPageRow' => null,
144 // Holds the "neighbor" row if incoming vanillaUid is negative and record creation is relative to a row of the same table.
145 'neighborRow' => null,
146 // For "new" this is the fully initialized row with defaults
147 // The database row. For "edit" fixVersioningPid() was applied already.
148 // @todo: rename to valueStructure or handledData or similar
149 'databaseRow' => [],
150 // The "effective" page uid we're working on. This is the uid of a page if a page is edited, or the uid
151 // of the parent page if a page or other record is added, or 0 if a record is added or edited below root node.
152 'effectivePid' => 0,
153 // Rootline of page the record that is handled is located at as created by BackendUtility::BEgetRootline()
154 'rootline' => [],
155 // For "edit", this is the permission bitmask of the page that is edited, or of the page a record is located at
156 // For "new", this is the permission bitmask of the page the record is added to
157 // @todo: Remove if not needed on a lower level
158 'userPermissionOnPage' => 0,
159 // Full user TsConfig
160 'userTsConfig' => [],
161 // Full page TSConfig of the page that is edited or of the parent page if a record is added.
162 // This includes any defaultPageTSconfig and is merged with user TsConfig page. section. After type
163 // of handled record was determined, record type specific settings [TCEFORM.][tableName.][field.][types.][type.]
164 // are merged into [TCEFORM.][tableName.][field.]. Array keys still contain the concatenation dots.
165 'pageTsConfig' => [],
166 // Not changed TCA of parent page row if record is edited or added below a page and not root node
167 'vanillaParentPageTca' => null,
168 // List of available system languages. Array key is the system language uid, value array
169 // contains details of the record, with iso code resolved. Key is the sys_language_uid uid.
170 'systemLanguageRows' => [],
171 // If the page that is handled has "page_language_overlay" records (page has localizations in
172 // different languages), then this array holds those rows.
173 'pageLanguageOverlayRows' => [],
174 // If the handled row is a localized row, this entry hold the default language row array
175 'defaultLanguageRow' => null,
176 // If the handled row is a localized row and a transOrigDiffSourceField is defined, this
177 // is the unserialized version of it. The diff source field is basically a shadow version
178 // of the default language record at the time when the language overlay record was created.
179 // This is used later to compare the default record with this content to show a "diff" if
180 // the default language record changed meanwhile.
181 'defaultLanguageDiffRow' => null,
182 // With userTS options.additionalPreviewLanguages set, field values of additional languages
183 // can be shown. This array holds those additional language records, Array key is sys_language_uid.
184 'additionalLanguageRows' => [],
185 // The tca record type value of the record. Forced to string, there can be "named" type values.
186 'recordTypeValue' => '0',
187 // TCA of table with processed fields. After processing, this array contains merged and resolved
188 // array data, items were resolved, only used types are set, renderTypes are set.
189 'processedTca' => [],
190 // List of columns to be processed by data provider. Array value is the column name.
191 'columnsToProcess' => [],
192 // If set to TRUE, no wizards are calculated and rendered later
193 'disabledWizards' => false,
194
195 // BackendUser->uc['inlineView'] - This array holds status of expand / collapsed inline items
196 // @todo: better documentation of nesting behaviour and bug fixing in this area
197 'inlineExpandCollapseStateArray' => [],
198 // The "entry" pid for inline records. Nested inline records can potentially hang around on different
199 // pid's, but the entry pid is needed for AJAX calls, so that they would know where the action takes
200 // place on the page structure.
201 'inlineFirstPid' => null,
202 // The "config" section of an inline parent, prepared and sanitized by TcaInlineConfiguration provider
203 'inlineParentConfig' => [],
204 // Flag that is enabled if a records is child of an inline parent
205 'isInlineChild' => false,
206 // Flag if an inline child is expanded so that additional fields need to be rendered
207 'isInlineChildExpanded' => false,
208 // Flag if the inline is in an ajax context that wants to expand the element
209 'isInlineAjaxOpeningContext' => false,
210 // Uid of the direct parent of the inline element. Handled as string since it may be a "NEW123" string
211 'inlineParentUid' => '',
212 // Table name of the direct parent of the inline element
213 'inlineParentTableName' => '',
214 // Field name of the direct parent of the inline element
215 'inlineParentFieldName' => '',
216 // Uid of the top most parent element. Handled as string since it may be a "NEW123" string
217 'inlineTopMostParentUid' => '',
218 // Table name of the top most parent element
219 'inlineTopMostParentTableName' => '',
220 // Field name of the top most parent element
221 'inlineTopMostParentFieldName' => '',
222
223 // If is on symetric side of an inline child parent reference.
224 // symmetric side can be achieved in case of an mm relation to the same table. If record A has a relation
225 // to record B, the symmetric side is set in case that record B gets edited.
226 // Record A (table1) <=> mm <=> Record B (table1)
227 'isOnSymmetricSide' => false,
228
229 // Uid of a "child-child" if a new record of an intermediate table is compiled to an existing child. This
230 // happens if foreign_selector in parent inline config is set. It will be used by default database row
231 // data providers to set this as value for the foreign_selector field on the intermediate table. One use
232 // case is FAL, where for instance a tt_content parent adds relation to an existing sys_file record and
233 // should set the uid of the existing sys_file record as uid_local - the foreign_selector of this inline
234 // configuration - of the new intermediate sys_file_reference record. Data provider that are called later
235 // will then use this relation to resolve for instance input placeholder relation values.
236 'inlineChildChildUid' => null,
237 // Inline scenario: A localized parent record is handled and localizationMode is set to "select", so inline
238 // parents can have localized childen. This value is set to TRUE if this array represents a default language
239 // child record that was not yet localized.
240 'isInlineDefaultLanguageRecordInLocalizedParentContext' => false,
241 // If set, inline children will be resolved. This is set to FALSE in inline ajax context where new children
242 // are created and existing children don't matter much.
243 'inlineResolveExistingChildren' => true,
244 // @todo - for input placeholder inline to suppress an infinite loop, this *may* become obsolete if
245 // @todo compilation of certain fields is possible
246 'inlineCompileExistingChildren' => true,
247
248 // @todo: keys below must be handled / further defined
249 'elementBaseName' => '',
250 'flexFormFieldIdentifierPrefix' => 'ID',
251 'tabAndInlineStack' => [],
252 'inlineData' => [],
253 'inlineStructure' => [],
254 // This array of fields will be set as hidden-fields instead of rendered normally!
255 // This is used by EditDocumentController to force some field values if set as "overrideVals" in _GP
256 'overrideValues' => [],
257 ];
258 }
259 }