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