[BUGFIX] Fix "Invalid cache entry identifier"
[Packages/TYPO3.CMS.git] / typo3 / sysext / backend / Classes / Utility / BackendUtility.php
1 <?php
2 namespace TYPO3\CMS\Backend\Utility;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Backend\Configuration\TranslationConfigurationProvider;
18 use TYPO3\CMS\Backend\Template\DocumentTemplate;
19 use TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
20 use TYPO3\CMS\Core\Cache\CacheManager;
21 use TYPO3\CMS\Core\Database\RelationHandler;
22 use TYPO3\CMS\Core\FormProtection\FormProtectionFactory;
23 use TYPO3\CMS\Core\Messaging\FlashMessage;
24 use TYPO3\CMS\Core\Resource\Exception\ResourceDoesNotExistException;
25 use TYPO3\CMS\Core\Resource\File;
26 use TYPO3\CMS\Core\Resource\ProcessedFile;
27 use TYPO3\CMS\Core\Resource\ResourceFactory;
28 use TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser;
29 use TYPO3\CMS\Core\Utility\ArrayUtility;
30 use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
31 use TYPO3\CMS\Core\Utility\GeneralUtility;
32 use TYPO3\CMS\Core\Utility\HttpUtility;
33 use TYPO3\CMS\Core\Utility\MathUtility;
34 use TYPO3\CMS\Core\Utility\PathUtility;
35 use TYPO3\CMS\Core\Versioning\VersionState;
36 use TYPO3\CMS\Core\Database\DatabaseConnection;
37 use TYPO3\CMS\Frontend\Page\PageRepository;
38 use TYPO3\CMS\Lang\LanguageService;
39
40 /**
41 * Standard functions available for the TYPO3 backend.
42 * You are encouraged to use this class in your own applications (Backend Modules)
43 * Don't instantiate - call functions with "\TYPO3\CMS\Backend\Utility\BackendUtility::" prefixed the function name.
44 *
45 * Call ALL methods without making an object!
46 * Eg. to get a page-record 51 do this: '\TYPO3\CMS\Backend\Utility\BackendUtility::getRecord('pages',51)'
47 *
48 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
49 */
50 class BackendUtility {
51
52 /**
53 * Cache the TCA configuration of tables with their types during runtime
54 *
55 * @var array
56 * @see getTCAtypes()
57 */
58 static protected $tcaTableTypeConfigurationCache = array();
59
60 /*******************************************
61 *
62 * SQL-related, selecting records, searching
63 *
64 *******************************************/
65 /**
66 * Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field
67 * is configured in $GLOBALS['TCA'] for the tablename, $table
68 * This function should ALWAYS be called in the backend for selection on tables which
69 * are configured in $GLOBALS['TCA'] since it will ensure consistent selection of records,
70 * even if they are marked deleted (in which case the system must always treat them as non-existent!)
71 * In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime
72 * and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering
73 * on those fields as well in the backend you can use ->BEenableFields() though.
74 *
75 * @param string $table Table name present in $GLOBALS['TCA']
76 * @param string $tableAlias Table alias if any
77 * @return string WHERE clause for filtering out deleted records, eg " AND tablename.deleted=0
78 */
79 static public function deleteClause($table, $tableAlias = '') {
80 if ($GLOBALS['TCA'][$table]['ctrl']['delete']) {
81 return ' AND ' . ($tableAlias ?: $table) . '.' . $GLOBALS['TCA'][$table]['ctrl']['delete'] . '=0';
82 } else {
83 return '';
84 }
85 }
86
87 /**
88 * Gets record with uid = $uid from $table
89 * You can set $field to a list of fields (default is '*')
90 * Additional WHERE clauses can be added by $where (fx. ' AND blabla = 1')
91 * Will automatically check if records has been deleted and if so, not return anything.
92 * $table must be found in $GLOBALS['TCA']
93 *
94 * @param string $table Table name present in $GLOBALS['TCA']
95 * @param int $uid UID of record
96 * @param string $fields List of fields to select
97 * @param string $where Additional WHERE clause, eg. " AND blablabla = 0
98 * @param bool $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
99 * @return array|NULL Returns the row if found, otherwise NULL
100 */
101 static public function getRecord($table, $uid, $fields = '*', $where = '', $useDeleteClause = TRUE) {
102 // Ensure we have a valid uid (not 0 and not NEWxxxx) and a valid TCA
103 if ((int)$uid && !empty($GLOBALS['TCA'][$table])) {
104 $where = 'uid=' . (int)$uid . ($useDeleteClause ? self::deleteClause($table) : '') . $where;
105 $row = static::getDatabaseConnection()->exec_SELECTgetSingleRow($fields, $table, $where);
106 if ($row) {
107 return $row;
108 }
109 }
110 return NULL;
111 }
112
113 /**
114 * Like getRecord(), but overlays workspace version if any.
115 *
116 * @param string $table Table name present in $GLOBALS['TCA']
117 * @param int $uid UID of record
118 * @param string $fields List of fields to select
119 * @param string $where Additional WHERE clause, eg. " AND blablabla = 0
120 * @param bool $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
121 * @param bool $unsetMovePointers If TRUE the function does not return a "pointer" row for moved records in a workspace
122 * @return array Returns the row if found, otherwise nothing
123 */
124 static public function getRecordWSOL($table, $uid, $fields = '*', $where = '', $useDeleteClause = TRUE, $unsetMovePointers = FALSE) {
125 if ($fields !== '*') {
126 $internalFields = GeneralUtility::uniqueList($fields . ',uid,pid');
127 $row = self::getRecord($table, $uid, $internalFields, $where, $useDeleteClause);
128 self::workspaceOL($table, $row, -99, $unsetMovePointers);
129 if (is_array($row)) {
130 foreach ($row as $key => $_) {
131 if (!GeneralUtility::inList($fields, $key) && $key[0] !== '_') {
132 unset($row[$key]);
133 }
134 }
135 }
136 } else {
137 $row = self::getRecord($table, $uid, $fields, $where, $useDeleteClause);
138 self::workspaceOL($table, $row, -99, $unsetMovePointers);
139 }
140 return $row;
141 }
142
143 /**
144 * Returns the first record found from $table with $where as WHERE clause
145 * This function does NOT check if a record has the deleted flag set.
146 * $table does NOT need to be configured in $GLOBALS['TCA']
147 * The query used is simply this:
148 * $query = 'SELECT ' . $fields . ' FROM ' . $table . ' WHERE ' . $where;
149 *
150 * @param string $table Table name (not necessarily in TCA)
151 * @param string $where WHERE clause
152 * @param string $fields $fields is a list of fields to select, default is '*'
153 * @return array First row found, if any, FALSE otherwise
154 */
155 static public function getRecordRaw($table, $where = '', $fields = '*') {
156 $row = FALSE;
157 $db = static::getDatabaseConnection();
158 if (FALSE !== ($res = $db->exec_SELECTquery($fields, $table, $where, '', '', '1'))) {
159 $row = $db->sql_fetch_assoc($res);
160 $db->sql_free_result($res);
161 }
162 return $row;
163 }
164
165 /**
166 * Returns records from table, $theTable, where a field ($theField) equals the value, $theValue
167 * The records are returned in an array
168 * If no records were selected, the function returns nothing
169 *
170 * @param string $theTable Table name present in $GLOBALS['TCA']
171 * @param string $theField Field to select on
172 * @param string $theValue Value that $theField must match
173 * @param string $whereClause Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
174 * @param string $groupBy Optional GROUP BY field(s), if none, supply blank string.
175 * @param string $orderBy Optional ORDER BY field(s), if none, supply blank string.
176 * @param string $limit Optional LIMIT value ([begin,]max), if none, supply blank string.
177 * @param bool $useDeleteClause Use the deleteClause to check if a record is deleted (default TRUE)
178 * @return mixed Multidimensional array with selected records (if any is selected)
179 */
180 static public function getRecordsByField($theTable, $theField, $theValue, $whereClause = '', $groupBy = '', $orderBy = '', $limit = '', $useDeleteClause = TRUE) {
181 if (is_array($GLOBALS['TCA'][$theTable])) {
182 $db = static::getDatabaseConnection();
183 $res = $db->exec_SELECTquery(
184 '*',
185 $theTable,
186 $theField . '=' . $db->fullQuoteStr($theValue, $theTable) .
187 ($useDeleteClause ? self::deleteClause($theTable) . ' ' : '') .
188 self::versioningPlaceholderClause($theTable) . ' ' .
189 $whereClause,
190 $groupBy,
191 $orderBy,
192 $limit
193 );
194 $rows = array();
195 while ($row = $db->sql_fetch_assoc($res)) {
196 $rows[] = $row;
197 }
198 $db->sql_free_result($res);
199 if (count($rows)) {
200 return $rows;
201 }
202 }
203 return NULL;
204 }
205
206 /**
207 * Makes an backwards explode on the $str and returns an array with ($table, $uid).
208 * Example: tt_content_45 => array('tt_content', 45)
209 *
210 * @param string $str [tablename]_[uid] string to explode
211 * @return array
212 */
213 static public function splitTable_Uid($str) {
214 list($uid, $table) = explode('_', strrev($str), 2);
215 return array(strrev($table), strrev($uid));
216 }
217
218 /**
219 * Returns a list of pure ints based on $in_list being a list of records with table-names prepended.
220 * Ex: $in_list = "pages_4,tt_content_12,45" would result in a return value of "4,45" if $tablename is "pages" and $default_tablename is 'pages' as well.
221 *
222 * @param string $in_list Input list
223 * @param string $tablename Table name from which ids is returned
224 * @param string $default_tablename $default_tablename denotes what table the number '45' is from (if nothing is prepended on the value)
225 * @return string List of ids
226 */
227 static public function getSQLselectableList($in_list, $tablename, $default_tablename) {
228 $list = array();
229 if ((string)trim($in_list) != '') {
230 $tempItemArray = explode(',', trim($in_list));
231 foreach ($tempItemArray as $key => $val) {
232 $val = strrev($val);
233 $parts = explode('_', $val, 2);
234 if ((string)trim($parts[0]) != '') {
235 $theID = (int)strrev($parts[0]);
236 $theTable = trim($parts[1]) ? strrev(trim($parts[1])) : $default_tablename;
237 if ($theTable == $tablename) {
238 $list[] = $theID;
239 }
240 }
241 }
242 }
243 return implode(',', $list);
244 }
245
246 /**
247 * Backend implementation of enableFields()
248 * Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
249 * Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
250 * $GLOBALS["SIM_ACCESS_TIME"] is used for date.
251 *
252 * @param string $table The table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
253 * @param bool $inv Means that the query will select all records NOT VISIBLE records (inverted selection)
254 * @return string WHERE clause part
255 */
256 static public function BEenableFields($table, $inv = FALSE) {
257 $ctrl = $GLOBALS['TCA'][$table]['ctrl'];
258 $query = array();
259 $invQuery = array();
260 if (is_array($ctrl)) {
261 if (is_array($ctrl['enablecolumns'])) {
262 if ($ctrl['enablecolumns']['disabled']) {
263 $field = $table . '.' . $ctrl['enablecolumns']['disabled'];
264 $query[] = $field . '=0';
265 $invQuery[] = $field . '<>0';
266 }
267 if ($ctrl['enablecolumns']['starttime']) {
268 $field = $table . '.' . $ctrl['enablecolumns']['starttime'];
269 $query[] = '(' . $field . '<=' . $GLOBALS['SIM_ACCESS_TIME'] . ')';
270 $invQuery[] = '(' . $field . '<>0 AND ' . $field . '>' . $GLOBALS['SIM_ACCESS_TIME'] . ')';
271 }
272 if ($ctrl['enablecolumns']['endtime']) {
273 $field = $table . '.' . $ctrl['enablecolumns']['endtime'];
274 $query[] = '(' . $field . '=0 OR ' . $field . '>' . $GLOBALS['SIM_ACCESS_TIME'] . ')';
275 $invQuery[] = '(' . $field . '<>0 AND ' . $field . '<=' . $GLOBALS['SIM_ACCESS_TIME'] . ')';
276 }
277 }
278 }
279 $outQ = $inv ? '(' . implode(' OR ', $invQuery) . ')' : implode(' AND ', $query);
280 return $outQ ? ' AND ' . $outQ : '';
281 }
282
283 /**
284 * Fetches the localization for a given record.
285 *
286 * @param string $table Table name present in $GLOBALS['TCA']
287 * @param int $uid The uid of the record
288 * @param int $language The uid of the language record in sys_language
289 * @param string $andWhereClause Optional additional WHERE clause (default: '')
290 * @return mixed Multidimensional array with selected records; if none exist, FALSE is returned
291 */
292 static public function getRecordLocalization($table, $uid, $language, $andWhereClause = '') {
293 $recordLocalization = FALSE;
294
295 // Check if translations are stored in other table
296 if (isset($GLOBALS['TCA'][$table]['ctrl']['transForeignTable'])) {
297 $table = $GLOBALS['TCA'][$table]['ctrl']['transForeignTable'];
298 }
299
300 if (self::isTableLocalizable($table)) {
301 $tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
302 $recordLocalization = self::getRecordsByField($table, $tcaCtrl['transOrigPointerField'], $uid, 'AND ' . $tcaCtrl['languageField'] . '=' . (int)$language . ($andWhereClause ? ' ' . $andWhereClause : ''), '', '', '1');
303 }
304 return $recordLocalization;
305 }
306
307 /*******************************************
308 *
309 * Page tree, TCA related
310 *
311 *******************************************/
312 /**
313 * Returns what is called the 'RootLine'. That is an array with information about the page records from a page id ($uid) and back to the root.
314 * By default deleted pages are filtered.
315 * This RootLine will follow the tree all the way to the root. This is opposite to another kind of root line known from the frontend where the rootline stops when a root-template is found.
316 *
317 * @param int $uid Page id for which to create the root line.
318 * @param string $clause Clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
319 * @param bool $workspaceOL If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
320 * @return array Root line array, all the way to the page tree root (or as far as $clause allows!)
321 */
322 static public function BEgetRootLine($uid, $clause = '', $workspaceOL = FALSE) {
323 static $BEgetRootLine_cache = array();
324 $output = array();
325 $pid = $uid;
326 $ident = $pid . '-' . $clause . '-' . $workspaceOL;
327 if (is_array($BEgetRootLine_cache[$ident])) {
328 $output = $BEgetRootLine_cache[$ident];
329 } else {
330 $loopCheck = 100;
331 $theRowArray = array();
332 while ($uid != 0 && $loopCheck) {
333 $loopCheck--;
334 $row = self::getPageForRootline($uid, $clause, $workspaceOL);
335 if (is_array($row)) {
336 $uid = $row['pid'];
337 $theRowArray[] = $row;
338 } else {
339 break;
340 }
341 }
342 if ($uid == 0) {
343 $theRowArray[] = array('uid' => 0, 'title' => '');
344 }
345 $c = count($theRowArray);
346 foreach ($theRowArray as $val) {
347 $c--;
348 $output[$c] = array(
349 'uid' => $val['uid'],
350 'pid' => $val['pid'],
351 'title' => $val['title'],
352 'TSconfig' => $val['TSconfig'],
353 'is_siteroot' => $val['is_siteroot'],
354 'storage_pid' => $val['storage_pid'],
355 't3ver_oid' => $val['t3ver_oid'],
356 't3ver_wsid' => $val['t3ver_wsid'],
357 't3ver_state' => $val['t3ver_state'],
358 't3ver_stage' => $val['t3ver_stage'],
359 'backend_layout_next_level' => $val['backend_layout_next_level']
360 );
361 if (isset($val['_ORIG_pid'])) {
362 $output[$c]['_ORIG_pid'] = $val['_ORIG_pid'];
363 }
364 }
365 $BEgetRootLine_cache[$ident] = $output;
366 }
367 return $output;
368 }
369
370 /**
371 * Gets the cached page record for the rootline
372 *
373 * @param int $uid Page id for which to create the root line.
374 * @param string $clause Clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
375 * @param bool $workspaceOL If TRUE, version overlay is applied. This must be requested specifically because it is usually only wanted when the rootline is used for visual output while for permission checking you want the raw thing!
376 * @return array Cached page record for the rootline
377 * @see BEgetRootLine
378 */
379 static protected function getPageForRootline($uid, $clause, $workspaceOL) {
380 static $getPageForRootline_cache = array();
381 $ident = $uid . '-' . $clause . '-' . $workspaceOL;
382 if (is_array($getPageForRootline_cache[$ident])) {
383 $row = $getPageForRootline_cache[$ident];
384 } else {
385 $db = static::getDatabaseConnection();
386 $res = $db->exec_SELECTquery('pid,uid,title,TSconfig,is_siteroot,storage_pid,t3ver_oid,t3ver_wsid,t3ver_state,t3ver_stage,backend_layout_next_level', 'pages', 'uid=' . (int)$uid . ' ' . self::deleteClause('pages') . ' ' . $clause);
387 $row = $db->sql_fetch_assoc($res);
388 if ($row) {
389 $newLocation = FALSE;
390 if ($workspaceOL) {
391 self::workspaceOL('pages', $row);
392 $newLocation = self::getMovePlaceholder('pages', $row['uid'], 'pid');
393 }
394 if (is_array($row)) {
395 if ($newLocation !== FALSE) {
396 $row['pid'] = $newLocation['pid'];
397 } else {
398 self::fixVersioningPid('pages', $row);
399 }
400 $getPageForRootline_cache[$ident] = $row;
401 }
402 }
403 $db->sql_free_result($res);
404 }
405 return $row;
406 }
407
408 /**
409 * Opens the page tree to the specified page id
410 *
411 * @param int $pid Page id.
412 * @param bool $clearExpansion If set, then other open branches are closed.
413 * @return void
414 */
415 static public function openPageTree($pid, $clearExpansion) {
416 $beUser = static::getBackendUserAuthentication();
417 // Get current expansion data:
418 if ($clearExpansion) {
419 $expandedPages = array();
420 } else {
421 $expandedPages = unserialize($beUser->uc['browseTrees']['browsePages']);
422 }
423 // Get rootline:
424 $rL = self::BEgetRootLine($pid);
425 // First, find out what mount index to use (if more than one DB mount exists):
426 $mountIndex = 0;
427 $mountKeys = array_flip($beUser->returnWebmounts());
428 foreach ($rL as $rLDat) {
429 if (isset($mountKeys[$rLDat['uid']])) {
430 $mountIndex = $mountKeys[$rLDat['uid']];
431 break;
432 }
433 }
434 // Traverse rootline and open paths:
435 foreach ($rL as $rLDat) {
436 $expandedPages[$mountIndex][$rLDat['uid']] = 1;
437 }
438 // Write back:
439 $beUser->uc['browseTrees']['browsePages'] = serialize($expandedPages);
440 $beUser->writeUC();
441 }
442
443 /**
444 * Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage"
445 * Each part of the path will be limited to $titleLimit characters
446 * Deleted pages are filtered out.
447 *
448 * @param int $uid Page uid for which to create record path
449 * @param string $clause Clause is additional where clauses, eg.
450 * @param int $titleLimit Title limit
451 * @param int $fullTitleLimit Title limit of Full title (typ. set to 1000 or so)
452 * @return mixed Path of record (string) OR array with short/long title if $fullTitleLimit is set.
453 */
454 static public function getRecordPath($uid, $clause, $titleLimit, $fullTitleLimit = 0) {
455 if (!$titleLimit) {
456 $titleLimit = 1000;
457 }
458 $output = $fullOutput = '/';
459 $clause = trim($clause);
460 if ($clause !== '' && substr($clause, 0, 3) !== 'AND') {
461 $clause = 'AND ' . $clause;
462 }
463 $data = self::BEgetRootLine($uid, $clause);
464 foreach ($data as $record) {
465 if ($record['uid'] === 0) {
466 continue;
467 }
468 $output = '/' . GeneralUtility::fixed_lgd_cs(strip_tags($record['title']), $titleLimit) . $output;
469 if ($fullTitleLimit) {
470 $fullOutput = '/' . GeneralUtility::fixed_lgd_cs(strip_tags($record['title']), $fullTitleLimit) . $fullOutput;
471 }
472 }
473 if ($fullTitleLimit) {
474 return array($output, $fullOutput);
475 } else {
476 return $output;
477 }
478 }
479
480 /**
481 * Returns an array with the exclude-fields as defined in TCA and FlexForms
482 * Used for listing the exclude-fields in be_groups forms
483 *
484 * @return array Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries and from FlexForms (fieldname, table:extkey;sheetname;fieldname)
485 */
486 static public function getExcludeFields() {
487 $finalExcludeArray = array();
488
489 // Fetch translations for table names
490 $tableToTranslation = array();
491 $lang = static::getLanguageService();
492 // All TCA keys
493 foreach ($GLOBALS['TCA'] as $table => $conf) {
494 $tableToTranslation[$table] = $lang->sl($conf['ctrl']['title']);
495 }
496 // Sort by translations
497 asort($tableToTranslation);
498 foreach ($tableToTranslation as $table => $translatedTable) {
499 $excludeArrayTable = array();
500
501 // All field names configured and not restricted to admins
502 if (is_array($GLOBALS['TCA'][$table]['columns'])
503 && empty($GLOBALS['TCA'][$table]['ctrl']['adminOnly'])
504 && (empty($GLOBALS['TCA'][$table]['ctrl']['rootLevel']) || !empty($GLOBALS['TCA'][$table]['ctrl']['security']['ignoreRootLevelRestriction']))
505 ) {
506 foreach ($GLOBALS['TCA'][$table]['columns'] as $field => $_) {
507 if ($GLOBALS['TCA'][$table]['columns'][$field]['exclude']) {
508 // Get human readable names of fields
509 $translatedField = $lang->sl($GLOBALS['TCA'][$table]['columns'][$field]['label']);
510 // Add entry
511 $excludeArrayTable[] = array($translatedTable . ': ' . $translatedField, $table . ':' . $field);
512 }
513 }
514 }
515 // All FlexForm fields
516 $flexFormArray = static::getRegisteredFlexForms($table);
517 foreach ($flexFormArray as $tableField => $flexForms) {
518 // Prefix for field label, e.g. "Plugin Options:"
519 $labelPrefix = '';
520 if (!empty($GLOBALS['TCA'][$table]['columns'][$tableField]['label'])) {
521 $labelPrefix = $lang->sl($GLOBALS['TCA'][$table]['columns'][$tableField]['label']);
522 }
523 // Get all sheets and title
524 foreach ($flexForms as $extIdent => $extConf) {
525 $extTitle = $lang->sl($extConf['title']);
526 // Get all fields in sheet
527 foreach ($extConf['ds']['sheets'] as $sheetName => $sheet) {
528 if (empty($sheet['ROOT']['el']) || !is_array($sheet['ROOT']['el'])) {
529 continue;
530 }
531 foreach ($sheet['ROOT']['el'] as $fieldName => $field) {
532 // Use only excludeable fields
533 if (empty($field['TCEforms']['exclude'])) {
534 continue;
535 }
536 $fieldLabel = !empty($field['TCEforms']['label']) ? $lang->sl($field['TCEforms']['label']) : $fieldName;
537 $fieldIdent = $table . ':' . $tableField . ';' . $extIdent . ';' . $sheetName . ';' . $fieldName;
538 $excludeArrayTable[] = array(trim(($labelPrefix . ' ' . $extTitle), ': ') . ': ' . $fieldLabel, $fieldIdent);
539 }
540 }
541 }
542 }
543 // Sort fields by the translated value
544 if (count($excludeArrayTable) > 0) {
545 usort($excludeArrayTable, array(\TYPO3\CMS\Backend\Form\FlexFormsHelper::class, 'compareArraysByFirstValue'));
546 $finalExcludeArray = array_merge($finalExcludeArray, $excludeArrayTable);
547 }
548 }
549
550 return $finalExcludeArray;
551 }
552
553 /**
554 * Returns an array with explicit Allow/Deny fields.
555 * Used for listing these field/value pairs in be_groups forms
556 *
557 * @return array Array with information from all of $GLOBALS['TCA']
558 */
559 static public function getExplicitAuthFieldValues() {
560 // Initialize:
561 $lang = static::getLanguageService();
562 $adLabel = array(
563 'ALLOW' => $lang->sl('LLL:EXT:lang/locallang_core.xlf:labels.allow'),
564 'DENY' => $lang->sl('LLL:EXT:lang/locallang_core.xlf:labels.deny')
565 );
566 // All TCA keys:
567 $allowDenyOptions = array();
568 foreach ($GLOBALS['TCA'] as $table => $_) {
569 // All field names configured:
570 if (is_array($GLOBALS['TCA'][$table]['columns'])) {
571 foreach ($GLOBALS['TCA'][$table]['columns'] as $field => $_) {
572 $fCfg = $GLOBALS['TCA'][$table]['columns'][$field]['config'];
573 if ($fCfg['type'] == 'select' && $fCfg['authMode']) {
574 // Check for items:
575 if (is_array($fCfg['items'])) {
576 // Get Human Readable names of fields and table:
577 $allowDenyOptions[$table . ':' . $field]['tableFieldLabel'] =
578 $lang->sl($GLOBALS['TCA'][$table]['ctrl']['title']) . ': '
579 . $lang->sl($GLOBALS['TCA'][$table]['columns'][$field]['label']);
580 // Check for items:
581 foreach ($fCfg['items'] as $iVal) {
582 // Values '' is not controlled by this setting.
583 if ((string)$iVal[1] !== '') {
584 // Find iMode
585 $iMode = '';
586 switch ((string)$fCfg['authMode']) {
587 case 'explicitAllow':
588 $iMode = 'ALLOW';
589 break;
590 case 'explicitDeny':
591 $iMode = 'DENY';
592 break;
593 case 'individual':
594 if ($iVal[4] === 'EXPL_ALLOW') {
595 $iMode = 'ALLOW';
596 } elseif ($iVal[4] === 'EXPL_DENY') {
597 $iMode = 'DENY';
598 }
599 break;
600 }
601 // Set iMode
602 if ($iMode) {
603 $allowDenyOptions[$table . ':' . $field]['items'][$iVal[1]] = array($iMode, $lang->sl($iVal[0]), $adLabel[$iMode]);
604 }
605 }
606 }
607 }
608 }
609 }
610 }
611 }
612 return $allowDenyOptions;
613 }
614
615 /**
616 * Returns an array with system languages:
617 *
618 * The property flagIcon returns a string <flags-xx>. The calling party should call
619 * \TYPO3\CMS\Backend\Utility\IconUtility::getSpriteIcon(<flags-xx>) to get an HTML
620 * which will represent the flag of this language.
621 *
622 * @return array Array with languages (title, uid, flagIcon - used with IconUtility::getSpriteIcon)
623 */
624 static public function getSystemLanguages() {
625 /** @var TranslationConfigurationProvider $translationConfigurationProvider */
626 $translationConfigurationProvider = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Configuration\TranslationConfigurationProvider::class);
627 $languages = $translationConfigurationProvider->getSystemLanguages();
628 $sysLanguages = array();
629 foreach ($languages as $language) {
630 if ($language['uid'] !== -1) {
631 $sysLanguages[] = array(
632 0 => htmlspecialchars($language['title']) . ' [' . $language['uid'] . ']',
633 1 => $language['uid'],
634 2 => $language['flagIcon']
635 );
636 }
637 }
638 return $sysLanguages;
639 }
640
641 /**
642 * Gets the original translation pointer table.
643 * For e.g. pages_language_overlay this would be pages.
644 *
645 * @param string $table Name of the table
646 * @return string Pointer table (if any)
647 */
648 static public function getOriginalTranslationTable($table) {
649 if (!empty($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerTable'])) {
650 $table = $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerTable'];
651 }
652
653 return $table;
654 }
655
656 /**
657 * Determines whether a table is localizable and has the languageField and transOrigPointerField set in $GLOBALS['TCA'].
658 *
659 * @param string $table The table to check
660 * @return bool Whether a table is localizable
661 */
662 static public function isTableLocalizable($table) {
663 $isLocalizable = FALSE;
664 if (isset($GLOBALS['TCA'][$table]['ctrl']) && is_array($GLOBALS['TCA'][$table]['ctrl'])) {
665 $tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
666 $isLocalizable = isset($tcaCtrl['languageField']) && $tcaCtrl['languageField'] && isset($tcaCtrl['transOrigPointerField']) && $tcaCtrl['transOrigPointerField'];
667 }
668 return $isLocalizable;
669 }
670
671 /**
672 * Returns the value of the property localizationMode in the given $config array ($GLOBALS['TCA'][<table>]['columns'][<field>]['config']).
673 * If the table is prepared for localization and no localizationMode is set, 'select' is returned by default.
674 * If the table is not prepared for localization or not defined at all in $GLOBALS['TCA'], FALSE is returned.
675 *
676 * @param string $table The name of the table to lookup in TCA
677 * @param mixed $fieldOrConfig The fieldname (string) or the configuration of the field to check (array)
678 * @return mixed If table is localizable, the set localizationMode is returned (if property is not set, 'select' is returned by default); if table is not localizable, FALSE is returned
679 */
680 static public function getInlineLocalizationMode($table, $fieldOrConfig) {
681 $localizationMode = FALSE;
682 $config = NULL;
683 if (is_array($fieldOrConfig) && !empty($fieldOrConfig)) {
684 $config = $fieldOrConfig;
685 } elseif (is_string($fieldOrConfig) && isset($GLOBALS['TCA'][$table]['columns'][$fieldOrConfig]['config'])) {
686 $config = $GLOBALS['TCA'][$table]['columns'][$fieldOrConfig]['config'];
687 }
688 if (is_array($config) && isset($config['type']) && $config['type'] === 'inline' && self::isTableLocalizable($table)) {
689 $localizationMode = isset($config['behaviour']['localizationMode']) && $config['behaviour']['localizationMode']
690 ? $config['behaviour']['localizationMode']
691 : 'select';
692 // The mode 'select' is not possible when child table is not localizable at all:
693 if ($localizationMode === 'select' && !self::isTableLocalizable($config['foreign_table'])) {
694 $localizationMode = FALSE;
695 }
696 }
697 return $localizationMode;
698 }
699
700 /**
701 * Returns a page record (of page with $id) with an extra field "_thePath" set to the record path IF the WHERE clause, $perms_clause, selects the record. Thus is works as an access check that returns a page record if access was granted, otherwise not.
702 * If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin.
703 * In any case ->isInWebMount must return TRUE for the user (regardless of $perms_clause)
704 *
705 * @param int $id Page uid for which to check read-access
706 * @param string $perms_clause This is typically a value generated with static::getBackendUserAuthentication()->getPagePermsClause(1);
707 * @return array Returns page record if OK, otherwise FALSE.
708 */
709 static public function readPageAccess($id, $perms_clause) {
710 if ((string)$id !== '') {
711 $id = (int)$id;
712 if (!$id) {
713 if (static::getBackendUserAuthentication()->isAdmin()) {
714 $path = '/';
715 $pageinfo['_thePath'] = $path;
716 return $pageinfo;
717 }
718 } else {
719 $pageinfo = self::getRecord('pages', $id, '*', $perms_clause ? ' AND ' . $perms_clause : '');
720 if ($pageinfo['uid'] && static::getBackendUserAuthentication()->isInWebMount($id, $perms_clause)) {
721 self::workspaceOL('pages', $pageinfo);
722 if (is_array($pageinfo)) {
723 self::fixVersioningPid('pages', $pageinfo);
724 list($pageinfo['_thePath'], $pageinfo['_thePathFull']) = self::getRecordPath((int)$pageinfo['uid'], $perms_clause, 15, 1000);
725 return $pageinfo;
726 }
727 }
728 }
729 }
730 return FALSE;
731 }
732
733 /**
734 * Returns the "types" configuration parsed into an array for the record, $rec, from table, $table
735 *
736 * @param string $table Table name (present in TCA)
737 * @param array $rec Record from $table
738 * @param bool $useFieldNameAsKey If $useFieldNameAsKey is set, then the fieldname is associative keys in the return array, otherwise just numeric keys.
739 * @return array|NULL
740 */
741 static public function getTCAtypes($table, $rec, $useFieldNameAsKey = FALSE) {
742 if ($GLOBALS['TCA'][$table]) {
743 // Get type value:
744 $fieldValue = self::getTCAtypeValue($table, $rec);
745 $cacheIdentifier = $table . '-type-' . $fieldValue . '-fnk-' . $useFieldNameAsKey;
746
747 // Fetch from first-level-cache if available
748 if (isset(self::$tcaTableTypeConfigurationCache[$cacheIdentifier])) {
749 return self::$tcaTableTypeConfigurationCache[$cacheIdentifier];
750 }
751
752 // Get typesConf
753 $typesConf = $GLOBALS['TCA'][$table]['types'][$fieldValue];
754 // Get fields list and traverse it
755 $fieldList = explode(',', $typesConf['showitem']);
756
757 // Add subtype fields e.g. for a valid RTE transformation
758 // The RTE runs the DB -> RTE transformation only, if the RTE field is part of the getTCAtypes array
759 if (isset($typesConf['subtype_value_field'])) {
760 $subType = $rec[$typesConf['subtype_value_field']];
761 if (isset($typesConf['subtypes_addlist'][$subType])) {
762 $subFields = GeneralUtility::trimExplode(',', $typesConf['subtypes_addlist'][$subType], TRUE);
763 $fieldList = array_merge($fieldList, $subFields);
764 }
765 }
766
767 $altFieldList = array();
768 // Traverse fields in types config and parse the configuration into a nice array:
769 foreach ($fieldList as $k => $v) {
770 list($pFieldName, $pAltTitle, $pPalette, $pSpec) = GeneralUtility::trimExplode(';', $v);
771 $defaultExtras = is_array($GLOBALS['TCA'][$table]['columns'][$pFieldName]) ? $GLOBALS['TCA'][$table]['columns'][$pFieldName]['defaultExtras'] : '';
772 $specConfParts = self::getSpecConfParts($pSpec, $defaultExtras);
773 $fieldList[$k] = array(
774 'field' => $pFieldName,
775 'title' => $pAltTitle,
776 'palette' => $pPalette,
777 'spec' => $specConfParts,
778 'origString' => $v
779 );
780 if ($useFieldNameAsKey) {
781 $altFieldList[$fieldList[$k]['field']] = $fieldList[$k];
782 }
783 }
784 if ($useFieldNameAsKey) {
785 $fieldList = $altFieldList;
786 }
787
788 // Add to first-level-cache
789 self::$tcaTableTypeConfigurationCache[$cacheIdentifier] = $fieldList;
790
791 // Return array:
792 return $fieldList;
793 }
794 return NULL;
795 }
796
797 /**
798 * Returns the "type" value of $rec from $table which can be used to look up the correct "types" rendering section in $GLOBALS['TCA']
799 * If no "type" field is configured in the "ctrl"-section of the $GLOBALS['TCA'] for the table, zero is used.
800 * If zero is not an index in the "types" section of $GLOBALS['TCA'] for the table, then the $fieldValue returned will default to 1 (no matter if that is an index or not)
801 *
802 * Note: This method is very similar to \TYPO3\CMS\Backend\Form\FormEngine::getRTypeNum(),
803 * however, it has two differences:
804 * 1) The method in TCEForms also takes care of localization (which is difficult to do here as the whole infrastructure for language overlays is only in TCEforms).
805 * 2) The $rec array looks different in TCEForms, as in there it's not the raw record but the \TYPO3\CMS\Backend\Form\DataPreprocessor version of it, which changes e.g. how "select"
806 * and "group" field values are stored, which makes different processing of the "foreign pointer field" type field variant necessary.
807 *
808 * @param string $table Table name present in TCA
809 * @param array $row Record from $table
810 * @throws \RuntimeException
811 * @return string Field value
812 * @see getTCAtypes()
813 */
814 static public function getTCAtypeValue($table, $row) {
815 $typeNum = 0;
816 if ($GLOBALS['TCA'][$table]) {
817 $field = $GLOBALS['TCA'][$table]['ctrl']['type'];
818 if (strpos($field, ':') !== FALSE) {
819 list($pointerField, $foreignTableTypeField) = explode(':', $field);
820 // Get field value from database if field is not in the $row array
821 if (!isset($row[$pointerField])) {
822 $localRow = self::getRecord($table, $row['uid'], $pointerField);
823 $foreignUid = $localRow[$pointerField];
824 } else {
825 $foreignUid = $row[$pointerField];
826 }
827 if ($foreignUid) {
828 $fieldConfig = $GLOBALS['TCA'][$table]['columns'][$pointerField]['config'];
829 $relationType = $fieldConfig['type'];
830 if ($relationType === 'select') {
831 $foreignTable = $fieldConfig['foreign_table'];
832 } elseif ($relationType === 'group') {
833 $allowedTables = explode(',', $fieldConfig['allowed']);
834 $foreignTable = $allowedTables[0];
835 } else {
836 throw new \RuntimeException('TCA foreign field pointer fields are only allowed to be used with group or select field types.', 1325862240);
837 }
838 $foreignRow = self::getRecord($foreignTable, $foreignUid, $foreignTableTypeField);
839 if ($foreignRow[$foreignTableTypeField]) {
840 $typeNum = $foreignRow[$foreignTableTypeField];
841 }
842 }
843 } else {
844 $typeNum = $row[$field];
845 }
846 // If that value is an empty string, set it to "0" (zero)
847 if (empty($typeNum)) {
848 $typeNum = 0;
849 }
850 }
851 // If current typeNum doesn't exist, set it to 0 (or to 1 for historical reasons, if 0 doesn't exist)
852 if (!$GLOBALS['TCA'][$table]['types'][$typeNum]) {
853 $typeNum = $GLOBALS['TCA'][$table]['types']['0'] ? 0 : 1;
854 }
855 // Force to string. Necessary for eg '-1' to be recognized as a type value.
856 $typeNum = (string)$typeNum;
857 return $typeNum;
858 }
859
860 /**
861 * Parses a part of the field lists in the "types"-section of $GLOBALS['TCA'] arrays, namely the "special configuration" at index 3 (position 4)
862 * Elements are splitted by ":" and within those parts, parameters are splitted by "|".
863 * Everything is returned in an array and you should rather see it visually than listen to me anymore now... Check out example in Inside TYPO3
864 *
865 * @param string $str Content from the "types" configuration of TCA (the special configuration) - see description of function
866 * @param string $defaultExtras The ['defaultExtras'] value from field configuration
867 * @return array
868 */
869 static public function getSpecConfParts($str, $defaultExtras) {
870 // Add defaultExtras:
871 $specConfParts = GeneralUtility::trimExplode(':', $defaultExtras . ':' . $str, TRUE);
872 $reg = array();
873 if (count($specConfParts)) {
874 foreach ($specConfParts as $k2 => $v2) {
875 unset($specConfParts[$k2]);
876 if (preg_match('/(.*)\\[(.*)\\]/', $v2, $reg)) {
877 $specConfParts[trim($reg[1])] = array(
878 'parameters' => GeneralUtility::trimExplode('|', $reg[2], TRUE)
879 );
880 } else {
881 $specConfParts[trim($v2)] = 1;
882 }
883 }
884 } else {
885 $specConfParts = array();
886 }
887 return $specConfParts;
888 }
889
890 /**
891 * Takes an array of "[key] = [value]" strings and returns an array with the keys set as keys pointing to the value.
892 * Better see it in action! Find example in Inside TYPO3
893 *
894 * @param array $pArr Array of "[key] = [value]" strings to convert.
895 * @return array
896 */
897 static public function getSpecConfParametersFromArray($pArr) {
898 $out = array();
899 if (is_array($pArr)) {
900 foreach ($pArr as $k => $v) {
901 $parts = explode('=', $v, 2);
902 if (count($parts) == 2) {
903 $out[trim($parts[0])] = trim($parts[1]);
904 } else {
905 $out[$k] = $v;
906 }
907 }
908 }
909 return $out;
910 }
911
912 /**
913 * Finds the Data Structure for a FlexForm field
914 *
915 * NOTE ON data structures for deleted records: This function may fail to deliver the data structure
916 * for a record for a few reasons:
917 * a) The data structure could be deleted (either with deleted-flagged or hard-deleted),
918 * b) the data structure is fetched using the ds_pointerField_searchParent in which case any
919 * deleted record on the route to the final location of the DS will make it fail.
920 * In theory, we can solve the problem in the case where records that are deleted-flagged keeps us
921 * from finding the DS - this is done at the markers ###NOTE_A### where we make sure to also select deleted records.
922 * However, we generally want the DS lookup to fail for deleted records since for the working website we expect a
923 * deleted-flagged record to be as inaccessible as one that is completely deleted from the DB. Any way we look
924 * at it, this may lead to integrity problems of the reference index and even lost files if attached.
925 * However, that is not really important considering that a single change to a data structure can instantly
926 * invalidate large amounts of the reference index which we do accept as a cost for the flexform features.
927 * Other than requiring a reference index update, deletion of/changes in data structure or the failure to look
928 * them up when completely deleting records may lead to lost files in the uploads/ folders since those are now
929 * without a proper reference.
930 *
931 * @param array $conf Field config array
932 * @param array $row Record data
933 * @param string $table The table name
934 * @param string $fieldName Optional fieldname passed to hook object
935 * @param bool $WSOL If set, workspace overlay is applied to records. This is correct behaviour for all presentation and export, but NOT if you want a TRUE reflection of how things are in the live workspace.
936 * @param int $newRecordPidValue SPECIAL CASES: Use this, if the DataStructure may come from a parent record and the INPUT row doesn't have a uid yet (hence, the pid cannot be looked up). Then it is necessary to supply a PID value to search recursively in for the DS (used from TCEmain)
937 * @return mixed If array, the data structure was found and returned as an array. Otherwise (string) it is an error message.
938 * @see \TYPO3\CMS\Backend\Form\FormEngine::getSingleField_typeFlex()
939 */
940 static public function getFlexFormDS($conf, $row, $table, $fieldName = '', $WSOL = TRUE, $newRecordPidValue = 0) {
941 // Get pointer field etc from TCA-config:
942 $ds_pointerField = $conf['ds_pointerField'];
943 $ds_array = $conf['ds'];
944 $ds_tableField = $conf['ds_tableField'];
945 $ds_searchParentField = $conf['ds_pointerField_searchParent'];
946 // If there is a data source array, that takes precedence
947 if (is_array($ds_array)) {
948 // If a pointer field is set, take the value from that field in the $row array and use as key.
949 if ($ds_pointerField) {
950 // Up to two pointer fields can be specified in a comma separated list.
951 $pointerFields = GeneralUtility::trimExplode(',', $ds_pointerField);
952 // If we have two pointer fields, the array keys should contain both field values separated by comma. The asterisk "*" catches all values. For backwards compatibility, it's also possible to specify only the value of the first defined ds_pointerField.
953 if (count($pointerFields) == 2) {
954 if ($ds_array[$row[$pointerFields[0]] . ',' . $row[$pointerFields[1]]]) {
955 // Check if we have a DS for the combination of both pointer fields values
956 $srcPointer = $row[$pointerFields[0]] . ',' . $row[$pointerFields[1]];
957 } elseif ($ds_array[$row[$pointerFields[1]] . ',*']) {
958 // Check if we have a DS for the value of the first pointer field suffixed with ",*"
959 $srcPointer = $row[$pointerFields[1]] . ',*';
960 } elseif ($ds_array['*,' . $row[$pointerFields[1]]]) {
961 // Check if we have a DS for the value of the second pointer field prefixed with "*,"
962 $srcPointer = '*,' . $row[$pointerFields[1]];
963 } elseif ($ds_array[$row[$pointerFields[0]]]) {
964 // Check if we have a DS for just the value of the first pointer field (mainly for backwards compatibility)
965 $srcPointer = $row[$pointerFields[0]];
966 } else {
967 $srcPointer = NULL;
968 }
969 } else {
970 $srcPointer = $row[$pointerFields[0]];
971 }
972 $srcPointer = $srcPointer !== NULL && isset($ds_array[$srcPointer]) ? $srcPointer : 'default';
973 } else {
974 $srcPointer = 'default';
975 }
976 // Get Data Source: Detect if it's a file reference and in that case read the file and parse as XML. Otherwise the value is expected to be XML.
977 if (substr($ds_array[$srcPointer], 0, 5) == 'FILE:') {
978 $file = GeneralUtility::getFileAbsFileName(substr($ds_array[$srcPointer], 5));
979 if ($file && @is_file($file)) {
980 $dataStructArray = GeneralUtility::xml2array(GeneralUtility::getUrl($file));
981 } else {
982 $dataStructArray = 'The file "' . substr($ds_array[$srcPointer], 5) . '" in ds-array key "' . $srcPointer . '" was not found ("' . $file . '")';
983 }
984 } else {
985 $dataStructArray = GeneralUtility::xml2array($ds_array[$srcPointer]);
986 }
987 } elseif ($ds_pointerField) {
988 // If pointer field AND possibly a table/field is set:
989 // Value of field pointed to:
990 $srcPointer = $row[$ds_pointerField];
991 // Searching recursively back if 'ds_pointerField_searchParent' is defined (typ. a page rootline, or maybe a tree-table):
992 if ($ds_searchParentField && !$srcPointer) {
993 $rr = self::getRecord($table, $row['uid'], 'uid,' . $ds_searchParentField);
994 // Get the "pid" field - we cannot know that it is in the input record! ###NOTE_A###
995 if ($WSOL) {
996 self::workspaceOL($table, $rr);
997 self::fixVersioningPid($table, $rr, TRUE);
998 }
999 $db = static::getDatabaseConnection();
1000 $uidAcc = array();
1001 // Used to avoid looping, if any should happen.
1002 $subFieldPointer = $conf['ds_pointerField_searchParent_subField'];
1003 while (!$srcPointer) {
1004 $res = $db->exec_SELECTquery('uid,' . $ds_pointerField . ',' . $ds_searchParentField . ($subFieldPointer ? ',' . $subFieldPointer : ''), $table, 'uid=' . (int)($newRecordPidValue ?: $rr[$ds_searchParentField]) . self::deleteClause($table));
1005 $newRecordPidValue = 0;
1006 $rr = $db->sql_fetch_assoc($res);
1007 $db->sql_free_result($res);
1008 // Break if no result from SQL db or if looping...
1009 if (!is_array($rr) || isset($uidAcc[$rr['uid']])) {
1010 break;
1011 }
1012 $uidAcc[$rr['uid']] = 1;
1013 if ($WSOL) {
1014 self::workspaceOL($table, $rr);
1015 self::fixVersioningPid($table, $rr, TRUE);
1016 }
1017 $srcPointer = $subFieldPointer && $rr[$subFieldPointer] ? $rr[$subFieldPointer] : $rr[$ds_pointerField];
1018 }
1019 }
1020 // If there is a srcPointer value:
1021 if ($srcPointer) {
1022 if (MathUtility::canBeInterpretedAsInteger($srcPointer)) {
1023 // If integer, then its a record we will look up:
1024 list($tName, $fName) = explode(':', $ds_tableField, 2);
1025 if ($tName && $fName && is_array($GLOBALS['TCA'][$tName])) {
1026 $dataStructRec = self::getRecord($tName, $srcPointer);
1027 if ($WSOL) {
1028 self::workspaceOL($tName, $dataStructRec);
1029 }
1030 if (strpos($dataStructRec[$fName], '<') === FALSE) {
1031 if (is_file(PATH_site . $dataStructRec[$fName])) {
1032 // The value is a pointer to a file
1033 $dataStructArray = GeneralUtility::xml2array(GeneralUtility::getUrl(PATH_site . $dataStructRec[$fName]));
1034 } else {
1035 $dataStructArray = sprintf('File \'%s\' was not found', $dataStructRec[$fName]);
1036 }
1037 } else {
1038 // No file pointer, handle as being XML (default behaviour)
1039 $dataStructArray = GeneralUtility::xml2array($dataStructRec[$fName]);
1040 }
1041 } else {
1042 $dataStructArray = 'No tablename (' . $tName . ') or fieldname (' . $fName . ') was found an valid!';
1043 }
1044 } else {
1045 // Otherwise expect it to be a file:
1046 $file = GeneralUtility::getFileAbsFileName($srcPointer);
1047 if ($file && @is_file($file)) {
1048 $dataStructArray = GeneralUtility::xml2array(GeneralUtility::getUrl($file));
1049 } else {
1050 // Error message.
1051 $dataStructArray = 'The file "' . $srcPointer . '" was not found ("' . $file . '")';
1052 }
1053 }
1054 } else {
1055 // Error message.
1056 $dataStructArray = 'No source value in fieldname "' . $ds_pointerField . '"';
1057 }
1058 } else {
1059 $dataStructArray = 'No proper configuration!';
1060 }
1061 // Hook for post-processing the Flexform DS. Introduces the possibility to configure Flexforms via TSConfig
1062 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['getFlexFormDSClass'])) {
1063 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['getFlexFormDSClass'] as $classRef) {
1064 $hookObj = GeneralUtility::getUserObj($classRef);
1065 if (method_exists($hookObj, 'getFlexFormDS_postProcessDS')) {
1066 $hookObj->getFlexFormDS_postProcessDS($dataStructArray, $conf, $row, $table, $fieldName);
1067 }
1068 }
1069 }
1070 return $dataStructArray;
1071 }
1072
1073 /**
1074 * Returns all registered FlexForm definitions with title and fields
1075 *
1076 * @param string $table The content table
1077 * @return array The data structures with speaking extension title
1078 * @see \TYPO3\CMS\Backend\Utility\BackendUtility::getExcludeFields()
1079 */
1080 static public function getRegisteredFlexForms($table = 'tt_content') {
1081 if (empty($table) || empty($GLOBALS['TCA'][$table]['columns'])) {
1082 return array();
1083 }
1084 $flexForms = array();
1085 foreach ($GLOBALS['TCA'][$table]['columns'] as $tableField => $fieldConf) {
1086 if (!empty($fieldConf['config']['type']) && !empty($fieldConf['config']['ds']) && $fieldConf['config']['type'] == 'flex') {
1087 $flexForms[$tableField] = array();
1088 unset($fieldConf['config']['ds']['default']);
1089 // Get pointer fields
1090 $pointerFields = !empty($fieldConf['config']['ds_pointerField']) ? $fieldConf['config']['ds_pointerField'] : 'list_type,CType';
1091 $pointerFields = GeneralUtility::trimExplode(',', $pointerFields);
1092 // Get FlexForms
1093 foreach ($fieldConf['config']['ds'] as $flexFormKey => $dataStruct) {
1094 // Get extension identifier (uses second value if it's not empty, "list" or "*", else first one)
1095 $identFields = GeneralUtility::trimExplode(',', $flexFormKey);
1096 $extIdent = $identFields[0];
1097 if (!empty($identFields[1]) && $identFields[1] != 'list' && $identFields[1] != '*') {
1098 $extIdent = $identFields[1];
1099 }
1100 // Load external file references
1101 if (!is_array($dataStruct)) {
1102 $file = GeneralUtility::getFileAbsFileName(str_ireplace('FILE:', '', $dataStruct));
1103 if ($file && @is_file($file)) {
1104 $dataStruct = GeneralUtility::getUrl($file);
1105 }
1106 $dataStruct = GeneralUtility::xml2array($dataStruct);
1107 if (!is_array($dataStruct)) {
1108 continue;
1109 }
1110 }
1111 // Get flexform content
1112 $dataStruct = GeneralUtility::resolveAllSheetsInDS($dataStruct);
1113 if (empty($dataStruct['sheets']) || !is_array($dataStruct['sheets'])) {
1114 continue;
1115 }
1116 // Use DS pointer to get extension title from TCA
1117 $title = $extIdent;
1118 $keyFields = GeneralUtility::trimExplode(',', $flexFormKey);
1119 foreach ($pointerFields as $pointerKey => $pointerName) {
1120 if (empty($keyFields[$pointerKey]) || $keyFields[$pointerKey] == '*' || $keyFields[$pointerKey] == 'list') {
1121 continue;
1122 }
1123 if (!empty($GLOBALS['TCA'][$table]['columns'][$pointerName]['config']['items'])) {
1124 $items = $GLOBALS['TCA'][$table]['columns'][$pointerName]['config']['items'];
1125 if (!is_array($items)) {
1126 continue;
1127 }
1128 foreach ($items as $itemConf) {
1129 if (!empty($itemConf[0]) && !empty($itemConf[1]) && $itemConf[1] == $keyFields[$pointerKey]) {
1130 $title = $itemConf[0];
1131 break 2;
1132 }
1133 }
1134 }
1135 }
1136 $flexForms[$tableField][$extIdent] = array(
1137 'title' => $title,
1138 'ds' => $dataStruct
1139 );
1140 }
1141 }
1142 }
1143 return $flexForms;
1144 }
1145
1146 /*******************************************
1147 *
1148 * Caching related
1149 *
1150 *******************************************/
1151 /**
1152 * Stores $data in the 'cache_hash' cache with the hash key, $hash
1153 * and visual/symbolic identification, $ident
1154 *
1155 * IDENTICAL to the function by same name found in \TYPO3\CMS\Frontend\Page\PageRepository
1156 *
1157 * @param string $hash 32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
1158 * @param mixed $data The data to store
1159 * @param string $ident $ident is just a textual identification in order to inform about the content!
1160 * @return void
1161 */
1162 static public function storeHash($hash, $data, $ident) {
1163 /** @var CacheManager $cacheManager */
1164 $cacheManager = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Cache\CacheManager::class);
1165 $cacheManager->getCache('cache_hash')->set($hash, $data, array('ident_' . $ident), 0);
1166 }
1167
1168 /**
1169 * Returns data stored for the hash string in the cache "cache_hash"
1170 * Can be used to retrieved a cached value, array or object
1171 *
1172 * IDENTICAL to the function by same name found in \TYPO3\CMS\Frontend\Page\PageRepository
1173 *
1174 * @param string $hash The hash-string which was used to store the data value
1175 * @return mixed The "data" from the cache
1176 */
1177 static public function getHash($hash) {
1178 /** @var CacheManager $cacheManager */
1179 $cacheManager = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Cache\CacheManager::class);
1180 $cacheEntry = $cacheManager->getCache('cache_hash')->get($hash);
1181 $hashContent = NULL;
1182 if ($cacheEntry) {
1183 $hashContent = $cacheEntry;
1184 }
1185 return $hashContent;
1186 }
1187
1188 /*******************************************
1189 *
1190 * TypoScript related
1191 *
1192 *******************************************/
1193 /**
1194 * Returns the Page TSconfig for page with id, $id
1195 *
1196 * @param int $id Page uid for which to create Page TSconfig
1197 * @param array $rootLine If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated
1198 * @param bool $returnPartArray If $returnPartArray is set, then the array with accumulated Page TSconfig is returned non-parsed. Otherwise the output will be parsed by the TypoScript parser.
1199 * @return array Page TSconfig
1200 * @see \TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser
1201 */
1202 static public function getPagesTSconfig($id, $rootLine = NULL, $returnPartArray = FALSE) {
1203 static $pagesTSconfig_cacheReference = array();
1204 static $combinedTSconfig_cache = array();
1205
1206 $id = (int)$id;
1207 if ($returnPartArray === FALSE
1208 && $rootLine === NULL
1209 && isset($pagesTSconfig_cacheReference[$id])
1210 ) {
1211 return $combinedTSconfig_cache[$pagesTSconfig_cacheReference[$id]];
1212 } else {
1213 $TSconfig = array();
1214 if (!is_array($rootLine)) {
1215 $useCacheForCurrentPageId = TRUE;
1216 $rootLine = self::BEgetRootLine($id, '', TRUE);
1217 } else {
1218 $useCacheForCurrentPageId = FALSE;
1219 }
1220
1221 // Order correctly
1222 ksort($rootLine);
1223 $TSdataArray = array();
1224 // Setting default configuration
1225 $TSdataArray['defaultPageTSconfig'] = $GLOBALS['TYPO3_CONF_VARS']['BE']['defaultPageTSconfig'];
1226 foreach ($rootLine as $k => $v) {
1227 $TSdataArray['uid_' . $v['uid']] = $v['TSconfig'];
1228 }
1229 $TSdataArray = static::emitGetPagesTSconfigPreIncludeSignal($TSdataArray, $id, $rootLine, $returnPartArray);
1230 $TSdataArray = TypoScriptParser::checkIncludeLines_array($TSdataArray);
1231 if ($returnPartArray) {
1232 return $TSdataArray;
1233 }
1234 // Parsing the page TS-Config
1235 $pageTS = implode(LF . '[GLOBAL]' . LF, $TSdataArray);
1236 /* @var $parseObj \TYPO3\CMS\Backend\Configuration\TsConfigParser */
1237 $parseObj = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Configuration\TsConfigParser::class);
1238 $res = $parseObj->parseTSconfig($pageTS, 'PAGES', $id, $rootLine);
1239 if ($res) {
1240 $TSconfig = $res['TSconfig'];
1241 }
1242 $cacheHash = $res['hash'];
1243 // Get User TSconfig overlay
1244 $userTSconfig = static::getBackendUserAuthentication()->userTS['page.'];
1245 if (is_array($userTSconfig)) {
1246 ArrayUtility::mergeRecursiveWithOverrule($TSconfig, $userTSconfig);
1247 $cacheHash .= '_user' . $GLOBALS['BE_USER']->user['uid'];
1248 }
1249
1250 if ($useCacheForCurrentPageId) {
1251 if (!isset($combinedTSconfig_cache[$cacheHash])) {
1252 $combinedTSconfig_cache[$cacheHash] = $TSconfig;
1253 }
1254 $pagesTSconfig_cacheReference[$id] = $cacheHash;
1255 }
1256 }
1257 return $TSconfig;
1258 }
1259
1260 /**
1261 * Implodes a multi dimensional TypoScript array, $p, into a one-dimensional array (return value)
1262 *
1263 * @param array $p TypoScript structure
1264 * @param string $k Prefix string
1265 * @return array Imploded TypoScript objectstring/values
1266 * @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8
1267 */
1268 static public function implodeTSParams($p, $k = '') {
1269 GeneralUtility::logDeprecatedFunction();
1270 $implodeParams = array();
1271 if (is_array($p)) {
1272 foreach ($p as $kb => $val) {
1273 if (is_array($val)) {
1274 $implodeParams = array_merge($implodeParams, self::implodeTSParams($val, $k . $kb));
1275 } else {
1276 $implodeParams[$k . $kb] = $val;
1277 }
1278 }
1279 }
1280 return $implodeParams;
1281 }
1282
1283 /*******************************************
1284 *
1285 * Users / Groups related
1286 *
1287 *******************************************/
1288 /**
1289 * Returns an array with be_users records of all user NOT DELETED sorted by their username
1290 * Keys in the array is the be_users uid
1291 *
1292 * @param string $fields Optional $fields list (default: username,usergroup,usergroup_cached_list,uid) can be used to set the selected fields
1293 * @param string $where Optional $where clause (fx. "AND username='pete'") can be used to limit query
1294 * @return array
1295 */
1296 static public function getUserNames($fields = 'username,usergroup,usergroup_cached_list,uid', $where = '') {
1297 return self::getRecordsSortedByTitle(
1298 GeneralUtility::trimExplode(',', $fields, TRUE),
1299 'be_users',
1300 'username',
1301 'AND pid=0 ' . $where
1302 );
1303 }
1304
1305 /**
1306 * Returns an array with be_groups records (title, uid) of all groups NOT DELETED sorted by their title
1307 *
1308 * @param string $fields Field list
1309 * @param string $where WHERE clause
1310 * @return array
1311 */
1312 static public function getGroupNames($fields = 'title,uid', $where = '') {
1313 return self::getRecordsSortedByTitle(
1314 GeneralUtility::trimExplode(',', $fields, TRUE),
1315 'be_groups',
1316 'title',
1317 'AND pid=0 ' . $where
1318 );
1319 }
1320
1321 /**
1322 * Returns an array of all non-deleted records of a table sorted by a given title field.
1323 * The value of the title field will be replaced by the return value
1324 * of self::getRecordTitle() before the sorting is performed.
1325 *
1326 * @param array $fields Fields to select
1327 * @param string $table Table name
1328 * @param string $titleField Field that will contain the record title
1329 * @param string $where Additional where clause
1330 * @return array Array of sorted records
1331 */
1332 static protected function getRecordsSortedByTitle(array $fields, $table, $titleField, $where = '') {
1333 $fieldsIndex = array_flip($fields);
1334 // Make sure the titleField is amongst the fields when getting sorted
1335 $fieldsIndex[$titleField] = 1;
1336
1337 $result = array();
1338 $db = static::getDatabaseConnection();
1339 $res = $db->exec_SELECTquery('*', $table, '1=1 ' . $where . self::deleteClause($table));
1340 while ($record = $db->sql_fetch_assoc($res)) {
1341 // store the uid, because it might be unset if it's not among the requested $fields
1342 $recordId = $record['uid'];
1343 $record[$titleField] = self::getRecordTitle($table, $record);
1344
1345 // include only the requested fields in the result
1346 $result[$recordId] = array_intersect_key($record, $fieldsIndex);
1347 }
1348 $db->sql_free_result($res);
1349
1350 // sort records by $sortField. This is not done in the query because the title might have been overwritten by
1351 // self::getRecordTitle();
1352 return ArrayUtility::sortArraysByKey($result, $titleField);
1353 }
1354
1355 /**
1356 * Returns an array with be_groups records (like ->getGroupNames) but:
1357 * - if the current BE_USER is admin, then all groups are returned, otherwise only groups that the current user is member of (usergroup_cached_list) will be returned.
1358 *
1359 * @param string $fields Field list; $fields specify the fields selected (default: title,uid)
1360 * @return array
1361 */
1362 static public function getListGroupNames($fields = 'title, uid') {
1363 $beUser = static::getBackendUserAuthentication();
1364 $exQ = ' AND hide_in_lists=0';
1365 if (!$beUser->isAdmin()) {
1366 $exQ .= ' AND uid IN (' . ($beUser->user['usergroup_cached_list'] ?: 0) . ')';
1367 }
1368 return self::getGroupNames($fields, $exQ);
1369 }
1370
1371 /**
1372 * Returns the array $usernames with the names of all users NOT IN $groupArray changed to the uid (hides the usernames!).
1373 * If $excludeBlindedFlag is set, then these records are unset from the array $usernames
1374 * Takes $usernames (array made by \TYPO3\CMS\Backend\Utility\BackendUtility::getUserNames()) and a $groupArray (array with the groups a certain user is member of) as input
1375 *
1376 * @param array $usernames User names
1377 * @param array $groupArray Group names
1378 * @param bool $excludeBlindedFlag If $excludeBlindedFlag is set, then these records are unset from the array $usernames
1379 * @return array User names, blinded
1380 */
1381 static public function blindUserNames($usernames, $groupArray, $excludeBlindedFlag = FALSE) {
1382 if (is_array($usernames) && is_array($groupArray)) {
1383 foreach ($usernames as $uid => $row) {
1384 $userN = $uid;
1385 $set = 0;
1386 if ($row['uid'] != static::getBackendUserAuthentication()->user['uid']) {
1387 foreach ($groupArray as $v) {
1388 if ($v && GeneralUtility::inList($row['usergroup_cached_list'], $v)) {
1389 $userN = $row['username'];
1390 $set = 1;
1391 }
1392 }
1393 } else {
1394 $userN = $row['username'];
1395 $set = 1;
1396 }
1397 $usernames[$uid]['username'] = $userN;
1398 if ($excludeBlindedFlag && !$set) {
1399 unset($usernames[$uid]);
1400 }
1401 }
1402 }
1403 return $usernames;
1404 }
1405
1406 /**
1407 * Corresponds to blindUserNames but works for groups instead
1408 *
1409 * @param array $groups Group names
1410 * @param array $groupArray Group names (reference)
1411 * @param bool $excludeBlindedFlag If $excludeBlindedFlag is set, then these records are unset from the array $usernames
1412 * @return array
1413 */
1414 static public function blindGroupNames($groups, $groupArray, $excludeBlindedFlag = FALSE) {
1415 if (is_array($groups) && is_array($groupArray)) {
1416 foreach ($groups as $uid => $row) {
1417 $groupN = $uid;
1418 $set = 0;
1419 if (ArrayUtility::inArray($groupArray, $uid)) {
1420 $groupN = $row['title'];
1421 $set = 1;
1422 }
1423 $groups[$uid]['title'] = $groupN;
1424 if ($excludeBlindedFlag && !$set) {
1425 unset($groups[$uid]);
1426 }
1427 }
1428 }
1429 return $groups;
1430 }
1431
1432 /*******************************************
1433 *
1434 * Output related
1435 *
1436 *******************************************/
1437 /**
1438 * Returns the difference in days between input $tstamp and $EXEC_TIME
1439 *
1440 * @param int $tstamp Time stamp, seconds
1441 * @return int
1442 */
1443 static public function daysUntil($tstamp) {
1444 $delta_t = $tstamp - $GLOBALS['EXEC_TIME'];
1445 return ceil($delta_t / (3600 * 24));
1446 }
1447
1448 /**
1449 * Returns $tstamp formatted as "ddmmyy" (According to $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'])
1450 *
1451 * @param int $tstamp Time stamp, seconds
1452 * @return string Formatted time
1453 */
1454 static public function date($tstamp) {
1455 return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'], (int)$tstamp);
1456 }
1457
1458 /**
1459 * Returns $tstamp formatted as "ddmmyy hhmm" (According to $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] AND $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'])
1460 *
1461 * @param int $value Time stamp, seconds
1462 * @return string Formatted time
1463 */
1464 static public function datetime($value) {
1465 return date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] . ' ' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'], $value);
1466 }
1467
1468 /**
1469 * Returns $value (in seconds) formatted as hh:mm:ss
1470 * For instance $value = 3600 + 60*2 + 3 should return "01:02:03"
1471 *
1472 * @param int $value Time stamp, seconds
1473 * @param bool $withSeconds Output hh:mm:ss. If FALSE: hh:mm
1474 * @return string Formatted time
1475 */
1476 static public function time($value, $withSeconds = TRUE) {
1477 $hh = floor($value / 3600);
1478 $min = floor(($value - $hh * 3600) / 60);
1479 $sec = $value - $hh * 3600 - $min * 60;
1480 $l = sprintf('%02d', $hh) . ':' . sprintf('%02d', $min);
1481 if ($withSeconds) {
1482 $l .= ':' . sprintf('%02d', $sec);
1483 }
1484 return $l;
1485 }
1486
1487 /**
1488 * Returns the "age" in minutes / hours / days / years of the number of $seconds inputted.
1489 *
1490 * @param int $seconds Seconds could be the difference of a certain timestamp and time()
1491 * @param string $labels Labels should be something like ' min| hrs| days| yrs| min| hour| day| year'. This value is typically delivered by this function call: $GLOBALS["LANG"]->sL("LLL:EXT:lang/locallang_core.xlf:labels.minutesHoursDaysYears")
1492 * @return string Formatted time
1493 */
1494 static public function calcAge($seconds, $labels = ' min| hrs| days| yrs| min| hour| day| year') {
1495 $labelArr = explode('|', $labels);
1496 $absSeconds = abs($seconds);
1497 $sign = $seconds < 0 ? -1 : 1;
1498 if ($absSeconds < 3600) {
1499 $val = round($absSeconds / 60);
1500 $seconds = $sign * $val . ($val == 1 ? $labelArr[4] : $labelArr[0]);
1501 } elseif ($absSeconds < 24 * 3600) {
1502 $val = round($absSeconds / 3600);
1503 $seconds = $sign * $val . ($val == 1 ? $labelArr[5] : $labelArr[1]);
1504 } elseif ($absSeconds < 365 * 24 * 3600) {
1505 $val = round($absSeconds / (24 * 3600));
1506 $seconds = $sign * $val . ($val == 1 ? $labelArr[6] : $labelArr[2]);
1507 } else {
1508 $val = round($absSeconds / (365 * 24 * 3600));
1509 $seconds = $sign * $val . ($val == 1 ? $labelArr[7] : $labelArr[3]);
1510 }
1511 return $seconds;
1512 }
1513
1514 /**
1515 * Returns a formatted timestamp if $tstamp is set.
1516 * The date/datetime will be followed by the age in parenthesis.
1517 *
1518 * @param int $tstamp Time stamp, seconds
1519 * @param int $prefix 1/-1 depending on polarity of age.
1520 * @param string $date $date=="date" will yield "dd:mm:yy" formatting, otherwise "dd:mm:yy hh:mm
1521 * @return string
1522 */
1523 static public function dateTimeAge($tstamp, $prefix = 1, $date = '') {
1524 if (!$tstamp) {
1525 return '';
1526 }
1527 $label = static::getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:labels.minutesHoursDaysYears');
1528 $age = ' (' . self::calcAge($prefix * ($GLOBALS['EXEC_TIME'] - $tstamp), $label) . ')';
1529 return $date === 'date' ? self::date($tstamp) : self::datetime($tstamp) . $age;
1530 }
1531
1532 /**
1533 * Returns alt="" and title="" attributes with the value of $content.
1534 *
1535 * @param string $content Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output)
1536 * @return string
1537 */
1538 static public function titleAltAttrib($content) {
1539 $out = '';
1540 $out .= ' alt="' . htmlspecialchars($content) . '"';
1541 $out .= ' title="' . htmlspecialchars($content) . '"';
1542 return $out;
1543 }
1544
1545 /**
1546 * Resolves file references for a given record.
1547 *
1548 * @param string $tableName Name of the table of the record
1549 * @param string $fieldName Name of the field of the record
1550 * @param array $element Record data
1551 * @param NULL|int $workspaceId Workspace to fetch data for
1552 * @return NULL|\TYPO3\CMS\Core\Resource\FileReference[]
1553 */
1554 static public function resolveFileReferences($tableName, $fieldName, $element, $workspaceId = NULL) {
1555 if (empty($GLOBALS['TCA'][$tableName]['columns'][$fieldName]['config'])) {
1556 return NULL;
1557 }
1558 $configuration = $GLOBALS['TCA'][$tableName]['columns'][$fieldName]['config'];
1559 if (empty($configuration['type']) || $configuration['type'] !== 'inline'
1560 || empty($configuration['foreign_table']) || $configuration['foreign_table'] !== 'sys_file_reference') {
1561 return NULL;
1562 }
1563
1564 $fileReferences = array();
1565 /** @var $relationHandler RelationHandler */
1566 $relationHandler = GeneralUtility::makeInstance(RelationHandler::class);
1567 if ($workspaceId !== NULL) {
1568 $relationHandler->setWorkspaceId($workspaceId);
1569 }
1570 $relationHandler->start($element[$fieldName], $configuration['foreign_table'], $configuration['MM'], $element['uid'], $tableName, $configuration);
1571 $relationHandler->processDeletePlaceholder();
1572 $referenceUids = $relationHandler->tableArray[$configuration['foreign_table']];
1573
1574 foreach ($referenceUids as $referenceUid) {
1575 try {
1576 $fileReference = ResourceFactory::getInstance()->getFileReferenceObject($referenceUid, array(), ($workspaceId === 0));
1577 $fileReferences[$fileReference->getUid()] = $fileReference;
1578 } catch (\TYPO3\CMS\Core\Resource\Exception\FileDoesNotExistException $e) {
1579 /**
1580 * We just catch the exception here
1581 * Reasoning: There is nothing an editor or even admin could do
1582 */
1583 }
1584 }
1585
1586 return $fileReferences;
1587 }
1588
1589 /**
1590 * Returns a linked image-tag for thumbnail(s)/fileicons/truetype-font-previews from a database row with a list of image files in a field
1591 * All $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'] extension are made to thumbnails + ttf file (renders font-example)
1592 * Thumbsnails are linked to the show_item.php script which will display further details.
1593 *
1594 * @param array $row Row is the database row from the table, $table.
1595 * @param string $table Table name for $row (present in TCA)
1596 * @param string $field Field is pointing to the list of image files
1597 * @param string $backPath Back path prefix for image tag src="" field
1598 * @param string $thumbScript UNUSED since FAL
1599 * @param string $uploaddir Optional: $uploaddir is the directory relative to PATH_site where the image files from the $field value is found (Is by default set to the entry in $GLOBALS['TCA'] for that field! so you don't have to!)
1600 * @param int $abs UNUSED
1601 * @param string $tparams Optional: $tparams is additional attributes for the image tags
1602 * @param int|string $size Optional: $size is [w]x[h] of the thumbnail. 64 is default.
1603 * @param bool $linkInfoPopup Whether to wrap with a link opening the info popup
1604 * @return string Thumbnail image tag.
1605 */
1606 static public function thumbCode($row, $table, $field, $backPath, $thumbScript = '', $uploaddir = NULL, $abs = 0, $tparams = '', $size = '', $linkInfoPopup = TRUE) {
1607 // Check and parse the size parameter
1608 $size = trim($size);
1609 $sizeParts = array(64, 64);
1610 if ($size) {
1611 $sizeParts = explode('x', $size . 'x' . $size);
1612 }
1613 $thumbData = '';
1614 $fileReferences = static::resolveFileReferences($table, $field, $row);
1615 // FAL references
1616 if ($fileReferences !== NULL) {
1617 foreach ($fileReferences as $fileReferenceObject) {
1618 $fileObject = $fileReferenceObject->getOriginalFile();
1619
1620 if ($fileObject->isMissing()) {
1621 $flashMessage = \TYPO3\CMS\Core\Resource\Utility\BackendUtility::getFlashMessageForMissingFile($fileObject);
1622 $thumbData .= $flashMessage->render();
1623 continue;
1624 }
1625
1626 // Web image
1627 if (GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $fileReferenceObject->getExtension())) {
1628 $processedImage = $fileObject->process(ProcessedFile::CONTEXT_IMAGECROPSCALEMASK, array(
1629 'width' => $sizeParts[0],
1630 'height' => $sizeParts[1] . 'c',
1631 'crop' => $fileReferenceObject->getProperty('crop')
1632 ));
1633 $imageUrl = $processedImage->getPublicUrl(TRUE);
1634 $imgTag = '<img src="' . $imageUrl . '" ' .
1635 'width="' . $processedImage->getProperty('width') . '" ' .
1636 'height="' . $processedImage->getProperty('height') . '" ' .
1637 'alt="' . htmlspecialchars($fileReferenceObject->getName()) . '" />';
1638 } else {
1639 // Icon
1640 $imgTag = IconUtility::getSpriteIconForResource($fileObject, array('title' => $fileObject->getName()));
1641 }
1642 if ($linkInfoPopup) {
1643 $onClick = 'top.launchView(\'_FILE\',\'' . $fileObject->getUid() . '\',\'' . $backPath . '\'); return false;';
1644 $thumbData .= '<a href="#" onclick="' . htmlspecialchars($onClick) . '">' . $imgTag . '</a> ';
1645 } else {
1646 $thumbData .= $imgTag;
1647 }
1648 }
1649 } else {
1650 // Find uploaddir automatically
1651 if (is_null($uploaddir)) {
1652 $uploaddir = $GLOBALS['TCA'][$table]['columns'][$field]['config']['uploadfolder'];
1653 }
1654 $uploaddir = rtrim($uploaddir, '/');
1655 // Traverse files:
1656 $thumbs = GeneralUtility::trimExplode(',', $row[$field], TRUE);
1657 $thumbData = '';
1658 foreach ($thumbs as $theFile) {
1659 if ($theFile) {
1660 $fileName = trim($uploaddir . '/' . $theFile, '/');
1661 try {
1662 /** @var File $fileObject */
1663 $fileObject = ResourceFactory::getInstance()->retrieveFileOrFolderObject($fileName);
1664 if ($fileObject->isMissing()) {
1665 $flashMessage = \TYPO3\CMS\Core\Resource\Utility\BackendUtility::getFlashMessageForMissingFile($fileObject);
1666 $thumbData .= $flashMessage->render();
1667 continue;
1668 }
1669 } catch (ResourceDoesNotExistException $exception) {
1670 /** @var FlashMessage $flashMessage */
1671 $flashMessage = GeneralUtility::makeInstance(\TYPO3\CMS\Core\Messaging\FlashMessage::class,
1672 htmlspecialchars($exception->getMessage()),
1673 static::getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:warning.file_missing', TRUE),
1674 FlashMessage::ERROR
1675 );
1676 $thumbData .= $flashMessage->render();
1677 continue;
1678 }
1679
1680 $fileExtension = $fileObject->getExtension();
1681 if ($fileExtension == 'ttf' || GeneralUtility::inList($GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $fileExtension)) {
1682 $imageUrl = $fileObject->process(ProcessedFile::CONTEXT_IMAGEPREVIEW, array(
1683 'width' => $sizeParts[0],
1684 'height' => $sizeParts[1]
1685 ))->getPublicUrl(TRUE);
1686 $image = '<img src="' . htmlspecialchars($imageUrl) . '" hspace="2" border="0" title="' . htmlspecialchars($fileObject->getName()) . '"' . $tparams . ' alt="" />';
1687 if ($linkInfoPopup) {
1688 $onClick = 'top.launchView(\'_FILE\', \'' . $fileName . '\',\'\',\'' . $backPath . '\');return false;';
1689 $thumbData .= '<a href="#" onclick="' . htmlspecialchars($onClick) . '">' . $image . '</a> ';
1690 } else {
1691 $thumbData .= $image;
1692 }
1693 } else {
1694 // Gets the icon
1695 $fileIcon = IconUtility::getSpriteIconForResource($fileObject, array('title' => $fileObject->getName()));
1696 if ($linkInfoPopup) {
1697 $onClick = 'top.launchView(\'_FILE\', \'' . $fileName . '\',\'\',\'' . $backPath . '\'); return false;';
1698 $thumbData .= '<a href="#" onclick="' . htmlspecialchars($onClick) . '">' . $fileIcon . '</a> ';
1699 } else {
1700 $thumbData .= $fileIcon;
1701 }
1702 }
1703 }
1704 }
1705 }
1706 return $thumbData;
1707 }
1708
1709 /**
1710 * Returns single image tag to thumbnail using a thumbnail script (like thumbs.php)
1711 *
1712 * @param string $thumbScript Must point to "thumbs.php" relative to the script position
1713 * @param string $theFile Must be the proper reference to the file that thumbs.php should show
1714 * @param string $tparams The additional attributes for the image tag
1715 * @param string $size The size of the thumbnail send along to thumbs.php
1716 * @return string Image tag
1717 * @deprecated since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use the corresponding Resource objects and Processing functionality
1718 */
1719 static public function getThumbNail($thumbScript, $theFile, $tparams = '', $size = '') {
1720 GeneralUtility::logDeprecatedFunction();
1721 $size = trim($size);
1722 $check = basename($theFile) . ':' . filemtime($theFile) . ':' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
1723 $params = '&file=' . rawurlencode($theFile);
1724 $params .= $size ? '&size=' . $size : '';
1725 $params .= '&md5sum=' . md5($check);
1726 $url = $thumbScript . '?' . $params;
1727 $th = '<img src="' . htmlspecialchars($url) . '" title="' . trim(basename($theFile)) . '"' . ($tparams ? ' ' . $tparams : '') . ' alt="" />';
1728 return $th;
1729 }
1730
1731 /**
1732 * Returns title-attribute information for a page-record informing about id, alias, doktype, hidden, starttime, endtime, fe_group etc.
1733 *
1734 * @param array $row Input must be a page row ($row) with the proper fields set (be sure - send the full range of fields for the table)
1735 * @param string $perms_clause This is used to get the record path of the shortcut page, if any (and doktype==4)
1736 * @param bool $includeAttrib If $includeAttrib is set, then the 'title=""' attribute is wrapped about the return value, which is in any case htmlspecialchar()'ed already
1737 * @return string
1738 */
1739 static public function titleAttribForPages($row, $perms_clause = '', $includeAttrib = TRUE) {
1740 $lang = static::getLanguageService();
1741 $parts = array();
1742 $parts[] = 'id=' . $row['uid'];
1743 if ($row['alias']) {
1744 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['alias']['label']) . ' ' . $row['alias'];
1745 }
1746 if ($row['pid'] < 0) {
1747 $parts[] = 'v#1.' . $row['t3ver_id'];
1748 }
1749 switch (VersionState::cast($row['t3ver_state'])) {
1750 case new VersionState(VersionState::NEW_PLACEHOLDER):
1751 $parts[] = 'PLH WSID#' . $row['t3ver_wsid'];
1752 break;
1753 case new VersionState(VersionState::DELETE_PLACEHOLDER):
1754 $parts[] = 'Deleted element!';
1755 break;
1756 case new VersionState(VersionState::MOVE_PLACEHOLDER):
1757 $parts[] = 'NEW LOCATION (PLH) WSID#' . $row['t3ver_wsid'];
1758 break;
1759 case new VersionState(VersionState::MOVE_POINTER):
1760 $parts[] = 'OLD LOCATION (PNT) WSID#' . $row['t3ver_wsid'];
1761 break;
1762 case new VersionState(VersionState::NEW_PLACEHOLDER_VERSION):
1763 $parts[] = 'New element!';
1764 break;
1765 }
1766 if ($row['doktype'] == PageRepository::DOKTYPE_LINK) {
1767 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['url']['label']) . ' ' . $row['url'];
1768 } elseif ($row['doktype'] == PageRepository::DOKTYPE_SHORTCUT) {
1769 if ($perms_clause) {
1770 $label = self::getRecordPath((int)$row['shortcut'], $perms_clause, 20);
1771 } else {
1772 $row['shortcut'] = (int)$row['shortcut'];
1773 $lRec = self::getRecordWSOL('pages', $row['shortcut'], 'title');
1774 $label = $lRec['title'] . ' (id=' . $row['shortcut'] . ')';
1775 }
1776 if ($row['shortcut_mode'] != PageRepository::SHORTCUT_MODE_NONE) {
1777 $label .= ', ' . $lang->sL($GLOBALS['TCA']['pages']['columns']['shortcut_mode']['label']) . ' ' . $lang->sL(self::getLabelFromItemlist('pages', 'shortcut_mode', $row['shortcut_mode']));
1778 }
1779 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['shortcut']['label']) . ' ' . $label;
1780 } elseif ($row['doktype'] == PageRepository::DOKTYPE_MOUNTPOINT) {
1781 if ($perms_clause) {
1782 $label = self::getRecordPath((int)$row['mount_pid'], $perms_clause, 20);
1783 } else {
1784 $lRec = self::getRecordWSOL('pages', (int)$row['mount_pid'], 'title');
1785 $label = $lRec['title'] . ' (id=' . $row['mount_pid'] . ')';
1786 }
1787 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['mount_pid']['label']) . ' ' . $label;
1788 if ($row['mount_pid_ol']) {
1789 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['mount_pid_ol']['label']);
1790 }
1791 }
1792 if ($row['nav_hide']) {
1793 $parts[] = rtrim($lang->sL($GLOBALS['TCA']['pages']['columns']['nav_hide']['label']), ':');
1794 }
1795 if ($row['hidden']) {
1796 $parts[] = $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.hidden');
1797 }
1798 if ($row['starttime']) {
1799 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['starttime']['label']) . ' ' . self::dateTimeAge($row['starttime'], -1, 'date');
1800 }
1801 if ($row['endtime']) {
1802 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['endtime']['label']) . ' ' . self::dateTimeAge($row['endtime'], -1, 'date');
1803 }
1804 if ($row['fe_group']) {
1805 $fe_groups = array();
1806 foreach (GeneralUtility::intExplode(',', $row['fe_group']) as $fe_group) {
1807 if ($fe_group < 0) {
1808 $fe_groups[] = $lang->sL(self::getLabelFromItemlist('pages', 'fe_group', $fe_group));
1809 } else {
1810 $lRec = self::getRecordWSOL('fe_groups', $fe_group, 'title');
1811 $fe_groups[] = $lRec['title'];
1812 }
1813 }
1814 $label = implode(', ', $fe_groups);
1815 $parts[] = $lang->sL($GLOBALS['TCA']['pages']['columns']['fe_group']['label']) . ' ' . $label;
1816 }
1817 $out = htmlspecialchars(implode(' - ', $parts));
1818 return $includeAttrib ? 'title="' . $out . '"' : $out;
1819 }
1820
1821 /**
1822 * Returns title-attribute information for ANY record (from a table defined in TCA of course)
1823 * The included information depends on features of the table, but if hidden, starttime, endtime and fe_group fields are configured for, information about the record status in regard to these features are is included.
1824 * "pages" table can be used as well and will return the result of ->titleAttribForPages() for that page.
1825 *
1826 * @param array $row Table row; $row is a row from the table, $table
1827 * @param string $table Table name
1828 * @return string
1829 */
1830 static public function getRecordIconAltText($row, $table = 'pages') {
1831 if ($table == 'pages') {
1832 $out = self::titleAttribForPages($row, '', 0);
1833 } else {
1834 $ctrl = $GLOBALS['TCA'][$table]['ctrl']['enablecolumns'];
1835 // Uid is added
1836 $out = 'id=' . $row['uid'];
1837 if ($table == 'pages' && $row['alias']) {
1838 $out .= ' / ' . $row['alias'];
1839 }
1840 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS'] && $row['pid'] < 0) {
1841 $out .= ' - v#1.' . $row['t3ver_id'];
1842 }
1843 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
1844 switch (VersionState::cast($row['t3ver_state'])) {
1845 case new VersionState(VersionState::NEW_PLACEHOLDER):
1846 $out .= ' - PLH WSID#' . $row['t3ver_wsid'];
1847 break;
1848 case new VersionState(VersionState::DELETE_PLACEHOLDER):
1849 $out .= ' - Deleted element!';
1850 break;
1851 case new VersionState(VersionState::MOVE_PLACEHOLDER):
1852 $out .= ' - NEW LOCATION (PLH) WSID#' . $row['t3ver_wsid'];
1853 break;
1854 case new VersionState(VersionState::MOVE_POINTER):
1855 $out .= ' - OLD LOCATION (PNT) WSID#' . $row['t3ver_wsid'];
1856 break;
1857 case new VersionState(VersionState::NEW_PLACEHOLDER_VERSION):
1858 $out .= ' - New element!';
1859 break;
1860 }
1861 }
1862 // Hidden
1863 $lang = static::getLanguageService();
1864 if ($ctrl['disabled']) {
1865 $out .= $row[$ctrl['disabled']] ? ' - ' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.hidden') : '';
1866 }
1867 if ($ctrl['starttime']) {
1868 if ($row[$ctrl['starttime']] > $GLOBALS['EXEC_TIME']) {
1869 $out .= ' - ' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.starttime') . ':' . self::date($row[$ctrl['starttime']]) . ' (' . self::daysUntil($row[$ctrl['starttime']]) . ' ' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.days') . ')';
1870 }
1871 }
1872 if ($row[$ctrl['endtime']]) {
1873 $out .= ' - ' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.endtime') . ': ' . self::date($row[$ctrl['endtime']]) . ' (' . self::daysUntil($row[$ctrl['endtime']]) . ' ' . $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.days') . ')';
1874 }
1875 }
1876 return htmlspecialchars($out);
1877 }
1878
1879 /**
1880 * Returns the label of the first found entry in an "items" array from $GLOBALS['TCA'] (tablename = $table/fieldname = $col) where the value is $key
1881 *
1882 * @param string $table Table name, present in $GLOBALS['TCA']
1883 * @param string $col Field name, present in $GLOBALS['TCA']
1884 * @param string $key items-array value to match
1885 * @return string Label for item entry
1886 */
1887 static public function getLabelFromItemlist($table, $col, $key) {
1888 // Check, if there is an "items" array:
1889 if (is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['columns'][$col]) && is_array($GLOBALS['TCA'][$table]['columns'][$col]['config']['items'])) {
1890 // Traverse the items-array...
1891 foreach ($GLOBALS['TCA'][$table]['columns'][$col]['config']['items'] as $v) {
1892 // ... and return the first found label where the value was equal to $key
1893 if ((string)$v[1] === (string)$key) {
1894 return $v[0];
1895 }
1896 }
1897 }
1898 return '';
1899 }
1900
1901 /**
1902 * Return the label of a field by additionally checking TsConfig values
1903 *
1904 * @param int $pageId Page id
1905 * @param string $table Table name
1906 * @param string $column Field Name
1907 * @param string $key item value
1908 * @return string Label for item entry
1909 */
1910 static public function getLabelFromItemListMerged($pageId, $table, $column, $key) {
1911 $pageTsConfig = static::getPagesTSconfig($pageId);
1912 $label = '';
1913 if (is_array($pageTsConfig['TCEFORM.']) && is_array($pageTsConfig['TCEFORM.'][$table . '.']) && is_array($pageTsConfig['TCEFORM.'][$table . '.'][$column . '.'])) {
1914 if (is_array($pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['addItems.']) && isset($pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['addItems.'][$key])) {
1915 $label = $pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['addItems.'][$key];
1916 } elseif (is_array($pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['altLabels.']) && isset($pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['altLabels.'][$key])) {
1917 $label = $pageTsConfig['TCEFORM.'][$table . '.'][$column . '.']['altLabels.'][$key];
1918 }
1919 }
1920 if (empty($label)) {
1921 $tcaValue = self::getLabelFromItemlist($table, $column, $key);
1922 if (!empty($tcaValue)) {
1923 $label = $tcaValue;
1924 }
1925 }
1926 return $label;
1927 }
1928
1929 /**
1930 * Splits the given key with commas and returns the list of all the localized items labels, separated by a comma.
1931 * NOTE: this does not take itemsProcFunc into account
1932 *
1933 * @param string $table Table name, present in TCA
1934 * @param string $column Field name
1935 * @param string $key Key or comma-separated list of keys.
1936 * @return string Comma-separated list of localized labels
1937 */
1938 static public function getLabelsFromItemsList($table, $column, $key) {
1939 $labels = array();
1940 $values = GeneralUtility::trimExplode(',', $key, TRUE);
1941 if (count($values) > 0) {
1942 // Check if there is an "items" array
1943 if (is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['columns'][$column]) && is_array($GLOBALS['TCA'][$table]['columns'][$column]['config']['items'])) {
1944 // Loop on all selected values
1945 foreach ($values as $aValue) {
1946 foreach ($GLOBALS['TCA'][$table]['columns'][$column]['config']['items'] as $itemConfiguration) {
1947 // Loop on all available items
1948 // Keep matches and move on to next value
1949 if ((string)$aValue === (string)$itemConfiguration[1]) {
1950 $labels[] = static::getLanguageService()->sL($itemConfiguration[0]);
1951 break;
1952 }
1953 }
1954 }
1955 }
1956 }
1957 return implode(', ', $labels);
1958 }
1959
1960 /**
1961 * Returns the label-value for fieldname $col in table, $table
1962 * If $printAllWrap is set (to a "wrap") then it's wrapped around the $col value IF THE COLUMN $col DID NOT EXIST in TCA!, eg. $printAllWrap = '<strong>|</strong>' and the fieldname was 'not_found_field' then the return value would be '<strong>not_found_field</strong>'
1963 *
1964 * @param string $table Table name, present in $GLOBALS['TCA']
1965 * @param string $col Field name
1966 * @param string $printAllWrap Wrap value - set function description - this parameter is deprecated since TYPO3 6.2 and is removed two versions later. This parameter is a conceptual failure, as the content can then never be HSCed afterwards (which is how the method is used all the time), and then the code would be HSCed twice.
1967 * @return string or NULL if $col is not found in the TCA table
1968 */
1969 static public function getItemLabel($table, $col, $printAllWrap = '') {
1970 // Check if column exists
1971 if (is_array($GLOBALS['TCA'][$table]) && is_array($GLOBALS['TCA'][$table]['columns'][$col])) {
1972 return $GLOBALS['TCA'][$table]['columns'][$col]['label'];
1973 }
1974 if ($printAllWrap) {
1975 GeneralUtility::deprecationLog('The third parameter of getItemLabel() is deprecated with TYPO3 CMS 6.2 and will be removed two versions later.');
1976 $parts = explode('|', $printAllWrap);
1977 return $parts[0] . $col . $parts[1];
1978 }
1979
1980 return NULL;
1981 }
1982
1983 /**
1984 * Replace field values in given row with values from the original language
1985 * if l10n_mode TCA settings require to do so.
1986 *
1987 * @param string $table Table name
1988 * @param array $row Row to fill with original language values
1989 * @return array Row with values from the original language
1990 */
1991 static protected function replaceL10nModeFields($table, array $row) {
1992 $originalUidField = isset($GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField'])
1993 ? $GLOBALS['TCA'][$table]['ctrl']['transOrigPointerField']
1994 : '';
1995 if (empty($row[$originalUidField])) {
1996 return $row;
1997 }
1998
1999 $originalTable = self::getOriginalTranslationTable($table);
2000 $originalRow = self::getRecord($originalTable, $row[$originalUidField]);
2001 foreach ($row as $field => $_) {
2002 $l10n_mode = isset($GLOBALS['TCA'][$originalTable]['columns'][$field]['l10n_mode'])
2003 ? $GLOBALS['TCA'][$originalTable]['columns'][$field]['l10n_mode']
2004 : '';
2005 if ($l10n_mode === 'exclude' || ($l10n_mode === 'mergeIfNotBlank' && trim($originalRow[$field]) !== '')) {
2006 $row[$field] = $originalRow[$field];
2007 }
2008 }
2009 return $row;
2010 }
2011
2012 /**
2013 * Returns the "title"-value in record, $row, from table, $table
2014 * The field(s) from which the value is taken is determined by the "ctrl"-entries 'label', 'label_alt' and 'label_alt_force'
2015 *
2016 * @param string $table Table name, present in TCA
2017 * @param array $row Row from table
2018 * @param bool $prep If set, result is prepared for output: The output is cropped to a limited length (depending on BE_USER->uc['titleLen']) and if no value is found for the title, '<em>[No title]</em>' is returned (localized). Further, the output is htmlspecialchars()'ed
2019 * @param bool $forceResult If set, the function always returns an output. If no value is found for the title, '[No title]' is returned (localized).
2020 * @return string
2021 */
2022 static public function getRecordTitle($table, $row, $prep = FALSE, $forceResult = TRUE) {
2023 if (is_array($GLOBALS['TCA'][$table])) {
2024 // If configured, call userFunc
2025 if ($GLOBALS['TCA'][$table]['ctrl']['label_userFunc']) {
2026 $params['table'] = $table;
2027 $params['row'] = $row;
2028 $params['title'] = '';
2029 $params['options'] = isset($GLOBALS['TCA'][$table]['ctrl']['label_userFunc_options']) ? $GLOBALS['TCA'][$table]['ctrl']['label_userFunc_options'] : array();
2030
2031 // Create NULL-reference
2032 $null = NULL;
2033 GeneralUtility::callUserFunction($GLOBALS['TCA'][$table]['ctrl']['label_userFunc'], $params, $null);
2034 $t = $params['title'];
2035 } else {
2036 if (is_array($row)) {
2037 $row = self::replaceL10nModeFields($table, $row);
2038 }
2039
2040 // No userFunc: Build label
2041 $t = self::getProcessedValue($table, $GLOBALS['TCA'][$table]['ctrl']['label'], $row[$GLOBALS['TCA'][$table]['ctrl']['label']], 0, 0, FALSE, $row['uid'], $forceResult);
2042 if ($GLOBALS['TCA'][$table]['ctrl']['label_alt'] && ($GLOBALS['TCA'][$table]['ctrl']['label_alt_force'] || (string)$t === '')) {
2043 $altFields = GeneralUtility::trimExplode(',', $GLOBALS['TCA'][$table]['ctrl']['label_alt'], TRUE);
2044 $tA = array();
2045 if (!empty($t)) {
2046 $tA[] = $t;
2047 }
2048 foreach ($altFields as $fN) {
2049 $t = trim(strip_tags($row[$fN]));
2050 if ((string)$t !== '') {
2051 $t = self::getProcessedValue($table, $fN, $t, 0, 0, FALSE, $row['uid']);
2052 if (!$GLOBALS['TCA'][$table]['ctrl']['label_alt_force']) {
2053 break;
2054 }
2055 $tA[] = $t;
2056 }
2057 }
2058 if ($GLOBALS['TCA'][$table]['ctrl']['label_alt_force']) {
2059 $t = implode(', ', $tA);
2060 }
2061 }
2062 }
2063 // If the current result is empty, set it to '[No title]' (localized) and prepare for output if requested
2064 if ($prep || $forceResult) {
2065 if ($prep) {
2066 $t = self::getRecordTitlePrep($t);
2067 }
2068 if (trim($t) === '') {
2069 $t = self::getNoRecordTitle($prep);
2070 }
2071 }
2072 return $t;
2073 }
2074 return '';
2075 }
2076
2077 /**
2078 * Crops a title string to a limited length and if it really was cropped, wrap it in a <span title="...">|</span>,
2079 * which offers a tooltip with the original title when moving mouse over it.
2080 *
2081 * @param string $title The title string to be cropped
2082 * @param int $titleLength Crop title after this length - if not set, BE_USER->uc['titleLen'] is used
2083 * @return string The processed title string, wrapped in <span title="...">|</span> if cropped
2084 */
2085 static public function getRecordTitlePrep($title, $titleLength = 0) {
2086 // If $titleLength is not a valid positive integer, use BE_USER->uc['titleLen']:
2087 if (!$titleLength || !MathUtility::canBeInterpretedAsInteger($titleLength) || $titleLength < 0) {
2088 $titleLength = static::getBackendUserAuthentication()->uc['titleLen'];
2089 }
2090 $titleOrig = htmlspecialchars($title);
2091 $title = htmlspecialchars(GeneralUtility::fixed_lgd_cs($title, $titleLength));
2092 // If title was cropped, offer a tooltip:
2093 if ($titleOrig != $title) {
2094 $title = '<span title="' . $titleOrig . '">' . $title . '</span>';
2095 }
2096 return $title;
2097 }
2098
2099 /**
2100 * Get a localized [No title] string, wrapped in <em>|</em> if $prep is TRUE.
2101 *
2102 * @param bool $prep Wrap result in <em>|</em>
2103 * @return string Localized [No title] string
2104 */
2105 static public function getNoRecordTitle($prep = FALSE) {
2106 $noTitle = '[' . static::getLanguageService()->sL('LLL:EXT:lang/locallang_core.xlf:labels.no_title', TRUE) . ']';
2107 if ($prep) {
2108 $noTitle = '<em>' . $noTitle . '</em>';
2109 }
2110 return $noTitle;
2111 }
2112
2113 /**
2114 * Returns a human readable output of a value from a record
2115 * For instance a database record relation would be looked up to display the title-value of that record. A checkbox with a "1" value would be "Yes", etc.
2116 * $table/$col is tablename and fieldname
2117 * REMEMBER to pass the output through htmlspecialchars() if you output it to the browser! (To protect it from XSS attacks and be XHTML compliant)
2118 *
2119 * @param string $table Table name, present in TCA
2120 * @param string $col Field name, present in TCA
2121 * @param string $value The value of that field from a selected record
2122 * @param int $fixed_lgd_chars The max amount of characters the value may occupy
2123 * @param bool $defaultPassthrough Flag means that values for columns that has no conversion will just be pass through directly (otherwise cropped to 200 chars or returned as "N/A")
2124 * @param bool $noRecordLookup If set, no records will be looked up, UIDs are just shown.
2125 * @param int $uid Uid of the current record
2126 * @param bool $forceResult If BackendUtility::getRecordTitle is used to process the value, this parameter is forwarded.
2127 * @return string|NULL
2128 */
2129 static public function getProcessedValue($table, $col, $value, $fixed_lgd_chars = 0, $defaultPassthrough = FALSE, $noRecordLookup = FALSE, $uid = 0, $forceResult = TRUE) {
2130 if ($col === 'uid') {
2131 // uid is not in TCA-array
2132 return $value;
2133 }
2134 // Check if table and field is configured
2135 if (!is_array($GLOBALS['TCA'][$table]) || !is_array($GLOBALS['TCA'][$table]['columns'][$col])) {
2136 return NULL;
2137 }
2138 // Depending on the fields configuration, make a meaningful output value.
2139 $theColConf = $GLOBALS['TCA'][$table]['columns'][$col]['config'];
2140 /*****************
2141 *HOOK: pre-processing the human readable output from a record
2142 ****************/
2143 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['preProcessValue'])) {
2144 // Create NULL-reference
2145 $null = NULL;
2146 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['preProcessValue'] as $_funcRef) {
2147 GeneralUtility::callUserFunction($_funcRef, $theColConf, $null);
2148 }
2149 }
2150 $l = '';
2151 $db = static::getDatabaseConnection();
2152 $lang = static::getLanguageService();
2153 switch ((string)$theColConf['type']) {
2154 case 'radio':
2155 $l = self::getLabelFromItemlist($table, $col, $value);
2156 $l = $lang->sL($l);
2157 break;
2158 case 'inline':
2159 case 'select':
2160 if ($theColConf['MM']) {
2161 if ($uid) {
2162 // Display the title of MM related records in lists
2163 if ($noRecordLookup) {
2164 $MMfield = $theColConf['foreign_table'] . '.uid';
2165 } else {
2166 $MMfields = array($theColConf['foreign_table'] . '.' . $GLOBALS['TCA'][$theColConf['foreign_table']]['ctrl']['label']);
2167 foreach (GeneralUtility::trimExplode(',', $GLOBALS['TCA'][$theColConf['foreign_table']]['ctrl']['label_alt'], TRUE) as $f) {
2168 $MMfields[] = $theColConf['foreign_table'] . '.' . $f;
2169 }
2170 $MMfield = join(',', $MMfields);
2171 }
2172 /** @var $dbGroup RelationHandler */
2173 $dbGroup = GeneralUtility::makeInstance(RelationHandler::class);
2174 $dbGroup->start($value, $theColConf['foreign_table'], $theColConf['MM'], $uid, $table, $theColConf);
2175 $selectUids = $dbGroup->tableArray[$theColConf['foreign_table']];
2176 if (is_array($selectUids) && count($selectUids) > 0) {
2177 $MMres = $db->exec_SELECTquery('uid, ' . $MMfield, $theColConf['foreign_table'], 'uid IN (' . implode(',', $selectUids) . ')' . self::deleteClause($theColConf['foreign_table']));
2178 $mmlA = array();
2179 while ($MMrow = $db->sql_fetch_assoc($MMres)) {
2180 // Keep sorting of $selectUids
2181 $mmlA[array_search($MMrow['uid'], $selectUids)] = $noRecordLookup ?
2182 $MMrow['uid'] :
2183 static::getRecordTitle($theColConf['foreign_table'], $MMrow, FALSE, $forceResult);
2184 }
2185 $db->sql_free_result($MMres);
2186 if (!empty($mmlA)) {
2187 ksort($mmlA);
2188 $l = implode('; ', $mmlA);
2189 } else {
2190 $l = 'N/A';
2191 }
2192 } else {
2193 $l = 'N/A';
2194 }
2195 } else {
2196 $l = 'N/A';
2197 }
2198 } else {
2199 $l = self::getLabelsFromItemsList($table, $col, $value);
2200 if ($theColConf['foreign_table'] && !$l && $GLOBALS['TCA'][$theColConf['foreign_table']]) {
2201 if ($noRecordLookup) {
2202 $l = $value;
2203 } else {
2204 $rParts = array();
2205 if ($uid && isset($theColConf['foreign_field']) && $theColConf['foreign_field'] !== '') {
2206 $whereClause = '';
2207 // Add additional where clause if foreign_match_fields are defined
2208 $foreignMatchFields = is_array($theColConf['foreign_match_fields']) ? $theColConf['foreign_match_fields'] : array();
2209 foreach ($foreignMatchFields as $matchField => $matchValue) {
2210 $whereClause .= ' AND ' . $matchField . '=' . static::getDatabaseConnection()->fullQuoteStr($matchValue, $theColConf['foreign_table']);
2211 }
2212 $records = self::getRecordsByField($theColConf['foreign_table'], $theColConf['foreign_field'], $uid, $whereClause);
2213 if (!empty($records)) {
2214 foreach ($records as $record) {
2215 $rParts[] = $record['uid'];
2216 }
2217 }
2218 }
2219 if (empty($rParts)) {
2220 $rParts = GeneralUtility::trimExplode(',', $value, TRUE);
2221 }
2222 $lA = array();
2223 foreach ($rParts as $rVal) {
2224 $rVal = (int)$rVal;
2225 if ($rVal > 0) {
2226 $r = self::getRecordWSOL($theColConf['foreign_table'], $rVal);
2227 } else {
2228 $r = self::getRecordWSOL($theColConf['neg_foreign_table'], -$rVal);
2229 }
2230 if (is_array($r)) {
2231 $lA[] = $lang->sL(($rVal > 0 ? $theColConf['foreign_table_prefix'] : $theColConf['neg_foreign_table_prefix'])) . self::getRecordTitle(($rVal > 0 ? $theColConf['foreign_table'] : $theColConf['neg_foreign_table']), $r, FALSE, $forceResult);
2232 } else {
2233 $lA[] = $rVal ? '[' . $rVal . '!]' : '';
2234 }
2235 }
2236 $l = implode(', ', $lA);
2237 }
2238 }
2239 if (empty($l) && !empty($value)) {
2240 // Use plain database value when label is empty
2241 $l = $value;
2242 }
2243 }
2244 break;
2245 case 'group':
2246 // resolve the titles for DB records
2247 if ($theColConf['internal_type'] === 'db') {
2248 if ($theColConf['MM']) {
2249 if ($uid) {
2250 // Display the title of MM related records in lists
2251 if ($noRecordLookup) {
2252 $MMfield = $theColConf['foreign_table'] . '.uid';
2253 } else {
2254 $MMfields = array($theColConf['foreign_table'] . '.' . $GLOBALS['TCA'][$theColConf['foreign_table']]['ctrl']['label']);
2255 $altLabelFields = explode(',', $GLOBALS['TCA'][$theColConf['foreign_table']]['ctrl']['label_alt']);
2256 foreach ($altLabelFields as $f) {
2257 $f = trim($f);
2258 if ($f !== '') {
2259 $MMfields[] = $theColConf['foreign_table'] . '.' . $f;
2260 }
2261 }
2262 $MMfield = join(',', $MMfields);
2263 }
2264 /** @var $dbGroup RelationHandler */
2265 $dbGroup = GeneralUtility::makeInstance(RelationHandler::class);
2266 $dbGroup->start($value, $theColConf['foreign_table'], $theColConf['MM'], $uid, $table, $theColConf);
2267 $selectUids = $dbGroup->tableArray[$theColConf['foreign_table']];
2268 if (!empty($selectUids) && is_array($selectUids)) {
2269 $MMres = $db->exec_SELECTquery(
2270 'uid, ' . $MMfield,
2271 $theColConf['foreign_table'],
2272 'uid IN (' . implode(',', $selectUids) . ')' . static::deleteClause($theColConf['foreign_table'])
2273 );
2274 $mmlA = array();
2275 while ($MMrow = $db->sql_fetch_assoc($MMres)) {
2276 // Keep sorting of $selectUids
2277 $mmlA[array_search($MMrow['uid'], $selectUids)] = $noRecordLookup
2278 ? $MMrow['uid']
2279 : static::getRecordTitle($theColConf['foreign_table'], $MMrow, FALSE, $forceResult);
2280 }
2281 $db->sql_free_result($MMres);
2282 if (!empty($mmlA)) {
2283 ksort($mmlA);
2284 $l = implode('; ', $mmlA);
2285 } else {
2286 $l = 'N/A';
2287 }
2288 } else {
2289 $l = 'N/A';
2290 }
2291 } else {
2292 $l = 'N/A';
2293 }
2294 } else {
2295 $finalValues = array();
2296 $relationTableName = $theColConf['allowed'];
2297 $explodedValues = GeneralUtility::trimExplode(',', $value, TRUE);
2298
2299 foreach ($explodedValues as $explodedValue) {
2300 if (MathUtility::canBeInterpretedAsInteger($explodedValue)) {
2301 $relationTableNameForField = $relationTableName;
2302 } else {
2303 list($relationTableNameForField, $explodedValue) = self::splitTable_Uid($explodedValue);
2304 }
2305
2306 $relationRecord = static::getRecordWSOL($relationTableNameForField, $explodedValue);
2307 $finalValues[] = static::getRecordTitle($relationTableNameForField, $relationRecord);
2308 }
2309 $l = implode(', ', $finalValues);
2310 }
2311 } else {
2312 $l = implode(', ', GeneralUtility::trimExplode(',', $value, TRUE));
2313 }
2314 break;
2315 case 'check':
2316 if (!is_array($theColConf['items']) || count($theColConf['items']) == 1) {
2317 $l = $value ? $lang->sL('LLL:EXT:lang/locallang_common.xlf:yes') : $lang->sL('LLL:EXT:lang/locallang_common.xlf:no');
2318 } else {
2319 $lA = array();
2320 foreach ($theColConf['items'] as $key => $val) {
2321 if ($value & pow(2, $key)) {
2322 $lA[] = $lang->sL($val[0]);
2323 }
2324 }
2325 $l = implode(', ', $lA);
2326 }
2327 break;
2328 case 'input':
2329 // Hide value 0 for dates, but show it for everything else
2330 if (isset($value)) {
2331 if (GeneralUtility::inList($theColConf['eval'], 'date')) {
2332 // Handle native date field
2333 if (isset($theColConf['dbType']) && $theColConf['dbType'] === 'date') {
2334 $dateTimeFormats = $db->getDateTimeFormats($table);
2335 $emptyValue = $dateTimeFormats['date']['empty'];
2336 $value = $value !== $emptyValue ? strtotime($value) : 0;
2337 }
2338 if (!empty($value)) {
2339 $l = self::date($value) . ' (' . ($GLOBALS['EXEC_TIME'] - $value > 0 ? '-' : '') . self::calcAge(abs(($GLOBALS['EXEC_TIME'] - $value)), $lang->sL('LLL:EXT:lang/locallang_core.xlf:labels.minutesHoursDaysYears')) . ')';
2340 }
2341 } elseif (GeneralUtility::inList($theColConf['eval'], 'time')) {
2342 if (!empty($value)) {
2343 $l = self::time($value, FALSE);
2344 }
2345 } elseif (GeneralUtility::inList($theColConf['eval'], 'timesec')) {
2346 if (!empty($value)) {
2347 $l = self::time($value);
2348 }
2349 } elseif (GeneralUtility::inList($theColConf['eval'], 'datetime')) {
2350 // Handle native date/time field
2351 if (isset($theColConf['dbType']) && $theColConf['dbType'] === 'datetime') {
2352 $dateTimeFormats = $db->getDateTimeFormats($table);
2353 $emptyValue = $dateTimeFormats['datetime']['empty'];
2354 $value = $value !== $emptyValue ? strtotime($value) : 0;
2355 }
2356 if (!empty($value)) {
2357 $l = self::datetime($value);
2358 }
2359 } else {
2360 $l = $value;
2361 }
2362 }
2363 break;
2364 case 'flex':
2365 $l = strip_tags($value);
2366 break;
2367 default:
2368 if ($defaultPassthrough) {
2369 $l = $value;
2370 } elseif ($theColConf['MM']) {
2371 $l = 'N/A';
2372 } elseif ($value) {
2373 $l = GeneralUtility::fixed_lgd_cs(strip_tags($value), 200);
2374 }
2375 }
2376 // If this field is a password field, then hide the password by changing it to a random number of asterisk (*)
2377 if (stristr($theColConf['eval'], 'password')) {
2378 $l = '';
2379 $randomNumber = rand(5, 12);
2380 for ($i = 0; $i < $randomNumber; $i++) {
2381 $l .= '*';
2382 }
2383 }
2384 /*****************
2385 *HOOK: post-processing the human readable output from a record
2386 ****************/
2387 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['postProcessValue'])) {
2388 // Create NULL-reference
2389 $null = NULL;
2390 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['t3lib/class.t3lib_befunc.php']['postProcessValue'] as $_funcRef) {
2391 $params = array(
2392 'value' => $l,
2393 'colConf' => $theColConf
2394 );
2395 $l = GeneralUtility::callUserFunction($_funcRef, $params, $null);
2396 }
2397 }
2398 if ($fixed_lgd_chars) {
2399 return GeneralUtility::fixed_lgd_cs($l, $fixed_lgd_chars);
2400 } else {
2401 return $l;
2402 }
2403 }
2404
2405 /**
2406 * Same as ->getProcessedValue() but will go easy on fields like "tstamp" and "pid" which are not configured in TCA - they will be formatted by this function instead.
2407 *
2408 * @param string $table Table name, present in TCA
2409 * @param string $fN Field name
2410 * @param string $fV Field value
2411 * @param int $fixed_lgd_chars The max amount of characters the value may occupy
2412 * @param int $uid Uid of the current record
2413 * @param bool $forceResult If BackendUtility::getRecordTitle is used to process the value, this parameter is forwarded.
2414 * @return string
2415 * @see getProcessedValue()
2416 */
2417 static public function getProcessedValueExtra($table, $fN, $fV, $fixed_lgd_chars = 0, $uid = 0, $forceResult = TRUE) {
2418 $fVnew = self::getProcessedValue($table, $fN, $fV, $fixed_lgd_chars, 1, 0, $uid, $forceResult);
2419 if (!isset($fVnew)) {
2420 if (is_array($GLOBALS['TCA'][$table])) {
2421 if ($fN == $GLOBALS['TCA'][$table]['ctrl']['tstamp'] || $fN == $GLOBALS['TCA'][$table]['ctrl']['crdate']) {
2422 $fVnew = self::datetime($fV);
2423 } elseif ($fN == 'pid') {
2424 // Fetches the path with no regard to the users permissions to select pages.
2425 $fVnew = self::getRecordPath($fV, '1=1', 20);
2426 } else {
2427 $fVnew = $fV;
2428 }
2429 }
2430 }
2431 return $fVnew;
2432 }
2433
2434 /**
2435 * Returns file icon name (from $FILEICONS) for the fileextension $ext
2436 *
2437 * @param string $ext File extension, lowercase
2438 * @return string File icon filename
2439 */
2440 static public function getFileIcon($ext) {
2441 return $GLOBALS['FILEICONS'][$ext] ?: $GLOBALS['FILEICONS']['default'];
2442 }
2443
2444 /**
2445 * Returns fields for a table, $table, which would typically be interesting to select
2446 * This includes uid, the fields defined for title, icon-field.
2447 * Returned as a list ready for query ($prefix can be set to eg. "pages." if you are selecting from the pages table and want the table name prefixed)
2448 *
2449 * @param string $table Table name, present in $GLOBALS['TCA']
2450 * @param string $prefix Table prefix
2451 * @param array $fields Preset fields (must include prefix if that is used)
2452 * @return string List of fields.
2453 */
2454 static public function getCommonSelectFields($table, $prefix = '', $fields = array()) {
2455 $fields[] = $prefix . 'uid';
2456 if (isset($GLOBALS['TCA'][$table]['ctrl']['label']) && $GLOBALS['TCA'][$table]['ctrl']['label'] != '') {
2457 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['label'];
2458 }
2459 if ($GLOBALS['TCA'][$table]['ctrl']['label_alt']) {
2460 $secondFields = GeneralUtility::trimExplode(',', $GLOBALS['TCA'][$table]['ctrl']['label_alt'], TRUE);
2461 foreach ($secondFields as $fieldN) {
2462 $fields[] = $prefix . $fieldN;
2463 }
2464 }
2465 if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
2466 $fields[] = $prefix . 't3ver_id';
2467 $fields[] = $prefix . 't3ver_state';
2468 $fields[] = $prefix . 't3ver_wsid';
2469 $fields[] = $prefix . 't3ver_count';
2470 }
2471 if ($GLOBALS['TCA'][$table]['ctrl']['selicon_field']) {
2472 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['selicon_field'];
2473 }
2474 if ($GLOBALS['TCA'][$table]['ctrl']['typeicon_column']) {
2475 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['typeicon_column'];
2476 }
2477 if (is_array($GLOBALS['TCA'][$table]['ctrl']['enablecolumns'])) {
2478 if ($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled']) {
2479 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled'];
2480 }
2481 if ($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['starttime']) {
2482 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['starttime'];
2483 }
2484 if ($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['endtime']) {
2485 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['endtime'];
2486 }
2487 if ($GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['fe_group']) {
2488 $fields[] = $prefix . $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['fe_group'];
2489 }
2490 }
2491 return implode(',', array_unique($fields));
2492 }
2493
2494 /**
2495 * Makes a form for configuration of some values based on configuration found in the array $configArray,
2496 * with default values from $defaults and a data-prefix $dataPrefix
2497 * <form>-tags must be supplied separately
2498 * Needs more documentation and examples, in particular syntax for configuration array. See Inside TYPO3.
2499 * That's were you can expect to find example, if anywhere.
2500 *
2501 * @param array $configArray Field configuration code.
2502 * @param array $defaults Defaults
2503 * @param string $dataPrefix Prefix for formfields
2504 * @return string HTML for a form.
2505 */
2506 static public function makeConfigForm($configArray, $defaults, $dataPrefix) {
2507 $params = $defaults;
2508 $lines = array();
2509 if (is_array($configArray)) {
2510 foreach ($configArray as $fname => $config) {
2511 if (is_array($config)) {
2512 $lines[$fname] = '<strong>' . htmlspecialchars($config[1]) . '</strong><br />';
2513 $lines[$fname] .= $config[2] . '<br />';
2514 switch ($config[0]) {
2515 case 'string':
2516
2517 case 'short':
2518 $formEl = '<input type="text" name="' . $dataPrefix . '[' . $fname . ']" value="' . $params[$fname] . '"' . static::getDocumentTemplate()->formWidth(($config[0] == 'short' ? 24 : 48)) . ' />';
2519 break;
2520 case 'check':
2521 $formEl = '<input type="hidden" name="' . $dataPrefix . '[' . $fname . ']" value="0" /><input type="checkbox" name="' . $dataPrefix . '[' . $fname . ']" value="1"' . ($params[$fname] ? ' checked="checked"' : '') . ' />';
2522 break;
2523 case 'comment':
2524 $formEl = '';
2525 break;
2526 case 'select':
2527 $opt = array();
2528 foreach ($config[3] as $k => $v) {
2529 $opt[] = '<option value="' . htmlspecialchars($k) . '"' . ($params[$fname] == $k ? ' selected="selected"' : '') . '>' . htmlspecialchars($v) . '</option>';
2530 }
2531 $formEl = '<select name="' . $dataPrefix . '[' . $fname . ']">' . implode('', $opt) . '</select>';
2532 break;
2533 default:
2534 $formEl = '<strong>Should not happen. Bug in config.</strong>';
2535 }
2536 $lines[$fname] .= $formEl;
2537 $lines[$fname] .= '<br /><br />';
2538 } else {
2539 $lines[$fname] = '<hr />';
2540 if ($config) {
2541 $lines[$fname] .= '<strong>' . strtoupper(htmlspecialchars($config)) . '</strong><br />';
2542 }
2543 if ($config) {
2544 $lines[$fname] .= '<br />';
2545 }
2546 }
2547 }
2548 }
2549 $out = implode('', $lines);
2550 $out .= '<input class="btn btn-default" type="submit" name="submit" value="Update configuration" />';
2551 return $out;
2552 }
2553
2554 /*******************************************
2555 *
2556 * Backend Modules API functions
2557 *
2558 *******************************************/
2559 /**
2560 * Returns help-text icon if configured for.
2561 * TCA_DESCR must be loaded prior to this function
2562 *
2563 * Please note: since TYPO3 4.5 the UX team decided to not use CSH in its former way,
2564 * but to wrap the given text (where before the help icon was, and you could hover over it)
2565 * Please also note that since TYPO3 4.5 the option to enable help (none, icon only, full text)
2566 * was completely removed.
2567 *
2568 * @param string $table Table name
2569 * @param string $field Field name
2570 * @param string $BACK_PATH UNUSED
2571 * @param bool $force Force display of icon no matter BE_USER setting for help
2572 * @return string HTML content for a help icon/text
2573 * @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8, use cshItem() instead
2574 */
2575 static public function helpTextIcon($table, $field, $BACK_PATH = '', $force = FALSE) {
2576 GeneralUtility::logDeprecatedFunction();
2577 if (is_array($GLOBALS['TCA_DESCR'][$table]) && is_array($GLOBALS['TCA_DESCR'][$table]['columns'][$field])) {
2578 return self::wrapInHelp($table, $field);
2579 }
2580 return '';
2581 }
2582
2583 /**
2584 * Returns CSH help text (description), if configured for, as an array (title, description)
2585 *
2586 * @param string $table Table name
2587 * @param string $field Field name
2588 * @return array With keys 'description' (raw, as available in locallang), 'title' (optional), 'moreInfo'
2589 */
2590 static public function helpTextArray($table, $field) {
2591 if (!isset($GLOBALS['TCA_DESCR'][$table]['columns'])) {
2592 static::getLanguageService()->loadSingleTableDescription($table);
2593 }
2594 $output = array(
2595 'description' => NULL,
2596 'title' => NULL,
2597 'moreInfo' => FALSE
2598 );
2599 if (is_array($GLOBALS['TCA_DESCR'][$table]) && is_array($GLOBALS['TCA_DESCR'][$table]['columns'][$field])) {
2600 $data = $GLOBALS['TCA_DESCR'][$table]['columns'][$field];
2601 // Add alternative title, if defined
2602 if ($data['alttitle']) {
2603 $output['title'] = $data['alttitle'];
2604 }
2605 // If we have more information to show
2606 if ($data['image_descr'] || $data['seeAlso'] || $data['details'] || $data['syntax']) {
2607 $output['moreInfo'] = TRUE;
2608 }
2609 // Add description
2610 if ($data['description']) {
2611 $output['description'] = $data['description'];
2612 }
2613 }
2614 return $output;
2615 }
2616
2617 /**
2618 * Returns CSH help text
2619 *
2620 * @param string $table Table name
2621 * @param string $field Field name
2622 * @return string HTML content for help text
2623 * @see cshItem()
2624 */
2625 static public function helpText($table, $field) {
2626 $helpTextArray = self::helpTextArray($table, $field);
2627 $output = '';
2628 $arrow = '';
2629 // Put header before the rest of the text
2630 if ($helpTextArray['title'] !== NULL) {
2631 $output .= '<h2 class="t3-row-header">' . $helpTextArray['title'] . '</h2>';
2632 }
2633 // Add see also arrow if we have more info
2634 if ($helpTextArray['moreInfo']) {
2635 $arrow = IconUtility::getSpriteIcon('actions-view-go-forward');