7525ce51de5ae69275cfbc95707781481ca30bc3
[Packages/TYPO3.CMS.git] / typo3 / sysext / backend / Classes / Form / Element / InlineElement.php
1 <?php
2 namespace TYPO3\CMS\Backend\Form\Element;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2006-2013 Oliver Hader <oliver@typo3.org>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the text file GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29
30 use TYPO3\CMS\Backend\Utility\BackendUtility;
31 use TYPO3\CMS\Backend\Utility\IconUtility;
32 use TYPO3\CMS\Core\Database\RelationHandler;
33 use TYPO3\CMS\Core\Utility\GeneralUtility;
34 use TYPO3\CMS\Core\Utility\MathUtility;
35
36 /**
37 * The Inline-Relational-Record-Editing (IRRE) functions as part of the TCEforms.
38 *
39 * @author Oliver Hader <oliver@typo3.org>
40 */
41 class InlineElement {
42
43 const Structure_Separator = '-';
44 const FlexForm_Separator = '---';
45 const FlexForm_Substitute = ':';
46 const Disposal_AttributeName = 'Disposal_AttributeName';
47 const Disposal_AttributeId = 'Disposal_AttributeId';
48 /**
49 * Reference to the calling TCEforms instance
50 *
51 * @var \TYPO3\CMS\Backend\Form\FormEngine
52 * @todo Define visibility
53 */
54 public $fObj;
55
56 // Reference to $fObj->backPath
57 /**
58 * @todo Define visibility
59 */
60 public $backPath;
61
62 // Indicates if a field is rendered upon an AJAX call
63 /**
64 * @todo Define visibility
65 */
66 public $isAjaxCall = FALSE;
67
68 // The structure/hierarchy where working in, e.g. cascading inline tables
69 /**
70 * @todo Define visibility
71 */
72 public $inlineStructure = array();
73
74 // The first call of an inline type appeared on this page (pid of record)
75 /**
76 * @todo Define visibility
77 */
78 public $inlineFirstPid;
79
80 // Keys: form, object -> hold the name/id for each of them
81 /**
82 * @todo Define visibility
83 */
84 public $inlineNames = array();
85
86 // Inline data array used for JSON output
87 /**
88 * @todo Define visibility
89 */
90 public $inlineData = array();
91
92 // Expanded/collapsed states for the current BE user
93 /**
94 * @todo Define visibility
95 */
96 public $inlineView = array();
97
98 // Count the number of inline types used
99 /**
100 * @todo Define visibility
101 */
102 public $inlineCount = 0;
103
104 /**
105 * @todo Define visibility
106 */
107 public $inlineStyles = array();
108
109 // How the $this->fObj->prependFormFieldNames should be set ('data' is default)
110 /**
111 * @todo Define visibility
112 */
113 public $prependNaming = 'data';
114
115 // Reference to $this->fObj->prependFormFieldNames
116 /**
117 * @todo Define visibility
118 */
119 public $prependFormFieldNames;
120
121 // Reference to $this->fObj->prependCmdFieldNames
122 /**
123 * @todo Define visibility
124 */
125 public $prependCmdFieldNames;
126
127 // Array containing instances of hook classes called once for IRRE objects
128 protected $hookObjects = array();
129
130 /**
131 * Initialize
132 *
133 * @param \TYPO3\CMS\Backend\Form\FormEngine $tceForms Reference to an TCEforms instance
134 * @return void
135 * @todo Define visibility
136 */
137 public function init(&$tceForms) {
138 $this->fObj = $tceForms;
139 $this->backPath = &$tceForms->backPath;
140 $this->prependFormFieldNames = &$this->fObj->prependFormFieldNames;
141 $this->prependCmdFieldNames = &$this->fObj->prependCmdFieldNames;
142 $this->inlineStyles['margin-right'] = '5';
143 $this->initHookObjects();
144 }
145
146 /**
147 * Initialized the hook objects for this class.
148 * Each hook object has to implement the interface
149 * \TYPO3\CMS\Backend\Form\Element\InlineElementHookInterface
150 *
151 * @return void
152 */
153 protected function initHookObjects() {
154 $this->hookObjects = array();
155 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tceforms_inline.php']['tceformsInlineHook'])) {
156 $tceformsInlineHook = &$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_tceforms_inline.php']['tceformsInlineHook'];
157 if (is_array($tceformsInlineHook)) {
158 foreach ($tceformsInlineHook as $classData) {
159 $processObject = GeneralUtility::getUserObj($classData);
160 if (!$processObject instanceof \TYPO3\CMS\Backend\Form\Element\InlineElementHookInterface) {
161 throw new \UnexpectedValueException('$processObject must implement interface TYPO3\\CMS\\Backend\\Form\\Element\\InlineElementHookInterface', 1202072000);
162 }
163 $processObject->init($this);
164 $this->hookObjects[] = $processObject;
165 }
166 }
167 }
168 }
169
170 /**
171 * Generation of TCEform elements of the type "inline"
172 * This will render inline-relational-record sets. Relations.
173 *
174 * @param string $table The table name of the record
175 * @param string $field The field name which this element is supposed to edit
176 * @param array $row The record data array where the value(s) for the field can be found
177 * @param array $PA An array with additional configuration options.
178 * @return string The HTML code for the TCEform field
179 * @todo Define visibility
180 */
181 public function getSingleField_typeInline($table, $field, $row, &$PA) {
182 // Check the TCA configuration - if FALSE is returned, something was wrong
183 if ($this->checkConfiguration($PA['fieldConf']['config']) === FALSE) {
184 return FALSE;
185 }
186 $item = '';
187 // Count the number of processed inline elements
188 $this->inlineCount++;
189 // Init:
190 $config = $PA['fieldConf']['config'];
191 $foreign_table = $config['foreign_table'];
192 if (BackendUtility::isTableLocalizable($table)) {
193 $language = (int)$row[$GLOBALS['TCA'][$table]['ctrl']['languageField']];
194 }
195 $minitems = MathUtility::forceIntegerInRange($config['minitems'], 0);
196 $maxitems = MathUtility::forceIntegerInRange($config['maxitems'], 0);
197 if (!$maxitems) {
198 $maxitems = 100000;
199 }
200 // Register the required number of elements:
201 $this->fObj->requiredElements[$PA['itemFormElName']] = array($minitems, $maxitems, 'imgName' => $table . '_' . $row['uid'] . '_' . $field);
202 // Remember the page id (pid of record) where inline editing started first
203 // We need that pid for ajax calls, so that they would know where the action takes place on the page structure
204 if (!isset($this->inlineFirstPid)) {
205 // If this record is not new, try to fetch the inlineView states
206 // @TODO: Add checking/cleaning for unused tables, records, etc. to save space in uc-field
207 if (MathUtility::canBeInterpretedAsInteger($row['uid'])) {
208 $inlineView = unserialize($GLOBALS['BE_USER']->uc['inlineView']);
209 $this->inlineView = $inlineView[$table][$row['uid']];
210 }
211 // If the parent is a page, use the uid(!) of the (new?) page as pid for the child records:
212 if ($table == 'pages') {
213 $liveVersionId = BackendUtility::getLiveVersionIdOfRecord('pages', $row['uid']);
214 $this->inlineFirstPid = is_null($liveVersionId) ? $row['uid'] : $liveVersionId;
215 } elseif ($row['pid'] < 0) {
216 $prevRec = BackendUtility::getRecord($table, abs($row['pid']));
217 $this->inlineFirstPid = $prevRec['pid'];
218 } else {
219 $this->inlineFirstPid = $row['pid'];
220 }
221 }
222 // Add the current inline job to the structure stack
223 $this->pushStructure($table, $row['uid'], $field, $config, $PA);
224 // e.g. data[<table>][<uid>][<field>]
225 $nameForm = $this->inlineNames['form'];
226 // e.g. data-<pid>-<table1>-<uid1>-<field1>-<table2>-<uid2>-<field2>
227 $nameObject = $this->inlineNames['object'];
228 // Get the records related to this inline record
229 $relatedRecords = $this->getRelatedRecords($table, $field, $row, $PA, $config);
230 // Set the first and last record to the config array
231 $relatedRecordsUids = array_keys($relatedRecords['records']);
232 $config['inline']['first'] = reset($relatedRecordsUids);
233 $config['inline']['last'] = end($relatedRecordsUids);
234 // Tell the browser what we have (using JSON later):
235 $top = $this->getStructureLevel(0);
236 $this->inlineData['config'][$nameObject] = array(
237 'table' => $foreign_table,
238 'md5' => md5($nameObject)
239 );
240 $this->inlineData['config'][$nameObject . self::Structure_Separator . $foreign_table] = array(
241 'min' => $minitems,
242 'max' => $maxitems,
243 'sortable' => $config['appearance']['useSortable'],
244 'top' => array(
245 'table' => $top['table'],
246 'uid' => $top['uid']
247 ),
248 'context' => array(
249 'config' => $config,
250 'hmac' => GeneralUtility::hmac(serialize($config)),
251 ),
252 );
253 // Set a hint for nested IRRE and tab elements:
254 $this->inlineData['nested'][$nameObject] = $this->fObj->getDynNestedStack(FALSE, $this->isAjaxCall);
255 // If relations are required to be unique, get the uids that have already been used on the foreign side of the relation
256 if ($config['foreign_unique']) {
257 // If uniqueness *and* selector are set, they should point to the same field - so, get the configuration of one:
258 $selConfig = $this->getPossibleRecordsSelectorConfig($config, $config['foreign_unique']);
259 // Get the used unique ids:
260 $uniqueIds = $this->getUniqueIds($relatedRecords['records'], $config, $selConfig['type'] == 'groupdb');
261 $possibleRecords = $this->getPossibleRecords($table, $field, $row, $config, 'foreign_unique');
262 $uniqueMax = $config['appearance']['useCombination'] || $possibleRecords === FALSE ? -1 : count($possibleRecords);
263 $this->inlineData['unique'][$nameObject . self::Structure_Separator . $foreign_table] = array(
264 'max' => $uniqueMax,
265 'used' => $uniqueIds,
266 'type' => $selConfig['type'],
267 'table' => $config['foreign_table'],
268 'elTable' => $selConfig['table'],
269 // element/record table (one step down in hierarchy)
270 'field' => $config['foreign_unique'],
271 'selector' => $selConfig['selector'],
272 'possible' => $this->getPossibleRecordsFlat($possibleRecords)
273 );
274 }
275 // If it's required to select from possible child records (reusable children), add a selector box
276 if ($config['foreign_selector'] && $config['appearance']['showPossibleRecordsSelector'] !== FALSE) {
277 // If not already set by the foreign_unique, set the possibleRecords here and the uniqueIds to an empty array
278 if (!$config['foreign_unique']) {
279 $possibleRecords = $this->getPossibleRecords($table, $field, $row, $config);
280 $uniqueIds = array();
281 }
282 $selectorBox = $this->renderPossibleRecordsSelector($possibleRecords, $config, $uniqueIds);
283 $item .= $selectorBox;
284 }
285 // Wrap all inline fields of a record with a <div> (like a container)
286 $item .= '<div id="' . $nameObject . '">';
287 // Define how to show the "Create new record" link - if there are more than maxitems, hide it
288 if ($relatedRecords['count'] >= $maxitems || $uniqueMax > 0 && $relatedRecords['count'] >= $uniqueMax) {
289 $config['inline']['inlineNewButtonStyle'] = 'display: none;';
290 }
291 // Render the level links (create new record, localize all, synchronize):
292 if ($config['appearance']['levelLinksPosition'] != 'none') {
293 $levelLinks = $this->getLevelInteractionLink('newRecord', $nameObject . self::Structure_Separator . $foreign_table, $config);
294 if ($language > 0 && $row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']] > 0) {
295 // Add the "Localize all records" link before all child records:
296 if (isset($config['appearance']['showAllLocalizationLink']) && $config['appearance']['showAllLocalizationLink']) {
297 $levelLinks .= ' ' . $this->getLevelInteractionLink('localize', $nameObject . self::Structure_Separator . $foreign_table, $config);
298 }
299 // Add the "Synchronize with default language" link before all child records:
300 if (isset($config['appearance']['showSynchronizationLink']) && $config['appearance']['showSynchronizationLink']) {
301 $levelLinks .= ' ' . $this->getLevelInteractionLink('synchronize', $nameObject . self::Structure_Separator . $foreign_table, $config);
302 }
303 }
304 }
305 // Add the level links before all child records:
306 if (in_array($config['appearance']['levelLinksPosition'], array('both', 'top'))) {
307 $item .= $levelLinks;
308 }
309 $item .= '<div id="' . $nameObject . '_records">';
310 $relationList = array();
311 if (count($relatedRecords['records'])) {
312 foreach ($relatedRecords['records'] as $rec) {
313 $item .= $this->renderForeignRecord($row['uid'], $rec, $config);
314 if (!isset($rec['__virtual']) || !$rec['__virtual']) {
315 $relationList[] = $rec['uid'];
316 }
317 }
318 }
319 $item .= '</div>';
320 // Add the level links after all child records:
321 if (in_array($config['appearance']['levelLinksPosition'], array('both', 'bottom'))) {
322 $item .= $levelLinks;
323 }
324 if (is_array($config['customControls'])) {
325 $item .= '<div id="' . $nameObject . '_customControls">';
326 foreach ($config['customControls'] as $customControlConfig) {
327 $parameters = array(
328 'table' => $table,
329 'field' => $field,
330 'row' => $row,
331 'nameObject' => $nameObject,
332 'nameForm' => $nameForm,
333 'config' => $config
334 );
335 $item .= GeneralUtility::callUserFunction($customControlConfig, $parameters, $this);
336 }
337 $item .= '</div>';
338 }
339 // Add Drag&Drop functions for sorting to TCEforms::$additionalJS_post
340 if (count($relationList) > 1 && $config['appearance']['useSortable']) {
341 $this->addJavaScriptSortable($nameObject . '_records');
342 }
343 // Publish the uids of the child records in the given order to the browser
344 $item .= '<input type="hidden" name="' . $nameForm . '" value="' . implode(',', $relationList) . '" class="inlineRecord" />';
345 // Close the wrap for all inline fields (container)
346 $item .= '</div>';
347 // On finishing this section, remove the last item from the structure stack
348 $this->popStructure();
349 // If this was the first call to the inline type, restore the values
350 if (!$this->getStructureDepth()) {
351 unset($this->inlineFirstPid);
352 }
353 return $item;
354 }
355
356 /*******************************************************
357 *
358 * Regular rendering of forms, fields, etc.
359 *
360 *******************************************************/
361 /**
362 * Render the form-fields of a related (foreign) record.
363 *
364 * @param string $parentUid The uid of the parent (embedding) record (uid or NEW...)
365 * @param array $rec The table record of the child/embedded table (normaly post-processed by \TYPO3\CMS\Backend\Form\DataPreprocessor)
366 * @param array $config Content of $PA['fieldConf']['config']
367 * @return string The HTML code for this "foreign record
368 * @todo Define visibility
369 */
370 public function renderForeignRecord($parentUid, $rec, $config = array()) {
371 $foreign_table = $config['foreign_table'];
372 $foreign_field = $config['foreign_field'];
373 $foreign_selector = $config['foreign_selector'];
374 // Register default localization content:
375 $parent = $this->getStructureLevel(-1);
376 if (isset($parent['localizationMode']) && $parent['localizationMode'] != FALSE) {
377 $this->fObj->registerDefaultLanguageData($foreign_table, $rec);
378 }
379 // Send a mapping information to the browser via JSON:
380 // e.g. data[<curTable>][<curId>][<curField>] => data-<pid>-<parentTable>-<parentId>-<parentField>-<curTable>-<curId>-<curField>
381 $this->inlineData['map'][$this->inlineNames['form']] = $this->inlineNames['object'];
382 // Set this variable if we handle a brand new unsaved record:
383 $isNewRecord = !MathUtility::canBeInterpretedAsInteger($rec['uid']);
384 // Set this variable if the record is virtual and only show with header and not editable fields:
385 $isVirtualRecord = isset($rec['__virtual']) && $rec['__virtual'];
386 // If there is a selector field, normalize it:
387 if ($foreign_selector) {
388 $rec[$foreign_selector] = $this->normalizeUid($rec[$foreign_selector]);
389 }
390 if (!$this->checkAccess(($isNewRecord ? 'new' : 'edit'), $foreign_table, $rec['uid'])) {
391 return FALSE;
392 }
393 // Get the current naming scheme for DOM name/id attributes:
394 $nameObject = $this->inlineNames['object'];
395 $appendFormFieldNames = '[' . $foreign_table . '][' . $rec['uid'] . ']';
396 $objectId = $nameObject . self::Structure_Separator . $foreign_table . self::Structure_Separator . $rec['uid'];
397 // Put the current level also to the dynNestedStack of TCEforms:
398 $this->fObj->pushToDynNestedStack('inline', $objectId);
399 $class = '';
400 if (!$isVirtualRecord) {
401 // Get configuration:
402 $collapseAll = isset($config['appearance']['collapseAll']) && $config['appearance']['collapseAll'];
403 $expandAll = isset($config['appearance']['collapseAll']) && !$config['appearance']['collapseAll'];
404 $ajaxLoad = isset($config['appearance']['ajaxLoad']) && !$config['appearance']['ajaxLoad'] ? FALSE : TRUE;
405 if ($isNewRecord) {
406 // Show this record expanded or collapsed
407 $isExpanded = $expandAll || (!$collapseAll ? 1 : 0);
408 } else {
409 $isExpanded = $config['renderFieldsOnly'] || !$collapseAll && $this->getExpandedCollapsedState($foreign_table, $rec['uid']) || $expandAll;
410 }
411 // Render full content ONLY IF this is a AJAX-request, a new record, the record is not collapsed or AJAX-loading is explicitly turned off
412 if ($isNewRecord || $isExpanded || !$ajaxLoad) {
413 $combination = $this->renderCombinationTable($rec, $appendFormFieldNames, $config);
414 $overruleTypesArray = isset($config['foreign_types']) ? $config['foreign_types'] : array();
415 $fields = $this->renderMainFields($foreign_table, $rec, $overruleTypesArray);
416 $fields = $this->wrapFormsSection($fields);
417 // Replace returnUrl in Wizard-Code, if this is an AJAX call
418 $ajaxArguments = GeneralUtility::_GP('ajax');
419 if (isset($ajaxArguments[2]) && trim($ajaxArguments[2]) != '') {
420 $fields = str_replace('P[returnUrl]=%2F' . rawurlencode(TYPO3_mainDir) . 'ajax.php', 'P[returnUrl]=' . rawurlencode($ajaxArguments[2]), $fields);
421 }
422 } else {
423 $combination = '';
424 // This string is the marker for the JS-function to check if the full content has already been loaded
425 $fields = '<!--notloaded-->';
426 }
427 if ($isNewRecord) {
428 // Get the top parent table
429 $top = $this->getStructureLevel(0);
430 $ucFieldName = 'uc[inlineView][' . $top['table'] . '][' . $top['uid'] . ']' . $appendFormFieldNames;
431 // Set additional fields for processing for saving
432 $fields .= '<input type="hidden" name="' . $this->prependFormFieldNames . $appendFormFieldNames . '[pid]" value="' . $rec['pid'] . '"/>';
433 $fields .= '<input type="hidden" name="' . $ucFieldName . '" value="' . $isExpanded . '" />';
434 } else {
435 // Set additional field for processing for saving
436 $fields .= '<input type="hidden" name="' . $this->prependCmdFieldNames . $appendFormFieldNames . '[delete]" value="1" disabled="disabled" />';
437 if (!$isExpanded
438 && !empty($GLOBALS['TCA'][$foreign_table]['ctrl']['enablecolumns']['disabled'])
439 && $ajaxLoad
440 ) {
441 $checked = !empty($rec['hidden']) ? ' checked="checked"' : '';
442 $fields .= '<input type="checkbox" name="' . $this->prependFormFieldNames . $appendFormFieldNames . '[hidden]_0" value="1"' . $checked . ' />';
443 $fields .= '<input type="input" name="' . $this->prependFormFieldNames . $appendFormFieldNames . '[hidden]" value="' . $rec['hidden'] . '" />';
444 }
445 }
446 // If this record should be shown collapsed
447 if (!$isExpanded) {
448 $class = 't3-form-field-container-inline-collapsed';
449 }
450 }
451 if ($config['renderFieldsOnly']) {
452 $out = $fields . $combination;
453 } else {
454 // Set the record container with data for output
455 if ($isVirtualRecord) {
456 $class .= ' t3-form-field-container-inline-placeHolder';
457 }
458 if (isset($rec['hidden']) && (int)$rec['hidden']) {
459 $class .= ' t3-form-field-container-inline-hidden';
460 }
461 $out = '<div class="t3-form-field-record-inline" id="' . $objectId . '_fields" data-expandSingle="' . ($config['appearance']['expandSingle'] ? 1 : 0) . '" data-returnURL="' . htmlspecialchars(GeneralUtility::getIndpEnv('REQUEST_URI')) . '">' . $fields . $combination . '</div>';
462 $header = IconUtility::getSpriteIcon('apps-irre-' . ($class != '' ? 'collapsed' : 'expanded'));
463 $header .= $this->renderForeignRecordHeader($parentUid, $foreign_table, $rec, $config, $isVirtualRecord);
464 $out = '<div class="t3-form-field-header-inline" id="' . $objectId . '_header">' . $header . '</div>' . $out;
465 // Wrap the header, fields and combination part of a child record with a div container
466 $classMSIE = $this->fObj->clientInfo['BROWSER'] == 'msie' && $this->fObj->clientInfo['VERSION'] < 8 ? 'MSIE' : '';
467 $class .= ' inlineDiv' . $classMSIE . ($isNewRecord ? ' inlineIsNewRecord' : '');
468 $out = '<div id="' . $objectId . '_div" class="t3-form-field-container-inline ' . trim($class) . '">' . $out . '</div>';
469 }
470 // Remove the current level also from the dynNestedStack of TCEforms:
471 $this->fObj->popFromDynNestedStack();
472 return $out;
473 }
474
475 /**
476 * Wrapper for TCEforms::getMainFields().
477 *
478 * @param string $table The table name
479 * @param array $row The record to be rendered
480 * @param array $overruleTypesArray Overrule TCA [types] array, e.g to overrride [showitem] configuration of a particular type
481 * @return string The rendered form
482 */
483 protected function renderMainFields($table, array $row, array $overruleTypesArray = array()) {
484 // The current render depth of \TYPO3\CMS\Backend\Form\FormEngine
485 $depth = $this->fObj->renderDepth;
486 // If there is some information about already rendered palettes of our parent, store this info:
487 if (isset($this->fObj->palettesRendered[$depth][$table])) {
488 $palettesRendered = $this->fObj->palettesRendered[$depth][$table];
489 }
490 // Render the form:
491 $content = $this->fObj->getMainFields($table, $row, $depth, $overruleTypesArray);
492 // If there was some info about rendered palettes stored, write it back for our parent:
493 if (isset($palettesRendered)) {
494 $this->fObj->palettesRendered[$depth][$table] = $palettesRendered;
495 }
496 return $content;
497 }
498
499 /**
500 * Renders the HTML header for a foreign record, such as the title, toggle-function, drag'n'drop, etc.
501 * Later on the command-icons are inserted here.
502 *
503 * @param string $parentUid The uid of the parent (embedding) record (uid or NEW...)
504 * @param string $foreign_table The foreign_table we create a header for
505 * @param array $rec The current record of that foreign_table
506 * @param array $config content of $PA['fieldConf']['config']
507 * @param boolean $isVirtualRecord
508 * @return string The HTML code of the header
509 * @todo Define visibility
510 */
511 public function renderForeignRecordHeader($parentUid, $foreign_table, $rec, $config, $isVirtualRecord = FALSE) {
512 // Init:
513 $objectId = $this->inlineNames['object'] . self::Structure_Separator . $foreign_table . self::Structure_Separator . $rec['uid'];
514 // We need the returnUrl of the main script when loading the fields via AJAX-call (to correct wizard code, so include it as 3rd parameter)
515 // Pre-Processing:
516 $isOnSymmetricSide = RelationHandler::isOnSymmetricSide($parentUid, $config, $rec);
517 $hasForeignLabel = !$isOnSymmetricSide && $config['foreign_label'] ? TRUE : FALSE;
518 $hasSymmetricLabel = $isOnSymmetricSide && $config['symmetric_label'] ? TRUE : FALSE;
519
520 // Get the record title/label for a record:
521 // Try using a self-defined user function only for formatted labels
522 if (isset($GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc'])) {
523 $params = array(
524 'table' => $foreign_table,
525 'row' => $rec,
526 'title' => '',
527 'isOnSymmetricSide' => $isOnSymmetricSide,
528 'options' => isset($GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc_options'])
529 ? $GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc_options']
530 : array(),
531 'parent' => array(
532 'uid' => $parentUid,
533 'config' => $config
534 )
535 );
536 // callUserFunction requires a third parameter, but we don't want to give $this as reference!
537 $null = NULL;
538 GeneralUtility::callUserFunction($GLOBALS['TCA'][$foreign_table]['ctrl']['formattedLabel_userFunc'], $params, $null);
539 $recTitle = $params['title'];
540
541 // Try using a normal self-defined user function
542 } elseif (isset($GLOBALS['TCA'][$foreign_table]['ctrl']['label_userFunc'])) {
543 $params = array(
544 'table' => $foreign_table,
545 'row' => $rec,
546 'title' => '',
547 'isOnSymmetricSide' => $isOnSymmetricSide,
548 'parent' => array(
549 'uid' => $parentUid,
550 'config' => $config
551 )
552 );
553 // callUserFunction requires a third parameter, but we don't want to give $this as reference!
554 $null = NULL;
555 GeneralUtility::callUserFunction($GLOBALS['TCA'][$foreign_table]['ctrl']['label_userFunc'], $params, $null);
556 $recTitle = $params['title'];
557 } elseif ($hasForeignLabel || $hasSymmetricLabel) {
558 $titleCol = $hasForeignLabel ? $config['foreign_label'] : $config['symmetric_label'];
559 $foreignConfig = $this->getPossibleRecordsSelectorConfig($config, $titleCol);
560 // Render title for everything else than group/db:
561 if ($foreignConfig['type'] != 'groupdb') {
562 $recTitle = BackendUtility::getProcessedValueExtra($foreign_table, $titleCol, $rec[$titleCol], 0, 0, FALSE);
563 } else {
564 // $recTitle could be something like: "tx_table_123|...",
565 $valueParts = GeneralUtility::trimExplode('|', $rec[$titleCol]);
566 $itemParts = GeneralUtility::revExplode('_', $valueParts[0], 2);
567 $recTemp = BackendUtility::getRecordWSOL($itemParts[0], $itemParts[1]);
568 $recTitle = BackendUtility::getRecordTitle($itemParts[0], $recTemp, FALSE);
569 }
570 $recTitle = BackendUtility::getRecordTitlePrep($recTitle);
571 if (trim($recTitle) === '') {
572 $recTitle = BackendUtility::getNoRecordTitle(TRUE);
573 }
574 } else {
575 $recTitle = BackendUtility::getRecordTitle($foreign_table, $rec, TRUE);
576 }
577
578 $altText = BackendUtility::getRecordIconAltText($rec, $foreign_table);
579 $iconImg = IconUtility::getSpriteIconForRecord($foreign_table, $rec, array('title' => htmlspecialchars($altText), 'id' => $objectId . '_icon'));
580 $label = '<span id="' . $objectId . '_label">' . $recTitle . '</span>';
581 $ctrl = $this->renderForeignRecordHeaderControl($parentUid, $foreign_table, $rec, $config, $isVirtualRecord);
582 $thumbnail = FALSE;
583
584 // Renders a thumbnail for the header
585 if (!empty($config['appearance']['headerThumbnail']['field'])) {
586 $fieldValue = $rec[$config['appearance']['headerThumbnail']['field']];
587 $firstElement = array_shift(GeneralUtility::trimExplode(',', $fieldValue));
588 $fileUid = array_pop(BackendUtility::splitTable_Uid($firstElement));
589
590 if (!empty($fileUid)) {
591 $fileObject = \TYPO3\CMS\Core\Resource\ResourceFactory::getInstance()->getFileObject($fileUid);
592 if ($fileObject && $fileObject->isMissing()) {
593 $flashMessage = \TYPO3\CMS\Core\Resource\Utility\BackendUtility::getFlashMessageForMissingFile($fileObject);
594 $thumbnail = $flashMessage->render();
595 } elseif($fileObject) {
596 $imageSetup = $config['appearance']['headerThumbnail'];
597 unset($imageSetup['field']);
598 $imageSetup = array_merge(array('width' => '45', 'height' => '45c'), $imageSetup);
599 $imageUrl = $fileObject->process(\TYPO3\CMS\Core\Resource\ProcessedFile::CONTEXT_IMAGECROPSCALEMASK, $imageSetup)->getPublicUrl(TRUE);
600 $thumbnail = '<img class="t3-form-field-header-inline-thumbnail-image" src="' . $imageUrl . '" alt="' . htmlspecialchars($recTitle) . '">';
601 }
602 }
603 }
604
605 if (!empty($config['appearance']['headerThumbnail']['field']) && $thumbnail) {
606 $headerClasses = ' t3-form-field-header-inline-has-thumbnail';
607 $mediaContainer = '<div class="t3-form-field-header-inline-thumbnail" id="' . $objectId . '_thumbnailcontainer">' . $thumbnail . '</div>';
608 } else {
609 $headerClasses = ' t3-form-field-header-inline-has-icon';
610 $mediaContainer = '<div class="t3-form-field-header-inline-icon" id="' . $objectId . '_iconcontainer">' . $iconImg . '</div>';
611 }
612
613 $header = '<div class="t3-form-field-header-inline-wrap' . $headerClasses . '">'
614 . '<div class="t3-form-field-header-inline-ctrl">' . $ctrl . '</div>'
615 . '<div class="t3-form-field-header-inline-body">'
616 . $mediaContainer
617 . '<div class="t3-form-field-header-inline-summary">' . $label . '</div>'
618 . '</div>'
619 . '</div>';
620
621 return $header;
622 }
623
624 /**
625 * Render the control-icons for a record header (create new, sorting, delete, disable/enable).
626 * Most of the parts are copy&paste from TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList and
627 * modified for the JavaScript calls here
628 *
629 * @param string $parentUid The uid of the parent (embedding) record (uid or NEW...)
630 * @param string $foreign_table The table (foreign_table) we create control-icons for
631 * @param array $rec The current record of that foreign_table
632 * @param array $config (modified) TCA configuration of the field
633 * @return string The HTML code with the control-icons
634 * @todo Define visibility
635 */
636 public function renderForeignRecordHeaderControl($parentUid, $foreign_table, $rec, $config = array(), $isVirtualRecord = FALSE) {
637 // Initialize:
638 $cells = array();
639 $isNewItem = substr($rec['uid'], 0, 3) == 'NEW';
640 $tcaTableCtrl = &$GLOBALS['TCA'][$foreign_table]['ctrl'];
641 $tcaTableCols = &$GLOBALS['TCA'][$foreign_table]['columns'];
642 $isPagesTable = $foreign_table == 'pages' ? TRUE : FALSE;
643 $isOnSymmetricSide = RelationHandler::isOnSymmetricSide($parentUid, $config, $rec);
644 $enableManualSorting = $tcaTableCtrl['sortby'] || $config['MM'] || !$isOnSymmetricSide && $config['foreign_sortby'] || $isOnSymmetricSide && $config['symmetric_sortby'] ? TRUE : FALSE;
645 $nameObject = $this->inlineNames['object'];
646 $nameObjectFt = $nameObject . self::Structure_Separator . $foreign_table;
647 $nameObjectFtId = $nameObjectFt . self::Structure_Separator . $rec['uid'];
648 $calcPerms = $GLOBALS['BE_USER']->calcPerms(BackendUtility::readPageAccess($rec['pid'], $GLOBALS['BE_USER']->getPagePermsClause(1)));
649 // If the listed table is 'pages' we have to request the permission settings for each page:
650 if ($isPagesTable) {
651 $localCalcPerms = $GLOBALS['BE_USER']->calcPerms(BackendUtility::getRecord('pages', $rec['uid']));
652 }
653 // This expresses the edit permissions for this particular element:
654 $permsEdit = $isPagesTable && $localCalcPerms & 2 || !$isPagesTable && $calcPerms & 16;
655 // Controls: Defines which controls should be shown
656 $enabledControls = $config['appearance']['enabledControls'];
657 // Hook: Can disable/enable single controls for specific child records:
658 foreach ($this->hookObjects as $hookObj) {
659 $hookObj->renderForeignRecordHeaderControl_preProcess($parentUid, $foreign_table, $rec, $config, $isVirtualRecord, $enabledControls);
660 }
661 // Icon to visualize that a required field is nested in this inline level:
662 $cells['required'] = '<img name="' . $nameObjectFtId . '_req" src="clear.gif" width="10" height="10" hspace="4" vspace="3" alt="" />';
663 if (isset($rec['__create'])) {
664 $cells['localize.isLocalizable'] = IconUtility::getSpriteIcon('actions-edit-localize-status-low', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:localize.isLocalizable', TRUE)));
665 } elseif (isset($rec['__remove'])) {
666 $cells['localize.wasRemovedInOriginal'] = IconUtility::getSpriteIcon('actions-edit-localize-status-high', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:localize.wasRemovedInOriginal', TRUE)));
667 }
668 // "Info": (All records)
669 if ($enabledControls['info'] && !$isNewItem) {
670 $cells['info'] = '<a href="#" onclick="' . htmlspecialchars(('top.launchView(\'' . $foreign_table . '\', \'' . $rec['uid'] . '\'); return false;')) . '">' . IconUtility::getSpriteIcon('status-dialog-information', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:showInfo', TRUE))) . '</a>';
671 }
672 // If the table is NOT a read-only table, then show these links:
673 if (!$tcaTableCtrl['readOnly'] && !$isVirtualRecord) {
674 // "New record after" link (ONLY if the records in the table are sorted by a "sortby"-row or if default values can depend on previous record):
675 if ($enabledControls['new'] && ($enableManualSorting || $tcaTableCtrl['useColumnsForDefaultValues'])) {
676 if (!$isPagesTable && $calcPerms & 16 || $isPagesTable && $calcPerms & 8) {
677 $onClick = 'return inline.createNewRecord(\'' . $nameObjectFt . '\',\'' . $rec['uid'] . '\')';
678 $class = ' class="inlineNewButton ' . $this->inlineData['config'][$nameObject]['md5'] . '"';
679 if ($config['inline']['inlineNewButtonStyle']) {
680 $style = ' style="' . $config['inline']['inlineNewButtonStyle'] . '"';
681 }
682 $cells['new'] = '<a href="#" onclick="' . htmlspecialchars($onClick) . '"' . $class . $style . '>' . IconUtility::getSpriteIcon(('actions-' . ($isPagesTable ? 'page' : 'document') . '-new'), array(
683 'title' => $GLOBALS['LANG']->sL(('LLL:EXT:lang/locallang_mod_web_list.xlf:new' . ($isPagesTable ? 'Page' : 'Record')), TRUE)
684 )) . '</a>';
685 }
686 }
687 // "Up/Down" links
688 if ($enabledControls['sort'] && $permsEdit && $enableManualSorting) {
689 $onClick = 'return inline.changeSorting(\'' . $nameObjectFtId . '\', \'1\')';
690 // Up
691 $style = $config['inline']['first'] == $rec['uid'] ? 'style="visibility: hidden;"' : '';
692 $cells['sort.up'] = '<a href="#" onclick="' . htmlspecialchars($onClick) . '" class="sortingUp" ' . $style . '>' . IconUtility::getSpriteIcon('actions-move-up', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:moveUp', TRUE))) . '</a>';
693 $onClick = 'return inline.changeSorting(\'' . $nameObjectFtId . '\', \'-1\')';
694 // Down
695 $style = $config['inline']['last'] == $rec['uid'] ? 'style="visibility: hidden;"' : '';
696 $cells['sort.down'] = '<a href="#" onclick="' . htmlspecialchars($onClick) . '" class="sortingDown" ' . $style . '>' . IconUtility::getSpriteIcon('actions-move-down', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:moveDown', TRUE))) . '</a>';
697 }
698 // "Delete" link:
699 if ($enabledControls['delete'] && ($isPagesTable && $localCalcPerms & 4 || !$isPagesTable && $calcPerms & 16)) {
700 $onClick = 'inline.deleteRecord(\'' . $nameObjectFtId . '\');';
701 $cells['delete'] = '<a href="#" onclick="' . htmlspecialchars(('if (confirm(' . $GLOBALS['LANG']->JScharCode($GLOBALS['LANG']->getLL('deleteWarning')) . ')) { ' . $onClick . ' } return false;')) . '">' . IconUtility::getSpriteIcon('actions-edit-delete', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_mod_web_list.xlf:delete', TRUE))) . '</a>';
702 }
703
704 // "Hide/Unhide" links:
705 $hiddenField = $tcaTableCtrl['enablecolumns']['disabled'];
706 if ($enabledControls['hide'] && $permsEdit && $hiddenField && $tcaTableCols[$hiddenField] && (!$tcaTableCols[$hiddenField]['exclude'] || $GLOBALS['BE_USER']->check('non_exclude_fields', $foreign_table . ':' . $hiddenField))) {
707 $onClick = 'return inline.enableDisableRecord(\'' . $nameObjectFtId . '\')';
708 if ($rec[$hiddenField]) {
709 $cells['hide.unhide'] = '<a href="#" class="hiddenHandle" onclick="' . htmlspecialchars($onClick) . '">' . IconUtility::getSpriteIcon('actions-edit-unhide', array(
710 'title' => $GLOBALS['LANG']->sL(('LLL:EXT:lang/locallang_mod_web_list.xlf:unHide' . ($isPagesTable ? 'Page' : '')), TRUE),
711 'id' => ($nameObjectFtId . '_disabled')
712 )) . '</a>';
713 } else {
714 $cells['hide.hide'] = '<a href="#" class="hiddenHandle" onclick="' . htmlspecialchars($onClick) . '">' . IconUtility::getSpriteIcon('actions-edit-hide', array(
715 'title' => $GLOBALS['LANG']->sL(('LLL:EXT:lang/locallang_mod_web_list.xlf:hide' . ($isPagesTable ? 'Page' : '')), TRUE),
716 'id' => ($nameObjectFtId . '_disabled')
717 )) . '</a>';
718 }
719 }
720 // Drag&Drop Sorting: Sortable handler for script.aculo.us
721 if ($enabledControls['dragdrop'] && $permsEdit && $enableManualSorting && $config['appearance']['useSortable']) {
722 $cells['dragdrop'] = IconUtility::getSpriteIcon('actions-move-move', array('data-id' => $rec['uid'], 'class' => 'sortableHandle', 'title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:labels.move', TRUE)));
723 }
724 } elseif ($isVirtualRecord) {
725 if ($enabledControls['localize'] && isset($rec['__create'])) {
726 $onClick = 'inline.synchronizeLocalizeRecords(\'' . $nameObjectFt . '\', ' . $rec['uid'] . ');';
727 $cells['localize'] = '<a href="#" onclick="' . htmlspecialchars($onClick) . '">' . IconUtility::getSpriteIcon('actions-document-localize', array('title' => $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:localize', TRUE))) . '</a>';
728 }
729 }
730 // If the record is edit-locked by another user, we will show a little warning sign:
731 if ($lockInfo = BackendUtility::isRecordLocked($foreign_table, $rec['uid'])) {
732 $cells['locked'] = '<a href="#" onclick="' . htmlspecialchars(('alert(' . $GLOBALS['LANG']->JScharCode($lockInfo['msg']) . ');return false;')) . '">' . IconUtility::getSpriteIcon('status-warning-in-use', array('title' => htmlspecialchars($lockInfo['msg']))) . '</a>';
733 }
734 // Hook: Post-processing of single controls for specific child records:
735 foreach ($this->hookObjects as $hookObj) {
736 $hookObj->renderForeignRecordHeaderControl_postProcess($parentUid, $foreign_table, $rec, $config, $isVirtualRecord, $cells);
737 }
738 return '<!-- CONTROL PANEL: ' . $foreign_table . ':' . $rec['uid'] . ' -->' . implode('', $cells);
739 }
740
741 /**
742 * Render a table with TCEforms, that occurs on a intermediate table but should be editable directly,
743 * so two tables are combined (the intermediate table with attributes and the sub-embedded table).
744 * -> This is a direct embedding over two levels!
745 *
746 * @param array $rec The table record of the child/embedded table (normaly post-processed by \TYPO3\CMS\Backend\Form\DataPreprocessor)
747 * @param string $appendFormFieldNames The [<table>][<uid>] of the parent record (the intermediate table)
748 * @param array $config content of $PA['fieldConf']['config']
749 * @return string A HTML string with <table> tag around.
750 * @todo Define visibility
751 */
752 public function renderCombinationTable(&$rec, $appendFormFieldNames, $config = array()) {
753 $foreign_table = $config['foreign_table'];
754 $foreign_selector = $config['foreign_selector'];
755 if ($foreign_selector && $config['appearance']['useCombination']) {
756 $comboConfig = $GLOBALS['TCA'][$foreign_table]['columns'][$foreign_selector]['config'];
757 $comboRecord = array();
758 // If record does already exist, load it:
759 if ($rec[$foreign_selector] && MathUtility::canBeInterpretedAsInteger($rec[$foreign_selector])) {
760 $comboRecord = $this->getRecord($this->inlineFirstPid, $comboConfig['foreign_table'], $rec[$foreign_selector]);
761 $isNewRecord = FALSE;
762 } else {
763 $comboRecord = $this->getNewRecord($this->inlineFirstPid, $comboConfig['foreign_table']);
764 $isNewRecord = TRUE;
765 }
766 // Get the TCEforms interpretation of the TCA of the child table
767 $out = $this->renderMainFields($comboConfig['foreign_table'], $comboRecord);
768 $out = $this->wrapFormsSection($out, array(), array('class' => 'wrapperAttention'));
769 // If this is a new record, add a pid value to store this record and the pointer value for the intermediate table
770 if ($isNewRecord) {
771 $comboFormFieldName = $this->prependFormFieldNames . '[' . $comboConfig['foreign_table'] . '][' . $comboRecord['uid'] . '][pid]';
772 $out .= '<input type="hidden" name="' . $comboFormFieldName . '" value="' . $comboRecord['pid'] . '" />';
773 }
774 // If the foreign_selector field is also responsible for uniqueness, tell the browser the uid of the "other" side of the relation
775 if ($isNewRecord || $config['foreign_unique'] == $foreign_selector) {
776 $parentFormFieldName = $this->prependFormFieldNames . $appendFormFieldNames . '[' . $foreign_selector . ']';
777 $out .= '<input type="hidden" name="' . $parentFormFieldName . '" value="' . $comboRecord['uid'] . '" />';
778 }
779 }
780 return $out;
781 }
782
783 /**
784 * Get a selector as used for the select type, to select from all available
785 * records and to create a relation to the embedding record (e.g. like MM).
786 *
787 * @param array $selItems Array of all possible records
788 * @param array $conf TCA configuration of the parent(!) field
789 * @param array $uniqueIds The uids that have already been used and should be unique
790 * @return string A HTML <select> box with all possible records
791 * @todo Define visibility
792 */
793 public function renderPossibleRecordsSelector($selItems, $conf, $uniqueIds = array()) {
794 $foreign_table = $conf['foreign_table'];
795 $foreign_selector = $conf['foreign_selector'];
796 $selConfig = $this->getPossibleRecordsSelectorConfig($conf, $foreign_selector);
797 $config = $selConfig['PA']['fieldConf']['config'];
798 if ($selConfig['type'] == 'select') {
799 $item = $this->renderPossibleRecordsSelectorTypeSelect($selItems, $conf, $selConfig['PA'], $uniqueIds);
800 } elseif ($selConfig['type'] == 'groupdb') {
801 $item = $this->renderPossibleRecordsSelectorTypeGroupDB($conf, $selConfig['PA']);
802 }
803 return $item;
804 }
805
806 /**
807 * Get a selector as used for the select type, to select from all available
808 * records and to create a relation to the embedding record (e.g. like MM).
809 *
810 * @param array $selItems Array of all possible records
811 * @param array $conf TCA configuration of the parent(!) field
812 * @param array $PA An array with additional configuration options
813 * @param array $uniqueIds The uids that have already been used and should be unique
814 * @return string A HTML <select> box with all possible records
815 * @todo Define visibility
816 */
817 public function renderPossibleRecordsSelectorTypeSelect($selItems, $conf, &$PA, $uniqueIds = array()) {
818 $foreign_table = $conf['foreign_table'];
819 $foreign_selector = $conf['foreign_selector'];
820 $PA = array();
821 $PA['fieldConf'] = $GLOBALS['TCA'][$foreign_table]['columns'][$foreign_selector];
822 $PA['fieldConf']['config']['form_type'] = $PA['fieldConf']['config']['form_type'] ?: $PA['fieldConf']['config']['type'];
823 // Using "form_type" locally in this script
824 $PA['fieldTSConfig'] = $this->fObj->setTSconfig($foreign_table, array(), $foreign_selector);
825 $config = $PA['fieldConf']['config'];
826 //TODO: $disabled is not present - should be read from config?
827 $disabled = FALSE;
828 if (!$disabled) {
829 // Create option tags:
830 $opt = array();
831 $styleAttrValue = '';
832 foreach ($selItems as $p) {
833 if ($config['iconsInOptionTags']) {
834 $styleAttrValue = $this->fObj->optionTagStyle($p[2]);
835 }
836 if (!in_array($p[1], $uniqueIds)) {
837 $opt[] = '<option value="' . htmlspecialchars($p[1]) . '"' . ' style="' . (in_array($p[1], $uniqueIds) ? '' : '') . ($styleAttrValue ? ' style="' . htmlspecialchars($styleAttrValue) : '') . '">' . htmlspecialchars($p[0]) . '</option>';
838 }
839 }
840 // Put together the selector box:
841 $selector_itemListStyle = isset($config['itemListStyle']) ? ' style="' . htmlspecialchars($config['itemListStyle']) . '"' : ' style="' . $this->fObj->defaultMultipleSelectorStyle . '"';
842 $size = (int)$conf['size'];
843 $size = $conf['autoSizeMax'] ? MathUtility::forceIntegerInRange(count($selItems) + 1, MathUtility::forceIntegerInRange($size, 1), $conf['autoSizeMax']) : $size;
844 $onChange = 'return inline.importNewRecord(\'' . $this->inlineNames['object'] . self::Structure_Separator . $conf['foreign_table'] . '\')';
845 $item = '
846 <select id="' . $this->inlineNames['object'] . self::Structure_Separator . $conf['foreign_table'] . '_selector"' . $this->fObj->insertDefStyle('select') . ($size ? ' size="' . $size . '"' : '') . ' onchange="' . htmlspecialchars($onChange) . '"' . $PA['onFocus'] . $selector_itemListStyle . ($conf['foreign_unique'] ? ' isunique="isunique"' : '') . '>
847 ' . implode('
848 ', $opt) . '
849 </select>';
850 // Add a "Create new relation" link for adding new relations
851 // This is neccessary, if the size of the selector is "1" or if
852 // there is only one record item in the select-box, that is selected by default
853 // The selector-box creates a new relation on using a onChange event (see some line above)
854 if (!empty($conf['appearance']['createNewRelationLinkTitle'])) {
855 $createNewRelationText = $GLOBALS['LANG']->sL($conf['appearance']['createNewRelationLinkTitle'], TRUE);
856 } else {
857 $createNewRelationText = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:cm.createNewRelation', TRUE);
858 }
859 $item .= ' <a href="#" class="t3-button" onclick="' . htmlspecialchars($onChange) . '" align="abstop">' . IconUtility::getSpriteIcon('actions-document-new', array('title' => $createNewRelationText)) . $createNewRelationText . '</a>';
860 $item = '<div class="t3-form-field-group">' . $item . '</div>';
861 }
862 return $item;
863 }
864
865 /**
866 * Generate a link that opens an element browser in a new window.
867 * For group/db there is no way o use a "selector" like a <select>|</select>-box.
868 *
869 * @param array $conf TCA configuration of the parent(!) field
870 * @param array $PA An array with additional configuration options
871 * @return string A HTML link that opens an element browser in a new window
872 * @todo Define visibility
873 */
874 public function renderPossibleRecordsSelectorTypeGroupDB($conf, &$PA) {
875 $foreign_table = $conf['foreign_table'];
876 $config = $PA['fieldConf']['config'];
877 $allowed = $config['allowed'];
878 $objectPrefix = $this->inlineNames['object'] . self::Structure_Separator . $foreign_table;
879 $mode = 'db';
880 $showUpload = FALSE;
881 if (!empty($conf['appearance']['createNewRelationLinkTitle'])) {
882 $createNewRelationText = $GLOBALS['LANG']->sL($conf['appearance']['createNewRelationLinkTitle'], TRUE);
883 } else {
884 $createNewRelationText = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:cm.createNewRelation', TRUE);
885 }
886 if (is_array($config['appearance'])) {
887 if (isset($config['appearance']['elementBrowserType'])) {
888 $mode = $config['appearance']['elementBrowserType'];
889 }
890 if ($mode === 'file') {
891 $showUpload = TRUE;
892 }
893 if (isset($config['appearance']['fileUploadAllowed'])) {
894 $showUpload = (bool)$config['appearance']['fileUploadAllowed'];
895 }
896 if (isset($config['appearance']['elementBrowserAllowed'])) {
897 $allowed = $config['appearance']['elementBrowserAllowed'];
898 }
899 }
900 $browserParams = '|||' . $allowed . '|' . $objectPrefix . '|inline.checkUniqueElement||inline.importElement';
901 $onClick = 'setFormValueOpenBrowser(\'' . $mode . '\', \'' . $browserParams . '\'); return false;';
902
903 $item = '<a href="#" class="t3-button" onclick="' . htmlspecialchars($onClick) . '">' . IconUtility::getSpriteIcon('actions-insert-record', array('title' => $createNewRelationText)) . $createNewRelationText . '</a>';
904
905 if ($showUpload && $this->fObj->edit_docModuleUpload) {
906 $maxFileSize = GeneralUtility::getMaxUploadFileSize() * 1024;
907 $folder = $folder = $GLOBALS['BE_USER']->getDefaultUploadFolder();
908 $item .= ' <a href="#" class="t3-button t3-drag-uploader"
909 style="display:none"
910 data-dropzone-target="#'.htmlspecialchars($this->inlineNames['object']).'"
911 data-insert-dropzone-before="1"
912 data-file-irre-object="'.htmlspecialchars($objectPrefix).'"
913 data-file-allowed="'.htmlspecialchars($allowed).'"
914 data-target-folder="'.htmlspecialchars($folder->getCombinedIdentifier()).'"
915 data-max-file-size="'.htmlspecialchars($maxFileSize).'"
916 ><span class="t3-icon t3-icon-actions t3-icon-actions-edit t3-icon-edit-upload">&nbsp;</span>';
917 $item .= $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:file_upload.select-and-submit', TRUE);
918 $item .= '</a>';
919
920 $this->loadDragUploadJs();
921 }
922 return $item;
923 }
924
925 /**
926 * Load the required javascript for the DragUploader
927 */
928 protected function loadDragUploadJs() {
929
930 /** @var $pageRenderer \TYPO3\CMS\Core\Page\PageRenderer */
931 $pageRenderer = $GLOBALS['SOBE']->doc->getPageRenderer();
932 $pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/FileListLocalisation');
933 $pageRenderer->loadRequireJsModule('TYPO3/CMS/Backend/DragUploader');
934 $pageRenderer->addInlineLanguagelabelFile(
935 \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('lang') . 'locallang_core.xlf',
936 'file_upload'
937 );
938 }
939
940 /**
941 * Creates the HTML code of a general link to be used on a level of inline children.
942 * The possible keys for the parameter $type are 'newRecord', 'localize' and 'synchronize'.
943 *
944 * @param string $type The link type, values are 'newRecord', 'localize' and 'synchronize'.
945 * @param string $objectPrefix The "path" to the child record to create (e.g. 'data-parentPageId-partenTable-parentUid-parentField-childTable]')
946 * @param array $conf TCA configuration of the parent(!) field
947 * @return string The HTML code of the new link, wrapped in a div
948 */
949 protected function getLevelInteractionLink($type, $objectPrefix, $conf = array()) {
950 $nameObject = $this->inlineNames['object'];
951 $attributes = array();
952 switch ($type) {
953 case 'newRecord':
954 $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:cm.createnew', TRUE);
955 $icon = 'actions-document-new';
956 $className = 'typo3-newRecordLink';
957 $attributes['class'] = 't3-button inlineNewButton ' . $this->inlineData['config'][$nameObject]['md5'];
958 $attributes['onclick'] = 'return inline.createNewRecord(\'' . $objectPrefix . '\')';
959 if (!empty($conf['inline']['inlineNewButtonStyle'])) {
960 $attributes['style'] = $conf['inline']['inlineNewButtonStyle'];
961 }
962 if (!empty($conf['appearance']['newRecordLinkAddTitle'])) {
963 $title = sprintf(
964 $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_core.xlf:cm.createnew.link', TRUE),
965 $GLOBALS['LANG']->sL($GLOBALS['TCA'][$conf['foreign_table']]['ctrl']['title'], TRUE)
966 );
967 } elseif (isset($conf['appearance']['newRecordLinkTitle']) && $conf['appearance']['newRecordLinkTitle'] !== '') {
968 $title = $GLOBALS['LANG']->sL($conf['appearance']['newRecordLinkTitle'], TRUE);
969 }
970 break;
971 case 'localize':
972 $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:localizeAllRecords', 1);
973 $icon = 'actions-document-localize';
974 $className = 'typo3-localizationLink';
975 $attributes['class'] = 't3-button';
976 $attributes['onclick'] = 'return inline.synchronizeLocalizeRecords(\'' . $objectPrefix . '\', \'localize\')';
977 break;
978 case 'synchronize':
979 $title = $GLOBALS['LANG']->sL('LLL:EXT:lang/locallang_misc.xlf:synchronizeWithOriginalLanguage', TRUE);
980 $icon = 'actions-document-synchronize';
981 $className = 'typo3-synchronizationLink';
982 $attributes['class'] = 't3-button inlineNewButton ' . $this->inlineData['config'][$nameObject]['md5'];
983 $attributes['onclick'] = 'return inline.synchronizeLocalizeRecords(\'' . $objectPrefix . '\', \'synchronize\')';
984 break;
985 default:
986 $title = '';
987 $icon = '';
988 $className = '';
989 }
990 // Create the link:
991 $icon = $icon ? IconUtility::getSpriteIcon($icon, array('title' => htmlspecialchars($title))) : '';
992 $link = $this->wrapWithAnchor($icon . $title, '#', $attributes);
993 return '<div' . ($className ? ' class="' . $className . '"' : '') . '>' . $link . '</div>';
994 }
995
996 /**
997 * Add Sortable functionality using script.acolo.us "Sortable".
998 *
999 * @param string $objectId The container id of the object - elements inside will be sortable
1000 * @return void
1001 * @todo Define visibility
1002 */
1003 public function addJavaScriptSortable($objectId) {
1004 $this->fObj->additionalJS_post[] = '
1005 inline.createDragAndDropSorting("' . $objectId . '");
1006 ';
1007 }
1008
1009 /*******************************************************
1010 *
1011 * Handling of AJAX calls
1012 *
1013 *******************************************************/
1014 /**
1015 * General processor for AJAX requests concerning IRRE.
1016 * (called by typo3/ajax.php)
1017 *
1018 * @param array $params Additional parameters (not used here)
1019 * @param \TYPO3\CMS\Core\Http\AjaxRequestHandler $ajaxObj The AjaxRequestHandler object of this request
1020 * @return void
1021 */
1022 public function processAjaxRequest($params, $ajaxObj) {
1023 $ajaxArguments = GeneralUtility::_GP('ajax');
1024 $ajaxIdParts = explode('::', $GLOBALS['ajaxID'], 2);
1025 if (isset($ajaxArguments) && is_array($ajaxArguments) && count($ajaxArguments)) {
1026 $ajaxMethod = $ajaxIdParts[1];
1027 switch ($ajaxMethod) {
1028 case 'createNewRecord':
1029
1030 case 'synchronizeLocalizeRecords':
1031
1032 case 'getRecordDetails':
1033 $this->isAjaxCall = TRUE;
1034 // Construct runtime environment for Inline Relational Record Editing:
1035 $this->processAjaxRequestConstruct($ajaxArguments);
1036 // Parse the DOM identifier (string), add the levels to the structure stack (array) and load the TCA config:
1037 $this->parseStructureString($ajaxArguments[0], TRUE);
1038 $this->injectAjaxConfiguration($ajaxArguments);
1039 // Render content:
1040 $ajaxObj->setContentFormat('jsonbody');
1041 $ajaxObj->setContent(call_user_func_array(array(&$this, $ajaxMethod), $ajaxArguments));
1042 break;
1043 case 'setExpandedCollapsedState':
1044 $ajaxObj->setContentFormat('jsonbody');
1045 call_user_func_array(array(&$this, $ajaxMethod), $ajaxArguments);
1046 break;
1047 }
1048 }
1049 }
1050
1051 /**
1052 * Injects configuration via AJAX calls.
1053 * The configuration is validated using HMAC to avoid hijacking.
1054 *
1055 * @param array $ajaxArguments
1056 * @return void
1057 */
1058 protected function injectAjaxConfiguration(array $ajaxArguments) {
1059 $level = $this->calculateStructureLevel(-1);
1060
1061 if (empty($ajaxArguments['context']) || $level === FALSE) {
1062 return;
1063 }
1064
1065 $current = &$this->inlineStructure['stable'][$level];
1066 $context = json_decode($ajaxArguments['context'], TRUE);
1067
1068 if (GeneralUtility::hmac(serialize($context['config'])) !== $context['hmac']) {
1069 return;
1070 }
1071
1072 $current['config'] = $context['config'];
1073 $current['localizationMode'] = BackendUtility::getInlineLocalizationMode(
1074 $current['table'],
1075 $current['config']
1076 );
1077 }
1078
1079 /**
1080 * Construct runtime environment for Inline Relational Record Editing.
1081 * - creates an anoymous SC_alt_doc in $GLOBALS['SOBE']
1082 * - creates a \TYPO3\CMS\Backend\Form\FormEngine in $GLOBALS['SOBE']->tceforms
1083 * - sets ourself as reference to $GLOBALS['SOBE']->tceforms->inline
1084 * - sets $GLOBALS['SOBE']->tceforms->RTEcounter to the current situation on client-side
1085 *
1086 * @param array &$ajaxArguments The arguments to be processed by the AJAX request
1087 * @return void
1088 */
1089 protected function processAjaxRequestConstruct(&$ajaxArguments) {
1090 $GLOBALS['LANG']->includeLLFile('EXT:lang/locallang_alt_doc.xlf');
1091 // Create a new anonymous object:
1092 $GLOBALS['SOBE'] = new \stdClass();
1093 $GLOBALS['SOBE']->MOD_MENU = array(
1094 'showPalettes' => '',
1095 'showDescriptions' => '',
1096 'disableRTE' => ''
1097 );
1098 // Setting virtual document name
1099 $GLOBALS['SOBE']->MCONF['name'] = 'xMOD_alt_doc.php';
1100 // CLEANSE SETTINGS
1101 $GLOBALS['SOBE']->MOD_SETTINGS = BackendUtility::getModuleData($GLOBALS['SOBE']->MOD_MENU, GeneralUtility::_GP('SET'), $GLOBALS['SOBE']->MCONF['name']);
1102 // Create an instance of the document template object
1103 $GLOBALS['SOBE']->doc = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Template\\DocumentTemplate');
1104 $GLOBALS['SOBE']->doc->backPath = $GLOBALS['BACK_PATH'];
1105 // Initialize TCEforms (rendering the forms)
1106 $GLOBALS['SOBE']->tceforms = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Form\\FormEngine');
1107 $GLOBALS['SOBE']->tceforms->inline = $this;
1108 $GLOBALS['SOBE']->tceforms->RTEcounter = (int)array_shift($ajaxArguments);
1109 $GLOBALS['SOBE']->tceforms->initDefaultBEMode();
1110 $GLOBALS['SOBE']->tceforms->palettesCollapsed = !$GLOBALS['SOBE']->MOD_SETTINGS['showPalettes'];
1111 $GLOBALS['SOBE']->tceforms->disableRTE = $GLOBALS['SOBE']->MOD_SETTINGS['disableRTE'];
1112 $GLOBALS['SOBE']->tceforms->enableClickMenu = TRUE;
1113 $GLOBALS['SOBE']->tceforms->enableTabMenu = TRUE;
1114 // Clipboard is initialized:
1115 // Start clipboard
1116 $GLOBALS['SOBE']->tceforms->clipObj = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Clipboard\\Clipboard');
1117 // Initialize - reads the clipboard content from the user session
1118 $GLOBALS['SOBE']->tceforms->clipObj->initializeClipboard();
1119 }
1120
1121 /**
1122 * Determines and sets several script calls to a JSON array, that would have been executed if processed in non-AJAX mode.
1123 *
1124 * @param array &$jsonArray Reference of the array to be used for JSON
1125 * @param array $config The configuration of the IRRE field of the parent record
1126 * @return void
1127 */
1128 protected function getCommonScriptCalls(&$jsonArray, $config) {
1129 // Add data that would have been added at the top of a regular TCEforms call:
1130 if ($headTags = $this->getHeadTags()) {
1131 $jsonArray['headData'] = $headTags;
1132 }
1133 // Add the JavaScript data that would have been added at the bottom of a regular TCEforms call:
1134 $jsonArray['scriptCall'][] = $this->fObj->JSbottom($this->fObj->formName, TRUE);
1135 // If script.aculo.us Sortable is used, update the Observer to know the record:
1136 if ($config['appearance']['useSortable']) {
1137 $jsonArray['scriptCall'][] = 'inline.createDragAndDropSorting(\'' . $this->inlineNames['object'] . '_records\');';
1138 }
1139 // if TCEforms has some JavaScript code to be executed, just do it
1140 if ($this->fObj->extJSCODE) {
1141 $jsonArray['scriptCall'][] = $this->fObj->extJSCODE;
1142 }
1143 }
1144
1145 /**
1146 * Generates an error message that transferred as JSON for AJAX calls
1147 *
1148 * @param string $message The error message to be shown
1149 * @return array The error message in a JSON array
1150 */
1151 protected function getErrorMessageForAJAX($message) {
1152 $jsonArray = array(
1153 'data' => $message,
1154 'scriptCall' => array(
1155 'alert("' . $message . '");'
1156 )
1157 );
1158 return $jsonArray;
1159 }
1160
1161 /**
1162 * Handle AJAX calls to show a new inline-record of the given table.
1163 * Normally this method is never called from inside TYPO3. Always from outside by AJAX.
1164 *
1165 * @param string $domObjectId The calling object in hierarchy, that requested a new record.
1166 * @param string $foreignUid If set, the new record should be inserted after that one.
1167 * @return array An array to be used for JSON
1168 * @todo Define visibility
1169 */
1170 public function createNewRecord($domObjectId, $foreignUid = 0) {
1171 // The current table - for this table we should add/import records
1172 $current = $this->inlineStructure['unstable'];
1173 // The parent table - this table embeds the current table
1174 $parent = $this->getStructureLevel(-1);
1175 $config = $parent['config'];
1176 // Get TCA 'config' of the parent table
1177 if (!$this->checkConfiguration($config)) {
1178 return $this->getErrorMessageForAJAX('Wrong configuration in table ' . $parent['table']);
1179 }
1180 $collapseAll = isset($config['appearance']['collapseAll']) && $config['appearance']['collapseAll'];
1181 $expandSingle = isset($config['appearance']['expandSingle']) && $config['appearance']['expandSingle'];
1182 // Put the current level also to the dynNestedStack of TCEforms:
1183 $this->fObj->pushToDynNestedStack('inline', $this->inlineNames['object']);
1184 // Dynamically create a new record using \TYPO3\CMS\Backend\Form\DataPreprocessor
1185 if (!$foreignUid || !MathUtility::canBeInterpretedAsInteger($foreignUid) || $config['foreign_selector']) {
1186 $record = $this->getNewRecord($this->inlineFirstPid, $current['table']);
1187 // Set default values for new created records
1188 if (isset($config['foreign_record_defaults']) && is_array($config['foreign_record_defaults'])) {
1189 $foreignTableConfig = $GLOBALS['TCA'][$current['table']];
1190 // the following system relevant fields can't be set by foreign_record_defaults
1191 $notSettableFields = array(
1192 'uid', 'pid', 't3ver_oid', 't3ver_id', 't3ver_label', 't3ver_wsid', 't3ver_state', 't3ver_stage',
1193 't3ver_count', 't3ver_tstamp', 't3ver_move_id'
1194 );
1195 $configurationKeysForNotSettableFields = array(
1196 'crdate', 'cruser_id', 'delete', 'origUid', 'transOrigDiffSourceField', 'transOrigPointerField',
1197 'tstamp'
1198 );
1199 foreach ($configurationKeysForNotSettableFields as $configurationKey) {
1200 if (isset($foreignTableConfig['ctrl'][$configurationKey])) {
1201 $notSettableFields[] = $foreignTableConfig['ctrl'][$configurationKey];
1202 }
1203 }
1204 foreach ($config['foreign_record_defaults'] as $fieldName => $defaultValue) {
1205 if (isset($foreignTableConfig['columns'][$fieldName]) && !in_array($fieldName, $notSettableFields)) {
1206 $record[$fieldName] = $defaultValue;
1207 }
1208 }
1209 }
1210 // Set language of new child record to the language of the parent record:
1211 if ($config['localizationMode'] == 'select') {
1212 $parentRecord = $this->getRecord(0, $parent['table'], $parent['uid']);
1213 $parentLanguageField = $GLOBALS['TCA'][$parent['table']]['ctrl']['languageField'];
1214 $childLanguageField = $GLOBALS['TCA'][$current['table']]['ctrl']['languageField'];
1215 if ($parentRecord[$parentLanguageField] > 0) {
1216 $record[$childLanguageField] = $parentRecord[$parentLanguageField];
1217 }
1218 }
1219 } else {
1220 $record = $this->getRecord($this->inlineFirstPid, $current['table'], $foreignUid);
1221 }
1222 // Now there is a foreign_selector, so there is a new record on the intermediate table, but
1223 // this intermediate table holds a field, which is responsible for the foreign_selector, so
1224 // we have to set this field to the uid we get - or if none, to a new uid
1225 if ($config['foreign_selector'] && $foreignUid) {
1226 $selConfig = $this->getPossibleRecordsSelectorConfig($config, $config['foreign_selector']);
1227 // For a selector of type group/db, prepend the tablename (<tablename>_<uid>):
1228 $record[$config['foreign_selector']] = $selConfig['type'] != 'groupdb' ? '' : $selConfig['table'] . '_';
1229 $record[$config['foreign_selector']] .= $foreignUid;
1230 }
1231 // The HTML-object-id's prefix of the dynamically created record
1232 $objectPrefix = $this->inlineNames['object'] . self::Structure_Separator . $current['table'];
1233 $objectId = $objectPrefix . self::Structure_Separator . $record['uid'];
1234 // Render the foreign record that should passed back to browser
1235 $item = $this->renderForeignRecord($parent['uid'], $record, $config);
1236 if ($item === FALSE) {
1237 return $this->getErrorMessageForAJAX('Access denied');
1238 }
1239 if (!$current['uid']) {
1240 $jsonArray = array(
1241 'data' => $item,
1242 'scriptCall' => array(
1243 'inline.domAddNewRecord(\'bottom\',\'' . $this->inlineNames['object'] . '_records\',\'' . $objectPrefix . '\',json.data);',
1244 'inline.memorizeAddRecord(\'' . $objectPrefix . '\',\'' . $record['uid'] . '\',null,\'' . $foreignUid . '\');'
1245 )
1246 );
1247 } else {
1248 $jsonArray = array(
1249 'data' => $item,
1250 'scriptCall' => array(
1251 'inline.domAddNewRecord(\'after\',\'' . $domObjectId . '_div' . '\',\'' . $objectPrefix . '\',json.data);',
1252 'inline.memorizeAddRecord(\'' . $objectPrefix . '\',\'' . $record['uid'] . '\',\'' . $current['uid'] . '\',\'' . $foreignUid . '\');'
1253 )
1254 );
1255 }
1256 $this->getCommonScriptCalls($jsonArray, $config);
1257 // Collapse all other records if requested:
1258 if (!$collapseAll && $expandSingle) {
1259 $jsonArray['scriptCall'][] = 'inline.collapseAllRecords(\'' . $objectId . '\', \'' . $objectPrefix . '\', \'' . $record['uid'] . '\');';
1260 }
1261 // Tell the browser to scroll to the newly created record
1262 $jsonArray['scriptCall'][] = 'Element.scrollTo(\'' . $objectId . '_div\');';
1263 // Fade out and fade in the new record in the browser view to catch the user's eye
1264 $jsonArray['scriptCall'][] = 'inline.fadeOutFadeIn(\'' . $objectId . '_div\');';
1265 // Remove the current level also from the dynNestedStack of TCEforms:
1266 $this->fObj->popFromDynNestedStack();
1267 // Return the JSON array:
1268 return $jsonArray;
1269 }
1270
1271 /**
1272 * Handle AJAX calls to localize all records of a parent, localize a single record or to synchronize with the original language parent.
1273 *
1274 * @param string $domObjectId The calling object in hierarchy, that requested a new record.
1275 * @param mixed $type Defines the type 'localize' or 'synchronize' (string) or a single uid to be localized (integer)
1276 * @return array An array to be used for JSON
1277 */
1278 protected function synchronizeLocalizeRecords($domObjectId, $type) {
1279 $jsonArray = FALSE;
1280 if (GeneralUtility::inList('localize,synchronize', $type) || MathUtility::canBeInterpretedAsInteger($type)) {
1281 // The current level:
1282 $current = $this->inlineStructure['unstable'];
1283 // The parent level:
1284 $parent = $this->getStructureLevel(-1);
1285 $parentRecord = $this->getRecord(0, $parent['table'], $parent['uid']);
1286 $cmd = array();
1287 $cmd[$parent['table']][$parent['uid']]['inlineLocalizeSynchronize'] = $parent['field'] . ',' . $type;
1288 /** @var $tce \TYPO3\CMS\Core\DataHandling\DataHandler */
1289 $tce = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\DataHandling\\DataHandler');
1290 $tce->stripslashes_values = FALSE;
1291 $tce->start(array(), $cmd);
1292 $tce->process_cmdmap();
1293 $newItemList = $tce->registerDBList[$parent['table']][$parent['uid']][$parent['field']];
1294 unset($tce);
1295 $jsonArray = $this->getExecuteChangesJsonArray($parentRecord[$parent['field']], $newItemList);
1296 $this->getCommonScriptCalls($jsonArray, $parent['config']);
1297 }
1298 return $jsonArray;
1299 }
1300
1301 /**
1302 * Handle AJAX calls to dynamically load the form fields of a given record.
1303 * (basically a copy of "createNewRecord")
1304 * Normally this method is never called from inside TYPO3. Always from outside by AJAX.
1305 *
1306 * @param string $domObjectId The calling object in hierarchy, that requested a new record.
1307 * @return array An array to be used for JSON
1308 * @todo Define visibility
1309 */
1310 public function getRecordDetails($domObjectId) {
1311 // The current table - for this table we should add/import records
1312 $current = $this->inlineStructure['unstable'];
1313 // The parent table - this table embeds the current table
1314 $parent = $this->getStructureLevel(-1);
1315 // Get TCA 'config' of the parent table
1316 if (!$this->checkConfiguration($parent['config'])) {
1317 return $this->getErrorMessageForAJAX('Wrong configuration in table ' . $parent['table']);
1318 }
1319 $config = $parent['config'];
1320 // Set flag in config so that only the fields are rendered
1321 $config['renderFieldsOnly'] = TRUE;
1322 $collapseAll = isset($config['appearance']['collapseAll']) && $config['appearance']['collapseAll'];
1323 $expandSingle = isset($config['appearance']['expandSingle']) && $config['appearance']['expandSingle'];
1324 // Put the current level also to the dynNestedStack of TCEforms:
1325 $this->fObj->pushToDynNestedStack('inline', $this->inlineNames['object']);
1326 $record = $this->getRecord($this->inlineFirstPid, $current['table'], $current['uid']);
1327 // The HTML-object-id's prefix of the dynamically created record
1328 $objectPrefix = $this->inlineNames['object'] . self::Structure_Separator . $current['table'];
1329 $objectId = $objectPrefix . self::Structure_Separator . $record['uid'];
1330 $item = $this->renderForeignRecord($parent['uid'], $record, $config);
1331 if ($item === FALSE) {
1332 return $this->getErrorMessageForAJAX('Access denied');
1333 }
1334 $jsonArray = array(
1335 'data' => $item,
1336 'scriptCall' => array(
1337 'inline.domAddRecordDetails(\'' . $domObjectId . '\',\'' . $objectPrefix . '\',' . ($expandSingle ? '1' : '0') . ',json.data);'
1338 )
1339 );
1340 if ($config['foreign_unique']) {
1341 $jsonArray['scriptCall'][] = 'inline.removeUsed(\'' . $objectPrefix . '\',\'' . $record['uid'] . '\');';
1342 }
1343 $this->getCommonScriptCalls($jsonArray, $config);
1344 // Collapse all other records if requested:
1345 if (!$collapseAll && $expandSingle) {
1346 $jsonArray['scriptCall'][] = 'inline.collapseAllRecords(\'' . $objectId . '\',\'' . $objectPrefix . '\',\'' . $record['uid'] . '\');';
1347 }
1348 // Remove the current level also from the dynNestedStack of TCEforms:
1349 $this->fObj->popFromDynNestedStack();
1350 // Return the JSON array:
1351 return $jsonArray;
1352 }
1353
1354 /**
1355 * Generates a JSON array which executes the changes and thus updates the forms view.
1356 *
1357 * @param string $oldItemList List of related child reocrds before changes were made (old)
1358 * @param string $newItemList List of related child records after changes where made (new)
1359 * @return array An array to be used for JSON
1360 */
1361 protected function getExecuteChangesJsonArray($oldItemList, $newItemList) {
1362 $data = '';
1363 $parent = $this->getStructureLevel(-1);
1364 $current = $this->inlineStructure['unstable'];
1365 $jsonArray = array('scriptCall' => array());
1366 $jsonArrayScriptCall = &$jsonArray['scriptCall'];
1367 $nameObject = $this->inlineNames['object'];
1368 $nameObjectForeignTable = $nameObject . self::Structure_Separator . $current['table'];
1369 // Get the name of the field pointing to the original record:
1370 $transOrigPointerField = $GLOBALS['TCA'][$current['table']]['ctrl']['transOrigPointerField'];
1371 // Get the name of the field used as foreign selector (if any):
1372 $foreignSelector = isset($parent['config']['foreign_selector']) && $parent['config']['foreign_selector'] ? $parent['config']['foreign_selector'] : FALSE;
1373 // Convert lists to array with uids of child records:
1374 $oldItems = $this->getRelatedRecordsUidArray($oldItemList);
1375 $newItems = $this->getRelatedRecordsUidArray($newItemList);
1376 // Determine the items that were localized or localized:
1377 $removedItems = array_diff($oldItems, $newItems);
1378 $localizedItems = array_diff($newItems, $oldItems);
1379 // Set the items that should be removed in the forms view:
1380 foreach ($removedItems as $item) {
1381 $jsonArrayScriptCall[] = 'inline.deleteRecord(\'' . $nameObjectForeignTable . self::Structure_Separator . $item . '\', {forceDirectRemoval: true});';
1382 }
1383 // Set the items that should be added in the forms view:
1384 foreach ($localizedItems as $item) {
1385 $row = $this->getRecord($this->inlineFirstPid, $current['table'], $item);
1386 $selectedValue = $foreignSelector ? '\'' . $row[$foreignSelector] . '\'' : 'null';
1387 $data .= $this->renderForeignRecord($parent['uid'], $row, $parent['config']);
1388 $jsonArrayScriptCall[] = 'inline.memorizeAddRecord(\'' . $nameObjectForeignTable . '\', \'' . $item . '\', null, ' . $selectedValue . ');';
1389 // Remove possible virtual records in the form which showed that a child records could be localized:
1390 if (isset($row[$transOrigPointerField]) && $row[$transOrigPointerField]) {
1391 $jsonArrayScriptCall[] = 'inline.fadeAndRemove(\'' . $nameObjectForeignTable . self::Structure_Separator . $row[$transOrigPointerField] . '_div' . '\');';
1392 }
1393 }
1394 if ($data) {
1395 $jsonArray['data'] = $data;
1396 array_unshift($jsonArrayScriptCall, 'inline.domAddNewRecord(\'bottom\', \'' . $nameObject . '_records\', \'' . $nameObjectForeignTable . '\', json.data);');
1397 }
1398 return $jsonArray;
1399 }
1400
1401 /**
1402 * Save the expanded/collapsed state of a child record in the BE_USER->uc.
1403 *
1404 * @param string $domObjectId The calling object in hierarchy, that requested a new record.
1405 * @param string $expand Whether this record is expanded.
1406 * @param string $collapse Whether this record is collapsed.
1407 * @return void
1408 * @todo Define visibility
1409 */
1410 public function setExpandedCollapsedState($domObjectId, $expand, $collapse) {
1411 // Parse the DOM identifier (string), add the levels to the structure stack (array), but don't load TCA config
1412 $this->parseStructureString($domObjectId, FALSE);
1413 // The current table - for this table we should add/import records
1414 $current = $this->inlineStructure['unstable'];
1415 // The top parent table - this table embeds the current table
1416 $top = $this->getStructureLevel(0);
1417 // Only do some action if the top record and the current record were saved before
1418 if (MathUtility::canBeInterpretedAsInteger($top['uid'])) {
1419 $inlineView = (array) unserialize($GLOBALS['BE_USER']->uc['inlineView']);
1420 $inlineViewCurrent = &$inlineView[$top['table']][$top['uid']];
1421 $expandUids = GeneralUtility::trimExplode(',', $expand);
1422 $collapseUids = GeneralUtility::trimExplode(',', $collapse);
1423 // Set records to be expanded
1424 foreach ($expandUids as $uid) {
1425 $inlineViewCurrent[$current['table']][] = $uid;
1426 }
1427 // Set records to be collapsed
1428 foreach ($collapseUids as $uid) {
1429 $inlineViewCurrent[$current['table']] = $this->removeFromArray($uid, $inlineViewCurrent[$current['table']]);
1430 }
1431 // Save states back to database
1432 if (is_array($inlineViewCurrent[$current['table']])) {
1433 $inlineViewCurrent[$current['table']] = array_unique($inlineViewCurrent[$current['table']]);
1434 $GLOBALS['BE_USER']->uc['inlineView'] = serialize($inlineView);
1435 $GLOBALS['BE_USER']->writeUC();
1436 }
1437 }
1438 }
1439
1440 /*******************************************************
1441 *
1442 * Get data from database and handle relations
1443 *
1444 *******************************************************/
1445 /**
1446 * Get the related records of the embedding item, this could be 1:n, m:n.
1447 * Returns an associative array with the keys records and count. 'count' contains only real existing records on the current parent record.
1448 *
1449 * @param string $table The table name of the record
1450 * @param string $field The field name which this element is supposed to edit
1451 * @param array $row The record data array where the value(s) for the field can be found
1452 * @param array $PA An array with additional configuration options.
1453 * @param array $config (Redundant) content of $PA['fieldConf']['config'] (for convenience)
1454 * @return array The records related to the parent item as associative array.
1455 * @todo Define visibility
1456 */
1457 public function getRelatedRecords($table, $field, $row, &$PA, $config) {
1458 $pid = $row['pid'];
1459 $elements = $PA['itemFormElValue'];
1460 $foreignTable = $config['foreign_table'];
1461 $localizationMode = BackendUtility::getInlineLocalizationMode($table, $config);
1462 if ($localizationMode != FALSE) {
1463 $language = (int)$row[$GLOBALS['TCA'][$table]['ctrl']['languageField']];
1464 $transOrigPointer = (int)$row[$GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']];
1465 $transOrigTable = BackendUtility::getOriginalTranslationTable($table);
1466
1467 if ($language > 0 && $transOrigPointer) {
1468 // Localization in mode 'keep', isn't a real localization, but keeps the children of the original parent record:
1469 if ($localizationMode == 'keep') {
1470 $transOrigRec = $this->getRecord(0, $transOrigTable, $transOrigPointer);
1471 $elements = $transOrigRec[$field];
1472 $pid = $transOrigRec['pid'];
1473 } elseif ($localizationMode == 'select') {
1474 $transOrigRec = $this->getRecord(0, $transOrigTable, $transOrigPointer);
1475 $pid = $transOrigRec['pid'];
1476 $recordsOriginal = $this->getRelatedRecordsArray($pid, $foreignTable, $transOrigRec[$field]);
1477 }
1478 }
1479 }
1480 $records = $this->getRelatedRecordsArray($pid, $foreignTable, $elements);
1481 $relatedRecords = array('records' => $records, 'count' => count($records));
1482 // Merge original language with current localization and show differences:
1483 if (is_array($recordsOriginal)) {
1484 $options = array(
1485 'showPossible' => isset($config['appearance']['showPossibleLocalizationRecords']) && $config['appearance']['showPossibleLocalizationRecords'],
1486 'showRemoved' => isset($config['appearance']['showRemovedLocalizationRecords']) && $config['appearance']['showRemovedLocalizationRecords']
1487 );
1488 if ($options['showPossible'] || $options['showRemoved']) {
1489 $relatedRecords['records'] = $this->getLocalizationDifferences($foreignTable, $options, $recordsOriginal, $records);
1490 }
1491 }
1492 return $relatedRecords;
1493 }
1494
1495 /**
1496 * Gets the related records of the embedding item, this could be 1:n, m:n.
1497 *
1498 * @param integer $pid The pid of the parent record
1499 * @param string $table The table name of the record
1500 * @param string $itemList The list of related child records
1501 * @return array The records related to the parent item
1502 */
1503 protected function getRelatedRecordsArray($pid, $table, $itemList) {
1504 $records = array();
1505 $itemArray = $this->getRelatedRecordsUidArray($itemList);
1506 // Perform modification of the selected items array:
1507 foreach ($itemArray as $uid) {
1508 // Get the records for this uid using \TYPO3\CMS\Backend\Form\DataPreprocessor
1509 if ($record = $this->getRecord($pid, $table, $uid)) {
1510 $records[$uid] = $record;
1511 }
1512 }
1513 return $records;
1514 }
1515
1516 /**
1517 * Gets an array with the uids of related records out of a list of items.
1518 * This list could contain more information than required. This methods just
1519 * extracts the uids.
1520 *
1521 * @param string $itemList The list of related child records
1522 * @return array An array with uids
1523 */
1524 protected function getRelatedRecordsUidArray($itemList) {
1525 $itemArray = GeneralUtility::trimExplode(',', $itemList, TRUE);
1526 // Perform modification of the selected items array:
1527 foreach ($itemArray as $key => &$value) {
1528 $parts = explode('|', $value, 2);
1529 $value = $parts[0];
1530 }
1531 unset($value);
1532 return $itemArray;
1533 }
1534
1535 /**
1536 * Gets the difference between current localized structure and the original language structure.
1537 * If there are records which once were localized but don't exist in the original version anymore, the record row is marked with '__remove'.
1538 * If there are records which can be localized and exist only in the original version, the record row is marked with '__create' and '__virtual'.
1539 *
1540 * @param string $table The table name of the parent records
1541 * @param array $options Options defining what kind of records to display
1542 * @param array $recordsOriginal The uids of the child records of the original language
1543 * @param array $recordsLocalization The uids of the child records of the current localization
1544 * @return array Merged array of uids of the child records of both versions
1545 */
1546 protected function getLocalizationDifferences($table, array $options, array $recordsOriginal, array $recordsLocalization) {
1547 $records = array();
1548 $transOrigPointerField = $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'];
1549 // Compare original to localized version of the records:
1550 foreach ($recordsLocalization as $uid => $row) {
1551 // If the record points to a original translation which doesn't exist anymore, it could be removed:
1552 if (isset($row[$transOrigPointerField]) && $row[$transOrigPointerField] > 0) {
1553 $transOrigPointer = $row[$transOrigPointerField];
1554 if (isset($recordsOriginal[$transOrigPointer])) {
1555 unset($recordsOriginal[$transOrigPointer]);
1556 } elseif ($options['showRemoved']) {
1557 $row['__remove'] = TRUE;
1558 }
1559 }
1560 $records[$uid] = $row;
1561 }
1562 // Process the remaining records in the original unlocalized parent:
1563 if ($options['showPossible']) {
1564 foreach ($recordsOriginal as $uid => $row) {
1565 $row['__create'] = TRUE;
1566 $row['__virtual'] = TRUE;
1567 $records[$uid] = $row;
1568 }
1569 }
1570 return $records;
1571 }
1572
1573 /**
1574 * Get possible records.
1575 * Copied from TCEform and modified.
1576 *
1577 * @param string $table The table name of the record
1578 * @param string $field The field name which this element is supposed to edit
1579 * @param array $row The record data array where the value(s) for the field can be found
1580 * @param array $conf An array with additional configuration options.
1581 * @param string $checkForConfField For which field in the foreign_table the possible records should be fetched
1582 * @return mixed Array of possible record items; FALSE if type is "group/db", then everything could be "possible
1583 * @todo Define visibility
1584 */
1585 public function getPossibleRecords($table, $field, $row, $conf, $checkForConfField = 'foreign_selector') {
1586 // ctrl configuration from TCA:
1587 $tcaTableCtrl = $GLOBALS['TCA'][$table]['ctrl'];
1588 // Field configuration from TCA:
1589 $foreign_table = $conf['foreign_table'];
1590 $foreign_check = $conf[$checkForConfField];
1591 $foreignConfig = $this->getPossibleRecordsSelectorConfig($conf, $foreign_check);
1592 $PA = $foreignConfig['PA'];
1593 $config = $PA['fieldConf']['config'];
1594 if ($foreignConfig['type'] == 'select') {
1595 // Getting the selector box items from the system
1596 $selItems = $this->fObj->addSelectOptionsToItemArray($this->fObj->initItemArray($PA['fieldConf']), $PA['fieldConf'], $this->fObj->setTSconfig($table, $row), $field);
1597
1598 // Possibly filter some items:
1599 $selItems = GeneralUtility::keepItemsInArray(
1600 $selItems,
1601 $PA['fieldTSConfig']['keepItems'],
1602 function ($value) {
1603 return $value[1];
1604 }
1605 );
1606
1607 // Possibly add some items:
1608 $selItems = $this->fObj->addItems($selItems, $PA['fieldTSConfig']['addItems.']);
1609 if (isset($config['itemsProcFunc']) && $config['itemsProcFunc']) {
1610 $selItems = $this->fObj->procItems($selItems, $PA['fieldTSConfig']['itemsProcFunc.'], $config, $table, $row, $field);
1611 }
1612 // Possibly remove some items:
1613 $removeItems = GeneralUtility::trimExplode(',', $PA['fieldTSConfig']['removeItems'], TRUE);
1614 foreach ($selItems as $tk => $p) {
1615 // Checking languages and authMode:
1616 $languageDeny = $tcaTableCtrl['languageField'] && (string)$tcaTableCtrl['languageField'] === $field && !$GLOBALS['BE_USER']->checkLanguageAccess($p[1]);
1617 $authModeDeny = $config['form_type'] == 'select' && $config['authMode'] && !$GLOBALS['BE_USER']->checkAuthMode($table, $field, $p[1], $config['authMode']);
1618 if (in_array($p[1], $removeItems) || $languageDeny || $authModeDeny) {
1619 unset($selItems[$tk]);
1620 } elseif (isset($PA['fieldTSConfig']['altLabels.'][$p[1]])) {
1621 $selItems[$tk][0] = htmlspecialchars($this->fObj->sL($PA['fieldTSConfig']['altLabels.'][$p[1]]));
1622 }
1623 // Removing doktypes with no access:
1624 if (($table === 'pages' || $table === 'pages_language_overlay') && $field === 'doktype') {
1625 if (!($GLOBALS['BE_USER']->isAdmin() || GeneralUtility::inList($GLOBALS['BE_USER']->groupData['pagetypes_select'], $p[1]))) {
1626 unset($selItems[$tk]);
1627 }
1628 }
1629 }
1630 } else {
1631 $selItems = FALSE;
1632 }
1633 return $selItems;
1634 }
1635
1636 /**
1637 * Gets the uids of a select/selector that should be unique an have already been used.
1638 *
1639 * @param array $records All inline records on this level
1640 * @param array $conf The TCA field configuration of the inline field to be rendered
1641 * @param boolean $splitValue For usage with group/db, values come like "tx_table_123|Title%20abc", but we need "tx_table" and "123
1642 * @return array The uids, that have been used already and should be used unique
1643 * @todo Define visibility
1644 */
1645 public function getUniqueIds($records, $conf = array(), $splitValue = FALSE) {
1646 $uniqueIds = array();
1647 if (isset($conf['foreign_unique']) && $conf['foreign_unique'] && count($records)) {
1648 foreach ($records as $rec) {
1649 // Skip virtual records (e.g. shown in localization mode):
1650 if (!isset($rec['__virtual']) || !$rec['__virtual']) {
1651 $value = $rec[$conf['foreign_unique']];
1652 // Split the value and extract the table and uid:
1653 if ($splitValue) {
1654 $valueParts = GeneralUtility::trimExplode('|', $value);
1655 $itemParts = explode('_', $valueParts[0]);
1656 $value = array(
1657 'uid' => array_pop($itemParts),
1658 'table' => implode('_', $itemParts)
1659 );
1660 }
1661 $uniqueIds[$rec['uid']] = $value;
1662 }
1663 }
1664 }
1665 return $uniqueIds;
1666 }
1667
1668 /**
1669 * Determines the corrected pid to be used for a new record.
1670 * The pid to be used can be defined by a Page TSconfig.
1671 *
1672 * @param string $table The table name
1673 * @param integer $parentPid The pid of the parent record
1674 * @return integer The corrected pid to be used for a new record
1675 */
1676 protected function getNewRecordPid($table, $parentPid = NULL) {
1677 $newRecordPid = $this->inlineFirstPid;
1678 $pageTS = BackendUtility::getPagesTSconfig($parentPid);
1679 if (isset($pageTS['TCAdefaults.'][$table . '.']['pid']) && MathUtility::canBeInterpretedAsInteger($pageTS['TCAdefaults.'][$table . '.']['pid'])) {
1680 $newRecordPid = $pageTS['TCAdefaults.'][$table . '.']['pid'];
1681 } elseif (isset($parentPid) && MathUtility::canBeInterpretedAsInteger($parentPid)) {
1682 $newRecordPid = $parentPid;
1683 }
1684 return $newRecordPid;
1685 }
1686
1687 /**
1688 * Get a single record row for a TCA table from the database.
1689 * \TYPO3\CMS\Backend\Form\DataPreprocessor is used for "upgrading" the
1690 * values, especially the relations.
1691 *
1692 * @param integer $pid The pid of the page the record should be stored (only relevant for NEW records)
1693 * @param string $table The table to fetch data from (= foreign_table)
1694 * @param string $uid The uid of the record to fetch, or the pid if a new record should be created
1695 * @param string $cmd The command to perform, empty or 'new'
1696 * @return array A record row from the database post-processed by \TYPO3\CMS\Backend\Form\DataPreprocessor
1697 * @todo Define visibility
1698 */
1699 public function getRecord($pid, $table, $uid, $cmd = '') {
1700 // Fetch workspace version of a record (if any):
1701 if ($cmd !== 'new' && $GLOBALS['BE_USER']->workspace !== 0) {
1702 $workspaceVersion = BackendUtility::getWorkspaceVersionOfRecord($GLOBALS['BE_USER']->workspace, $table, $uid, 'uid');
1703 if ($workspaceVersion !== FALSE) {
1704 $uid = $workspaceVersion['uid'];
1705 }
1706 }
1707 $trData = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Form\\DataPreprocessor');
1708 $trData->addRawData = TRUE;
1709 $trData->lockRecords = 1;
1710 $trData->disableRTE = $GLOBALS['SOBE']->MOD_SETTINGS['disableRTE'];
1711 // If a new record should be created
1712 $trData->fetchRecord($table, $uid, $cmd === 'new' ? 'new' : '');
1713 $rec = reset($trData->regTableItems_data);
1714 return $rec;
1715 }
1716
1717 /**
1718 * Wrapper. Calls getRecord in case of a new record should be created.
1719 *
1720 * @param integer $pid The pid of the page the record should be stored (only relevant for NEW records)
1721 * @param string $table The table to fetch data from (= foreign_table)
1722 * @return array A record row from the database post-processed by \TYPO3\CMS\Backend\Form\DataPreprocessor
1723 * @todo Define visibility
1724 */
1725 public function getNewRecord($pid, $table) {
1726 $rec = $this->getRecord($pid, $table, $pid, 'new');
1727 $rec['uid'] = uniqid('NEW');
1728 $rec['pid'] = $this->getNewRecordPid($table, $pid);
1729 return $rec;
1730 }
1731
1732 /*******************************************************
1733 *
1734 * Structure stack for handling inline objects/levels
1735 *
1736 *******************************************************/
1737 /**
1738 * Add a new level on top of the structure stack. Other functions can access the
1739 * stack and determine, if there's possibly a endless loop.
1740 *
1741 * @param string $table The table name of the record
1742 * @param string $uid The uid of the record that embeds the inline data
1743 * @param string $field The field name which this element is supposed to edit
1744 * @param array $config The TCA-configuration of the inline field
1745 * @param array $parameters The full parameter array (PA)
1746 * @return void
1747 * @todo Define visibility
1748 */
1749 public function pushStructure($table, $uid, $field = '', $config = array(), array $parameters = array()) {
1750 $structure = array(
1751 'table' => $table,
1752 'uid' => $uid,
1753 'field' => $field,
1754 'config' => $config,
1755 'localizationMode' => BackendUtility::getInlineLocalizationMode($table, $config),
1756 );
1757
1758 // Extract FlexForm parts (if any) from element name,
1759 // e.g. array('vDEF', 'lDEF', 'FlexField', 'vDEF')
1760 if (!empty($parameters['itemFormElName'])) {
1761 $flexFormParts = $this->extractFlexFormParts($parameters['itemFormElName']);
1762
1763 if ($flexFormParts !== NULL) {
1764 $structure['flexform'] = $flexFormParts;
1765 }
1766 }
1767
1768 $this->inlineStructure['stable'][] = $structure;
1769 $this->updateStructureNames();
1770 }
1771
1772 /**
1773 * Remove the item on top of the structure stack and return it.
1774 *
1775 * @return array The top item of the structure stack - array(<table>,<uid>,<field>,<config>)
1776 * @todo Define visibility
1777 */
1778 public function popStructure() {
1779 $popItem = NULL;
1780
1781 if (count($this->inlineStructure['stable'])) {
1782 $popItem = array_pop($this->inlineStructure['stable']);
1783 $this->updateStructureNames();
1784 }
1785 return $popItem;
1786 }
1787
1788 /**
1789 * For common use of DOM object-ids and form field names of a several inline-level,
1790 * these names/identifiers are preprocessed and set to $this->inlineNames.
1791 * This function is automatically called if a level is pushed to or removed from the
1792 * inline structure stack.
1793 *
1794 * @return void
1795 * @todo Define visibility
1796 */
1797 public function updateStructureNames() {
1798 $current = $this->getStructureLevel(-1);
1799 // If there are still more inline levels available
1800 if ($current !== FALSE) {
1801 $this->inlineNames = array(
1802 'form' => $this->prependFormFieldNames . $this->getStructureItemName($current, self::Disposal_AttributeName),
1803 'object' => $this->prependNaming . self::Structure_Separator . $this->inlineFirstPid . self::Structure_Separator . $this->getStructurePath()
1804 );
1805 } else {
1806 $this->inlineNames = array();
1807 }
1808 }
1809
1810 /**
1811 * Create a name/id for usage in HTML output of a level of the structure stack to be used in form names.
1812 *
1813 * @param array $levelData Array of a level of the structure stack (containing the keys table, uid and field)
1814 * @param string $disposal How the structure name is used (e.g. as <div id="..."> or <input name="..." />)
1815 * @return string The name/id of that level, to be used for HTML output
1816 * @todo Define visibility
1817 */
1818 public function getStructureItemName($levelData, $disposal = self::Disposal_AttributeId) {
1819 $name = NULL;
1820
1821 if (is_array($levelData)) {
1822 $parts = array($levelData['table'], $levelData['uid']);
1823
1824 if (!empty($levelData['field'])) {
1825 $parts[] = $levelData['field'];
1826 }
1827
1828 // Use in name attributes:
1829 if ($disposal === self::Disposal_AttributeName) {
1830 if (!empty($levelData['field']) && !empty($levelData['flexform']) && $this->getStructureLevel(-1) === $levelData) {
1831 $parts[] = implode('][', $levelData['flexform']);
1832 }
1833 $name = '[' . implode('][', $parts) . ']';
1834 // Use in object id attributes:
1835 } else {
1836 $name = implode(self::Structure_Separator, $parts);
1837
1838 if (!empty($levelData['field']) && !empty($levelData['flexform'])) {
1839 array_unshift($levelData['flexform'], $name);
1840 $name = implode(self::FlexForm_Separator, $levelData['flexform']);
1841 }
1842 }
1843 }
1844
1845 return $name;
1846 }
1847
1848 /**
1849 * Get a level from the stack and return the data.
1850 * If the $level value is negative, this function works top-down,
1851 * if the $level value is positive, this function works bottom-up.
1852 *
1853 * @param integer $level Which level to return
1854 * @return array The item of the stack at the requested level
1855 * @todo Define visibility
1856 */
1857 public function getStructureLevel($level) {
1858 $level = $this->calculateStructureLevel($level);
1859
1860 if ($level !== FALSE) {
1861 return $this->inlineStructure['stable'][$level];
1862 } else {
1863 return FALSE;
1864 }
1865 }
1866
1867 /**
1868 * Calculates structure level.
1869 *
1870 * @param integer $level Which level to return
1871 * @return boolean|integer
1872 */
1873 protected function calculateStructureLevel($level) {
1874 $result = FALSE;
1875
1876 $inlineStructureCount = count($this->inlineStructure['stable']);
1877 if ($level < 0) {
1878 $level = $inlineStructureCount + $level;
1879 }
1880 if ($level >= 0 && $level < $inlineStructureCount) {
1881 $result = $level;
1882 }
1883
1884 return $result;
1885 }
1886
1887 /**
1888 * Get the identifiers of a given depth of level, from the top of the stack to the bottom.
1889 * An identifier looks like "<table>-<uid>-<field>".
1890 *
1891 * @param integer $structureDepth How much levels to output, beginning from the top of the stack
1892 * @return string The path of identifiers
1893 * @todo Define visibility
1894 */
1895 public function getStructurePath($structureDepth = -1) {
1896 $structureLevels = array();
1897 $structureCount = count($this->inlineStructure['stable']);
1898 if ($structureDepth < 0 || $structureDepth > $structureCount) {
1899 $structureDepth = $structureCount;
1900 }
1901 for ($i = 1; $i <= $structureDepth; $i++) {
1902 array_unshift($structureLevels, $this->getStructureItemName($this->getStructureLevel(-$i), self::Disposal_AttributeId));
1903 }
1904 return implode(self::Structure_Separator, $structureLevels);
1905 }
1906
1907 /**
1908 * Convert the DOM object-id of an inline container to an array.
1909 * The object-id could look like 'data-parentPageId-tx_mmftest_company-1-employees'.
1910 * The result is written to $this->inlineStructure.
1911 * There are two keys:
1912 * - 'stable': Containing full qualified identifiers (table, uid and field)
1913 * - 'unstable': Containting partly filled data (e.g. only table and possibly field)
1914 *
1915 * @param string $domObjectId The DOM object-id
1916 * @param boolean $loadConfig Load the TCA configuration for that level (default: TRUE)
1917 * @return void
1918 * @todo Define visibility
1919 */
1920 public function parseStructureString($string, $loadConfig = TRUE) {
1921 $unstable = array();
1922 $vector = array('table', 'uid', 'field');
1923
1924 // Substitute FlexForm additon and make parsing a bit easier
1925 $string = str_replace(self::FlexForm_Separator, self::FlexForm_Substitute, $string);
1926 // The starting pattern of an object identifer (e.g. "data-<firstPidValue>-<anything>)
1927 $pattern = '/^' . $this->prependNaming . self::Structure_Separator . '(.+?)' . self::Structure_Separator . '(.+)$/';
1928
1929 if (preg_match($pattern, $string, $match)) {
1930 $this->inlineFirstPid = $match[1];
1931 $parts = explode(self::Structure_Separator, $match[2]);
1932 $partsCnt = count($parts);
1933 for ($i = 0; $i < $partsCnt; $i++) {
1934 if ($i > 0 && $i % 3 == 0) {
1935 // Load the TCA configuration of the table field and store it in the stack
1936 if ($loadConfig) {
1937 $unstable['config'] = $GLOBALS['TCA'][$unstable['table']]['columns'][$unstable['field']]['config'];
1938 // Fetch TSconfig:
1939 $TSconfig = $this->fObj->setTSconfig($unstable['table'], array('uid' => $unstable['uid'], 'pid' => $this->inlineFirstPid), $unstable['field']);
1940 // Override TCA field config by TSconfig:
1941 if (!$TSconfig['disabled']) {
1942 $unstable['config'] = $this->fObj->overrideFieldConf($unstable['config'], $TSconfig);
1943 }
1944 $unstable['localizationMode'] = BackendUtility::getInlineLocalizationMode($unstable['table'], $unstable['config']);
1945 }
1946
1947 // Extract FlexForm from field part (if any)
1948 if (strpos($unstable['field'], self::FlexForm_Substitute) !== FALSE) {
1949 $fieldParts = GeneralUtility::trimExplode(self::FlexForm_Substitute, $unstable['field']);
1950 $unstable['field'] = array_shift($fieldParts);
1951 // FlexForm parts start with data:
1952 if (count($fieldParts) > 0 && $fieldParts[0] === 'data') {
1953 $unstable['flexform'] = $fieldParts;
1954 }
1955 }
1956
1957 $this->inlineStructure['stable'][] = $unstable;
1958 $unstable = array();
1959 }
1960 $unstable[$vector[$i % 3]] = $parts[$i];
1961 }
1962 $this->updateStructureNames();
1963 if (count($unstable)) {
1964 $this->inlineStructure['unstable'] = $unstable;
1965 }
1966 }
1967 }
1968
1969 /*******************************************************
1970 *
1971 * Helper functions
1972 *
1973 *******************************************************/
1974 /**
1975 * Does some checks on the TCA configuration of the inline field to render.
1976 *
1977 * @param array $config Reference to the TCA field configuration
1978 * @param string $table The table name of the record
1979 * @param string $field The field name which this element is supposed to edit
1980 * @param array $row The record data array of the parent
1981 * @return boolean If critical configuration errors were found, FALSE is returned
1982 * @todo Define visibility
1983 */
1984 public function checkConfiguration(&$config) {
1985 $foreign_table = $config['foreign_table'];
1986 // An inline field must have a foreign_table, if not, stop all further inline actions for this field:
1987 if (!$foreign_table || !is_array($GLOBALS['TCA'][$foreign_table])) {
1988 return FALSE;
1989 }
1990 // Init appearance if not set:
1991 if (!isset($config['appearance']) || !is_array($config['appearance'])) {
1992 $config['appearance'] = array();
1993 }
1994 // Set the position/appearance of the "Create new record" link:
1995 if (isset($config['foreign_selector']) && $config['foreign_selector'] && (!isset($config['appearance']['useCombination']) || !$config['appearance']['useCombination'])) {
1996 $config['appearance']['levelLinksPosition'] = 'none';
1997 } elseif (!isset($config['appearance']['levelLinksPosition']) || !in_array($config['appearance']['levelLinksPosition'], array('top', 'bottom', 'both', 'none'))) {
1998 $config['appearance']['levelLinksPosition'] = 'top';
1999 }
2000 // Defines which controls should be shown in header of each record:
2001 $enabledControls = array(
2002 'info' => TRUE,
2003 'new' => TRUE,
2004 'dragdrop' => TRUE,
2005 'sort' => TRUE,
2006 'hide' => TRUE,
2007 'delete' => TRUE,
2008 'localize' => TRUE
2009 );
2010 if (isset($config['appearance']['enabledControls']) && is_array($config['appearance']['enabledControls'])) {
2011 $config['appearance']['enabledControls'] = array_merge($enabledControls, $config['appearance']['enabledControls']);
2012 } else {
2013 $config['appearance']['enabledControls'] = $enabledControls;
2014 }
2015 return TRUE;
2016 }
2017
2018 /**
2019 * Checks the page access rights (Code for access check mostly taken from alt_doc.php)
2020 * as well as the table access rights of the user.
2021 *
2022 * @param string $cmd The command that sould be performed ('new' or 'edit')
2023 * @param string $table The table to check access for
2024 * @param string $theUid The record uid of the table
2025 * @return boolean Returns TRUE is the user has access, or FALSE if not
2026 * @todo Define visibility
2027 */
2028 public function checkAccess($cmd, $table, $theUid) {
2029 // Checking if the user has permissions? (Only working as a precaution, because the final permission check is always down in TCE. But it's good to notify the user on beforehand...)
2030 // First, resetting flags.
2031 $hasAccess = 0;
2032 $deniedAccessReason = '';
2033 // Admin users always have acces:
2034 if ($GLOBALS['BE_USER']->isAdmin()) {
2035 return TRUE;
2036 }
2037 // If the command is to create a NEW record...:
2038 if ($cmd == 'new') {
2039 // If the pid is numerical, check if it's possible to write to this page:
2040 if (MathUtility::canBeInterpretedAsInteger($this->inlineFirstPid)) {
2041 $calcPRec = BackendUtility::getRecord('pages', $this->inlineFirstPid);
2042 if (!is_array($calcPRec)) {
2043 return FALSE;
2044 }
2045 // Permissions for the parent page
2046 $CALC_PERMS = $GLOBALS['BE_USER']->calcPerms($calcPRec);
2047 // If pages:
2048 if ($table == 'pages') {
2049 // Are we allowed to create new subpages?
2050 $hasAccess = $CALC_PERMS & 8 ? 1 : 0;
2051 } else {
2052 // Are we allowed to edit content on this page?
2053 $hasAccess = $CALC_PERMS & 16 ? 1 : 0;
2054 }
2055 } else {
2056 $hasAccess = 1;
2057 }
2058 } else {
2059 // Edit:
2060 $calcPRec = BackendUtility::getRecord($table, $theUid);
2061 BackendUtility::fixVersioningPid($table, $calcPRec);
2062 if (is_array($calcPRec)) {
2063 // If pages:
2064 if ($table == 'pages') {
2065 $CALC_PERMS = $GLOBALS['BE_USER']->calcPerms($calcPRec);
2066 $hasAccess = $CALC_PERMS & 2 ? 1 : 0;
2067 } else {
2068 // Fetching pid-record first.
2069 $CALC_PERMS = $GLOBALS['BE_USER']->calcPerms(BackendUtility::getRecord('pages', $calcPRec['pid']));
2070 $hasAccess = $CALC_PERMS & 16 ? 1 : 0;
2071 }
2072 // Check internals regarding access:
2073 if ($hasAccess) {
2074 $hasAccess = $GLOBALS['BE_USER']->recordEditAccessInternals($table, $calcPRec);
2075 }
2076 }
2077 }
2078 if (!$GLOBALS['BE_USER']->check('tables_modify', $table)) {
2079 $hasAccess = 0;
2080 }
2081 if (!$hasAccess) {
2082 $deniedAccessReason = $GLOBALS['BE_USER']->errorMsg;
2083 if ($deniedAccessReason) {
2084 debug($deniedAccessReason);
2085 }
2086 }
2087 return $hasAccess ? TRUE : FALSE;
2088 }
2089
2090 /**
2091 * Check the keys and values in the $compare array against the ['config'] part of the top level of the stack.
2092 * A boolean value is return depending on how the comparison was successful.
2093 *
2094 * @param array $compare Keys and values to compare to the ['config'] part of the top level of the stack
2095 * @return boolean Whether the comparison was successful
2096 * @see arrayCompareComplex
2097 * @todo Define visibility
2098 */
2099 public function compareStructureConfiguration($compare) {
2100 $level = $this->getStructureLevel(-1);
2101 $result = $this->arrayCompareComplex($level, $compare);
2102 return $result;
2103 }
2104
2105 /**
2106 * Normalize a relation "uid" published by transferData, like "1|Company%201"
2107 *
2108 * @param string $string A transferData reference string, containing the uid
2109 * @return string The normalized uid
2110 * @todo Define visibility
2111 */
2112 public function normalizeUid($string) {
2113 $parts = explode('|', $string);
2114 return $parts[0];
2115 }
2116
2117 /**
2118 * Wrap the HTML code of a section with a table tag.
2119 *
2120 * @param string $section The HTML code to be wrapped
2121 * @param array $styleAttrs Attributes for the style argument in the table tag
2122 * @param array $tableAttrs Attributes for the table tag (like width, border, etc.)
2123 * @return string The wrapped HTML code
2124 * @todo Define visibility
2125 */
2126 public function wrapFormsSection($section, $styleAttrs = array(), $tableAttrs = array()) {
2127 $style = '';
2128 $table = '';
2129 foreach ($styleAttrs as $key => $value) {
2130 $style .= ($style ? ' ' : '') . $key . ': ' . htmlspecialchars($value) . '; ';
2131 }
2132 if ($style) {
2133 $style = ' style="' . $style . '"';
2134 }
2135 if (!$tableAttrs['background'] && $this->fObj->borderStyle[2]) {
2136 $tableAttrs['background'] = $this->backPath . $this->borderStyle[2];
2137 }
2138 if (!$tableAttrs['class'] && $this->borderStyle[3]) {
2139 $tableAttrs['class'] = $this->borderStyle[3];
2140 }
2141 foreach ($tableAttrs as $key => $value) {
2142 $table .= ($table ? ' ' : '') . $key . '="' . htmlspecialchars($value) . '"';
2143 }
2144 $out = '<table ' . $table . $style . '>' . $section . '</table>';
2145 return $out;
2146 }
2147
2148 /**
2149 * Checks if the $table is the child of a inline type AND the $field is the label field of this table.
2150 * This function is used to dynamically update the label while editing. This has no effect on labels,
2151 * that were processed by a TCEmain-hook on saving.
2152 *
2153 * @param string $table The table to check
2154 * @param string $field The field on this table to check
2155 * @return boolean Is inline child and field is responsible for the label
2156 * @todo Define visibility
2157 */
2158 public function isInlineChildAndLabelField($table, $field) {
2159 $level = $this->getStructureLevel(-1);
2160 if ($level['config']['foreign_label']) {
2161 $label = $level['config']['foreign_label'];
2162 } else {
2163 $label = $GLOBALS['TCA'][$table]['ctrl']['label'];
2164 }
2165 return $level['config']['foreign_table'] === $table && $label == $field ? TRUE : FALSE;
2166 }
2167
2168 /**
2169 * Get the depth of the stable structure stack.
2170 * (count($this->inlineStructure['stable'])
2171 *
2172 * @return integer The depth of the structure stack
2173 * @todo Define visibility
2174 */
2175 public function getStructureDepth() {
2176 return count($this->inlineStructure['stable']);
2177 }
2178
2179 /**
2180 * Handles complex comparison requests on an array.
2181 * A request could look like the following:
2182 *
2183 * $searchArray = array(
2184 * '%AND' => array(
2185 * 'key1' => 'value1',
2186 * 'key2' => 'value2',
2187 * '%OR' => array(
2188 * 'subarray' => array(
2189 * 'subkey' => 'subvalue'
2190 * ),
2191 * 'key3' => 'value3',
2192 * 'key4' => 'value4'
2193 * )
2194 * )
2195 * );
2196 *
2197 * It is possible to use the array keys '%AND.1', '%AND.2', etc. to prevent
2198 * overwriting the sub-array. It could be neccessary, if you use complex comparisons.
2199 *
2200 * The example above means, key1 *AND* key2 (and their values) have to match with
2201 * the $subjectArray and additional one *OR* key3 or key4 have to meet the same
2202 * condition.
2203 * It is also possible to compare parts of a sub-array (e.g. "subarray"), so this
2204 * function recurses down one level in that sub-array.
2205 *
2206 * @param array $subjectArray The array to search in
2207 * @param array $searchArray The array with keys and values to search for
2208 * @param string $type Use '%AND' or '%OR' for comparision
2209 * @return boolean The result of the comparison
2210 * @todo Define visibility
2211 */
2212 public function arrayCompareComplex($subjectArray, $searchArray, $type = '') {
2213 $localMatches = 0;
2214 $localEntries = 0;
2215 if (is_array($searchArray) && count($searchArray)) {
2216 // If no type was passed, try to determine
2217 if (!$type) {
2218 reset($searchArray);
2219 $type = key($searchArray);
2220 $searchArray = current($searchArray);
2221 }
2222 // We use '%AND' and '%OR' in uppercase
2223 $type = strtoupper($type);
2224 // Split regular elements from sub elements
2225 foreach ($searchArray as $key => $value) {
2226 $localEntries++;
2227 // Process a sub-group of OR-conditions
2228 if ($key == '%OR') {
2229 $localMatches += $this->arrayCompareComplex($subjectArray, $value, '%OR') ? 1 : 0;
2230 } elseif ($key == '%AND') {
2231 $localMatches += $this->arrayCompareComplex($subjectArray, $value, '%AND') ? 1 : 0;
2232 } elseif (is_array($value) && $this->isAssociativeArray($searchArray)) {
2233 $localMatches += $this->arrayCompareComplex($subjectArray[$key], $value, $type) ? 1 : 0;
2234 } elseif (is_array($value)) {
2235 $localMatches += $this->arrayCompareComplex($subjectArray, $value, $type) ? 1 : 0;
2236 } else {
2237 if (isset($subjectArray[$key]) && isset($value)) {
2238 // Boolean match:
2239 if (is_bool($value)) {
2240 $localMatches += !($subjectArray[$key] xor $value) ? 1 : 0;
2241 } elseif (is_numeric($subjectArray[$key]) && is_numeric($value)) {
2242 $localMatches += $subjectArray[$key] == $value ? 1 : 0;
2243 } else {
2244 $localMatches += $subjectArray[$key] === $value ? 1 : 0;
2245 }
2246 }
2247 }
2248 // If one or more matches are required ('OR'), return TRUE after the first successful match
2249 if ($type == '%OR' && $localMatches > 0) {
2250 return TRUE;
2251 }
2252 // If all matches are required ('AND') and we have no result after the first run, return FALSE
2253 if ($type == '%AND' && $localMatches == 0) {
2254 return FALSE;
2255 }
2256 }
2257 }
2258 // Return the result for '%AND' (if nothing was checked, TRUE is returned)
2259 return $localEntries == $localMatches ? TRUE : FALSE;
2260 }
2261
2262 /**
2263 * Checks whether an object is an associative array.
2264 *
2265 * @param mixed $object The object to be checked
2266 * @return boolean Returns TRUE, if the object is an associative array
2267 * @todo Define visibility
2268 */
2269 public function isAssociativeArray($object) {
2270 return is_array($object) && count($object) && array_keys($object) !== range(0, sizeof($object) - 1) ? TRUE : FALSE;
2271 }
2272
2273 /**
2274 * Remove an element from an array.
2275 *
2276 * @param mixed $needle The element to be removed.
2277 * @param array $haystack The array the element should be removed from.
2278 * @param mixed $strict Search elements strictly.
2279 * @return array The array $haystack without the $needle
2280 * @todo Define visibility
2281 */
2282 public function removeFromArray($needle, $haystack, $strict = NULL) {
2283 $pos = array_search($needle, $haystack, $strict);
2284 if ($pos !== FALSE) {
2285 unset($haystack[$pos]);
2286 }
2287 return $haystack;
2288 }
2289
2290 /**
2291 * Makes a flat array from the $possibleRecords array.
2292 * The key of the flat array is the value of the record,
2293 * the value of the flat array is the label of the record.
2294 *
2295 * @param array $possibleRecords The possibleRecords array (for select fields)
2296 * @return mixed A flat array with key=uid, value=label; if $possibleRecords isn't an array, FALSE is returned.
2297 * @todo Define visibility
2298 */
2299 public function getPossibleRecordsFlat($possibleRecords) {
2300 $flat = FALSE;
2301 if (is_array($possibleRecords)) {
2302 $flat = array();
2303 foreach ($possibleRecords as $record) {
2304 $flat[$record[1]] = $record[0];
2305 }
2306 }
2307 return $flat;
2308 }
2309
2310 /**
2311 * Determine the configuration and the type of a record selector.
2312 *
2313 * @param array $conf TCA configuration of the parent(!) field
2314 * @return array Associative array with the keys 'PA' and 'type', both are FALSE if the selector was not valid.
2315 * @todo Define visibility
2316 */
2317 public function getPossibleRecordsSelectorConfig($conf, $field = '') {
2318 $foreign_table = $conf['foreign_table'];
2319 $foreign_selector = $conf['foreign_selector'];
2320 $PA = FALSE;
2321 $type = FALSE;
2322 $table = FALSE;
2323 $selector = FALSE;
2324 if ($field) {
2325 $PA = array();
2326 $PA['fieldConf'] = $GLOBALS['TCA'][$foreign_table]['columns'][$field];
2327 if ($PA['fieldConf'] && $conf['foreign_selector_fieldTcaOverride']) {
2328 \TYPO3\CMS\Core\Utility\ArrayUtility::mergeRecursiveWithOverrule($PA['fieldConf'], $conf['foreign_selector_fieldTcaOverride']);
2329 }
2330 $PA['fieldConf']['config']['form_type'] = $PA['fieldConf']['config']['form_type'] ?: $PA['fieldConf']['config']['type'];
2331 // Using "form_type" locally in this script
2332 $PA['fieldTSConfig'] = $this->fObj->setTSconfig($foreign_table, array(), $field);
2333 $config = $PA['fieldConf']['config'];
2334 // Determine type of Selector:
2335 $type = $this->getPossibleRecordsSelectorType($config);
2336 // Return table on this level:
2337 $table = $type == 'select' ? $config['foreign_table'] : $config['allowed'];
2338 // Return type of the selector if foreign_selector is defined and points to the same field as in $field:
2339 if ($foreign_selector && $foreign_selector == $field && $type) {
2340 $selector = $type;
2341 }
2342 }
2343 return array(
2344 'PA' => $PA,
2345 'type' => $type,
2346 'table' => $table,
2347 'selector' => $selector
2348 );
2349 }
2350
2351 /**
2352 * Determine the type of a record selector, e.g. select or group/db.
2353 *
2354 * @param array $config TCE configuration of the selector
2355 * @return mixed The type of the selector, 'select' or 'groupdb' - FALSE not valid
2356 * @todo Define visibility
2357 */
2358 public function getPossibleRecordsSelectorType($config) {
2359 $type = FALSE;
2360 if ($config['type'] == 'select') {
2361 $type = 'select';
2362 } elseif ($config['type'] == 'group' && $config['internal_type'] == 'db') {
2363 $type = 'groupdb';
2364 }
2365 return $type;
2366 }
2367
2368 /**
2369 * Check, if a field should be skipped, that was defined to be handled as foreign_field or foreign_sortby of
2370 * the parent record of the "inline"-type - if so, we have to skip this field - the rendering is done via "inline" as hidden field
2371 *
2372 * @param string $table The table name
2373 * @param string $field The field name
2374 * @param array $row The record row from the database
2375 * @param array $config TCA configuration of the field
2376 * @return boolean Determines whether the field should be skipped.
2377 * @todo Define visibility
2378 */
2379 public function skipField($table, $field, $row, $config) {
2380 $skipThisField = FALSE;
2381 if ($this->getStructureDepth()) {
2382 $searchArray = array(
2383 '%OR' => array(
2384 'config' => array(
2385 0 => array(
2386 '%AND' => array(
2387 'foreign_table' => $table,
2388 '%OR' => array(
2389 '%AND' => array(
2390 'appearance' => array('useCombination' => TRUE),
2391 'foreign_selector' => $field
2392 ),
2393 'MM' => $config['MM']
2394 )
2395 )
2396 ),
2397 1 => array(
2398 '%AND' => array(
2399 'foreign_table' => $config['foreign_table'],
2400 'foreign_selector' => $config['foreign_field']
2401 )
2402 )
2403 )
2404 )
2405 );
2406 // Get the parent record from structure stack
2407 $level = $this->getStructureLevel(-1);
2408 // If we have symmetric fields, check on which side we are and hide fields, that are set automatically:
2409 if (RelationHandler::isOnSymmetricSide($level['uid'], $level['config'], $row)) {
2410 $searchArray['%OR']['config'][0]['%AND']['%OR']['symmetric_field'] = $field;
2411 $searchArray['%OR']['config'][0]['%AND']['%OR']['symmetric_sortby'] = $field;
2412 } else {
2413 $searchArray['%OR']['config'][0]['%AND']['%OR']['foreign_field'] = $field;
2414 $searchArray['%OR']['config'][0]['%AND']['%OR']['foreign_sortby'] = $field;
2415 }
2416 $skipThisField = $this->compareStructureConfiguration($searchArray, TRUE);
2417 }
2418 return $skipThisField;
2419 }
2420
2421 /**
2422 * Checks if a uid of a child table is in the inline view settings.
2423 *
2424 * @param string $table Name of the child table
2425 * @param integer $uid uid of the the child record
2426 * @return boolean TRUE=expand, FALSE=collapse
2427 * @todo Define visibility
2428 */
2429 public function getExpandedCollapsedState($table, $uid) {
2430 if (isset($this->inlineView[$table]) && is_array($this->inlineView[$table])) {
2431 if (in_array($uid, $this->inlineView[$table]) !== FALSE) {
2432 return TRUE;
2433 }
2434 }
2435 return FALSE;
2436 }
2437
2438 /**
2439 * Update expanded/collapsed states on new inline records if any.
2440 *
2441 * @param array $uc The uc array to be processed and saved (by reference)
2442 * @param \TYPO3\CMS\Core\DataHandling\DataHandler $tce Instance of TCEmain that saved data before
2443 * @return void
2444 * @todo Define visibility
2445 */
2446 public function updateInlineView(&$uc, $tce) {
2447 if (isset($uc['inlineView']) && is_array($uc['inlineView'])) {
2448 $inlineView = (array) unserialize($GLOBALS['BE_USER']->uc['inlineView']);
2449 foreach ($uc['inlineView'] as $topTable => $topRecords) {
2450 foreach ($topRecords as $topUid => $childElements) {
2451 foreach ($childElements as $childTable => $childRecords) {
2452 $uids = array_keys($tce->substNEWwithIDs_table, $childTable);
2453 if (count($uids)) {
2454 $newExpandedChildren = array();
2455 foreach ($childRecords as $childUid => $state) {
2456 if ($state && in_array($childUid, $uids)) {
2457 $newChildUid = $tce->substNEWwithIDs[$childUid];
2458 $newExpandedChildren[] = $newChildUid;
2459 }
2460 }
2461 // Add new expanded child records to UC (if any):
2462 if (count($newExpandedChildren)) {
2463 $inlineViewCurrent = &$inlineView[$topTable][$topUid][$childTable];
2464 if (is_array($inlineViewCurrent)) {
2465 $inlineViewCurrent = array_unique(array_merge($inlineViewCurrent, $newExpandedChildren));
2466 } else {
2467 $inlineViewCurrent = $newExpandedChildren;
2468 }
2469 }
2470 }
2471 }
2472 }
2473 }
2474 $GLOBALS['BE_USER']->uc['inlineView'] = serialize($inlineView);
2475 $GLOBALS['BE_USER']->writeUC();
2476 }
2477 }
2478
2479 /**
2480 * Returns the the margin in pixels, that is used for each new inline level.
2481 *
2482 * @return integer A pixel value for the margin of each new inline level.
2483 * @todo Define visibility
2484 */
2485 public function getLevelMargin() {
2486 $margin = ($this->inlineStyles['margin-right'] + 1) * 2;
2487 return $margin;
2488 }
2489
2490 /**
2491 * Parses the HTML tags that would have been inserted to the <head> of a HTML document and returns the found tags as multidimensional array.
2492 *
2493 * @return array The parsed tags with their attributes and innerHTML parts
2494 */
2495 protected function getHeadTags() {
2496 $headTags = array();
2497 $headDataRaw = $this->fObj->JStop() . $this->getJavaScriptAndStyleSheetsOfPageRenderer();
2498 if ($headDataRaw) {
2499 // Create instance of the HTML parser:
2500 $parseObj = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Html\\HtmlParser');
2501 // Removes script wraps:
2502 $headDataRaw = str_replace(array('/*<![CDATA[*/', '/*]]>*/'), '', $headDataRaw);
2503 // Removes leading spaces of a multiline string:
2504 $headDataRaw = trim(preg_replace('/(^|\\r|\\n)( |\\t)+/', '$1', $headDataRaw));
2505 // Get script and link tags:
2506 $tags = array_merge($parseObj->getAllParts($parseObj->splitTags('link', $headDataRaw)), $parseObj->getAllParts($parseObj->splitIntoBlock('script', $headDataRaw)));
2507 foreach ($tags as $tagData) {
2508 $tagAttributes = $parseObj->get_tag_attributes($parseObj->getFirstTag($tagData), TRUE);
2509 $headTags[] = array(
2510 'name' => $parseObj->getFirstTagName($tagData),
2511 'attributes' => $tagAttributes[0],
2512 'innerHTML' => $parseObj->removeFirstAndLastTag($tagData)
2513 );
2514 }
2515 }
2516 return $headTags;
2517 }
2518
2519 /**
2520 * Gets the JavaScript of the pageRenderer.
2521 * This can be used to extract newly added files which have been added
2522 * during an AJAX request. Due to the spread possibilities of the pageRenderer
2523 * to add JavaScript rendering and extracting seems to be the easiest way.
2524 *
2525 * @return string
2526 */
2527 protected function getJavaScriptAndStyleSheetsOfPageRenderer() {
2528 /** @var $pageRenderer \TYPO3\CMS\Core\Page\PageRenderer */
2529 $pageRenderer = clone $GLOBALS['SOBE']->doc->getPageRenderer();
2530 $pageRenderer->setCharSet($GLOBALS['LANG']->charSet);
2531 $pageRenderer->setTemplateFile('EXT:backend/Resources/Private/Templates/helper_javascript_css.html');
2532 $javaScriptAndStyleSheets = $pageRenderer->render();
2533 return $javaScriptAndStyleSheets;
2534 }
2535
2536 /**
2537 * Wraps a text with an anchor and returns the HTML representation.
2538 *
2539 * @param string $text The text to be wrapped by an anchor
2540 * @param string $link The link to be used in the anchor
2541 * @param array $attributes Array of attributes to be used in the anchor
2542 * @return string The wrapped texted as HTML representation
2543 */
2544 protected function wrapWithAnchor($text, $link, $attributes = array()) {
2545 $link = trim($link);
2546 $result = '<a href="' . ($link ?: '#') . '"';
2547 foreach ($attributes as $key => $value) {
2548 $result .= ' ' . $key . '="' . htmlspecialchars(trim($value)) . '"';
2549 }
2550 $result .= '>' . $text . '</a>';
2551 return $result;
2552 }
2553
2554 /**
2555 * Extracts FlexForm parts of a form element name like
2556 * data[table][uid][field][sDEF][lDEF][FlexForm][vDEF]
2557 *
2558 * @param string $formElementName The form element name
2559 * @return array|NULL
2560 */
2561 protected function extractFlexFormParts($formElementName) {
2562 $flexFormParts = NULL;
2563
2564 $matches = array();
2565 $prefix = preg_quote($this->fObj->prependFormFieldNames, '#');
2566
2567 if (preg_match('#^' . $prefix . '(?:\[[^]]+\]){3}(\[data\](?:\[[^]]+\]){4,})$#', $formElementName, $matches)) {
2568 $flexFormParts = GeneralUtility::trimExplode(
2569 '][',
2570 trim($matches[1], '[]')
2571 );
2572 }
2573
2574 return $flexFormParts;
2575 }
2576
2577 }