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