[TASK] Cleanup ContentObject\ContentObjectRenderer
[Packages/TYPO3.CMS.git] / typo3 / sysext / frontend / Classes / ContentObject / ContentObjectRenderer.php
1 <?php
2 namespace TYPO3\CMS\Frontend\ContentObject;
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 textfile GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 *
29 ***************************************************************/
30
31 use TYPO3\CMS\Core\Utility\GeneralUtility;
32 use TYPO3\CMS\Core\Versioning\VersionState;
33
34 /**
35 * This class contains all main TypoScript features.
36 * This includes the rendering of TypoScript content objects (cObjects).
37 * Is the backbone of TypoScript Template rendering.
38 *
39 * There are lots of functions you can use from your include-scripts.
40 * The class is normally instantiated and referred to as "cObj".
41 * When you call your own PHP-code typically through a USER or USER_INT cObject then it is this class that instantiates the object and calls the main method. Before it does so it will set (if you are using classes) a reference to itself in the internal variable "cObj" of the object. Thus you can access all functions and data from this class by $this->cObj->... from within you classes written to be USER or USER_INT content objects.
42 *
43 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
44 */
45 class ContentObjectRenderer {
46
47 /**
48 * @todo Define visibility
49 */
50 public $align = array(
51 'center',
52 'right',
53 'left'
54 );
55
56 /**
57 * stdWrap functions in their correct order
58 *
59 * @see stdWrap()
60 * @todo Define visibility
61 */
62 public $stdWrapOrder = array(
63 'stdWrapPreProcess' => 'hook',
64 // this is a placeholder for the first Hook
65 'cacheRead' => 'hook',
66 // this is a placeholder for checking if the content is available in cache
67 'setContentToCurrent' => 'boolean',
68 'setContentToCurrent.' => 'array',
69 'addPageCacheTags' => 'string',
70 'addPageCacheTags.' => 'array',
71 'setCurrent' => 'string',
72 'setCurrent.' => 'array',
73 'lang.' => 'array',
74 'data' => 'getText',
75 'data.' => 'array',
76 'field' => 'fieldName',
77 'field.' => 'array',
78 'current' => 'boolean',
79 'current.' => 'array',
80 'cObject' => 'cObject',
81 'cObject.' => 'array',
82 'numRows.' => 'array',
83 'filelist' => 'dir',
84 'filelist.' => 'array',
85 'preUserFunc' => 'functionName',
86 'stdWrapOverride' => 'hook',
87 // this is a placeholder for the second Hook
88 'override' => 'string',
89 'override.' => 'array',
90 'preIfEmptyListNum' => 'listNum',
91 'preIfEmptyListNum.' => 'array',
92 'ifNull' => 'string',
93 'ifNull.' => 'array',
94 'ifEmpty' => 'string',
95 'ifEmpty.' => 'array',
96 'ifBlank' => 'string',
97 'ifBlank.' => 'array',
98 'listNum' => 'listNum',
99 'listNum.' => 'array',
100 'trim' => 'boolean',
101 'trim.' => 'array',
102 'strPad.' => 'array',
103 'stdWrap' => 'stdWrap',
104 'stdWrap.' => 'array',
105 'stdWrapProcess' => 'hook',
106 // this is a placeholder for the third Hook
107 'required' => 'boolean',
108 'required.' => 'array',
109 'if.' => 'array',
110 'fieldRequired' => 'fieldName',
111 'fieldRequired.' => 'array',
112 'csConv' => 'string',
113 'csConv.' => 'array',
114 'parseFunc' => 'objectpath',
115 'parseFunc.' => 'array',
116 'HTMLparser' => 'boolean',
117 'HTMLparser.' => 'array',
118 'split.' => 'array',
119 'replacement.' => 'array',
120 'prioriCalc' => 'boolean',
121 'prioriCalc.' => 'array',
122 'char' => 'integer',
123 'char.' => 'array',
124 'intval' => 'boolean',
125 'intval.' => 'array',
126 'hash' => 'string',
127 'hash.' => 'array',
128 'round' => 'boolean',
129 'round.' => 'array',
130 'numberFormat.' => 'array',
131 'expandList' => 'boolean',
132 'expandList.' => 'array',
133 'date' => 'dateconf',
134 'date.' => 'array',
135 'strftime' => 'strftimeconf',
136 'strftime.' => 'array',
137 'age' => 'boolean',
138 'age.' => 'array',
139 'case' => 'case',
140 'case.' => 'array',
141 'bytes' => 'boolean',
142 'bytes.' => 'array',
143 'substring' => 'parameters',
144 'substring.' => 'array',
145 'removeBadHTML' => 'boolean',
146 'removeBadHTML.' => 'array',
147 'cropHTML' => 'crop',
148 'cropHTML.' => 'array',
149 'stripHtml' => 'boolean',
150 'stripHtml.' => 'array',
151 'crop' => 'crop',
152 'crop.' => 'array',
153 'rawUrlEncode' => 'boolean',
154 'rawUrlEncode.' => 'array',
155 'htmlSpecialChars' => 'boolean',
156 'htmlSpecialChars.' => 'array',
157 'doubleBrTag' => 'string',
158 'doubleBrTag.' => 'array',
159 'br' => 'boolean',
160 'br.' => 'array',
161 'brTag' => 'string',
162 'brTag.' => 'array',
163 'encapsLines.' => 'array',
164 'keywords' => 'boolean',
165 'keywords.' => 'array',
166 'innerWrap' => 'wrap',
167 'innerWrap.' => 'array',
168 'innerWrap2' => 'wrap',
169 'innerWrap2.' => 'array',
170 'fontTag' => 'wrap',
171 'fontTag.' => 'array',
172 'addParams.' => 'array',
173 'textStyle.' => 'array',
174 'tableStyle.' => 'array',
175 'filelink.' => 'array',
176 'preCObject' => 'cObject',
177 'preCObject.' => 'array',
178 'postCObject' => 'cObject',
179 'postCObject.' => 'array',
180 'wrapAlign' => 'align',
181 'wrapAlign.' => 'array',
182 'typolink.' => 'array',
183 'TCAselectItem.' => 'array',
184 'space' => 'space',
185 'space.' => 'array',
186 'spaceBefore' => 'int',
187 'spaceBefore.' => 'array',
188 'spaceAfter' => 'int',
189 'spaceAfter.' => 'array',
190 'wrap' => 'wrap',
191 'wrap.' => 'array',
192 'noTrimWrap' => 'wrap',
193 'noTrimWrap.' => 'array',
194 'wrap2' => 'wrap',
195 'wrap2.' => 'array',
196 'dataWrap' => 'dataWrap',
197 'dataWrap.' => 'array',
198 'prepend' => 'cObject',
199 'prepend.' => 'array',
200 'append' => 'cObject',
201 'append.' => 'array',
202 'wrap3' => 'wrap',
203 'wrap3.' => 'array',
204 'orderedStdWrap' => 'stdWrap',
205 'orderedStdWrap.' => 'array',
206 'outerWrap' => 'wrap',
207 'outerWrap.' => 'array',
208 'insertData' => 'boolean',
209 'insertData.' => 'array',
210 'offsetWrap' => 'space',
211 'offsetWrap.' => 'array',
212 'postUserFunc' => 'functionName',
213 'postUserFuncInt' => 'functionName',
214 'prefixComment' => 'string',
215 'prefixComment.' => 'array',
216 'editIcons' => 'string',
217 'editIcons.' => 'array',
218 'editPanel' => 'boolean',
219 'editPanel.' => 'array',
220 'cacheStore' => 'hook',
221 // this is a placeholder for storing the content in cache
222 'stdWrapPostProcess' => 'hook',
223 // this is a placeholder for the last Hook
224 'debug' => 'boolean',
225 'debug.' => 'array',
226 'debugFunc' => 'boolean',
227 'debugFunc.' => 'array',
228 'debugData' => 'boolean',
229 'debugData.' => 'array'
230 );
231
232 /**
233 * Holds ImageMagick parameters and extensions used for compression
234 *
235 * @see IMGTEXT()
236 * @todo Define visibility
237 */
238 public $image_compression = array(
239 10 => array(
240 'params' => '',
241 'ext' => 'gif'
242 ),
243 11 => array(
244 'params' => '-colors 128',
245 'ext' => 'gif'
246 ),
247 12 => array(
248 'params' => '-colors 64',
249 'ext' => 'gif'
250 ),
251 13 => array(
252 'params' => '-colors 32',
253 'ext' => 'gif'
254 ),
255 14 => array(
256 'params' => '-colors 16',
257 'ext' => 'gif'
258 ),
259 15 => array(
260 'params' => '-colors 8',
261 'ext' => 'gif'
262 ),
263 20 => array(
264 'params' => '-quality 100',
265 'ext' => 'jpg'
266 ),
267 21 => array(
268 'params' => '-quality 90',
269 'ext' => 'jpg'
270 ),
271 22 => array(
272 'params' => '-quality 80',
273 'ext' => 'jpg'
274 ),
275 23 => array(
276 'params' => '-quality 70',
277 'ext' => 'jpg'
278 ),
279 24 => array(
280 'params' => '-quality 60',
281 'ext' => 'jpg'
282 ),
283 25 => array(
284 'params' => '-quality 50',
285 'ext' => 'jpg'
286 ),
287 26 => array(
288 'params' => '-quality 40',
289 'ext' => 'jpg'
290 ),
291 27 => array(
292 'params' => '-quality 30',
293 'ext' => 'jpg'
294 ),
295 28 => array(
296 'params' => '-quality 20',
297 'ext' => 'jpg'
298 ),
299 30 => array(
300 'params' => '-colors 256',
301 'ext' => 'png'
302 ),
303 31 => array(
304 'params' => '-colors 128',
305 'ext' => 'png'
306 ),
307 32 => array(
308 'params' => '-colors 64',
309 'ext' => 'png'
310 ),
311 33 => array(
312 'params' => '-colors 32',
313 'ext' => 'png'
314 ),
315 34 => array(
316 'params' => '-colors 16',
317 'ext' => 'png'
318 ),
319 35 => array(
320 'params' => '-colors 8',
321 'ext' => 'png'
322 ),
323 39 => array(
324 'params' => '',
325 'ext' => 'png'
326 )
327 );
328
329 /**
330 * ImageMagick parameters for image effects
331 *
332 * @see IMGTEXT()
333 * @todo Define visibility
334 */
335 public $image_effects = array(
336 1 => '-rotate 90',
337 2 => '-rotate 270',
338 3 => '-rotate 180',
339 10 => '-colorspace GRAY',
340 11 => '-sharpen 70',
341 20 => '-normalize',
342 23 => '-contrast',
343 25 => '-gamma 1.3',
344 26 => '-gamma 0.8'
345 );
346
347 /**
348 * Loaded with the current data-record.
349 *
350 * If the instance of this class is used to render records from the database those records are found in this array.
351 * The function stdWrap has TypoScript properties that fetch field-data from this array.
352 *
353 * @see init()
354 * @todo Define visibility
355 */
356 public $data = array();
357
358 protected $table = '';
359
360 // Used for backup...
361 /**
362 * @todo Define visibility
363 */
364 public $oldData = array();
365
366 // If this is set with an array before stdWrap, it's used instead of $this->data in the data-property in stdWrap
367 /**
368 * @todo Define visibility
369 */
370 public $alternativeData = '';
371
372 // Used by the parseFunc function and is loaded with tag-parameters when parsing tags.
373 /**
374 * @todo Define visibility
375 */
376 public $parameters = array();
377
378 /**
379 * @todo Define visibility
380 */
381 public $currentValKey = 'currentValue_kidjls9dksoje';
382
383 // This is set to the [table]:[uid] of the record delivered in the $data-array, if the cObjects CONTENT or RECORD is in operation.
384 // Note that $GLOBALS['TSFE']->currentRecord is set to an equal value but always indicating the latest record rendered.
385 /**
386 * @todo Define visibility
387 */
388 public $currentRecord = '';
389
390 // Set in cObj->RECORDS and cObj->CONTENT to the current number of records selected in a query.
391 /**
392 * @todo Define visibility
393 */
394 public $currentRecordTotal = 0;
395
396 // Incremented in cObj->RECORDS and cObj->CONTENT before each record rendering.
397 /**
398 * @todo Define visibility
399 */
400 public $currentRecordNumber = 0;
401
402 // Incremented in parent cObj->RECORDS and cObj->CONTENT before each record rendering.
403 /**
404 * @todo Define visibility
405 */
406 public $parentRecordNumber = 0;
407
408 // If the ContentObjectRender was started from CONTENT, RECORD or SEARCHRESULT cObject's this array has two keys, 'data' and 'currentRecord' which indicates the record and data for the parent cObj.
409 /**
410 * @todo Define visibility
411 */
412 public $parentRecord = array();
413
414 // This may be set as a reference to the calling object of eg. cObjGetSingle. Anyway, just use it as you like. It's used in productsLib.inc for example.
415 /**
416 * @todo Define visibility
417 */
418 public $regObj;
419
420 // internal
421 // Is set to 1 if the instance of this cObj is executed from a *_INT plugin (see pagegen, bottom of document)
422 /**
423 * @todo Define visibility
424 */
425 public $INT_include = 0;
426
427 // This is used by checkPid, that checks if pages are accessible. The $checkPid_cache['page_uid'] is set TRUE or FALSE upon this check featuring a caching function for the next request.
428 /**
429 * @todo Define visibility
430 */
431 public $checkPid_cache = array();
432
433 /**
434 * @todo Define visibility
435 */
436 public $checkPid_badDoktypeList = '255';
437
438 // This will be set by typoLink() to the url of the most recent link created.
439 /**
440 * @todo Define visibility
441 */
442 public $lastTypoLinkUrl = '';
443
444 // DO. link target.
445 /**
446 * @todo Define visibility
447 */
448 public $lastTypoLinkTarget = '';
449
450 /**
451 * @todo Define visibility
452 */
453 public $lastTypoLinkLD = array();
454
455 // Caching substituteMarkerArrayCached function
456 /**
457 * @todo Define visibility
458 */
459 public $substMarkerCache = array();
460
461 // array that registers rendered content elements (or any table) to make sure they are not rendered recursively!
462 /**
463 * @todo Define visibility
464 */
465 public $recordRegister = array();
466
467 // Containig hooks for userdefined cObjects
468 /**
469 * @todo Define visibility
470 */
471 public $cObjHookObjectsArr = array();
472
473 // Containing hook objects for stdWrap
474 protected $stdWrapHookObjects = array();
475
476 // Containing hook objects for getImgResource
477 protected $getImgResourceHookObjects;
478
479 /**
480 * @var array with members of AbstractContentObject
481 */
482 protected $contentObjects = array();
483
484 /**
485 * @var \TYPO3\CMS\Core\Resource\File Current file objects (during iterations over files)
486 */
487 protected $currentFile = NULL;
488
489 /**
490 * Set to TRUE by doConvertToUserIntObject() if USER object wants to become USER_INT
491 */
492 public $doConvertToUserIntObject = FALSE;
493
494 /**
495 * Indicates current object type. Can hold one of OBJECTTYPE_ constants or FALSE.
496 * The value is set and reset inside USER() function. Any time outside of
497 * USER() it is FALSE.
498 */
499 protected $userObjectType = FALSE;
500
501 /**
502 * Indicates that object type is USER.
503 *
504 * @see ContentObjectRender::$userObjectType
505 */
506 const OBJECTTYPE_USER_INT = 1;
507 /**
508 * Indicates that object type is USER.
509 *
510 * @see ContentObjectRender::$userObjectType
511 */
512 const OBJECTTYPE_USER = 2;
513 /**
514 * Class constructor.
515 * Well, it has to be called manually since it is not a real constructor function.
516 * So after making an instance of the class, call this function and pass to it a database record and the tablename from where the record is from. That will then become the "current" record loaded into memory and accessed by the .fields property found in eg. stdWrap.
517 *
518 * @param array $data The record data that is rendered.
519 * @param string $table The table that the data record is from.
520 * @return void
521 * @todo Define visibility
522 */
523 public function start($data, $table = '') {
524 global $TYPO3_CONF_VARS;
525 if (is_array($data) && !empty($data) && !empty($table)) {
526 \TYPO3\CMS\Core\Resource\Service\FrontendContentAdapterService::modifyDBRow($data, $table);
527 }
528 $this->data = $data;
529 $this->table = $table;
530 $this->currentRecord = $table ? $table . ':' . $this->data['uid'] : '';
531 $this->parameters = array();
532 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClass'])) {
533 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClass'] as $classArr) {
534 $this->cObjHookObjectsArr[$classArr[0]] = GeneralUtility::getUserObj($classArr[1]);
535 }
536 }
537 $this->stdWrapHookObjects = array();
538 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['stdWrap'])) {
539 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['stdWrap'] as $classData) {
540 $hookObject = GeneralUtility::getUserObj($classData);
541 if (!$hookObject instanceof \TYPO3\CMS\Frontend\ContentObject\ContentObjectStdWrapHookInterface) {
542 throw new \UnexpectedValueException($classData . ' must implement interface TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectStdWrapHookInterface', 1195043965);
543 }
544 $this->stdWrapHookObjects[] = $hookObject;
545 }
546 }
547 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['postInit'])) {
548 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['postInit'] as $classData) {
549 $postInitializationProcessor = GeneralUtility::getUserObj($classData);
550 if (!$postInitializationProcessor instanceof \TYPO3\CMS\Frontend\ContentObject\ContentObjectPostInitHookInterface) {
551 throw new \UnexpectedValueException($classData . ' must implement interface TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectPostInitHookInterface', 1274563549);
552 }
553 $postInitializationProcessor->postProcessContentObjectInitialization($this);
554 }
555 }
556 }
557
558 /**
559 * Returns the current table
560 *
561 * @return string
562 */
563 public function getCurrentTable() {
564 return $this->table;
565 }
566
567 /**
568 * Clone helper.
569 *
570 * Resets the references to the TypoScript Content Object implementation
571 * objects of tslib_content_*. Otherwise they would still point to the
572 * original ContentObjectRender instance's tslib_content_* instances, they in return
573 * would back-reference to the original ContentObjectRender instance instead of the
574 * newly cloned ContentObjectRender instance.
575 *
576 * @see http://forge.typo3.org/issues/24204
577 */
578 public function __clone() {
579 $this->contentObjects = array();
580 }
581
582 /**
583 * Serialization (sleep) helper.
584 *
585 * Removes properties of this object from serialization.
586 * This action is necessary, since there might be closures used
587 * in the accordant content objects (e.g. in FLUIDTEMPLATE) which
588 * cannot be serialized. It's fine to reset $this->contentObjects
589 * since elements will be recreated and are just a local cache,
590 * but not required for runtime logic and behaviour.
591 *
592 * @return array Names of the properties to be serialized
593 * @see http://forge.typo3.org/issues/36820
594 */
595 public function __sleep() {
596 // Use get_objects_vars() instead of
597 // a much more expensive Reflection:
598 $properties = get_object_vars($this);
599 if (isset($properties['contentObjects'])) {
600 unset($properties['contentObjects']);
601 }
602 return array_keys($properties);
603 }
604
605 /**
606 * Gets the 'getImgResource' hook objects.
607 * The first call initializes the accordant objects.
608 *
609 * @return array The 'getImgResource' hook objects (if any)
610 */
611 protected function getGetImgResourceHookObjects() {
612 if (!isset($this->getImgResourceHookObjects)) {
613 $this->getImgResourceHookObjects = array();
614 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getImgResource'])) {
615 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getImgResource'] as $classData) {
616 $hookObject = GeneralUtility::getUserObj($classData);
617 if (!$hookObject instanceof \TYPO3\CMS\Frontend\ContentObject\ContentObjectGetImageResourceHookInterface) {
618 throw new \UnexpectedValueException('$hookObject must implement interface TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectGetImageResourceHookInterface', 1218636383);
619 }
620 $this->getImgResourceHookObjects[] = $hookObject;
621 }
622 }
623 }
624 return $this->getImgResourceHookObjects;
625 }
626
627 /**
628 * Sets the internal variable parentRecord with information about current record.
629 * If the ContentObjectRender was started from CONTENT, RECORD or SEARCHRESULT cObject's this array has two keys, 'data' and 'currentRecord' which indicates the record and data for the parent cObj.
630 *
631 * @param array $data The record array
632 * @param string $currentRecord This is set to the [table]:[uid] of the record delivered in the $data-array, if the cObjects CONTENT or RECORD is in operation. Note that $GLOBALS['TSFE']->currentRecord is set to an equal value but always indicating the latest record rendered.
633 * @return void
634 * @access private
635 * @todo Define visibility
636 */
637 public function setParent($data, $currentRecord) {
638 $this->parentRecord = array(
639 'data' => $data,
640 'currentRecord' => $currentRecord
641 );
642 }
643
644 /***********************************************
645 *
646 * CONTENT_OBJ:
647 *
648 ***********************************************/
649 /**
650 * Returns the "current" value.
651 * The "current" value is just an internal variable that can be used by functions to pass a single value on to another function later in the TypoScript processing.
652 * It's like "load accumulator" in the good old C64 days... basically a "register" you can use as you like.
653 * The TSref will tell if functions are setting this value before calling some other object so that you know if it holds any special information.
654 *
655 * @return mixed The "current" value
656 * @todo Define visibility
657 */
658 public function getCurrentVal() {
659 return $this->data[$this->currentValKey];
660 }
661
662 /**
663 * Sets the "current" value.
664 *
665 * @param mixed $value The variable that you want to set as "current
666 * @return void
667 * @see getCurrentVal()
668 * @todo Define visibility
669 */
670 public function setCurrentVal($value) {
671 $this->data[$this->currentValKey] = $value;
672 }
673
674 /**
675 * Rendering of a "numerical array" of cObjects from TypoScript
676 * Will call ->cObjGetSingle() for each cObject found and accumulate the output.
677 *
678 * @param array $setup array with cObjects as values.
679 * @param string $addKey A prefix for the debugging information
680 * @return string Rendered output from the cObjects in the array.
681 * @see cObjGetSingle()
682 * @todo Define visibility
683 */
684 public function cObjGet($setup, $addKey = '') {
685 if (is_array($setup)) {
686 $sKeyArray = \TYPO3\CMS\Core\TypoScript\TemplateService::sortedKeyList($setup);
687 $content = '';
688 foreach ($sKeyArray as $theKey) {
689 $theValue = $setup[$theKey];
690 if (intval($theKey) && !strstr($theKey, '.')) {
691 $conf = $setup[$theKey . '.'];
692 $content .= $this->cObjGetSingle($theValue, $conf, $addKey . $theKey);
693 }
694 }
695 return $content;
696 }
697 }
698
699 /**
700 * Renders a content object
701 *
702 * @param string $name The content object name, eg. "TEXT" or "USER" or "IMAGE
703 * @param array $conf The array with TypoScript properties for the content object
704 * @param string $TSkey A string label used for the internal debugging tracking.
705 * @return string cObject output
706 * @throws \UnexpectedValueException
707 * @todo Define visibility
708 */
709 public function cObjGetSingle($name, $conf, $TSkey = '__') {
710 global $TYPO3_CONF_VARS;
711 $content = '';
712 // Checking that the function is not called eternally. This is done by interrupting at a depth of 100
713 $GLOBALS['TSFE']->cObjectDepthCounter--;
714 if ($GLOBALS['TSFE']->cObjectDepthCounter > 0) {
715 $name = trim($name);
716 if ($GLOBALS['TT']->LR) {
717 $GLOBALS['TT']->push($TSkey, $name);
718 }
719 // Checking if the COBJ is a reference to another object. (eg. name of 'blabla.blabla = < styles.something')
720 if ($name{0} === '<') {
721 $key = trim(substr($name, 1));
722 $cF = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\Parser\\TypoScriptParser');
723 // $name and $conf is loaded with the referenced values.
724 $old_conf = $conf;
725 list($name, $conf) = $cF->getVal($key, $GLOBALS['TSFE']->tmpl->setup);
726 if (is_array($old_conf) && count($old_conf)) {
727 $conf = array_replace_recursive($conf, $old_conf);
728 }
729 // Getting the cObject
730 $GLOBALS['TT']->incStackPointer();
731 $content .= $this->cObjGetSingle($name, $conf, $key);
732 $GLOBALS['TT']->decStackPointer();
733 } else {
734 $hooked = FALSE;
735 // Application defined cObjects
736 if (!empty($this->cObjHookObjectsArr[$name])) {
737 $hookObj = $this->cObjHookObjectsArr[$name];
738 if (method_exists($hookObj, 'cObjGetSingleExt')) {
739 $content .= $hookObj->cObjGetSingleExt($name, $conf, $TSkey, $this);
740 $hooked = TRUE;
741 }
742 }
743 if (!$hooked) {
744 $contentObject = $this->getContentObject($name);
745 if ($contentObject) {
746 $content .= $contentObject->render($conf);
747 } else {
748 // Call hook functions for extra processing
749 if ($name && is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClassDefault'])) {
750 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClassDefault'] as $classData) {
751 $hookObject = GeneralUtility::getUserObj($classData);
752 if (!$hookObject instanceof \TYPO3\CMS\Frontend\ContentObject\ContentObjectGetSingleHookInterface) {
753 throw new \UnexpectedValueException('$hookObject must implement interface TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectGetSingleHookInterface', 1195043731);
754 }
755 /** @var $hookObject \TYPO3\CMS\Frontend\ContentObject\ContentObjectGetSingleHookInterface */
756 $content .= $hookObject->getSingleContentObject($name, (array) $conf, $TSkey, $this);
757 }
758 } else {
759 // Log error in AdminPanel
760 $warning = sprintf('Content Object "%s" does not exist', $name);
761 $GLOBALS['TT']->setTSlogMessage($warning, 2);
762 }
763 }
764 }
765 }
766 if ($GLOBALS['TT']->LR) {
767 $GLOBALS['TT']->pull($content);
768 }
769 }
770 // Increasing on exit...
771 $GLOBALS['TSFE']->cObjectDepthCounter++;
772 return $content;
773 }
774
775 /**
776 * Returns a new content object of type $name.
777 *
778 * @param string $name
779 * @return AbstractContentObject
780 */
781 public function getContentObject($name) {
782 $classMapping = array(
783 'TEXT' => 'Text',
784 'CASE' => 'Case',
785 'CLEARGIF' => 'ClearGif',
786 'COBJ_ARRAY' => 'ContentObjectArray',
787 'COA' => 'ContentObjectArray',
788 'COA_INT' => 'ContentObjectArrayInternal',
789 'USER' => 'User',
790 'USER_INT' => 'UserInternal',
791 'FILE' => 'File',
792 'FILES' => 'Files',
793 'IMAGE' => 'Image',
794 'IMG_RESOURCE' => 'ImageResource',
795 'IMGTEXT' => 'ImageText',
796 'CONTENT' => 'Content',
797 'RECORDS' => 'Records',
798 'HMENU' => 'HierarchicalMenu',
799 'CTABLE' => 'ContentTable',
800 'OTABLE' => 'OffsetTable',
801 'COLUMNS' => 'Columns',
802 'HRULER' => 'HorizontalRuler',
803 'CASEFUNC' => 'Case',
804 'LOAD_REGISTER' => 'LoadRegister',
805 'RESTORE_REGISTER' => 'RestoreRegister',
806 'FORM' => 'Form',
807 'SEARCHRESULT' => 'SearchResult',
808 'TEMPLATE' => 'Template',
809 'FLUIDTEMPLATE' => 'FluidTemplate',
810 'MULTIMEDIA' => 'Multimedia',
811 'MEDIA' => 'Media',
812 'SWFOBJECT' => 'ShockwaveFlashObject',
813 'FLOWPLAYER' => 'FlowPlayer',
814 'QTOBJECT' => 'QuicktimeObject',
815 'SVG' => 'ScalableVectorGraphics',
816 'EDITPANEL' => 'EditPanel',
817 );
818 $name = $classMapping[$name];
819 if (!array_key_exists($name, $this->contentObjects)) {
820 $fullyQualifiedClassName = 'TYPO3\\CMS\\Frontend\\ContentObject\\' . $name . 'ContentObject';
821 if (class_exists($fullyQualifiedClassName)) {
822 $this->contentObjects[$name] = GeneralUtility::makeInstance(
823 $fullyQualifiedClassName,
824 $this
825 );
826 } else {
827 $this->contentObjects[$name] = NULL;
828 }
829 }
830 return $this->contentObjects[$name];
831 }
832
833 /********************************************
834 *
835 * Functions rendering content objects (cObjects)
836 *
837 ********************************************/
838 /**
839 * Rendering the cObject, HTML
840 *
841 * @param array $conf Array of TypoScript properties
842 * @return string Output
843 * @deprecated since 6.0, will be removed in two versions
844 * @todo Define visibility
845 */
846 public function HTML($conf) {
847 GeneralUtility::logDeprecatedFunction();
848 return '';
849 }
850
851 /**
852 * Rendering the cObject, FLOWPLAYER
853 *
854 * @param array $conf Array of TypoScript properties
855 * @return string Output
856 * @todo Define visibility
857 */
858 public function FLOWPLAYER($conf) {
859 return $this->getContentObject('FLOWPLAYER')->render($conf);
860 }
861
862 /**
863 * Rendering the cObject, TEXT
864 *
865 * @param array $conf Array of TypoScript properties
866 * @return string Output
867 * @todo Define visibility
868 */
869 public function TEXT($conf) {
870 return $this->getContentObject('TEXT')->render($conf);
871 }
872
873 /**
874 * Rendering the cObject, CLEARGIF
875 *
876 * @param array $conf Array of TypoScript properties
877 * @return string Output
878 * @todo Define visibility
879 */
880 public function CLEARGIF($conf) {
881 return $this->getContentObject('CLEARGIF')->render($conf);
882 }
883
884 /**
885 * Rendering the cObject, COBJ_ARRAY / COA and COBJ_ARRAY_INT
886 *
887 * @param array $conf Array of TypoScript properties
888 * @param string $ext If "INT" then the cObject is a "COBJ_ARRAY_INT" (non-cached), otherwise just "COBJ_ARRAY" (cached)
889 * @return string Output
890 * @todo Define visibility
891 */
892 public function COBJ_ARRAY($conf, $ext = '') {
893 if ($ext === 'INT') {
894 return $this->getContentObject('COA_INT')->render($conf);
895 } else {
896 return $this->getContentObject('COA')->render($conf);
897 }
898 }
899
900 /**
901 * Rendering the cObject, USER and USER_INT
902 *
903 * @param array $conf Array of TypoScript properties
904 * @param string $ext If "INT" then the cObject is a "USER_INT" (non-cached), otherwise just "USER" (cached)
905 * @return string Output
906 * @todo Define visibility
907 */
908 public function USER($conf, $ext = '') {
909 if ($ext === 'INT') {
910 return $this->getContentObject('USER_INT')->render($conf);
911 } else {
912 return $this->getContentObject('USER')->render($conf);
913 }
914 }
915
916 /**
917 * Retrieves a type of object called as USER or USER_INT. Object can detect their
918 * type by using this call. It returns OBJECTTYPE_USER_INT or OBJECTTYPE_USER depending on the
919 * current object execution. In all other cases it will return FALSE to indicate
920 * a call out of context.
921 *
922 * @return mixed One of OBJECTTYPE_ class constants or FALSE
923 */
924 public function getUserObjectType() {
925 return $this->userObjectType;
926 }
927
928 /**
929 * Sets the user object type
930 *
931 * @param mixed $userObjectType
932 * @return void
933 */
934 public function setUserObjectType($userObjectType) {
935 $this->userObjectType = $userObjectType;
936 }
937
938 /**
939 * Requests the current USER object to be converted to USER_INT.
940 *
941 * @return void
942 */
943 public function convertToUserIntObject() {
944 if ($this->userObjectType !== self::OBJECTTYPE_USER) {
945 $GLOBALS['TT']->setTSlogMessage('TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer::convertToUserIntObject() ' . 'is called in the wrong context or for the wrong object type', 2);
946 } else {
947 $this->doConvertToUserIntObject = TRUE;
948 }
949 }
950
951 /**
952 * Rendering the cObject, FILE
953 *
954 * @param array $conf Array of TypoScript properties
955 * @return string Output
956 * @todo Define visibility
957 */
958 public function FILE($conf) {
959 return $this->getContentObject('FILE')->render($conf);
960 }
961
962 /**
963 * Rendering the cObject, FILES
964 *
965 * @param array $conf Array of TypoScript properties
966 * @return string Output
967 * @todo Define visibility
968 */
969 public function FILES($conf) {
970 return $this->getContentObject('FILES')->render($conf);
971 }
972
973 /**
974 * Rendering the cObject, IMAGE
975 *
976 * @param array $conf Array of TypoScript properties
977 * @return string Output
978 * @see cImage()
979 * @todo Define visibility
980 */
981 public function IMAGE($conf) {
982 return $this->getContentObject('IMAGE')->render($conf);
983 }
984
985 /**
986 * Rendering the cObject, IMG_RESOURCE
987 *
988 * @param array $conf Array of TypoScript properties
989 * @return string Output
990 * @see getImgResource()
991 * @todo Define visibility
992 */
993 public function IMG_RESOURCE($conf) {
994 return $this->getContentObject('IMG_RESOURCE')->render($conf);
995 }
996
997 /**
998 * Rendering the cObject, IMGTEXT
999 *
1000 * @param array $conf Array of TypoScript properties
1001 * @return string Output
1002 * @todo Define visibility
1003 */
1004 public function IMGTEXT($conf) {
1005 return $this->getContentObject('IMGTEXT')->render($conf);
1006 }
1007
1008 /**
1009 * Rendering the cObject, CONTENT
1010 *
1011 * @param array $conf Array of TypoScript properties
1012 * @return string Output
1013 * @todo Define visibility
1014 */
1015 public function CONTENT($conf) {
1016 return $this->getContentObject('CONTENT')->render($conf);
1017 }
1018
1019 /**
1020 * Rendering the cObject, RECORDS
1021 *
1022 * @param array $conf Array of TypoScript properties
1023 * @return string Output
1024 * @todo Define visibility
1025 */
1026 public function RECORDS($conf) {
1027 return $this->getContentObject('RECORDS')->render($conf);
1028 }
1029
1030 /**
1031 * Rendering the cObject, HMENU
1032 *
1033 * @param array $conf Array of TypoScript properties
1034 * @return string Output
1035 * @todo Define visibility
1036 */
1037 public function HMENU($conf) {
1038 return $this->getContentObject('HMENU')->render($conf);
1039 }
1040
1041 /**
1042 * Rendering the cObject, CTABLE
1043 *
1044 * @param array $conf Array of TypoScript properties
1045 * @return string Output
1046 * @todo Define visibility
1047 */
1048 public function CTABLE($conf) {
1049 return $this->getContentObject('CTABLE')->render($conf);
1050 }
1051
1052 /**
1053 * Rendering the cObject, OTABLE
1054 *
1055 * @param array $conf Array of TypoScript properties
1056 * @return string Output
1057 * @todo Define visibility
1058 */
1059 public function OTABLE($conf) {
1060 return $this->getContentObject('OTABLE')->render($conf);
1061 }
1062
1063 /**
1064 * Rendering the cObject, COLUMNS
1065 *
1066 * @param array $conf Array of TypoScript properties
1067 * @return string Output
1068 * @todo Define visibility
1069 */
1070 public function COLUMNS($conf) {
1071 return $this->getContentObject('COLUMNS')->render($conf);
1072 }
1073
1074 /**
1075 * Rendering the cObject, HRULER
1076 *
1077 * @param array $conf Array of TypoScript properties
1078 * @return string Output
1079 * @todo Define visibility
1080 */
1081 public function HRULER($conf) {
1082 return $this->getContentObject('HRULER')->render($conf);
1083 }
1084
1085 /**
1086 * Rendering the cObject, CASE
1087 *
1088 * @param array $conf Array of TypoScript properties
1089 * @return string Output
1090 * @todo Define visibility
1091 */
1092 public function CASEFUNC($conf) {
1093 return $this->getContentObject('CASE')->render($conf);
1094 }
1095
1096 /**
1097 * Rendering the cObject, LOAD_REGISTER and RESTORE_REGISTER
1098 * NOTICE: This cObject does NOT return any content since it just sets internal data based on the TypoScript properties.
1099 *
1100 * @param array $conf Array of TypoScript properties
1101 * @param string $name If "RESTORE_REGISTER" then the cObject rendered is "RESTORE_REGISTER", otherwise "LOAD_REGISTER
1102 * @return string Empty string (the cObject only sets internal data!)
1103 * @todo Define visibility
1104 */
1105 public function LOAD_REGISTER($conf, $name) {
1106 if ($name === 'RESTORE_REGISTER') {
1107 return $this->getContentObject('RESTORE_REGISTER')->render($conf);
1108 } else {
1109 return $this->getContentObject('LOAD_REGISTER')->render($conf);
1110 }
1111 }
1112
1113 /**
1114 * Rendering the cObject, FORM
1115 *
1116 * @param array $conf Array of TypoScript properties
1117 * @param array $formData Alternative formdata overriding whatever comes from TypoScript
1118 * @return string Output
1119 * @todo Define visibility
1120 */
1121 public function FORM($conf, $formData = '') {
1122 return $this->getContentObject('FORM')->render($conf, $formData);
1123 }
1124
1125 /**
1126 * Rendering the cObject, SEARCHRESULT
1127 *
1128 * @param array $conf Array of TypoScript properties
1129 * @return string Output
1130 * @todo Define visibility
1131 */
1132 public function SEARCHRESULT($conf) {
1133 return $this->getContentObject('SEARCHRESULT')->render($conf);
1134 }
1135
1136 /**
1137 * Rendering the cObject, PHP_SCRIPT, PHP_SCRIPT_INT and PHP_SCRIPT_EXT
1138 *
1139 * @param array $conf Array of TypoScript properties
1140 * @param string $ext If "INT", then rendering "PHP_SCRIPT_INT"; If "EXT", then rendering "PHP_SCRIPT_EXT"; Default is rendering "PHP_SCRIPT" (cached)
1141 * @return string Output
1142 * @deprecated and unused since 6.0, will be removed two versions later
1143 * @todo Define visibility
1144 */
1145 public function PHP_SCRIPT($conf, $ext = '') {
1146 GeneralUtility::logDeprecatedFunction();
1147 return '';
1148 }
1149
1150 /**
1151 * Rendering the cObject, TEMPLATE
1152 *
1153 * @param array $conf Array of TypoScript properties
1154 * @return string Output
1155 * @see substituteMarkerArrayCached()
1156 * @todo Define visibility
1157 */
1158 public function TEMPLATE($conf) {
1159 return $this->getContentObject('TEMPLATE')->render($conf);
1160 }
1161
1162 /**
1163 * Rendering the cObject, FLUIDTEMPLATE
1164 *
1165 * @param array $conf Array of TypoScript properties
1166 * @return string the HTML output
1167 * @author Steffen Ritter <info@steffen-ritter.net>
1168 * @author Benjamin Mack <benni@typo3.org>
1169 */
1170 protected function FLUIDTEMPLATE(array $conf) {
1171 return $this->getContentObject('FLUIDTEMPLATE')->render($conf);
1172 }
1173
1174 /**
1175 * Rendering the cObject, MULTIMEDIA
1176 *
1177 * @param array $conf Array of TypoScript properties
1178 * @return string Output
1179 * @todo Define visibility
1180 */
1181 public function MULTIMEDIA($conf) {
1182 return $this->getContentObject('MULTIMEDIA')->render($conf);
1183 }
1184
1185 /**
1186 * Rendering the cObject, MEDIA
1187 *
1188 * @param array $conf Array of TypoScript properties
1189 * @return string Output
1190 */
1191 public function MEDIA($conf) {
1192 return $this->getContentObject('MEDIA')->render($conf);
1193 }
1194
1195 /**
1196 * Rendering the cObject, SWFOBJECT
1197 *
1198 * @param array $conf Array of TypoScript properties
1199 * @return string Output
1200 */
1201 public function SWFOBJECT($conf) {
1202 return $this->getContentObject('SWFOBJECT')->render($conf);
1203 }
1204
1205 /**
1206 * Rendering the cObject, QTOBJECT
1207 *
1208 * @param array $conf Array of TypoScript properties
1209 * @return string Output
1210 */
1211 public function QTOBJECT($conf) {
1212 return $this->getContentObject('QTOBJECT')->render($conf);
1213 }
1214
1215 /**
1216 * Rendering the cObject, SVG
1217 *
1218 * @param array $conf Array of TypoScript properties
1219 * @return string Output
1220 */
1221 public function SVG($conf) {
1222 return $this->getContentObject('SVG')->render($conf);
1223 }
1224
1225 /************************************
1226 *
1227 * Various helper functions for content objects:
1228 *
1229 ************************************/
1230 /**
1231 * Converts a given config in Flexform to a conf-array
1232 *
1233 * @param string $flexData Flexform data
1234 * @param array $conf Array to write the data into, by reference
1235 * @param boolean $recursive Is set if called recursive. Don't call function with this parameter, it's used inside the function only
1236 * @return void
1237 * @access public
1238 */
1239 public function readFlexformIntoConf($flexData, &$conf, $recursive = FALSE) {
1240 if ($recursive === FALSE) {
1241 $flexData = GeneralUtility::xml2array($flexData, 'T3');
1242 }
1243 if (is_array($flexData)) {
1244 if (isset($flexData['data']['sDEF']['lDEF'])) {
1245 $flexData = $flexData['data']['sDEF']['lDEF'];
1246 }
1247 foreach ($flexData as $key => $value) {
1248 if (is_array($value['el']) && count($value['el']) > 0) {
1249 foreach ($value['el'] as $ekey => $element) {
1250 if (isset($element['vDEF'])) {
1251 $conf[$ekey] = $element['vDEF'];
1252 } else {
1253 if (is_array($element)) {
1254 $this->readFlexformIntoConf($element, $conf[$key][key($element)][$ekey], TRUE);
1255 } else {
1256 $this->readFlexformIntoConf($element, $conf[$key][$ekey], TRUE);
1257 }
1258 }
1259 }
1260 } else {
1261 $this->readFlexformIntoConf($value['el'], $conf[$key], TRUE);
1262 }
1263 if ($value['vDEF']) {
1264 $conf[$key] = $value['vDEF'];
1265 }
1266 }
1267 }
1268 }
1269
1270 /**
1271 * Returns all parents of the given PID (Page UID) list
1272 *
1273 * @param string $pidList A list of page Content-Element PIDs (Page UIDs) / stdWrap
1274 * @param array $pidConf stdWrap array for the list
1275 * @return string A list of PIDs
1276 * @access private
1277 * @todo Define visibility
1278 */
1279 public function getSlidePids($pidList, $pidConf) {
1280 $pidList = isset($pidConf) ? trim($this->stdWrap($pidList, $pidConf)) : trim($pidList);
1281 if (!strcmp($pidList, '')) {
1282 $pidList = 'this';
1283 }
1284 if (trim($pidList)) {
1285 $listArr = GeneralUtility::intExplode(',', str_replace('this', $GLOBALS['TSFE']->contentPid, $pidList));
1286 $listArr = $this->checkPidArray($listArr);
1287 }
1288 $pidList = array();
1289 if (is_array($listArr) && count($listArr)) {
1290 foreach ($listArr as $uid) {
1291 $page = $GLOBALS['TSFE']->sys_page->getPage($uid);
1292 if (!$page['is_siteroot']) {
1293 $pidList[] = $page['pid'];
1294 }
1295 }
1296 }
1297 return implode(',', $pidList);
1298 }
1299
1300 /**
1301 * Returns a default value for a form field in the FORM cObject.
1302 * Page CANNOT be cached because that would include the inserted value for the current user.
1303 *
1304 * @param boolean $noValueInsert If noValueInsert OR if the no_cache flag for this page is NOT set, the original default value is returned.
1305 * @param string $fieldName The POST var name to get default value for
1306 * @param string $defaultVal The current default value
1307 * @return string The default value, either from INPUT var or the current default, based on whether caching is enabled or not.
1308 * @access private
1309 * @todo Define visibility
1310 */
1311 public function getFieldDefaultValue($noValueInsert, $fieldName, $defaultVal) {
1312 if (!$GLOBALS['TSFE']->no_cache || !isset($_POST[$fieldName]) && !isset($_GET[$fieldName]) || $noValueInsert) {
1313 return $defaultVal;
1314 } else {
1315 return GeneralUtility::_GP($fieldName);
1316 }
1317 }
1318
1319 /**
1320 * Returns a <img> tag with the image file defined by $file and processed according to the properties in the TypoScript array.
1321 * Mostly this function is a sub-function to the IMAGE function which renders the IMAGE cObject in TypoScript.
1322 * This function is called by "$this->cImage($conf['file'], $conf);" from IMAGE().
1323 *
1324 * @param string $file File TypoScript resource
1325 * @param array $conf TypoScript configuration properties
1326 * @return string <img> tag, (possibly wrapped in links and other HTML) if any image found.
1327 * @access private
1328 * @see IMAGE()
1329 * @todo Define visibility
1330 */
1331 public function cImage($file, $conf) {
1332 $info = $this->getImgResource($file, $conf['file.']);
1333 $GLOBALS['TSFE']->lastImageInfo = $info;
1334 if (is_array($info)) {
1335 if (is_file(PATH_site . $info['3'])) {
1336 $source = GeneralUtility::rawUrlEncodeFP(GeneralUtility::png_to_gif_by_imagemagick($info[3]));
1337 $source = $GLOBALS['TSFE']->absRefPrefix . $source;
1338 } else {
1339 $source = $info[3];
1340 }
1341
1342 $layoutKey = $this->stdWrap($conf['layoutKey'], $conf['layoutKey.']);
1343 $imageTagTemplate = $this->getImageTagTemplate($layoutKey, $conf);
1344 $sourceCollection = $this->getImageSourceCollection($layoutKey, $conf, $file);
1345
1346 // This array is used to collect the image-refs on the page...
1347 $GLOBALS['TSFE']->imagesOnPage[] = $source;
1348 $altParam = $this->getAltParam($conf);
1349 $params = '';
1350 if ($conf['params'] && !isset($conf['params.'])) {
1351 $params = ' ' . $conf['params'];
1352 } elseif ($conf['params'] && is_array($conf['params.'])) {
1353 $params = ' ' . $this->stdWrap($conf['params'], $conf['params.']);
1354 }
1355
1356 $imageTagValues = array(
1357 'width' => $info[0],
1358 'height' => $info[1],
1359 'src' => htmlspecialchars($source),
1360 'params' => $params,
1361 'altParams' => $altParam,
1362 'border' => $this->getBorderAttr(' border="' . intval($conf['border']) . '"'),
1363 'sourceCollection' => $sourceCollection,
1364 'selfClosingTagSlash' => (!empty($GLOBALS['TSFE']->xhtmlDoctype) ? ' /' : ''),
1365 );
1366
1367 $theValue = $this->substituteMarkerArray($imageTagTemplate, $imageTagValues, '###|###', TRUE, TRUE);
1368
1369 $linkWrap = isset($conf['linkWrap.']) ? $this->stdWrap($conf['linkWrap'], $conf['linkWrap.']) : $conf['linkWrap'];
1370 if ($linkWrap) {
1371 $theValue = $this->linkWrap($theValue, $linkWrap);
1372 } elseif ($conf['imageLinkWrap']) {
1373 $theValue = $this->imageLinkWrap($theValue, $info['origFile'], $conf['imageLinkWrap.']);
1374 }
1375 $wrap = isset($conf['wrap.']) ? $this->stdWrap($conf['wrap'], $conf['wrap.']) : $conf['wrap'];
1376 if ($wrap) {
1377 $theValue = $this->wrap($theValue, $conf['wrap']);
1378 }
1379 return $theValue;
1380 }
1381 }
1382
1383 /**
1384 * Returns the 'border' attribute for an <img> tag only if the doctype is not xhtml_strict, xhtml_11, xhtml_2 or html5
1385 * or if the config parameter 'disableImgBorderAttr' is not set.
1386 *
1387 * @param string $borderAttr The border attribute
1388 * @return string The border attribute
1389 * @todo Define visibility
1390 */
1391 public function getBorderAttr($borderAttr) {
1392 if (!GeneralUtility::inList('xhtml_strict,xhtml_11,xhtml_2', $GLOBALS['TSFE']->xhtmlDoctype) && $GLOBALS['TSFE']->config['config']['doctype'] != 'html5' && !$GLOBALS['TSFE']->config['config']['disableImgBorderAttr']) {
1393 return $borderAttr;
1394 }
1395 }
1396
1397 /**
1398 * Returns the html-template for rendering the image-Tag if no template is defined via typoscript the
1399 * default <img> tag template is returned
1400 *
1401 * @param string $layoutKey rendering key
1402 * @param array $conf TypoScript configuration properties
1403 * @return string
1404 */
1405 public function getImageTagTemplate($layoutKey, $conf) {
1406 if ($layoutKey && isset($conf['layout.']) && isset($conf['layout.'][$layoutKey . '.'])) {
1407 $imageTagLayout = $this->stdWrap($conf['layout.'][$layoutKey . '.']['element'], $conf['layout.'][$layoutKey . '.']['element.']);
1408 } else {
1409 $imageTagLayout = '<img src="###SRC###" width="###WIDTH###" height="###HEIGHT###" ###PARAMS### ###ALTPARAMS### ###BORDER######SELFCLOSINGTAGSLASH###>';
1410 }
1411 return $imageTagLayout;
1412 }
1413
1414 /**
1415 * Render alternate sources for the image tag. If no source collection is given an empty string is returned.
1416 *
1417 * @param string $layoutKey rendering key
1418 * @param array $conf TypoScript configuration properties
1419 * @param string $file
1420 * @throws \UnexpectedValueException
1421 * @return string
1422 */
1423 public function getImageSourceCollection($layoutKey, $conf, $file) {
1424 $sourceCollection = '';
1425 if ($layoutKey && $conf['sourceCollection.'] && ($conf['layout.'][$layoutKey . '.']['source'] || $conf['layout.'][$layoutKey . '.']['source.'])) {
1426
1427 // find active sourceCollection
1428 $activeSourceCollections = array();
1429 foreach ($conf['sourceCollection.'] as $sourceCollectionKey => $sourceCollectionConfiguration) {
1430 if (substr($sourceCollectionKey, -1) == '.') {
1431 if (
1432 (isset($sourceCollectionConfiguration['if.']) && $this->checkIf($sourceCollectionConfiguration['if.']))
1433 || !isset($sourceCollectionConfiguration['if.'])
1434 ) {
1435 $activeSourceCollections[] = $sourceCollectionConfiguration;
1436 }
1437 }
1438 }
1439
1440 // apply option split to configurations
1441 $srcLayoutOptionSplitted = $GLOBALS['TSFE']->tmpl->splitConfArray($conf['layout.'][$layoutKey . '.'], count($activeSourceCollections));
1442
1443 // render sources
1444 foreach ($activeSourceCollections as $key => $sourceConfiguration) {
1445 $sourceLayout = $this->stdWrap($srcLayoutOptionSplitted[$key]['source'], $srcLayoutOptionSplitted[$key]['source.']);
1446
1447 $sourceRenderConfiguration = array (
1448 'file' => $file,
1449 'file.' => $conf['file.']
1450 );
1451
1452 if (isset($sourceConfiguration['pixelDensity'])) {
1453 $pixelDensity = (int) $this->stdWrap($sourceConfiguration['pixelDensity'], $sourceConfiguration['pixelDensity.']);
1454 } else {
1455 $pixelDensity = 1;
1456 }
1457 $dimensionKeys = array('width', 'height', 'maxW', 'minW', 'maxH', 'minH');
1458 foreach ($dimensionKeys as $dimensionKey) {
1459 $dimension = $this->stdWrap($sourceConfiguration[$dimensionKey], $sourceConfiguration[$dimensionKey . '.']);
1460 if (!$dimension && isset($conf['file.'][$dimensionKey])) {
1461 $dimension = $this->stdWrap($conf['file.'][$dimensionKey], $conf['file.'][$dimensionKey . '.']);
1462 }
1463 if ($dimension) {
1464 if (strstr($dimension, 'c') !== FALSE && ($dimensionKey === 'width' || $dimensionKey === 'height')) {
1465 $dimensionParts = explode('c', $dimension, 2);
1466 $dimension = intval($dimensionParts[0] * $pixelDensity) . 'c';
1467 if ($dimensionParts[1]) {
1468 $dimension .= $dimensionParts[1];
1469 }
1470 } else {
1471 $dimension = intval($dimension * $pixelDensity);
1472 }
1473 $sourceRenderConfiguration['file.'][$dimensionKey] = $dimension;
1474 }
1475 }
1476
1477 $sourceInfo = $this->getImgResource($sourceRenderConfiguration['file'], $sourceRenderConfiguration['file.']);
1478 $sourceConfiguration['width'] = $sourceInfo[0];
1479 $sourceConfiguration['height'] = $sourceInfo[1];
1480 $sourceConfiguration['src'] = htmlspecialchars($sourceInfo[3]);
1481 $sourceConfiguration['selfClosingTagSlash'] = (!empty($GLOBALS['TSFE']->xhtmlDoctype) ? ' /' : '');
1482
1483 $oneSourceCollection = $this->substituteMarkerArray($sourceLayout, $sourceConfiguration, '###|###', TRUE, TRUE);
1484
1485 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getImageSourceCollection'])) {
1486 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getImageSourceCollection'] as $classData) {
1487 $hookObject = GeneralUtility::getUserObj($classData);
1488 if (!$hookObject instanceof ContentObjectOneSourceCollectionHookInterface) {
1489 throw new \UnexpectedValueException(
1490 '$hookObject must implement interface TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectOneSourceCollectionHookInterface',
1491 1380007853
1492 );
1493 }
1494 /** @var $hookObject \TYPO3\CMS\Frontend\ContentObject\ContentObjectGetSingleHookInterface */
1495 $oneSourceCollection = $hookObject->getOneSourceCollection((array) $sourceRenderConfiguration, (array) $sourceConfiguration, $oneSourceCollection, $this);
1496 }
1497 }
1498
1499 $sourceCollection .= $oneSourceCollection;
1500 }
1501 }
1502 return $sourceCollection;
1503 }
1504
1505 /**
1506 * Wraps the input string in link-tags that opens the image in a new window.
1507 *
1508 * @param string $string String to wrap, probably an <img> tag
1509 * @param string $imageFile The original image file
1510 * @param array $conf TypoScript properties for the "imageLinkWrap" function
1511 * @return string The input string, $string, wrapped as configured.
1512 * @see cImage()
1513 * @todo Define visibility
1514 */
1515 public function imageLinkWrap($string, $imageFile, $conf) {
1516 $a1 = '';
1517 $a2 = '';
1518 $content = $string;
1519 $enable = isset($conf['enable.']) ? $this->stdWrap($conf['enable'], $conf['enable.']) : $conf['enable'];
1520 if ($enable) {
1521 $content = $this->typolink($string, $conf['typolink.']);
1522 if (isset($conf['file.'])) {
1523 $imageFile = $this->stdWrap($imageFile, $conf['file.']);
1524 }
1525 // Create imageFileLink if not created with typolink
1526 if ($content == $string) {
1527 $parameterNames = array('width', 'height', 'effects', 'alternativeTempPath', 'bodyTag', 'title', 'wrap');
1528 $parameters = array();
1529 $sample = isset($conf['sample.']) ? $this->stdWrap($conf['sample'], $conf['sample.']) : $conf['sample'];
1530 if ($sample) {
1531 $parameters['sample'] = 1;
1532 }
1533 foreach ($parameterNames as $parameterName) {
1534 if (isset($conf[$parameterName . '.'])) {
1535 $conf[$parameterName] = $this->stdWrap($conf[$parameterName], $conf[$parameterName . '.']);
1536 }
1537 if (isset($conf[$parameterName]) && $conf[$parameterName]) {
1538 $parameters[$parameterName] = $conf[$parameterName];
1539 }
1540 }
1541 $parametersEncoded = base64_encode(serialize($parameters));
1542 $md5_value = GeneralUtility::hmac(implode('|', array($imageFile, $parametersEncoded)));
1543 $params = '&md5=' . $md5_value;
1544 foreach (str_split($parametersEncoded, 64) as $index => $chunk) {
1545 $params .= '&parameters' . rawurlencode('[') . $index . rawurlencode(']') . '=' . rawurlencode($chunk);
1546 }
1547 $url = $GLOBALS['TSFE']->absRefPrefix . 'index.php?eID=tx_cms_showpic&file=' . rawurlencode($imageFile) . $params;
1548 $directImageLink = isset($conf['directImageLink.']) ? $this->stdWrap($conf['directImageLink'], $conf['directImageLink.']) : $conf['directImageLink'];
1549 if ($directImageLink) {
1550 $imgResourceConf = array(
1551 'file' => $imageFile,
1552 'file.' => $conf
1553 );
1554 $url = $this->IMG_RESOURCE($imgResourceConf);
1555 if (!$url) {
1556 // If no imagemagick / gm is available
1557 $url = $imageFile;
1558 }
1559 }
1560 // Create TARGET-attribute only if the right doctype is used
1561 if (!GeneralUtility::inList('xhtml_strict,xhtml_11,xhtml_2', $GLOBALS['TSFE']->xhtmlDoctype)) {
1562 $target = isset($conf['target.']) ? $this->stdWrap($conf['target'], $conf['target.']) : $conf['target'];
1563 if ($target) {
1564 $target = sprintf(' target="%s"', $target);
1565 } else {
1566 $target = ' target="thePicture"';
1567 }
1568 } else {
1569 $target = '';
1570 }
1571 $conf['JSwindow'] = isset($conf['JSwindow.']) ? $this->stdWrap($conf['JSwindow'], $conf['JSwindow.']) : $conf['JSwindow'];
1572 if ($conf['JSwindow']) {
1573 if ($conf['JSwindow.']['altUrl'] || $conf['JSwindow.']['altUrl.']) {
1574 $altUrl = isset($conf['JSwindow.']['altUrl.']) ? $this->stdWrap($conf['JSwindow.']['altUrl'], $conf['JSwindow.']['altUrl.']) : $conf['JSwindow.']['altUrl'];
1575 if ($altUrl) {
1576 $url = $altUrl . ($conf['JSwindow.']['altUrl_noDefaultParams'] ? '' : '?file=' . rawurlencode($imageFile) . $params);
1577 }
1578 }
1579 $gifCreator = GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\Imaging\\GifBuilder');
1580 $gifCreator->init();
1581 $gifCreator->mayScaleUp = 0;
1582 $dims = $gifCreator->getImageScale($gifCreator->getImageDimensions($imageFile), $conf['width'], $conf['height'], array());
1583 $JSwindowExpand = isset($conf['JSwindow.']['expand.']) ? $this->stdWrap($conf['JSwindow.']['expand'], $conf['JSwindow.']['expand.']) : $conf['JSwindow.']['expand'];
1584 $offset = GeneralUtility::intExplode(',', $JSwindowExpand . ',');
1585 $newWindow = isset($conf['JSwindow.']['newWindow.']) ? $this->stdWrap($conf['JSwindow.']['newWindow'], $conf['JSwindow.']['newWindow.']) : $conf['JSwindow.']['newWindow'];
1586 $a1 = '<a href="' . htmlspecialchars($url) . '" onclick="' . htmlspecialchars(('openPic(\'' . $GLOBALS['TSFE']->baseUrlWrap($url) . '\',\'' . ($newWindow ? md5($url) : 'thePicture') . '\',\'width=' . ($dims[0] + $offset[0]) . ',height=' . ($dims[1] + $offset[1]) . ',status=0,menubar=0\'); return false;')) . '"' . $target . $GLOBALS['TSFE']->ATagParams . '>';
1587 $a2 = '</a>';
1588 $GLOBALS['TSFE']->setJS('openPic');
1589 } else {
1590 $conf['linkParams.']['parameter'] = $url;
1591 $string = $this->typoLink($string, $conf['linkParams.']);
1592 }
1593 if (isset($conf['stdWrap.'])) {
1594 $string = $this->stdWrap($string, $conf['stdWrap.']);
1595 }
1596 $content = $a1 . $string . $a2;
1597 }
1598 }
1599 return $content;
1600 }
1601
1602 /**
1603 * Returns content of a file. If it's an image the content of the file is not returned but rather an image tag is.
1604 *
1605 * @param string $fName The filename, being a TypoScript resource data type
1606 * @param string $addParams Additional parameters (attributes). Default is empty alt and title tags.
1607 * @return string If jpg,gif,jpeg,png: returns image_tag with picture in. If html,txt: returns content string
1608 * @see FILE()
1609 * @todo Define visibility
1610 */
1611 public function fileResource($fName, $addParams = 'alt="" title=""') {
1612 $incFile = $GLOBALS['TSFE']->tmpl->getFileName($fName);
1613 if ($incFile) {
1614 $fileinfo = GeneralUtility::split_fileref($incFile);
1615 if (GeneralUtility::inList('jpg,gif,jpeg,png', $fileinfo['fileext'])) {
1616 $imgFile = $incFile;
1617 $imgInfo = @getImageSize($imgFile);
1618 return '<img src="' . $GLOBALS['TSFE']->absRefPrefix . $imgFile . '" width="' . $imgInfo[0] . '" height="' . $imgInfo[1] . '"' . $this->getBorderAttr(' border="0"') . ' ' . $addParams . ' />';
1619 } elseif (filesize($incFile) < 1024 * 1024) {
1620 return $GLOBALS['TSFE']->tmpl->fileContent($incFile);
1621 }
1622 }
1623 }
1624
1625 /**
1626 * Sets the SYS_LASTCHANGED timestamp if input timestamp is larger than current value.
1627 * The SYS_LASTCHANGED timestamp can be used by various caching/indexing applications to determine if the page has new content.
1628 * Therefore you should call this function with the last-changed timestamp of any element you display.
1629 *
1630 * @param integer $tstamp Unix timestamp (number of seconds since 1970)
1631 * @return void
1632 * @see \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::setSysLastChanged()
1633 * @todo Define visibility
1634 */
1635 public function lastChanged($tstamp) {
1636 $tstamp = intval($tstamp);
1637 if ($tstamp > intval($GLOBALS['TSFE']->register['SYS_LASTCHANGED'])) {
1638 $GLOBALS['TSFE']->register['SYS_LASTCHANGED'] = $tstamp;
1639 }
1640 }
1641
1642 /**
1643 * Wraps the input string by the $wrap value and implements the "linkWrap" data type as well.
1644 * The "linkWrap" data type means that this function will find any integer encapsulated in {} (curly braces) in the first wrap part and substitute it with the corresponding page uid from the rootline where the found integer is pointing to the key in the rootline. See link below.
1645 *
1646 * @param string $content Input string
1647 * @param string $wrap A string where the first two parts separated by "|" (vertical line) will be wrapped around the input string
1648 * @return string Wrapped output string
1649 * @see wrap(), cImage(), FILE()
1650 * @todo Define visibility
1651 */
1652 public function linkWrap($content, $wrap) {
1653 $wrapArr = explode('|', $wrap);
1654 if (preg_match('/\\{([0-9]*)\\}/', $wrapArr[0], $reg)) {
1655 if ($uid = $GLOBALS['TSFE']->tmpl->rootLine[$reg[1]]['uid']) {
1656 $wrapArr[0] = str_replace($reg[0], $uid, $wrapArr[0]);
1657 }
1658 }
1659 return trim($wrapArr[0]) . $content . trim($wrapArr[1]);
1660 }
1661
1662 /**
1663 * An abstraction method which creates an alt or title parameter for an HTML img, applet, area or input element and the FILE content element.
1664 * From the $conf array it implements the properties "altText", "titleText" and "longdescURL"
1665 *
1666 * @param array $conf TypoScript configuration properties
1667 * @param boolean $longDesc If set, the longdesc attribute will be generated - must only be used for img elements!
1668 * @return string Parameter string containing alt and title parameters (if any)
1669 * @see IMGTEXT(), FILE(), FORM(), cImage(), filelink()
1670 * @todo Define visibility
1671 */
1672 public function getAltParam($conf, $longDesc = TRUE) {
1673 $altText = isset($conf['altText.']) ? trim($this->stdWrap($conf['altText'], $conf['altText.'])) : trim($conf['altText']);
1674 $titleText = isset($conf['titleText.']) ? trim($this->stdWrap($conf['titleText'], $conf['titleText.'])) : trim($conf['titleText']);
1675 if (isset($conf['longdescURL.']) && $GLOBALS['TSFE']->config['config']['doctype'] != 'html5') {
1676 $longDesc = $this->typoLink_URL($conf['longdescURL.']);
1677 } else {
1678 $longDesc = trim($conf['longdescURL']);
1679 }
1680 // "alt":
1681 $altParam = ' alt="' . htmlspecialchars($altText) . '"';
1682 // "title":
1683 $emptyTitleHandling = 'useAlt';
1684 $emptyTitleHandling = isset($conf['emptyTitleHandling.']) ? $this->stdWrap($conf['emptyTitleHandling'], $conf['emptyTitleHandling.']) : $conf['emptyTitleHandling'];
1685 // Choices: 'keepEmpty' | 'useAlt' | 'removeAttr'
1686 if ($titleText || $emptyTitleHandling == 'keepEmpty') {
1687 $altParam .= ' title="' . htmlspecialchars($titleText) . '"';
1688 } elseif (!$titleText && $emptyTitleHandling == 'useAlt') {
1689 $altParam .= ' title="' . htmlspecialchars($altText) . '"';
1690 }
1691 // "longDesc" URL
1692 if ($longDesc) {
1693 $altParam .= ' longdesc="' . htmlspecialchars(strip_tags($longDesc)) . '"';
1694 }
1695 return $altParam;
1696 }
1697
1698 /**
1699 * Removes forbidden characters and spaces from name/id attributes in the form tag and formfields
1700 *
1701 * @param string $name Input string
1702 * @return string the cleaned string
1703 * @see FORM()
1704 * @todo Define visibility
1705 */
1706 public function cleanFormName($name) {
1707 // Turn data[x][y] into data:x:y:
1708 $name = preg_replace('/\\[|\\]\\[?/', ':', trim($name));
1709 // Remove illegal chars like _
1710 return preg_replace('#[^:a-zA-Z0-9]#', '', $name);
1711 }
1712
1713 /**
1714 * An abstraction method to add parameters to an A tag.
1715 * Uses the ATagParams property.
1716 *
1717 * @param array $conf TypoScript configuration properties
1718 * @param boolean $addGlobal If set, will add the global config.ATagParams to the link
1719 * @return string String containing the parameters to the A tag (if non empty, with a leading space)
1720 * @see IMGTEXT(), filelink(), makelinks(), typolink()
1721 * @todo Define visibility
1722 */
1723 public function getATagParams($conf, $addGlobal = 1) {
1724 $aTagParams = '';
1725 if ($conf['ATagParams.']) {
1726 $aTagParams = ' ' . $this->stdWrap($conf['ATagParams'], $conf['ATagParams.']);
1727 } elseif ($conf['ATagParams']) {
1728 $aTagParams = ' ' . $conf['ATagParams'];
1729 }
1730 if ($addGlobal) {
1731 $aTagParams = ' ' . trim(($GLOBALS['TSFE']->ATagParams . $aTagParams));
1732 }
1733 // Extend params
1734 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getATagParamsPostProc']) && is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getATagParamsPostProc'])) {
1735 $_params = array(
1736 'conf' => &$conf,
1737 'aTagParams' => &$aTagParams
1738 );
1739 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getATagParamsPostProc'] as $objRef) {
1740 $processor =& GeneralUtility::getUserObj($objRef);
1741 $aTagParams = $processor->process($_params, $this);
1742 }
1743 }
1744
1745 $aTagParams = trim($aTagParams);
1746 if (!empty($aTagParams)) {
1747 $aTagParams = ' ' . $aTagParams;
1748 }
1749
1750 return $aTagParams;
1751 }
1752
1753 /**
1754 * All extension links should ask this function for additional properties to their tags.
1755 * Designed to add for instance an "onclick" property for site tracking systems.
1756 *
1757 * @param string $URL URL of the website
1758 * @param string $TYPE
1759 * @return string The additional tag properties
1760 * @todo Define visibility
1761 */
1762 public function extLinkATagParams($URL, $TYPE) {
1763 $out = '';
1764 if ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['extLinkATagParamsHandler']) {
1765 $extLinkATagParamsHandler = GeneralUtility::getUserObj($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['extLinkATagParamsHandler']);
1766 if (method_exists($extLinkATagParamsHandler, 'main')) {
1767 $out .= trim($extLinkATagParamsHandler->main($URL, $TYPE, $this));
1768 }
1769 }
1770 return trim($out) ? ' ' . trim($out) : '';
1771 }
1772
1773 /***********************************************
1774 *
1775 * HTML template processing functions
1776 *
1777 ***********************************************/
1778 /**
1779 * Returns a subpart from the input content stream.
1780 * A subpart is a part of the input stream which is encapsulated in a
1781 * string matching the input string, $marker. If this string is found
1782 * inside of HTML comment tags the start/end points of the content block
1783 * returned will be that right outside that comment block.
1784 * Example: The contennt string is
1785 * "Hello <!--###sub1### begin--> World. How are <!--###sub1### end--> you?"
1786 * If $marker is "###sub1###" then the content returned is
1787 * " World. How are ". The input content string could just as well have
1788 * been "Hello ###sub1### World. How are ###sub1### you?" and the result
1789 * would be the same
1790 * Wrapper for \TYPO3\CMS\Core\Html\HtmlParser::getSubpart which behaves identical
1791 *
1792 * @param string $content The content stream, typically HTML template content.
1793 * @param string $marker The marker string, typically on the form "###[the marker string]###
1794 * @return string The subpart found, if found.
1795 */
1796 public function getSubpart($content, $marker) {
1797 return \TYPO3\CMS\Core\Html\HtmlParser::getSubpart($content, $marker);
1798 }
1799
1800 /**
1801 * Substitute subpart in input template stream.
1802 * This function substitutes a subpart in $content with the content of
1803 * $subpartContent.
1804 * Wrapper for \TYPO3\CMS\Core\Html\HtmlParser::substituteSubpart which behaves identical
1805 *
1806 * @param string $content The content stream, typically HTML template content.
1807 * @param string $marker The marker string, typically on the form "###[the marker string]###
1808 * @param mixed $subpartContent The content to insert instead of the subpart found. If a string, then just plain substitution happens (includes removing the HTML comments of the subpart if found). If $subpartContent happens to be an array, it's [0] and [1] elements are wrapped around the EXISTING content of the subpart (fetched by getSubpart()) thereby not removing the original content.
1809 * @param boolean $recursive If $recursive is set, the function calls itself with the content set to the remaining part of the content after the second marker. This means that proceding subparts are ALSO substituted!
1810 * @return string The processed HTML content string.
1811 */
1812 public function substituteSubpart($content, $marker, $subpartContent, $recursive = 1) {
1813 return \TYPO3\CMS\Core\Html\HtmlParser::substituteSubpart($content, $marker, $subpartContent, $recursive);
1814 }
1815
1816 /**
1817 * Substitues multiple subparts at once
1818 *
1819 * @param string $content The content stream, typically HTML template content.
1820 * @param array $subpartsContent The array of key/value pairs being subpart/content values used in the substitution. For each element in this array the function will substitute a subpart in the content stream with the content.
1821 * @return string The processed HTML content string.
1822 */
1823 public function substituteSubpartArray($content, array $subpartsContent) {
1824 return \TYPO3\CMS\Core\Html\HtmlParser::substituteSubpartArray($content, $subpartsContent);
1825 }
1826
1827 /**
1828 * Substitutes a marker string in the input content
1829 * (by a simple str_replace())
1830 *
1831 * @param string $content The content stream, typically HTML template content.
1832 * @param string $marker The marker string, typically on the form "###[the marker string]###
1833 * @param mixed $markContent The content to insert instead of the marker string found.
1834 * @return string The processed HTML content string.
1835 * @see substituteSubpart()
1836 */
1837 public function substituteMarker($content, $marker, $markContent) {
1838 return \TYPO3\CMS\Core\Html\HtmlParser::substituteMarker($content, $marker, $markContent);
1839 }
1840
1841 /**
1842 * Multi substitution function with caching.
1843 *
1844 * This function should be a one-stop substitution function for working
1845 * with HTML-template. It does not substitute by str_replace but by
1846 * splitting. This secures that the value inserted does not themselves
1847 * contain markers or subparts.
1848 *
1849 * Note that the "caching" won't cache the content of the substition,
1850 * but only the splitting of the template in various parts. So if you
1851 * want only one cache-entry per template, make sure you always pass the
1852 * exact same set of marker/subpart keys. Else you will be flooding the
1853 * users cache table.
1854 *
1855 * This function takes three kinds of substitutions in one:
1856 * $markContentArray is a regular marker-array where the 'keys' are
1857 * substituted in $content with their values
1858 *
1859 * $subpartContentArray works exactly like markContentArray only is whole
1860 * subparts substituted and not only a single marker.
1861 *
1862 * $wrappedSubpartContentArray is an array of arrays with 0/1 keys where
1863 * the subparts pointed to by the main key is wrapped with the 0/1 value
1864 * alternating.
1865 *
1866 * @param string $content The content stream, typically HTML template content.
1867 * @param array $markContentArray Regular marker-array where the 'keys' are substituted in $content with their values
1868 * @param array $subpartContentArray Exactly like markContentArray only is whole subparts substituted and not only a single marker.
1869 * @param array $wrappedSubpartContentArray An array of arrays with 0/1 keys where the subparts pointed to by the main key is wrapped with the 0/1 value alternating.
1870 * @return string The output content stream
1871 * @see substituteSubpart(), substituteMarker(), substituteMarkerInObject(), TEMPLATE()
1872 */
1873 public function substituteMarkerArrayCached($content, array $markContentArray = NULL, array $subpartContentArray = NULL, array $wrappedSubpartContentArray = NULL) {
1874 $GLOBALS['TT']->push('substituteMarkerArrayCached');
1875 // If not arrays then set them
1876 if (is_null($markContentArray)) {
1877 // Plain markers
1878 $markContentArray = array();
1879 }
1880 if (is_null($subpartContentArray)) {
1881 // Subparts being directly substituted
1882 $subpartContentArray = array();
1883 }
1884 if (is_null($wrappedSubpartContentArray)) {
1885 // Subparts being wrapped
1886 $wrappedSubpartContentArray = array();
1887 }
1888 // Finding keys and check hash:
1889 $sPkeys = array_keys($subpartContentArray);
1890 $wPkeys = array_keys($wrappedSubpartContentArray);
1891 $aKeys = array_merge(array_keys($markContentArray), $sPkeys, $wPkeys);
1892 if (!count($aKeys)) {
1893 $GLOBALS['TT']->pull();
1894 return $content;
1895 }
1896 asort($aKeys);
1897 $storeKey = md5('substituteMarkerArrayCached_storeKey:' . serialize(array(
1898 $content,
1899 $aKeys
1900 )));
1901 if ($this->substMarkerCache[$storeKey]) {
1902 $storeArr = $this->substMarkerCache[$storeKey];
1903 $GLOBALS['TT']->setTSlogMessage('Cached', 0);
1904 } else {
1905 $storeArrDat = $GLOBALS['TSFE']->sys_page->getHash($storeKey);
1906 if (is_array($storeArrDat)) {
1907 $storeArr = $storeArrDat;
1908 // Setting cache:
1909 $this->substMarkerCache[$storeKey] = $storeArr;
1910 $GLOBALS['TT']->setTSlogMessage('Cached from DB', 0);
1911 } else {
1912 // Initialize storeArr
1913 $storeArr = array();
1914 // Finding subparts and substituting them with the subpart as a marker
1915 foreach ($sPkeys as $sPK) {
1916 $content = $this->substituteSubpart($content, $sPK, $sPK);
1917 }
1918 // Finding subparts and wrapping them with markers
1919 foreach ($wPkeys as $wPK) {
1920 $content = $this->substituteSubpart($content, $wPK, array(
1921 $wPK,
1922 $wPK
1923 ));
1924 }
1925 // Traverse keys and quote them for reg ex.
1926 foreach ($aKeys as $tK => $tV) {
1927 $aKeys[$tK] = preg_quote($tV, '/');
1928 }
1929 $regex = '/' . implode('|', $aKeys) . '/';
1930 // Doing regex's
1931 $storeArr['c'] = preg_split($regex, $content);
1932 preg_match_all($regex, $content, $keyList);
1933 $storeArr['k'] = $keyList[0];
1934 // Setting cache:
1935 $this->substMarkerCache[$storeKey] = $storeArr;
1936 // Storing the cached data:
1937 $GLOBALS['TSFE']->sys_page->storeHash($storeKey, $storeArr, 'substMarkArrayCached');
1938 $GLOBALS['TT']->setTSlogMessage('Parsing', 0);
1939 }
1940 }
1941 // Substitution/Merging:
1942 // Merging content types together, resetting
1943 $valueArr = array_merge($markContentArray, $subpartContentArray, $wrappedSubpartContentArray);
1944 $wSCA_reg = array();
1945 $content = '';
1946 // Traversing the keyList array and merging the static and dynamic content
1947 foreach ($storeArr['k'] as $n => $keyN) {
1948 $content .= $storeArr['c'][$n];
1949 if (!is_array($valueArr[$keyN])) {
1950 $content .= $valueArr[$keyN];
1951 } else {
1952 $content .= $valueArr[$keyN][intval($wSCA_reg[$keyN]) % 2];
1953 $wSCA_reg[$keyN]++;
1954 }
1955 }
1956 $content .= $storeArr['c'][count($storeArr['k'])];
1957 $GLOBALS['TT']->pull();
1958 return $content;
1959 }
1960
1961 /**
1962 * Traverses the input $markContentArray array and for each key the marker
1963 * by the same name (possibly wrapped and in upper case) will be
1964 * substituted with the keys value in the array.
1965 *
1966 * This is very useful if you have a data-record to substitute in some
1967 * content. In particular when you use the $wrap and $uppercase values to
1968 * pre-process the markers. Eg. a key name like "myfield" could effectively
1969 * be represented by the marker "###MYFIELD###" if the wrap value
1970 * was "###|###" and the $uppercase boolean TRUE.
1971 *
1972 * @param string $content The content stream, typically HTML template content.
1973 * @param array $markContentArray The array of key/value pairs being marker/content values used in the substitution. For each element in this array the function will substitute a marker in the content stream with the content.
1974 * @param string $wrap A wrap value - [part 1] | [part 2] - for the markers before substitution
1975 * @param boolean $uppercase If set, all marker string substitution is done with upper-case markers.
1976 * @param boolean $deleteUnused If set, all unused marker are deleted.
1977 * @return string The processed output stream
1978 * @see substituteMarker(), substituteMarkerInObject(), TEMPLATE()
1979 */
1980 public function substituteMarkerArray($content, array $markContentArray, $wrap = '', $uppercase = FALSE, $deleteUnused = FALSE) {
1981 return \TYPO3\CMS\Core\Html\HtmlParser::substituteMarkerArray($content, $markContentArray, $wrap, $uppercase, $deleteUnused);
1982 }
1983
1984 /**
1985 * Substitute marker array in an array of values
1986 *
1987 * @param mixed $tree If string, then it just calls substituteMarkerArray. If array(and even multi-dim) then for each key/value pair the marker array will be substituted (by calling this function recursively)
1988 * @param array $markContentArray The array of key/value pairs being marker/content values used in the substitution. For each element in this array the function will substitute a marker in the content string/array values.
1989 * @return mixed The processed input variable.
1990 * @see substituteMarker()
1991 */
1992 public function substituteMarkerInObject(&$tree, array $markContentArray) {
1993 if (is_array($tree)) {
1994 foreach ($tree as $key => $value) {
1995 $this->substituteMarkerInObject($tree[$key], $markContentArray);
1996 }
1997 } else {
1998 $tree = $this->substituteMarkerArray($tree, $markContentArray);
1999 }
2000 return $tree;
2001 }
2002
2003 /**
2004 * Replaces all markers and subparts in a template with the content provided in the structured array.
2005 *
2006 * @param string $content
2007 * @param array $markersAndSubparts
2008 * @param string $wrap
2009 * @param boolean $uppercase
2010 * @param boolean $deleteUnused
2011 * @return string
2012 */
2013 public function substituteMarkerAndSubpartArrayRecursive($content, array $markersAndSubparts, $wrap = '', $uppercase = FALSE, $deleteUnused = FALSE) {
2014 return \TYPO3\CMS\Core\Html\HtmlParser::substituteMarkerAndSubpartArrayRecursive($content, $markersAndSubparts, $wrap, $uppercase, $deleteUnused);
2015 }
2016
2017 /**
2018 * Adds elements to the input $markContentArray based on the values from
2019 * the fields from $fieldList found in $row
2020 *
2021 * @param array $markContentArray Array with key/values being marker-strings/substitution values.
2022 * @param array $row An array with keys found in the $fieldList (typically a record) which values should be moved to the $markContentArray
2023 * @param string $fieldList A list of fields from the $row array to add to the $markContentArray array. If empty all fields from $row will be added (unless they are integers)
2024 * @param boolean $nl2br If set, all values added to $markContentArray will be nl2br()'ed
2025 * @param string $prefix Prefix string to the fieldname before it is added as a key in the $markContentArray. Notice that the keys added to the $markContentArray always start and end with "###
2026 * @param boolean $HSC If set, all values are passed through htmlspecialchars() - RECOMMENDED to avoid most obvious XSS and maintain XHTML compliance.
2027 * @return array The modified $markContentArray
2028 */
2029 public function fillInMarkerArray(array $markContentArray, array $row, $fieldList = '', $nl2br = TRUE, $prefix = 'FIELD_', $HSC = FALSE) {
2030 if ($fieldList) {
2031 $fArr = GeneralUtility::trimExplode(',', $fieldList, TRUE);
2032 foreach ($fArr as $field) {
2033 $markContentArray['###' . $prefix . $field . '###'] = $nl2br ? nl2br($row[$field], !empty($GLOBALS['TSFE']->xhtmlDoctype)) : $row[$field];
2034 }
2035 } else {
2036 if (is_array($row)) {
2037 foreach ($row as $field => $value) {
2038 if (!\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($field)) {
2039 if ($HSC) {
2040 $value = htmlspecialchars($value);
2041 }
2042 $markContentArray['###' . $prefix . $field . '###'] = $nl2br ? nl2br($value, !empty($GLOBALS['TSFE']->xhtmlDoctype)) : $value;
2043 }
2044 }
2045 }
2046 }
2047 return $markContentArray;
2048 }
2049
2050 /**
2051 * Sets the current file object during iterations over files.
2052 *
2053 * @param \TYPO3\CMS\Core\Resource\File $fileObject The file object.
2054 */
2055 public function setCurrentFile($fileObject) {
2056 $this->currentFile = $fileObject;
2057 }
2058
2059 /**
2060 * Gets the current file object during iterations over files.
2061 *
2062 * @return \TYPO3\CMS\Core\Resource\File The current file object.
2063 */
2064 public function getCurrentFile() {
2065 return $this->currentFile;
2066 }
2067
2068 /***********************************************
2069 *
2070 * "stdWrap" + sub functions
2071 *
2072 ***********************************************/
2073 /**
2074 * The "stdWrap" function. This is the implementation of what is known as "stdWrap properties" in TypoScript.
2075 * Basically "stdWrap" performs some processing of a value based on properties in the input $conf array(holding the TypoScript "stdWrap properties")
2076 * See the link below for a complete list of properties and what they do. The order of the table with properties found in TSref (the link) follows the actual order of implementation in this function.
2077 *
2078 * If $this->alternativeData is an array it's used instead of the $this->data array in ->getData
2079 *
2080 * @param string $content Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
2081 * @param array $conf TypoScript "stdWrap properties".
2082 * @return string The processed input value
2083 */
2084 public function stdWrap($content = '', $conf = array()) {
2085 if (count($this->stdWrapHookObjects)) {
2086 foreach ($this->stdWrapHookObjects as $hookObject) {
2087 if (is_callable(array($hookObject, 'stdWrapPreProcess'))) {
2088 $conf['stdWrapPreProcess'] = 1;
2089 }
2090 if (is_callable(array($hookObject, 'stdWrapOverride'))) {
2091 $conf['stdWrapOverride'] = 1;
2092 }
2093 if (is_callable(array($hookObject, 'stdWrapProcess'))) {
2094 $conf['stdWrapProcess'] = 1;
2095 }
2096 if (is_callable(array($hookObject, 'stdWrapPostProcess'))) {
2097 $conf['stdWrapPostProcess'] = 1;
2098 }
2099 }
2100 }
2101 if (is_array($conf) && count($conf)) {
2102 // Cache handling
2103 if (is_array($conf['cache.'])) {
2104 $conf['cache.']['key'] = $this->stdWrap($conf['cache.']['key'], $conf['cache.']['key.']);
2105 $conf['cache.']['tags'] = $this->stdWrap($conf['cache.']['tags'], $conf['cache.']['tags.']);
2106 $conf['cache.']['lifetime'] = $this->stdWrap($conf['cache.']['lifetime'], $conf['cache.']['lifetime.']);
2107 $conf['cacheRead'] = 1;
2108 $conf['cacheStore'] = 1;
2109 }
2110 // Check, which of the available stdWrap functions is needed for the current conf Array
2111 // and keep only those but still in the same order
2112 $sortedConf = array_intersect_key($this->stdWrapOrder, $conf);
2113 // Functions types that should not make use of nested stdWrap function calls to avoid conflicts with internal TypoScript used by these functions
2114 $stdWrapDisabledFunctionTypes = 'cObject,functionName,stdWrap';
2115 // Additional Array to check whether a function has already been executed
2116 $isExecuted = array();
2117 // Additional switch to make sure 'required', 'if' and 'fieldRequired'
2118 // will still stop rendering immediately in case they return FALSE
2119 $this->stdWrapRecursionLevel++;
2120 $this->stopRendering[$this->stdWrapRecursionLevel] = FALSE;
2121 // execute each function in the predefined order
2122 foreach ($sortedConf as $stdWrapName => $functionType) {
2123 // eliminate the second key of a pair 'key'|'key.' to make sure functions get called only once and check if rendering has been stopped
2124 if (!$isExecuted[$stdWrapName] && !$this->stopRendering[$this->stdWrapRecursionLevel]) {
2125 $functionName = rtrim($stdWrapName, '.');
2126 $functionProperties = $functionName . '.';
2127 // If there is any code one the next level, check if it contains "official" stdWrap functions
2128 // if yes, execute them first - will make each function stdWrap aware
2129 // so additional stdWrap calls within the functions can be removed, since the result will be the same
2130 // exception: the recursive stdWrap function and cObject will still be using their own stdWrap call, since it modifies the content and not a property
2131 if (count($conf[$functionProperties]) && !GeneralUtility::inList($stdWrapDisabledFunctionTypes, $functionType)) {
2132 if (array_intersect_key($this->stdWrapOrder, $conf[$functionProperties])) {
2133 $conf[$functionName] = $this->stdWrap($conf[$functionName], $conf[$functionProperties]);
2134 }
2135 }
2136 // Get just that part of $conf that is needed for the particular function
2137 $singleConf = array(
2138 $functionName => $conf[$functionName],
2139 $functionProperties => $conf[$functionProperties]
2140 );
2141 // In this special case 'spaceBefore' and 'spaceAfter' need additional stuff from 'space.''
2142 if ($functionName == 'spaceBefore' || $functionName == 'spaceAfter') {
2143 $singleConf['space.'] = $conf['space.'];
2144 }
2145 // Hand over the whole $conf array to the stdWrapHookObjects
2146 if ($functionType === 'hook') {
2147 $singleConf = $conf;
2148 }
2149 // Check if key is still containing something, since it might have been changed by next level stdWrap before
2150 if ((isset($conf[$functionName]) || $conf[$functionProperties]) && !($functionType == 'boolean' && !$conf[$functionName])) {
2151 // Add both keys - with and without the dot - to the set of executed functions
2152 $isExecuted[$functionName] = TRUE;
2153 $isExecuted[$functionProperties] = TRUE;
2154 // Call the function with the prefix stdWrap_ to make sure nobody can execute functions just by adding their name to the TS Array
2155 $functionName = 'stdWrap_' . $functionName;
2156 $content = $this->{$functionName}($content, $singleConf);
2157 } elseif ($functionType == 'boolean' && !$conf[$functionName]) {
2158 $isExecuted[$functionName] = TRUE;
2159 $isExecuted[$functionProperties] = TRUE;
2160 }
2161 }
2162 }
2163 unset($this->stopRendering[$this->stdWrapRecursionLevel]);
2164 $this->stdWrapRecursionLevel--;
2165 }
2166 return $content;
2167 }
2168
2169 /**
2170 * stdWrap pre process hook
2171 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2172 * this hook will execute functions before any other stdWrap function can modify anything
2173 *
2174 * @param string $content Input value undergoing processing in these functions.
2175 * @param array $conf All stdWrap properties, not just the ones for a particular function.
2176 * @return string The processed input value
2177 */
2178 public function stdWrap_stdWrapPreProcess($content = '', $conf = array()) {
2179 foreach ($this->stdWrapHookObjects as $hookObject) {
2180 $content = $hookObject->stdWrapPreProcess($content, $conf, $this);
2181 }
2182 return $content;
2183 }
2184
2185 /**
2186 * Check if content was cached before (depending on the given cache key)
2187 *
2188 * @param string $content Input value undergoing processing in these functions.
2189 * @param array $conf All stdWrap properties, not just the ones for a particular function.
2190 * @return string The processed input value
2191 */
2192 public function stdWrap_cacheRead($content = '', $conf = array()) {
2193 if (!empty($conf['cache.']['key'])) {
2194 /** @var $cacheFrontend \TYPO3\CMS\Core\Cache\Frontend\VariableFrontend */
2195 $cacheFrontend = $GLOBALS['typo3CacheManager']->getCache('cache_hash');
2196 if ($cacheFrontend && $cacheFrontend->has($conf['cache.']['key'])) {
2197 $content = $cacheFrontend->get($conf['cache.']['key']);
2198 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2199 }
2200 }
2201 return $content;
2202 }
2203
2204 /**
2205 * Add tags to page cache (comma-separated list)
2206 *
2207 * @param string $content Input value undergoing processing in these functions.
2208 * @param array $conf All stdWrap properties, not just the ones for a particular function.
2209 * @return string The processed input value
2210 */
2211 public function stdWrap_addPageCacheTags($content = '', $conf = array()) {
2212 $tags = isset($conf['addPageCacheTags.'])
2213 ? $this->stdWrap($conf['addPageCacheTags'], $conf['addPageCacheTags.'])
2214 : $conf['addPageCacheTags'];
2215 if (!empty($tags)) {
2216 $cacheTags = GeneralUtility::trimExplode(',', $tags, TRUE);
2217 $GLOBALS['TSFE']->addCacheTags($cacheTags);
2218 }
2219 return $content;
2220 }
2221
2222 /**
2223 * setContentToCurrent
2224 * actually it just does the contrary: Sets the value of 'current' based on current content
2225 *
2226 * @param string $content Input value undergoing processing in this function.
2227 * @param array $conf stdWrap properties for setContentToCurrent.
2228 * @return string The processed input value
2229 */
2230 public function stdWrap_setContentToCurrent($content = '', $conf = array()) {
2231 $this->data[$this->currentValKey] = $content;
2232 return $content;
2233 }
2234
2235 /**
2236 * setCurrent
2237 * Sets the value of 'current' based on the outcome of stdWrap operations
2238 *
2239 * @param string $content Input value undergoing processing in this function.
2240 * @param array $conf stdWrap properties for setCurrent.
2241 * @return string The processed input value
2242 */
2243 public function stdWrap_setCurrent($content = '', $conf = array()) {
2244 $this->data[$this->currentValKey] = $conf['setCurrent'];
2245 return $content;
2246 }
2247
2248 /**
2249 * lang
2250 * Translates content based on the language currently used by the FE
2251 *
2252 * @param string $content Input value undergoing processing in this function.
2253 * @param array $conf stdWrap properties for lang.
2254 * @return string The processed input value
2255 */
2256 public function stdWrap_lang($content = '', $conf = array()) {
2257 if (isset($conf['lang.']) && $GLOBALS['TSFE']->config['config']['language'] && isset($conf['lang.'][$GLOBALS['TSFE']->config['config']['language']])) {
2258 $content = $conf['lang.'][$GLOBALS['TSFE']->config['config']['language']];
2259 }
2260 return $content;
2261 }
2262
2263 /**
2264 * data
2265 * Gets content from different sources based on getText functions, makes use of alternativeData, when set
2266 *
2267 * @param string $content Input value undergoing processing in this function.
2268 * @param array $conf stdWrap properties for data.
2269 * @return string The processed input value
2270 */
2271 public function stdWrap_data($content = '', $conf = array()) {
2272 $content = $this->getData($conf['data'], is_array($this->alternativeData) ? $this->alternativeData : $this->data);
2273 // This must be unset directly after
2274 $this->alternativeData = '';
2275 return $content;
2276 }
2277
2278 /**
2279 * field
2280 * Gets content from a DB field
2281 *
2282 * @param string $content Input value undergoing processing in this function.
2283 * @param array $conf stdWrap properties for field.
2284 * @return string The processed input value
2285 */
2286 public function stdWrap_field($content = '', $conf = array()) {
2287 return $this->getFieldVal($conf['field']);
2288 }
2289
2290 /**
2291 * current
2292 * Gets content that has been perviously set as 'current'
2293 * Can be set via setContentToCurrent or setCurrent or will be set automatically i.e. inside the split function
2294 *
2295 * @param string $content Input value undergoing processing in this function.
2296 * @param array $conf stdWrap properties for current.
2297 * @return string The processed input value
2298 */
2299 public function stdWrap_current($content = '', $conf = array()) {
2300 return $this->data[$this->currentValKey];
2301 }
2302
2303 /**
2304 * cObject
2305 * Will replace the content with the value of a any official TypoScript cObject
2306 * like TEXT, COA, HMENU
2307 *
2308 * @param string $content Input value undergoing processing in this function.
2309 * @param array $conf stdWrap properties for cObject.
2310 * @return string The processed input value
2311 */
2312 public function stdWrap_cObject($content = '', $conf = array()) {
2313 return $this->cObjGetSingle($conf['cObject'], $conf['cObject.'], '/stdWrap/.cObject');
2314 }
2315
2316 /**
2317 * numRows
2318 * Counts the number of returned records of a DB operation
2319 * makes use of select internally
2320 *
2321 * @param string $content Input value undergoing processing in this function.
2322 * @param array $conf stdWrap properties for numRows.
2323 * @return string The processed input value
2324 */
2325 public function stdWrap_numRows($content = '', $conf = array()) {
2326 return $this->numRows($conf['numRows.']);
2327 }
2328
2329 /**
2330 * filelist
2331 * Will create a list of files based on some additional parameters
2332 *
2333 * @param string $content Input value undergoing processing in this function.
2334 * @param array $conf stdWrap properties for filelist.
2335 * @return string The processed input value
2336 */
2337 public function stdWrap_filelist($content = '', $conf = array()) {
2338 return $this->filelist($conf['filelist']);
2339 }
2340
2341 /**
2342 * preUserFunc
2343 * Will execute a user public function before the content will be modified by any other stdWrap function
2344 *
2345 * @param string $content Input value undergoing processing in this function.
2346 * @param array $conf stdWrap properties for preUserFunc.
2347 * @return string The processed input value
2348 */
2349 public function stdWrap_preUserFunc($content = '', $conf = array()) {
2350 return $this->callUserFunction($conf['preUserFunc'], $conf['preUserFunc.'], $content);
2351 }
2352
2353 /**
2354 * stdWrap override hook
2355 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2356 * this hook will execute functions on existing content but still before the content gets modified or replaced
2357 *
2358 * @param string $content Input value undergoing processing in these functions.
2359 * @param array $conf All stdWrap properties, not just the ones for a particular function.
2360 * @return string The processed input value
2361 */
2362 public function stdWrap_stdWrapOverride($content = '', $conf = array()) {
2363 foreach ($this->stdWrapHookObjects as $hookObject) {
2364 $content = $hookObject->stdWrapOverride($content, $conf, $this);
2365 }
2366 return $content;
2367 }
2368
2369 /**
2370 * override
2371 * Will override the current value of content with its own value'
2372 *
2373 * @param string $content Input value undergoing processing in this function.
2374 * @param array $conf stdWrap properties for override.
2375 * @return string The processed input value
2376 */
2377 public function stdWrap_override($content = '', $conf = array()) {
2378 if (trim($conf['override'])) {
2379 $content = $conf['override'];
2380 }
2381 return $content;
2382 }
2383
2384 /**
2385 * preIfEmptyListNum
2386 * Gets a value off a CSV list before the following ifEmpty check
2387 * Makes sure that the result of ifEmpty will be TRUE in case the CSV does not contain a value at the position given by preIfEmptyListNum
2388 *
2389 * @param string $content Input value undergoing processing in this function.
2390 * @param array $conf stdWrap properties for preIfEmptyListNum.
2391 * @return string The processed input value
2392 */
2393 public function stdWrap_preIfEmptyListNum($content = '', $conf = array()) {
2394 return $this->listNum($content, $conf['preIfEmptyListNum'], $conf['preIfEmptyListNum.']['splitChar']);
2395 }
2396
2397 /**
2398 * ifNull
2399 * Will set content to a replacement value in case the value of content is NULL
2400 *
2401 * @param string|NULL $content Input value undergoing processing in this function.
2402 * @param array $conf stdWrap properties for ifNull.
2403 * @return string|NULL The processed input value
2404 */
2405 public function stdWrap_ifNull($content = '', $conf = array()) {
2406 if ($content === NULL) {
2407 $content = $conf['ifNull'];
2408 }
2409 return $content;
2410 }
2411
2412 /**
2413 * ifEmpty
2414 * Will set content to a replacement value in case the trimmed value of content returns FALSE
2415 * 0 (zero) will be replaced as well
2416 *
2417 * @param string $content Input value undergoing processing in this function.
2418 * @param array $conf stdWrap properties for ifEmpty.
2419 * @return string The processed input value
2420 */
2421 public function stdWrap_ifEmpty($content = '', $conf = array()) {
2422 if (!trim($content)) {
2423 $content = $conf['ifEmpty'];
2424 }
2425 return $content;
2426 }
2427
2428 /**
2429 * ifBlank
2430 * Will set content to a replacement value in case the trimmed value of content has no length
2431 * 0 (zero) will not be replaced
2432 *
2433 * @param string $content Input value undergoing processing in this function.
2434 * @param array $conf stdWrap properties for ifBlank.
2435 * @return string The processed input value
2436 */
2437 public function stdWrap_ifBlank($content = '', $conf = array()) {
2438 if (!strlen(trim($content))) {
2439 $content = $conf['ifBlank'];
2440 }
2441 return $content;
2442 }
2443
2444 /**
2445 * listNum
2446 * Gets a value off a CSV list after ifEmpty check
2447 * Might return an empty value in case the CSV does not contain a value at the position given by listNum
2448 * Use preIfEmptyListNum to avoid that behaviour
2449 *
2450 * @param string $content Input value undergoing processing in this function.
2451 * @param array $conf stdWrap properties for listNum.
2452 * @return string The processed input value
2453 */
2454 public function stdWrap_listNum($content = '', $conf = array()) {
2455 return $this->listNum($content, $conf['listNum'], $conf['listNum.']['splitChar']);
2456 }
2457
2458 /**
2459 * trim
2460 * Cuts off any whitespace at the beginning and the end of the content
2461 *
2462 * @param string $content Input value undergoing processing in this function.
2463 * @param array $conf stdWrap properties for trim.
2464 * @return string The processed input value
2465 */
2466 public function stdWrap_trim($content = '', $conf = array()) {
2467 return trim($content);
2468 }
2469
2470 /**
2471 * strPad
2472 * Will return a string padded left/right/on both sides, based on configuration given as stdWrap properties
2473 *
2474 * @param string $content Input value undergoing processing in this function.
2475 * @param array $conf stdWrap properties for strPad.
2476 * @return string The processed input value
2477 */
2478 public function stdWrap_strPad($content = '', $conf = array()) {
2479 // Must specify a length in conf for this to make sense
2480 $length = 0;
2481 // Padding with space is PHP-default
2482 $padWith = ' ';
2483 // Padding on the right side is PHP-default
2484 $padType = STR_PAD_RIGHT;
2485 if (!empty($conf['strPad.']['length'])) {
2486 $length = isset($conf['strPad.']['length.']) ? $this->stdWrap($conf['strPad.']['length'], $conf['strPad.']['length.']) : $conf['strPad.']['length'];
2487 $length = intval($length);
2488 }
2489 if (isset($conf['strPad.']['padWith']) && strlen($conf['strPad.']['padWith']) > 0) {
2490 $padWith = isset($conf['strPad.']['padWith.']) ? $this->stdWrap($conf['strPad.']['padWith'], $conf['strPad.']['padWith.']) : $conf['strPad.']['padWith'];
2491 }
2492 if (!empty($conf['strPad.']['type'])) {
2493 $type = isset($conf['strPad.']['type.']) ? $this->stdWrap($conf['strPad.']['type'], $conf['strPad.']['type.']) : $conf['strPad.']['type'];
2494 if (strtolower($type) === 'left') {
2495 $padType = STR_PAD_LEFT;
2496 } elseif (strtolower($type) === 'both') {
2497 $padType = STR_PAD_BOTH;
2498 }
2499 }
2500 $content = str_pad($content, $length, $padWith, $padType);
2501 return $content;
2502 }
2503
2504 /**
2505 * stdWrap
2506 * A recursive call of the stdWrap function set
2507 * This enables the user to execute stdWrap functions in another than the predefined order
2508 * It modifies the content, not the property
2509 * while the new feature of chained stdWrap functions modifies the property and not the content
2510 *
2511 * @param string $content Input value undergoing processing in this function.
2512 * @param array $conf stdWrap properties for stdWrap.
2513 * @return string The processed input value
2514 */
2515 public function stdWrap_stdWrap($content = '', $conf = array()) {
2516 return $this->stdWrap($content, $conf['stdWrap.']);
2517 }
2518
2519 /**
2520 * stdWrap process hook
2521 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2522 * this hook executes functions directly after the recursive stdWrap function call but still before the content gets modified
2523 *
2524 * @param string $content Input value undergoing processing in these functions.
2525 * @param array $conf All stdWrap properties, not just the ones for a particular function.
2526 * @return string The processed input value
2527 */
2528 public function stdWrap_stdWrapProcess($content = '', $conf = array()) {
2529 foreach ($this->stdWrapHookObjects as $hookObject) {
2530 $content = $hookObject->stdWrapProcess($content, $conf, $this);
2531 }
2532 return $content;
2533 }
2534
2535 /**
2536 * required
2537 * Will immediately stop rendering and return an empty value
2538 * when there is no content at this point
2539 *
2540 * @param string $content Input value undergoing processing in this function.
2541 * @param array $conf stdWrap properties for required.
2542 * @return string The processed input value
2543 */
2544 public function stdWrap_required($content = '', $conf = array()) {
2545 if ((string) $content === '') {
2546 $content = '';
2547 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2548 }
2549 return $content;
2550 }
2551
2552 /**
2553 * if
2554 * Will immediately stop rendering and return an empty value
2555 * when the result of the checks returns FALSE
2556 *
2557 * @param string $content Input value undergoing processing in this function.
2558 * @param array $conf stdWrap properties for if.
2559 * @return string The processed input value
2560 */
2561 public function stdWrap_if($content = '', $conf = array()) {
2562 if (!$this->checkIf($conf['if.'])) {
2563 $content = '';
2564 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2565 }
2566 return $content;
2567 }
2568
2569 /**
2570 * fieldRequired
2571 * Will immediately stop rendering and return an empty value
2572 * when there is no content in the field given by fieldRequired
2573 *
2574 * @param string $content Input value undergoing processing in this function.
2575 * @param array $conf stdWrap properties for fieldRequired.
2576 * @return string The processed input value
2577 */
2578 public function stdWrap_fieldRequired($content = '', $conf = array()) {
2579 if (!trim($this->data[$conf['fieldRequired']])) {
2580 $content = '';
2581 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2582 }
2583 return $content;
2584 }
2585
2586 /**
2587 * csConv
2588 * Will convert the current chracter set of the content to the one given in csConv
2589 *
2590 * @param string $content Input value undergoing processing in this function.
2591 * @param array $conf stdWrap properties for csConv.
2592 * @return string The processed input value
2593 */
2594 public function stdWrap_csConv($content = '', $conf = array()) {
2595 return $GLOBALS['TSFE']->csConv($content, $conf['csConv']);
2596 }
2597
2598 /**
2599 * parseFunc
2600 * Will parse the content based on functions given as stdWrap properties
2601 * Heavily used together with RTE based content
2602 *
2603 * @param string $content Input value undergoing processing in this function.
2604 * @param array $conf stdWrap properties for parseFunc.
2605 * @return string The processed input value
2606 */
2607 public function stdWrap_parseFunc($content = '', $conf = array()) {
2608 return $this->parseFunc($content, $conf['parseFunc.'], $conf['parseFunc']);
2609 }
2610
2611 /**
2612 * HTMLparser
2613 * Will parse HTML content based on functions given as stdWrap properties
2614 * Heavily used together with RTE based content
2615 *
2616 * @param string $content Input value undergoing processing in this function.
2617 * @param array $conf stdWrap properties for HTMLparser.
2618 * @return string The processed input value
2619 */
2620 public function stdWrap_HTMLparser($content = '', $conf = array()) {
2621 if (is_array($conf['HTMLparser.'])) {
2622 $content = $this->HTMLparser_TSbridge($content, $conf['HTMLparser.']);
2623 }
2624 return $content;
2625 }
2626
2627 /**
2628 * split
2629 * Will split the content by a given token and treat the results separately
2630 * Automatically fills 'current' with a single result
2631 *
2632 * @param string $content Input value undergoing processing in this function.
2633 * @param array $conf stdWrap properties for split.
2634 * @return string The processed input value
2635 */
2636 public function stdWrap_split($content = '', $conf = array()) {
2637 return $this->splitObj($content, $conf['split.']);
2638 }
2639
2640 /**
2641 * replacement
2642 * Will execute replacements on the content (optionally with preg-regex)
2643 *
2644 * @param string $content Input value undergoing processing in this function.
2645 * @param array $conf stdWrap properties for replacement.
2646 * @return string The processed input value
2647 */
2648 public function stdWrap_replacement($content = '', $conf = array()) {
2649 return $this->replacement($content, $conf['replacement.']);
2650 }
2651
2652 /**
2653 * prioriCalc
2654 * Will use the content as a mathematical term and calculate the result
2655 * Can be set to 1 to just get a calculated value or 'intval' to get the integer of the result
2656 *
2657 * @param string $content Input value undergoing processing in this function.
2658 * @param array $conf stdWrap properties for prioriCalc.
2659 * @return string The processed input value
2660 */
2661 public function stdWrap_prioriCalc($content = '', $conf = array()) {
2662 $content = \TYPO3\CMS\Core\Utility\MathUtility::calculateWithParentheses($content);
2663 if ($conf['prioriCalc'] == 'intval') {
2664 $content = intval($content);
2665 }
2666 return $content;
2667 }
2668
2669 /**
2670 * char
2671 * Will return a character based on its position within the current character set
2672 *
2673 * @param string $content Input value undergoing processing in this function.
2674 * @param array $conf stdWrap properties for char.
2675 * @return string The processed input value
2676 */
2677 public function stdWrap_char($content = '', $conf = array()) {
2678 return chr(intval($conf['char']));
2679 }
2680
2681 /**
2682 * intval
2683 * Will return an integer value of the current content
2684 *
2685 * @param string $content Input value undergoing processing in this function.
2686 * @param array $conf stdWrap properties for intval.
2687 * @return string The processed input value
2688 */
2689 public function stdWrap_intval($content = '', $conf = array()) {
2690 return intval($content);
2691 }
2692
2693 /**
2694 * Will return a hashed value of the current content
2695 *
2696 * @param string $content Input value undergoing processing in this function.
2697 * @param array $conf stdWrap properties for hash.
2698 * @return string The processed input value
2699 * @link http://php.net/manual/de/function.hash-algos.php for a list of supported hash algorithms
2700 */
2701 public function stdWrap_hash($content = '', array $conf = array()) {
2702 $algorithm = isset($conf['hash.']) ? $this->stdWrap($conf['hash'], $conf['hash.']) : $conf['hash'];
2703 if (function_exists('hash') && in_array($algorithm, hash_algos())) {
2704 $content = hash($algorithm, $content);
2705 } else {
2706 // Non-existing hashing algorithm
2707 $content = '';
2708 }
2709 return $content;
2710 }
2711
2712 /**
2713 * stdWrap_round will return a rounded number with ceil(), floor() or round(), defaults to round()
2714 * Only the english number format is supported . (dot) as decimal point
2715 *
2716 * @param string $content Input value undergoing processing in this function.
2717 * @param array $conf stdWrap properties for round.
2718 * @return string The processed input value
2719 */
2720 public function stdWrap_round($content = '', $conf = array()) {
2721 return $this->round($content, $conf['round.']);
2722 }
2723
2724 /**
2725 * numberFormat
2726 * Will return a formatted number based on configuration given as stdWrap properties
2727 *
2728 * @param string $content Input value undergoing processing in this function.
2729 * @param array $conf stdWrap properties for numberFormat.
2730 * @return string The processed input value
2731 */
2732 public function stdWrap_numberFormat($content = '', $conf = array()) {
2733 return $this->numberFormat($content, $conf['numberFormat.']);
2734 }
2735
2736 /**
2737 * expandList
2738 * Will return a formatted number based on configuration given as stdWrap properties
2739 *
2740 * @param string $content Input value undergoing processing in this function.
2741 * @param array $conf stdWrap properties for expandList.
2742 * @return string The processed input value
2743 */
2744 public function stdWrap_expandList($content = '', $conf = array()) {
2745 return GeneralUtility::expandList($content);
2746 }
2747
2748 /**
2749 * date
2750 * Will return a formatted date based on configuration given according to PHP date/gmdate properties
2751 * Will return gmdate when the property GMT returns TRUE
2752 *
2753 * @param string $content Input value undergoing processing in this function.
2754 * @param array $conf stdWrap properties for date.
2755 * @return string The processed input value
2756 */
2757 public function stdWrap_date($content = '', $conf = array()) {
2758 // Check for zero length string to mimic default case of date/gmdate.
2759 $content = $content == '' ? $GLOBALS['EXEC_TIME'] : intval($content);
2760 $content = $conf['date.']['GMT'] ? gmdate($conf['date'], $content) : date($conf['date'], $content);
2761 return $content;
2762 }
2763
2764 /**
2765 * strftime
2766 * Will return a formatted date based on configuration given according to PHP strftime/gmstrftime properties
2767 * Will return gmstrftime when the property GMT returns TRUE
2768 *
2769 * @param string $content Input value undergoing processing in this function.
2770 * @param array $conf stdWrap properties for strftime.
2771 * @return string The processed input value
2772 */
2773 public function stdWrap_strftime($content = '', $conf = array()) {
2774 // Check for zero length string to mimic default case of strtime/gmstrftime
2775 $content = $content == '' ? $GLOBALS['EXEC_TIME'] : intval($content);
2776 $content = $conf['strftime.']['GMT'] ? gmstrftime($conf['strftime'], $content) : strftime($conf['strftime'], $content);
2777 $tmp_charset = $conf['strftime.']['charset'] ? $conf['strftime.']['charset'] : $GLOBALS['TSFE']->localeCharset;
2778 if ($tmp_charset) {
2779 $content = $GLOBALS['TSFE']->csConv($content, $tmp_charset);
2780 }
2781 return $content;
2782 }
2783
2784 /**
2785 * age
2786 * Will return the age of a given timestamp based on configuration given by stdWrap properties
2787 *
2788 * @param string $content Input value undergoing processing in this function.
2789 * @param array $conf stdWrap properties for age.
2790 * @return string The processed input value
2791 */
2792 public function stdWrap_age($content = '', $conf = array()) {
2793 return $this->calcAge($GLOBALS['EXEC_TIME'] - $content, $conf['age']);
2794 }
2795
2796 /**
2797 * case
2798 * Will transform the content to be upper or lower case only
2799 * Leaves HTML tags untouched
2800 *
2801 * @param string $content Input value undergoing processing in this function.
2802 * @param array $conf stdWrap properties for case.
2803 * @return string The processed input value
2804 */
2805 public function stdWrap_case($content = '', $conf = array()) {
2806 return $this->HTMLcaseshift($content, $conf['case']);
2807 }
2808
2809 /**
2810 * bytes
2811 * Will return the size of a given number in Bytes *
2812 *
2813 * @param string $content Input value undergoing processing in this function.
2814 * @param array $conf stdWrap properties for bytes.
2815 * @return string The processed input value
2816 */
2817 public function stdWrap_bytes($content = '', $conf = array()) {
2818 return GeneralUtility::formatSize($content, $conf['bytes.']['labels']);
2819 }
2820
2821 /**
2822 * substring
2823 * Will return a substring based on position information given by stdWrap properties
2824 *
2825 * @param string $content Input value undergoing processing in this function.
2826 * @param array $conf stdWrap properties for substring.
2827 * @return string The processed input value
2828 */
2829 public function stdWrap_substring($content = '', $conf = array()) {
2830 return $this->substring($content, $conf['substring']);
2831 }
2832
2833 /**
2834 * removeBadHTML
2835 * Removes HTML tags based on stdWrap properties
2836 *
2837 * @param string $content Input value undergoing processing in this function.
2838 * @param array $conf stdWrap properties for removeBadHTML.
2839 * @return string The processed input value
2840 */
2841 public function stdWrap_removeBadHTML($content = '', $conf = array()) {
2842 return $this->removeBadHTML($content, $conf['removeBadHTML.']);
2843 }
2844
2845 /**
2846 * cropHTML
2847 * Crops content to a given size while leaving HTML tags untouched
2848 *
2849 * @param string $content Input value undergoing processing in this function.