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