[SECURITY] XSS in colorpicker wizard
[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 * @todo Define visibility
707 */
708 public function cObjGetSingle($name, $conf, $TSkey = '__') {
709 global $TYPO3_CONF_VARS;
710 $content = '';
711 // Checking that the function is not called eternally. This is done by interrupting at a depth of 100
712 $GLOBALS['TSFE']->cObjectDepthCounter--;
713 if ($GLOBALS['TSFE']->cObjectDepthCounter > 0) {
714 $name = trim($name);
715 if ($GLOBALS['TT']->LR) {
716 $GLOBALS['TT']->push($TSkey, $name);
717 }
718 // Checking if the COBJ is a reference to another object. (eg. name of 'blabla.blabla = < styles.something')
719 if (substr($name, 0, 1) == '<') {
720 $key = trim(substr($name, 1));
721 $cF = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\TypoScript\\Parser\\TypoScriptParser');
722 // $name and $conf is loaded with the referenced values.
723 $old_conf = $conf;
724 list($name, $conf) = $cF->getVal($key, $GLOBALS['TSFE']->tmpl->setup);
725 if (is_array($old_conf) && count($old_conf)) {
726 $conf = $this->joinTSarrays($conf, $old_conf);
727 }
728 // Getting the cObject
729 $GLOBALS['TT']->incStackPointer();
730 $content .= $this->cObjGetSingle($name, $conf, $key);
731 $GLOBALS['TT']->decStackPointer();
732 } else {
733 $hooked = FALSE;
734 // Application defined cObjects
735 if (!empty($this->cObjHookObjectsArr[$name])) {
736 $hookObj = $this->cObjHookObjectsArr[$name];
737 if (method_exists($hookObj, 'cObjGetSingleExt')) {
738 $content .= $hookObj->cObjGetSingleExt($name, $conf, $TSkey, $this);
739 $hooked = TRUE;
740 }
741 }
742 if (!$hooked) {
743 $contentObject = $this->getContentObject($name);
744 if ($contentObject) {
745 $content .= $contentObject->render($conf);
746 } else {
747 // Call hook functions for extra processing
748 if ($name && is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClassDefault'])) {
749 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClassDefault'] as $classData) {
750 $hookObject = GeneralUtility::getUserObj($classData);
751 if (!$hookObject instanceof \TYPO3\CMS\Frontend\ContentObject\ContentObjectGetSingleHookInterface) {
752 throw new \UnexpectedValueException('$hookObject must implement interface TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectGetSingleHookInterface', 1195043731);
753 }
754 /** @var $hookObject \TYPO3\CMS\Frontend\ContentObject\ContentObjectGetSingleHookInterface */
755 $content .= $hookObject->getSingleContentObject($name, (array) $conf, $TSkey, $this);
756 }
757 } else {
758 // Log error in AdminPanel
759 $warning = sprintf('Content Object "%s" does not exist', $name);
760 $GLOBALS['TT']->setTSlogMessage($warning, 2);
761 }
762 }
763 }
764 }
765 if ($GLOBALS['TT']->LR) {
766 $GLOBALS['TT']->pull($content);
767 }
768 }
769 // Increasing on exit...
770 $GLOBALS['TSFE']->cObjectDepthCounter++;
771 return $content;
772 }
773
774 /**
775 * Returns a new content object of type $name.
776 *
777 * @param string $name
778 * @return AbstractContentObject
779 */
780 public function getContentObject($name) {
781 $classMapping = array(
782 'TEXT' => 'Text',
783 'CASE' => 'Case',
784 'CLEARGIF' => 'ClearGif',
785 'COBJ_ARRAY' => 'ContentObjectArray',
786 'COA' => 'ContentObjectArray',
787 'COA_INT' => 'ContentObjectArrayInternal',
788 'USER' => 'User',
789 'USER_INT' => 'UserInternal',
790 'FILE' => 'File',
791 'FILES' => 'Files',
792 'IMAGE' => 'Image',
793 'IMG_RESOURCE' => 'ImageResource',
794 'IMGTEXT' => 'ImageText',
795 'CONTENT' => 'Content',
796 'RECORDS' => 'Records',
797 'HMENU' => 'HierarchicalMenu',
798 'CTABLE' => 'ContentTable',
799 'OTABLE' => 'OffsetTable',
800 'COLUMNS' => 'Columns',
801 'HRULER' => 'HorizontalRuler',
802 'CASEFUNC' => 'Case',
803 'LOAD_REGISTER' => 'LoadRegister',
804 'RESTORE_REGISTER' => 'RestoreRegister',
805 'FORM' => 'Form',
806 'SEARCHRESULT' => 'SearchResult',
807 'TEMPLATE' => 'Template',
808 'FLUIDTEMPLATE' => 'FluidTemplate',
809 'MULTIMEDIA' => 'Multimedia',
810 'MEDIA' => 'Media',
811 'SWFOBJECT' => 'ShockwaveFlashObject',
812 'FLOWPLAYER' => 'FlowPlayer',
813 'QTOBJECT' => 'QuicktimeObject',
814 'SVG' => 'ScalableVectorGraphics',
815 'EDITPANEL' => 'EditPanel',
816 );
817 $name = $classMapping[$name];
818 if (!array_key_exists($name, $this->contentObjects)) {
819 try {
820 $this->contentObjects[$name] = GeneralUtility::makeInstance(
821 'TYPO3\\CMS\\Frontend\\ContentObject\\' . $name . 'ContentObject',
822 $this
823 );
824 } catch (\ReflectionException $e) {
825 $this->contentObjects[$name] = NULL;
826 }
827 }
828 return $this->contentObjects[$name];
829 }
830
831 /********************************************
832 *
833 * Functions rendering content objects (cObjects)
834 *
835 ********************************************/
836 /**
837 * Rendering the cObject, HTML
838 *
839 * @param array $conf Array of TypoScript properties
840 * @return string Output
841 * @deprecated since 6.0, will be removed in two versions
842 * @todo Define visibility
843 */
844 public function HTML($conf) {
845 GeneralUtility::logDeprecatedFunction();
846 return '';
847 }
848
849 /**
850 * Rendering the cObject, FLOWPLAYER
851 *
852 * @param array $conf Array of TypoScript properties
853 * @return string Output
854 * @todo Define visibility
855 */
856 public function FLOWPLAYER($conf) {
857 return $this->getContentObject('FLOWPLAYER')->render($conf);
858 }
859
860 /**
861 * Rendering the cObject, TEXT
862 *
863 * @param array $conf Array of TypoScript properties
864 * @return string Output
865 * @todo Define visibility
866 */
867 public function TEXT($conf) {
868 return $this->getContentObject('TEXT')->render($conf);
869 }
870
871 /**
872 * Rendering the cObject, CLEARGIF
873 *
874 * @param array $conf Array of TypoScript properties
875 * @return string Output
876 * @todo Define visibility
877 */
878 public function CLEARGIF($conf) {
879 return $this->getContentObject('CLEARGIF')->render($conf);
880 }
881
882 /**
883 * Rendering the cObject, COBJ_ARRAY / COA and COBJ_ARRAY_INT
884 *
885 * @param array $conf Array of TypoScript properties
886 * @param string $ext If "INT" then the cObject is a "COBJ_ARRAY_INT" (non-cached), otherwise just "COBJ_ARRAY" (cached)
887 * @return string Output
888 * @todo Define visibility
889 */
890 public function COBJ_ARRAY($conf, $ext = '') {
891 if ($ext === 'INT') {
892 return $this->getContentObject('COA_INT')->render($conf);
893 } else {
894 return $this->getContentObject('COA')->render($conf);
895 }
896 }
897
898 /**
899 * Rendering the cObject, USER and USER_INT
900 *
901 * @param array $conf Array of TypoScript properties
902 * @param string $ext If "INT" then the cObject is a "USER_INT" (non-cached), otherwise just "USER" (cached)
903 * @return string Output
904 * @todo Define visibility
905 */
906 public function USER($conf, $ext = '') {
907 if ($ext === 'INT') {
908 return $this->getContentObject('USER_INT')->render($conf);
909 } else {
910 return $this->getContentObject('USER')->render($conf);
911 }
912 }
913
914 /**
915 * Retrieves a type of object called as USER or USER_INT. Object can detect their
916 * type by using this call. It returns OBJECTTYPE_USER_INT or OBJECTTYPE_USER depending on the
917 * current object execution. In all other cases it will return FALSE to indicate
918 * a call out of context.
919 *
920 * @return mixed One of OBJECTTYPE_ class constants or FALSE
921 */
922 public function getUserObjectType() {
923 return $this->userObjectType;
924 }
925
926 /**
927 * Sets the user object type
928 *
929 * @param mixed $userObjectType
930 * @return void
931 */
932 public function setUserObjectType($userObjectType) {
933 $this->userObjectType = $userObjectType;
934 }
935
936 /**
937 * Requests the current USER object to be converted to USER_INT.
938 *
939 * @return void
940 */
941 public function convertToUserIntObject() {
942 if ($this->userObjectType !== self::OBJECTTYPE_USER) {
943 $GLOBALS['TT']->setTSlogMessage('TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectRenderer::convertToUserIntObject() ' . 'is called in the wrong context or for the wrong object type', 2);
944 } else {
945 $this->doConvertToUserIntObject = TRUE;
946 }
947 }
948
949 /**
950 * Rendering the cObject, FILE
951 *
952 * @param array $conf Array of TypoScript properties
953 * @return string Output
954 * @todo Define visibility
955 */
956 public function FILE($conf) {
957 return $this->getContentObject('FILE')->render($conf);
958 }
959
960 /**
961 * Rendering the cObject, FILES
962 *
963 * @param array $conf Array of TypoScript properties
964 * @return string Output
965 * @todo Define visibility
966 */
967 public function FILES($conf) {
968 return $this->getContentObject('FILES')->render($conf);
969 }
970
971 /**
972 * Rendering the cObject, IMAGE
973 *
974 * @param array $conf Array of TypoScript properties
975 * @return string Output
976 * @see cImage()
977 * @todo Define visibility
978 */
979 public function IMAGE($conf) {
980 return $this->getContentObject('IMAGE')->render($conf);
981 }
982
983 /**
984 * Rendering the cObject, IMG_RESOURCE
985 *
986 * @param array $conf Array of TypoScript properties
987 * @return string Output
988 * @see getImgResource()
989 * @todo Define visibility
990 */
991 public function IMG_RESOURCE($conf) {
992 return $this->getContentObject('IMG_RESOURCE')->render($conf);
993 }
994
995 /**
996 * Rendering the cObject, IMGTEXT
997 *
998 * @param array $conf Array of TypoScript properties
999 * @return string Output
1000 * @todo Define visibility
1001 */
1002 public function IMGTEXT($conf) {
1003 return $this->getContentObject('IMGTEXT')->render($conf);
1004 }
1005
1006 /**
1007 * Rendering the cObject, CONTENT
1008 *
1009 * @param array $conf Array of TypoScript properties
1010 * @return string Output
1011 * @todo Define visibility
1012 */
1013 public function CONTENT($conf) {
1014 return $this->getContentObject('CONTENT')->render($conf);
1015 }
1016
1017 /**
1018 * Rendering the cObject, RECORDS
1019 *
1020 * @param array $conf Array of TypoScript properties
1021 * @return string Output
1022 * @todo Define visibility
1023 */
1024 public function RECORDS($conf) {
1025 return $this->getContentObject('RECORDS')->render($conf);
1026 }
1027
1028 /**
1029 * Rendering the cObject, HMENU
1030 *
1031 * @param array $conf Array of TypoScript properties
1032 * @return string Output
1033 * @todo Define visibility
1034 */
1035 public function HMENU($conf) {
1036 return $this->getContentObject('HMENU')->render($conf);
1037 }
1038
1039 /**
1040 * Rendering the cObject, CTABLE
1041 *
1042 * @param array $conf Array of TypoScript properties
1043 * @return string Output
1044 * @todo Define visibility
1045 */
1046 public function CTABLE($conf) {
1047 return $this->getContentObject('CTABLE')->render($conf);
1048 }
1049
1050 /**
1051 * Rendering the cObject, OTABLE
1052 *
1053 * @param array $conf Array of TypoScript properties
1054 * @return string Output
1055 * @todo Define visibility
1056 */
1057 public function OTABLE($conf) {
1058 return $this->getContentObject('OTABLE')->render($conf);
1059 }
1060
1061 /**
1062 * Rendering the cObject, COLUMNS
1063 *
1064 * @param array $conf Array of TypoScript properties
1065 * @return string Output
1066 * @todo Define visibility
1067 */
1068 public function COLUMNS($conf) {
1069 return $this->getContentObject('COLUMNS')->render($conf);
1070 }
1071
1072 /**
1073 * Rendering the cObject, HRULER
1074 *
1075 * @param array $conf Array of TypoScript properties
1076 * @return string Output
1077 * @todo Define visibility
1078 */
1079 public function HRULER($conf) {
1080 return $this->getContentObject('HRULER')->render($conf);
1081 }
1082
1083 /**
1084 * Rendering the cObject, CASE
1085 *
1086 * @param array $conf Array of TypoScript properties
1087 * @return string Output
1088 * @todo Define visibility
1089 */
1090 public function CASEFUNC($conf) {
1091 return $this->getContentObject('CASE')->render($conf);
1092 }
1093
1094 /**
1095 * Rendering the cObject, LOAD_REGISTER and RESTORE_REGISTER
1096 * NOTICE: This cObject does NOT return any content since it just sets internal data based on the TypoScript properties.
1097 *
1098 * @param array $conf Array of TypoScript properties
1099 * @param string $name If "RESTORE_REGISTER" then the cObject rendered is "RESTORE_REGISTER", otherwise "LOAD_REGISTER
1100 * @return string Empty string (the cObject only sets internal data!)
1101 * @todo Define visibility
1102 */
1103 public function LOAD_REGISTER($conf, $name) {
1104 if ($name === 'RESTORE_REGISTER') {
1105 return $this->getContentObject('RESTORE_REGISTER')->render($conf);
1106 } else {
1107 return $this->getContentObject('LOAD_REGISTER')->render($conf);
1108 }
1109 }
1110
1111 /**
1112 * Rendering the cObject, FORM
1113 *
1114 * @param array $conf Array of TypoScript properties
1115 * @param array $formData Alternative formdata overriding whatever comes from TypoScript
1116 * @return string Output
1117 * @todo Define visibility
1118 */
1119 public function FORM($conf, $formData = '') {
1120 return $this->getContentObject('FORM')->render($conf, $formData);
1121 }
1122
1123 /**
1124 * Rendering the cObject, SEARCHRESULT
1125 *
1126 * @param array $conf Array of TypoScript properties
1127 * @return string Output
1128 * @todo Define visibility
1129 */
1130 public function SEARCHRESULT($conf) {
1131 return $this->getContentObject('SEARCHRESULT')->render($conf);
1132 }
1133
1134 /**
1135 * Rendering the cObject, PHP_SCRIPT, PHP_SCRIPT_INT and PHP_SCRIPT_EXT
1136 *
1137 * @param array $conf Array of TypoScript properties
1138 * @param string $ext If "INT", then rendering "PHP_SCRIPT_INT"; If "EXT", then rendering "PHP_SCRIPT_EXT"; Default is rendering "PHP_SCRIPT" (cached)
1139 * @return string Output
1140 * @deprecated and unused since 6.0, will be removed two versions later
1141 * @todo Define visibility
1142 */
1143 public function PHP_SCRIPT($conf, $ext = '') {
1144 GeneralUtility::logDeprecatedFunction();
1145 return '';
1146 }
1147
1148 /**
1149 * Rendering the cObject, TEMPLATE
1150 *
1151 * @param array $conf Array of TypoScript properties
1152 * @return string Output
1153 * @see substituteMarkerArrayCached()
1154 * @todo Define visibility
1155 */
1156 public function TEMPLATE($conf) {
1157 return $this->getContentObject('TEMPLATE')->render($conf);
1158 }
1159
1160 /**
1161 * Rendering the cObject, FLUIDTEMPLATE
1162 *
1163 * @param array $conf Array of TypoScript properties
1164 * @return string the HTML output
1165 * @author Steffen Ritter <info@steffen-ritter.net>
1166 * @author Benjamin Mack <benni@typo3.org>
1167 */
1168 protected function FLUIDTEMPLATE(array $conf) {
1169 return $this->getContentObject('FLUIDTEMPLATE')->render($conf);
1170 }
1171
1172 /**
1173 * Rendering the cObject, MULTIMEDIA
1174 *
1175 * @param array $conf Array of TypoScript properties
1176 * @return string Output
1177 * @todo Define visibility
1178 */
1179 public function MULTIMEDIA($conf) {
1180 return $this->getContentObject('MULTIMEDIA')->render($conf);
1181 }
1182
1183 /**
1184 * Rendering the cObject, MEDIA
1185 *
1186 * @param array $conf Array of TypoScript properties
1187 * @return string Output
1188 */
1189 public function MEDIA($conf) {
1190 return $this->getContentObject('MEDIA')->render($conf);
1191 }
1192
1193 /**
1194 * Rendering the cObject, SWFOBJECT
1195 *
1196 * @param array $conf Array of TypoScript properties
1197 * @return string Output
1198 */
1199 public function SWFOBJECT($conf) {
1200 return $this->getContentObject('SWFOBJECT')->render($conf);
1201 }
1202
1203 /**
1204 * Rendering the cObject, QTOBJECT
1205 *
1206 * @param array $conf Array of TypoScript properties
1207 * @return string Output
1208 */
1209 public function QTOBJECT($conf) {
1210 return $this->getContentObject('QTOBJECT')->render($conf);
1211 }
1212
1213 /**
1214 * Rendering the cObject, SVG
1215 *
1216 * @param array $conf Array of TypoScript properties
1217 * @return string Output
1218 */
1219 public function SVG($conf) {
1220 return $this->getContentObject('SVG')->render($conf);
1221 }
1222
1223 /************************************
1224 *
1225 * Various helper functions for content objects:
1226 *
1227 ************************************/
1228 /**
1229 * Converts a given config in Flexform to a conf-array
1230 *
1231 * @param string $flexData Flexform data
1232 * @param array $conf Array to write the data into, by reference
1233 * @param boolean $recursive Is set if called recursive. Don't call function with this parameter, it's used inside the function only
1234 * @return void
1235 * @access public
1236 */
1237 public function readFlexformIntoConf($flexData, &$conf, $recursive = FALSE) {
1238 if ($recursive === FALSE) {
1239 $flexData = GeneralUtility::xml2array($flexData, 'T3');
1240 }
1241 if (is_array($flexData)) {
1242 if (isset($flexData['data']['sDEF']['lDEF'])) {
1243 $flexData = $flexData['data']['sDEF']['lDEF'];
1244 }
1245 foreach ($flexData as $key => $value) {
1246 if (is_array($value['el']) && count($value['el']) > 0) {
1247 foreach ($value['el'] as $ekey => $element) {
1248 if (isset($element['vDEF'])) {
1249 $conf[$ekey] = $element['vDEF'];
1250 } else {
1251 if (is_array($element)) {
1252 $this->readFlexformIntoConf($element, $conf[$key][key($element)][$ekey], TRUE);
1253 } else {
1254 $this->readFlexformIntoConf($element, $conf[$key][$ekey], TRUE);
1255 }
1256 }
1257 }
1258 } else {
1259 $this->readFlexformIntoConf($value['el'], $conf[$key], TRUE);
1260 }
1261 if ($value['vDEF']) {
1262 $conf[$key] = $value['vDEF'];
1263 }
1264 }
1265 }
1266 }
1267
1268 /**
1269 * Returns all parents of the given PID (Page UID) list
1270 *
1271 * @param string $pidList A list of page Content-Element PIDs (Page UIDs) / stdWrap
1272 * @param array $pidConf stdWrap array for the list
1273 * @return string A list of PIDs
1274 * @access private
1275 * @todo Define visibility
1276 */
1277 public function getSlidePids($pidList, $pidConf) {
1278 $pidList = isset($pidConf) ? trim($this->stdWrap($pidList, $pidConf)) : trim($pidList);
1279 if (!strcmp($pidList, '')) {
1280 $pidList = 'this';
1281 }
1282 if (trim($pidList)) {
1283 $listArr = GeneralUtility::intExplode(',', str_replace('this', $GLOBALS['TSFE']->contentPid, $pidList));
1284 $listArr = $this->checkPidArray($listArr);
1285 }
1286 $pidList = array();
1287 if (is_array($listArr) && count($listArr)) {
1288 foreach ($listArr as $uid) {
1289 $page = $GLOBALS['TSFE']->sys_page->getPage($uid);
1290 if (!$page['is_siteroot']) {
1291 $pidList[] = $page['pid'];
1292 }
1293 }
1294 }
1295 return implode(',', $pidList);
1296 }
1297
1298 /**
1299 * Returns a default value for a form field in the FORM cObject.
1300 * Page CANNOT be cached because that would include the inserted value for the current user.
1301 *
1302 * @param boolean $noValueInsert If noValueInsert OR if the no_cache flag for this page is NOT set, the original default value is returned.
1303 * @param string $fieldName The POST var name to get default value for
1304 * @param string $defaultVal The current default value
1305 * @return string The default value, either from INPUT var or the current default, based on whether caching is enabled or not.
1306 * @access private
1307 * @todo Define visibility
1308 */
1309 public function getFieldDefaultValue($noValueInsert, $fieldName, $defaultVal) {
1310 if (!$GLOBALS['TSFE']->no_cache || !isset($_POST[$fieldName]) && !isset($_GET[$fieldName]) || $noValueInsert) {
1311 return $defaultVal;
1312 } else {
1313 return GeneralUtility::_GP($fieldName);
1314 }
1315 }
1316
1317 /**
1318 * Returns a <img> tag with the image file defined by $file and processed according to the properties in the TypoScript array.
1319 * Mostly this function is a sub-function to the IMAGE function which renders the IMAGE cObject in TypoScript.
1320 * This function is called by "$this->cImage($conf['file'], $conf);" from IMAGE().
1321 *
1322 * @param string $file File TypoScript resource
1323 * @param array $conf TypoScript configuration properties
1324 * @return string <img> tag, (possibly wrapped in links and other HTML) if any image found.
1325 * @access private
1326 * @see IMAGE()
1327 * @todo Define visibility
1328 */
1329 public function cImage($file, $conf) {
1330 $info = $this->getImgResource($file, $conf['file.']);
1331 $GLOBALS['TSFE']->lastImageInfo = $info;
1332 if (is_array($info)) {
1333 if (is_file(PATH_site . $info['3'])) {
1334 $source = GeneralUtility::rawUrlEncodeFP(GeneralUtility::png_to_gif_by_imagemagick($info[3]));
1335 $source = $GLOBALS['TSFE']->absRefPrefix . $source;
1336 } else {
1337 $source = $info[3];
1338 }
1339
1340 $layoutKey = $this->stdWrap($conf['layoutKey'], $conf['layoutKey.']);
1341 $imageTagTemplate = $this->getImageTagTemplate($layoutKey, $conf);
1342 $sourceCollection = $this->getImageSourceCollection($layoutKey, $conf, $file);
1343
1344 // This array is used to collect the image-refs on the page...
1345 $GLOBALS['TSFE']->imagesOnPage[] = $source;
1346 $altParam = $this->getAltParam($conf);
1347 $params = '';
1348 if ($conf['params'] && !isset($conf['params.'])) {
1349 $params = ' ' . $conf['params'];
1350 } elseif ($conf['params'] && is_array($conf['params.'])) {
1351 $params = ' ' . $this->stdWrap($conf['params'], $conf['params.']);
1352 }
1353
1354 $imageTagValues = array(
1355 'width' => $info[0],
1356 'height' => $info[1],
1357 'src' => htmlspecialchars($source),
1358 'params' => $params,
1359 'altParams' => $altParam,
1360 'border' => $this->getBorderAttr(' border="' . intval($conf['border']) . '"'),
1361 'sourceCollection' => $sourceCollection,
1362 'selfClosingTagSlash' => (!empty($GLOBALS['TSFE']->xhtmlDoctype) ? ' /' : ''),
1363 );
1364
1365 $theValue = $this->substituteMarkerArray($imageTagTemplate, $imageTagValues, '###|###', TRUE, TRUE);
1366
1367 $linkWrap = isset($conf['linkWrap.']) ? $this->stdWrap($conf['linkWrap'], $conf['linkWrap.']) : $conf['linkWrap'];
1368 if ($linkWrap) {
1369 $theValue = $this->linkWrap($theValue, $linkWrap);
1370 } elseif ($conf['imageLinkWrap']) {
1371 $theValue = $this->imageLinkWrap($theValue, $info['origFile'], $conf['imageLinkWrap.']);
1372 }
1373 $wrap = isset($conf['wrap.']) ? $this->stdWrap($conf['wrap'], $conf['wrap.']) : $conf['wrap'];
1374 if ($wrap) {
1375 $theValue = $this->wrap($theValue, $conf['wrap']);
1376 }
1377 return $theValue;
1378 }
1379 }
1380
1381 /**
1382 * Returns the 'border' attribute for an <img> tag only if the doctype is not xhtml_strict, xhtml_11, xhtml_2 or html5
1383 * or if the config parameter 'disableImgBorderAttr' is not set.
1384 *
1385 * @param string $borderAttr The border attribute
1386 * @return string The border attribute
1387 * @todo Define visibility
1388 */
1389 public function getBorderAttr($borderAttr) {
1390 if (!GeneralUtility::inList('xhtml_strict,xhtml_11,xhtml_2', $GLOBALS['TSFE']->xhtmlDoctype) && $GLOBALS['TSFE']->config['config']['doctype'] != 'html5' && !$GLOBALS['TSFE']->config['config']['disableImgBorderAttr']) {
1391 return $borderAttr;
1392 }
1393 }
1394
1395 /**
1396 * Returns the html-template for rendering the image-Tag if no template is defined via typoscript the
1397 * default <img> tag template is returned
1398 *
1399 * @param string $layoutKey rendering key
1400 * @param array $conf TypoScript configuration properties
1401 * @return string
1402 */
1403 public function getImageTagTemplate($layoutKey, $conf) {
1404 if ($layoutKey && isset($conf['layout.']) && isset($conf['layout.'][$layoutKey . '.'])) {
1405 $imageTagLayout = $this->stdWrap($conf['layout.'][$layoutKey . '.']['element'], $conf['layout.'][$layoutKey . '.']['element.']);
1406 } else {
1407 $imageTagLayout = '<img src="###SRC###" width="###WIDTH###" height="###HEIGHT###" ###PARAMS### ###ALTPARAMS### ###BORDER######SELFCLOSINGTAGSLASH###>';
1408 }
1409 return $imageTagLayout;
1410 }
1411
1412 /**
1413 * Render alternate sources for the image tag. If no source collection is given an empty string is returned.
1414 *
1415 * @param string $layoutKey rendering key
1416 * @param array $conf TypoScript configuration properties
1417 * @param string $file
1418 * @throws \UnexpectedValueException
1419 * @return string
1420 */
1421 public function getImageSourceCollection($layoutKey, $conf, $file) {
1422 $sourceCollection = '';
1423 if ($layoutKey && $conf['sourceCollection.'] && ($conf['layout.'][$layoutKey . '.']['source'] || $conf['layout.'][$layoutKey . '.']['source.'])) {
1424
1425 // find active sourceCollection
1426 $activeSourceCollections = array();
1427 foreach ($conf['sourceCollection.'] as $sourceCollectionKey => $sourceCollectionConfiguration) {
1428 if (substr($sourceCollectionKey, -1) == '.') {
1429 if (
1430 (isset($sourceCollectionConfiguration['if.']) && $this->checkIf($sourceCollectionConfiguration['if.']))
1431 || !isset($sourceCollectionConfiguration['if.'])
1432 ) {
1433 $activeSourceCollections[] = $sourceCollectionConfiguration;
1434 }
1435 }
1436 }
1437
1438 // apply option split to configurations
1439 $srcLayoutOptionSplitted = $GLOBALS['TSFE']->tmpl->splitConfArray($conf['layout.'][$layoutKey . '.'], count($activeSourceCollections));
1440
1441 // render sources
1442 foreach ($activeSourceCollections as $key => $sourceConfiguration) {
1443 $sourceLayout = $this->stdWrap($srcLayoutOptionSplitted[$key]['source'], $srcLayoutOptionSplitted[$key]['source.']);
1444
1445 $sourceRenderConfiguration = array (
1446 'file' => $file,
1447 'file.' => $conf['file.']
1448 );
1449
1450 if (isset($sourceConfiguration['pixelDensity'])) {
1451 $pixelDensity = (int) $this->stdWrap($sourceConfiguration['pixelDensity'], $sourceConfiguration['pixelDensity.']);
1452 } else {
1453 $pixelDensity = 1;
1454 }
1455 $dimensionKeys = array('width', 'height', 'maxW', 'minW', 'maxH', 'minH');
1456 foreach ($dimensionKeys as $dimensionKey) {
1457 $dimension = $this->stdWrap($sourceConfiguration[$dimensionKey], $sourceConfiguration[$dimensionKey . '.']);
1458 if (!$dimension && isset($conf['file.'][$dimensionKey])) {
1459 $dimension = $this->stdWrap($conf['file.'][$dimensionKey], $conf['file.'][$dimensionKey . '.']);
1460 }
1461 if ($dimension) {
1462 if (strstr($dimension, 'c') !== FALSE && ($dimensionKey === 'width' || $dimensionKey === 'height')) {
1463 $dimensionParts = explode('c', $dimension, 2);
1464 $dimension = intval($dimensionParts[0] * $pixelDensity) . 'c';
1465 if ($dimensionParts[1]) {
1466 $dimension .= $dimensionParts[1];
1467 }
1468 } else {
1469 $dimension = intval($dimension * $pixelDensity);
1470 }
1471 $sourceRenderConfiguration['file.'][$dimensionKey] = $dimension;
1472 }
1473 }
1474
1475 $sourceInfo = $this->getImgResource($sourceRenderConfiguration['file'], $sourceRenderConfiguration['file.']);
1476 $sourceConfiguration['width'] = $sourceInfo[0];
1477 $sourceConfiguration['height'] = $sourceInfo[1];
1478 $sourceConfiguration['src'] = htmlspecialchars($sourceInfo[3]);
1479 $sourceConfiguration['selfClosingTagSlash'] = (!empty($GLOBALS['TSFE']->xhtmlDoctype) ? ' /' : '');
1480
1481 $oneSourceCollection = $this->substituteMarkerArray($sourceLayout, $sourceConfiguration, '###|###', TRUE, TRUE);
1482
1483 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getImageSourceCollection'])) {
1484 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getImageSourceCollection'] as $classData) {
1485 $hookObject = GeneralUtility::getUserObj($classData);
1486 if (!$hookObject instanceof ContentObjectOneSourceCollectionHookInterface) {
1487 throw new \UnexpectedValueException(
1488 '$hookObject must implement interface TYPO3\\CMS\\Frontend\\ContentObject\\ContentObjectOneSourceCollectionHookInterface',
1489 1380007853
1490 );
1491 }
1492 /** @var $hookObject \TYPO3\CMS\Frontend\ContentObject\ContentObjectGetSingleHookInterface */
1493 $oneSourceCollection = $hookObject->getOneSourceCollection((array) $sourceRenderConfiguration, (array) $sourceConfiguration, $oneSourceCollection, $this);
1494 }
1495 }
1496
1497 $sourceCollection .= $oneSourceCollection;
1498 }
1499 }
1500 return $sourceCollection;
1501 }
1502
1503 /**
1504 * Wraps the input string in link-tags that opens the image in a new window.
1505 *
1506 * @param string $string String to wrap, probably an <img> tag
1507 * @param string $imageFile The original image file
1508 * @param array $conf TypoScript properties for the "imageLinkWrap" function
1509 * @return string The input string, $string, wrapped as configured.
1510 * @see cImage()
1511 * @todo Define visibility
1512 */
1513 public function imageLinkWrap($string, $imageFile, $conf) {
1514 $a1 = '';
1515 $a2 = '';
1516 $content = $string;
1517 $enable = isset($conf['enable.']) ? $this->stdWrap($conf['enable'], $conf['enable.']) : $conf['enable'];
1518 if ($enable) {
1519 $content = $this->typolink($string, $conf['typolink.']);
1520 if (isset($conf['file.'])) {
1521 $imageFile = $this->stdWrap($imageFile, $conf['file.']);
1522 }
1523 // Create imageFileLink if not created with typolink
1524 if ($content == $string) {
1525 $parameterNames = array('width', 'height', 'effects', 'alternativeTempPath', 'bodyTag', 'title', 'wrap');
1526 $parameters = array();
1527 $sample = isset($conf['sample.']) ? $this->stdWrap($conf['sample'], $conf['sample.']) : $conf['sample'];
1528 if ($sample) {
1529 $parameters['sample'] = 1;
1530 }
1531 foreach ($parameterNames as $parameterName) {
1532 if (isset($conf[$parameterName . '.'])) {
1533 $conf[$parameterName] = $this->stdWrap($conf[$parameterName], $conf[$parameterName . '.']);
1534 }
1535 if (isset($conf[$parameterName]) && $conf[$parameterName]) {
1536 $parameters[$parameterName] = $conf[$parameterName];
1537 }
1538 }
1539 $parametersEncoded = base64_encode(serialize($parameters));
1540 $md5_value = GeneralUtility::hmac(implode('|', array($imageFile, $parametersEncoded)));
1541 $params = '&md5=' . $md5_value;
1542 foreach (str_split($parametersEncoded, 64) as $index => $chunk) {
1543 $params .= '&parameters' . rawurlencode('[') . $index . rawurlencode(']') . '=' . rawurlencode($chunk);
1544 }
1545 $url = $GLOBALS['TSFE']->absRefPrefix . 'index.php?eID=tx_cms_showpic&file=' . rawurlencode($imageFile) . $params;
1546 $directImageLink = isset($conf['directImageLink.']) ? $this->stdWrap($conf['directImageLink'], $conf['directImageLink.']) : $conf['directImageLink'];
1547 if ($directImageLink) {
1548 $imgResourceConf = array(
1549 'file' => $imageFile,
1550 'file.' => $conf
1551 );
1552 $url = $this->IMG_RESOURCE($imgResourceConf);
1553 if (!$url) {
1554 // If no imagemagick / gm is available
1555 $url = $imageFile;
1556 }
1557 }
1558 // Create TARGET-attribute only if the right doctype is used
1559 if (!GeneralUtility::inList('xhtml_strict,xhtml_11,xhtml_2', $GLOBALS['TSFE']->xhtmlDoctype)) {
1560 $target = isset($conf['target.']) ? $this->stdWrap($conf['target'], $conf['target.']) : $conf['target'];
1561 if ($target) {
1562 $target = sprintf(' target="%s"', $target);
1563 } else {
1564 $target = ' target="thePicture"';
1565 }
1566 } else {
1567 $target = '';
1568 }
1569 $conf['JSwindow'] = isset($conf['JSwindow.']) ? $this->stdWrap($conf['JSwindow'], $conf['JSwindow.']) : $conf['JSwindow'];
1570 if ($conf['JSwindow']) {
1571 if ($conf['JSwindow.']['altUrl'] || $conf['JSwindow.']['altUrl.']) {
1572 $altUrl = isset($conf['JSwindow.']['altUrl.']) ? $this->stdWrap($conf['JSwindow.']['altUrl'], $conf['JSwindow.']['altUrl.']) : $conf['JSwindow.']['altUrl'];
1573 if ($altUrl) {
1574 $url = $altUrl . ($conf['JSwindow.']['altUrl_noDefaultParams'] ? '' : '?file=' . rawurlencode($imageFile) . $params);
1575 }
1576 }
1577 $gifCreator = GeneralUtility::makeInstance('TYPO3\\CMS\\Frontend\\Imaging\\GifBuilder');
1578 $gifCreator->init();
1579 $gifCreator->mayScaleUp = 0;
1580 $dims = $gifCreator->getImageScale($gifCreator->getImageDimensions($imageFile), $conf['width'], $conf['height'], array());
1581 $JSwindowExpand = isset($conf['JSwindow.']['expand.']) ? $this->stdWrap($conf['JSwindow.']['expand'], $conf['JSwindow.']['expand.']) : $conf['JSwindow.']['expand'];
1582 $offset = GeneralUtility::intExplode(',', $JSwindowExpand . ',');
1583 $newWindow = isset($conf['JSwindow.']['newWindow.']) ? $this->stdWrap($conf['JSwindow.']['newWindow'], $conf['JSwindow.']['newWindow.']) : $conf['JSwindow.']['newWindow'];
1584 $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 . '>';
1585 $a2 = '</a>';
1586 $GLOBALS['TSFE']->setJS('openPic');
1587 } else {
1588 $conf['linkParams.']['parameter'] = $url;
1589 $string = $this->typoLink($string, $conf['linkParams.']);
1590 }
1591 if (isset($conf['stdWrap.'])) {
1592 $string = $this->stdWrap($string, $conf['stdWrap.']);
1593 }
1594 $content = $a1 . $string . $a2;
1595 }
1596 }
1597 return $content;
1598 }
1599
1600 /**
1601 * Returns content of a file. If it's an image the content of the file is not returned but rather an image tag is.
1602 *
1603 * @param string $fName The filename, being a TypoScript resource data type
1604 * @param string $addParams Additional parameters (attributes). Default is empty alt and title tags.
1605 * @return string If jpg,gif,jpeg,png: returns image_tag with picture in. If html,txt: returns content string
1606 * @see FILE()
1607 * @todo Define visibility
1608 */
1609 public function fileResource($fName, $addParams = 'alt="" title=""') {
1610 $incFile = $GLOBALS['TSFE']->tmpl->getFileName($fName);
1611 if ($incFile) {
1612 $fileinfo = GeneralUtility::split_fileref($incFile);
1613 if (GeneralUtility::inList('jpg,gif,jpeg,png', $fileinfo['fileext'])) {
1614 $imgFile = $incFile;
1615 $imgInfo = @getImageSize($imgFile);
1616 return '<img src="' . $GLOBALS['TSFE']->absRefPrefix . $imgFile . '" width="' . $imgInfo[0] . '" height="' . $imgInfo[1] . '"' . $this->getBorderAttr(' border="0"') . ' ' . $addParams . ' />';
1617 } elseif (filesize($incFile) < 1024 * 1024) {
1618 return $GLOBALS['TSFE']->tmpl->fileContent($incFile);
1619 }
1620 }
1621 }
1622
1623 /**
1624 * Sets the SYS_LASTCHANGED timestamp if input timestamp is larger than current value.
1625 * The SYS_LASTCHANGED timestamp can be used by various caching/indexing applications to determine if the page has new content.
1626 * Therefore you should call this function with the last-changed timestamp of any element you display.
1627 *
1628 * @param integer $tstamp Unix timestamp (number of seconds since 1970)
1629 * @return void
1630 * @see \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::setSysLastChanged()
1631 * @todo Define visibility
1632 */
1633 public function lastChanged($tstamp) {
1634 $tstamp = intval($tstamp);
1635 if ($tstamp > intval($GLOBALS['TSFE']->register['SYS_LASTCHANGED'])) {
1636 $GLOBALS['TSFE']->register['SYS_LASTCHANGED'] = $tstamp;
1637 }
1638 }
1639
1640 /**
1641 * Wraps the input string by the $wrap value and implements the "linkWrap" data type as well.
1642 * 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.
1643 *
1644 * @param string $content Input string
1645 * @param string $wrap A string where the first two parts separated by "|" (vertical line) will be wrapped around the input string
1646 * @return string Wrapped output string
1647 * @see wrap(), cImage(), FILE()
1648 * @todo Define visibility
1649 */
1650 public function linkWrap($content, $wrap) {
1651 $wrapArr = explode('|', $wrap);
1652 if (preg_match('/\\{([0-9]*)\\}/', $wrapArr[0], $reg)) {
1653 if ($uid = $GLOBALS['TSFE']->tmpl->rootLine[$reg[1]]['uid']) {
1654 $wrapArr[0] = str_replace($reg[0], $uid, $wrapArr[0]);
1655 }
1656 }
1657 return trim($wrapArr[0]) . $content . trim($wrapArr[1]);
1658 }
1659
1660 /**
1661 * An abstraction method which creates an alt or title parameter for an HTML img, applet, area or input element and the FILE content element.
1662 * From the $conf array it implements the properties "altText", "titleText" and "longdescURL"
1663 *
1664 * @param array $conf TypoScript configuration properties
1665 * @param boolean $longDesc If set, the longdesc attribute will be generated - must only be used for img elements!
1666 * @return string Parameter string containing alt and title parameters (if any)
1667 * @see IMGTEXT(), FILE(), FORM(), cImage(), filelink()
1668 * @todo Define visibility
1669 */
1670 public function getAltParam($conf, $longDesc = TRUE) {
1671 $altText = isset($conf['altText.']) ? trim($this->stdWrap($conf['altText'], $conf['altText.'])) : trim($conf['altText']);
1672 $titleText = isset($conf['titleText.']) ? trim($this->stdWrap($conf['titleText'], $conf['titleText.'])) : trim($conf['titleText']);
1673 if (isset($conf['longdescURL.']) && $GLOBALS['TSFE']->config['config']['doctype'] != 'html5') {
1674 $longDesc = $this->typoLink_URL($conf['longdescURL.']);
1675 } else {
1676 $longDesc = trim($conf['longdescURL']);
1677 }
1678 // "alt":
1679 $altParam = ' alt="' . htmlspecialchars($altText) . '"';
1680 // "title":
1681 $emptyTitleHandling = 'useAlt';
1682 $emptyTitleHandling = isset($conf['emptyTitleHandling.']) ? $this->stdWrap($conf['emptyTitleHandling'], $conf['emptyTitleHandling.']) : $conf['emptyTitleHandling'];
1683 // Choices: 'keepEmpty' | 'useAlt' | 'removeAttr'
1684 if ($titleText || $emptyTitleHandling == 'keepEmpty') {
1685 $altParam .= ' title="' . htmlspecialchars($titleText) . '"';
1686 } elseif (!$titleText && $emptyTitleHandling == 'useAlt') {
1687 $altParam .= ' title="' . htmlspecialchars($altText) . '"';
1688 }
1689 // "longDesc" URL
1690 if ($longDesc) {
1691 $altParam .= ' longdesc="' . htmlspecialchars(strip_tags($longDesc)) . '"';
1692 }
1693 return $altParam;
1694 }
1695
1696 /**
1697 * Removes forbidden characters and spaces from name/id attributes in the form tag and formfields
1698 *
1699 * @param string $name Input string
1700 * @return string the cleaned string
1701 * @see FORM()
1702 * @todo Define visibility
1703 */
1704 public function cleanFormName($name) {
1705 // Turn data[x][y] into data:x:y:
1706 $name = preg_replace('/\\[|\\]\\[?/', ':', trim($name));
1707 // Remove illegal chars like _
1708 return preg_replace('#[^:a-zA-Z0-9]#', '', $name);
1709 }
1710
1711 /**
1712 * An abstraction method to add parameters to an A tag.
1713 * Uses the ATagParams property.
1714 *
1715 * @param array $conf TypoScript configuration properties
1716 * @param boolean $addGlobal If set, will add the global config.ATagParams to the link
1717 * @return string String containing the parameters to the A tag (if non empty, with a leading space)
1718 * @see IMGTEXT(), filelink(), makelinks(), typolink()
1719 * @todo Define visibility
1720 */
1721 public function getATagParams($conf, $addGlobal = 1) {
1722 $aTagParams = '';
1723 if ($conf['ATagParams.']) {
1724 $aTagParams = ' ' . $this->stdWrap($conf['ATagParams'], $conf['ATagParams.']);
1725 } elseif ($conf['ATagParams']) {
1726 $aTagParams = ' ' . $conf['ATagParams'];
1727 }
1728 if ($addGlobal) {
1729 $aTagParams = ' ' . trim(($GLOBALS['TSFE']->ATagParams . $aTagParams));
1730 }
1731 // Extend params
1732 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'])) {
1733 $_params = array(
1734 'conf' => &$conf,
1735 'aTagParams' => &$aTagParams
1736 );
1737 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getATagParamsPostProc'] as $objRef) {
1738 $processor =& GeneralUtility::getUserObj($objRef);
1739 $aTagParams = $processor->process($_params, $this);
1740 }
1741 }
1742
1743 $aTagParams = trim($aTagParams);
1744 if (!empty($aTagParams)) {
1745 $aTagParams = ' ' . $aTagParams;
1746 }
1747
1748 return $aTagParams;
1749 }
1750
1751 /**
1752 * All extension links should ask this function for additional properties to their tags.
1753 * Designed to add for instance an "onclick" property for site tracking systems.
1754 *
1755 * @param string $URL URL of the website
1756 * @param string $TYPE
1757 * @return string The additional tag properties
1758 * @todo Define visibility
1759 */
1760 public function extLinkATagParams($URL, $TYPE) {
1761 $out = '';
1762 if ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['extLinkATagParamsHandler']) {
1763 $extLinkATagParamsHandler = GeneralUtility::getUserObj($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['extLinkATagParamsHandler']);
1764 if (method_exists($extLinkATagParamsHandler, 'main')) {
1765 $out .= trim($extLinkATagParamsHandler->main($URL, $TYPE, $this));
1766 }
1767 }
1768 return trim($out) ? ' ' . trim($out) : '';
1769 }
1770
1771 /***********************************************
1772 *
1773 * HTML template processing functions
1774 *
1775 ***********************************************/
1776 /**
1777 * Returns a subpart from the input content stream.
1778 * A subpart is a part of the input stream which is encapsulated in a
1779 * string matching the input string, $marker. If this string is found
1780 * inside of HTML comment tags the start/end points of the content block
1781 * returned will be that right outside that comment block.
1782 * Example: The contennt string is
1783 * "Hello <!--###sub1### begin--> World. How are <!--###sub1### end--> you?"
1784 * If $marker is "###sub1###" then the content returned is
1785 * " World. How are ". The input content string could just as well have
1786 * been "Hello ###sub1### World. How are ###sub1### you?" and the result
1787 * would be the same
1788 * Wrapper for \TYPO3\CMS\Core\Html\HtmlParser::getSubpart which behaves identical
1789 *
1790 * @param string $content The content stream, typically HTML template content.
1791 * @param string $marker The marker string, typically on the form "###[the marker string]###
1792 * @return string The subpart found, if found.
1793 */
1794 public function getSubpart($content, $marker) {
1795 return \TYPO3\CMS\Core\Html\HtmlParser::getSubpart($content, $marker);
1796 }
1797
1798 /**
1799 * Substitute subpart in input template stream.
1800 * This function substitutes a subpart in $content with the content of
1801 * $subpartContent.
1802 * Wrapper for \TYPO3\CMS\Core\Html\HtmlParser::substituteSubpart which behaves identical
1803 *
1804 * @param string $content The content stream, typically HTML template content.
1805 * @param string $marker The marker string, typically on the form "###[the marker string]###
1806 * @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.
1807 * @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!
1808 * @return string The processed HTML content string.
1809 */
1810 public function substituteSubpart($content, $marker, $subpartContent, $recursive = 1) {
1811 return \TYPO3\CMS\Core\Html\HtmlParser::substituteSubpart($content, $marker, $subpartContent, $recursive);
1812 }
1813
1814 /**
1815 * Substitues multiple subparts at once
1816 *
1817 * @param string $content The content stream, typically HTML template content.
1818 * @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.
1819 * @return string The processed HTML content string.
1820 */
1821 public function substituteSubpartArray($content, array $subpartsContent) {
1822 return \TYPO3\CMS\Core\Html\HtmlParser::substituteSubpartArray($content, $subpartsContent);
1823 }
1824
1825 /**
1826 * Substitutes a marker string in the input content
1827 * (by a simple str_replace())
1828 *
1829 * @param string $content The content stream, typically HTML template content.
1830 * @param string $marker The marker string, typically on the form "###[the marker string]###
1831 * @param mixed $markContent The content to insert instead of the marker string found.
1832 * @return string The processed HTML content string.
1833 * @see substituteSubpart()
1834 */
1835 public function substituteMarker($content, $marker, $markContent) {
1836 return \TYPO3\CMS\Core\Html\HtmlParser::substituteMarker($content, $marker, $markContent);
1837 }
1838
1839 /**
1840 * Multi substitution function with caching.
1841 *
1842 * This function should be a one-stop substitution function for working
1843 * with HTML-template. It does not substitute by str_replace but by
1844 * splitting. This secures that the value inserted does not themselves
1845 * contain markers or subparts.
1846 *
1847 * Note that the "caching" won't cache the content of the substition,
1848 * but only the splitting of the template in various parts. So if you
1849 * want only one cache-entry per template, make sure you always pass the
1850 * exact same set of marker/subpart keys. Else you will be flooding the
1851 * users cache table.
1852 *
1853 * This function takes three kinds of substitutions in one:
1854 * $markContentArray is a regular marker-array where the 'keys' are
1855 * substituted in $content with their values
1856 *
1857 * $subpartContentArray works exactly like markContentArray only is whole
1858 * subparts substituted and not only a single marker.
1859 *
1860 * $wrappedSubpartContentArray is an array of arrays with 0/1 keys where
1861 * the subparts pointed to by the main key is wrapped with the 0/1 value
1862 * alternating.
1863 *
1864 * @param string $content The content stream, typically HTML template content.
1865 * @param array $markContentArray Regular marker-array where the 'keys' are substituted in $content with their values
1866 * @param array $subpartContentArray Exactly like markContentArray only is whole subparts substituted and not only a single marker.
1867 * @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.
1868 * @return string The output content stream
1869 * @see substituteSubpart(), substituteMarker(), substituteMarkerInObject(), TEMPLATE()
1870 */
1871 public function substituteMarkerArrayCached($content, array $markContentArray = NULL, array $subpartContentArray = NULL, array $wrappedSubpartContentArray = NULL) {
1872 $GLOBALS['TT']->push('substituteMarkerArrayCached');
1873 // If not arrays then set them
1874 if (is_null($markContentArray)) {
1875 // Plain markers
1876 $markContentArray = array();
1877 }
1878 if (is_null($subpartContentArray)) {
1879 // Subparts being directly substituted
1880 $subpartContentArray = array();
1881 }
1882 if (is_null($wrappedSubpartContentArray)) {
1883 // Subparts being wrapped
1884 $wrappedSubpartContentArray = array();
1885 }
1886 // Finding keys and check hash:
1887 $sPkeys = array_keys($subpartContentArray);
1888 $wPkeys = array_keys($wrappedSubpartContentArray);
1889 $aKeys = array_merge(array_keys($markContentArray), $sPkeys, $wPkeys);
1890 if (!count($aKeys)) {
1891 $GLOBALS['TT']->pull();
1892 return $content;
1893 }
1894 asort($aKeys);
1895 $storeKey = md5('substituteMarkerArrayCached_storeKey:' . serialize(array(
1896 $content,
1897 $aKeys
1898 )));
1899 if ($this->substMarkerCache[$storeKey]) {
1900 $storeArr = $this->substMarkerCache[$storeKey];
1901 $GLOBALS['TT']->setTSlogMessage('Cached', 0);
1902 } else {
1903 $storeArrDat = $GLOBALS['TSFE']->sys_page->getHash($storeKey);
1904 if (is_array($storeArrDat)) {
1905 $storeArr = $storeArrDat;
1906 // Setting cache:
1907 $this->substMarkerCache[$storeKey] = $storeArr;
1908 $GLOBALS['TT']->setTSlogMessage('Cached from DB', 0);
1909 } else {
1910 // Initialize storeArr
1911 $storeArr = array();
1912 // Finding subparts and substituting them with the subpart as a marker
1913 foreach ($sPkeys as $sPK) {
1914 $content = $this->substituteSubpart($content, $sPK, $sPK);
1915 }
1916 // Finding subparts and wrapping them with markers
1917 foreach ($wPkeys as $wPK) {
1918 $content = $this->substituteSubpart($content, $wPK, array(
1919 $wPK,
1920 $wPK
1921 ));
1922 }
1923 // Traverse keys and quote them for reg ex.
1924 foreach ($aKeys as $tK => $tV) {
1925 $aKeys[$tK] = preg_quote($tV, '/');
1926 }
1927 $regex = '/' . implode('|', $aKeys) . '/';
1928 // Doing regex's
1929 $storeArr['c'] = preg_split($regex, $content);
1930 preg_match_all($regex, $content, $keyList);
1931 $storeArr['k'] = $keyList[0];
1932 // Setting cache:
1933 $this->substMarkerCache[$storeKey] = $storeArr;
1934 // Storing the cached data:
1935 $GLOBALS['TSFE']->sys_page->storeHash($storeKey, $storeArr, 'substMarkArrayCached');
1936 $GLOBALS['TT']->setTSlogMessage('Parsing', 0);
1937 }
1938 }
1939 // Substitution/Merging:
1940 // Merging content types together, resetting
1941 $valueArr = array_merge($markContentArray, $subpartContentArray, $wrappedSubpartContentArray);
1942 $wSCA_reg = array();
1943 $content = '';
1944 // Traversing the keyList array and merging the static and dynamic content
1945 foreach ($storeArr['k'] as $n => $keyN) {
1946 $content .= $storeArr['c'][$n];
1947 if (!is_array($valueArr[$keyN])) {
1948 $content .= $valueArr[$keyN];
1949 } else {
1950 $content .= $valueArr[$keyN][intval($wSCA_reg[$keyN]) % 2];
1951 $wSCA_reg[$keyN]++;
1952 }
1953 }
1954 $content .= $storeArr['c'][count($storeArr['k'])];
1955 $GLOBALS['TT']->pull();
1956 return $content;
1957 }
1958
1959 /**
1960 * Traverses the input $markContentArray array and for each key the marker
1961 * by the same name (possibly wrapped and in upper case) will be
1962 * substituted with the keys value in the array.
1963 *
1964 * This is very useful if you have a data-record to substitute in some
1965 * content. In particular when you use the $wrap and $uppercase values to
1966 * pre-process the markers. Eg. a key name like "myfield" could effectively
1967 * be represented by the marker "###MYFIELD###" if the wrap value
1968 * was "###|###" and the $uppercase boolean TRUE.
1969 *
1970 * @param string $content The content stream, typically HTML template content.
1971 * @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.
1972 * @param string $wrap A wrap value - [part 1] | [part 2] - for the markers before substitution
1973 * @param boolean $uppercase If set, all marker string substitution is done with upper-case markers.
1974 * @param boolean $deleteUnused If set, all unused marker are deleted.
1975 * @return string The processed output stream
1976 * @see substituteMarker(), substituteMarkerInObject(), TEMPLATE()
1977 */
1978 public function substituteMarkerArray($content, array $markContentArray, $wrap = '', $uppercase = FALSE, $deleteUnused = FALSE) {
1979 return \TYPO3\CMS\Core\Html\HtmlParser::substituteMarkerArray($content, $markContentArray, $wrap, $uppercase, $deleteUnused);
1980 }
1981
1982 /**
1983 * Substitute marker array in an array of values
1984 *
1985 * @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)
1986 * @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.
1987 * @return mixed The processed input variable.
1988 * @see substituteMarker()
1989 */
1990 public function substituteMarkerInObject(&$tree, array $markContentArray) {
1991 if (is_array($tree)) {
1992 foreach ($tree as $key => $value) {
1993 $this->substituteMarkerInObject($tree[$key], $markContentArray);
1994 }
1995 } else {
1996 $tree = $this->substituteMarkerArray($tree, $markContentArray);
1997 }
1998 return $tree;
1999 }
2000
2001 /**
2002 * Replaces all markers and subparts in a template with the content provided in the structured array.
2003 *
2004 * @param string $content
2005 * @param array $markersAndSubparts
2006 * @param string $wrap
2007 * @param boolean $uppercase
2008 * @param boolean $deleteUnused
2009 * @return string
2010 */
2011 public function substituteMarkerAndSubpartArrayRecursive($content, array $markersAndSubparts, $wrap = '', $uppercase = FALSE, $deleteUnused = FALSE) {
2012 return \TYPO3\CMS\Core\Html\HtmlParser::substituteMarkerAndSubpartArrayRecursive($content, $markersAndSubparts, $wrap, $uppercase, $deleteUnused);
2013 }
2014
2015 /**
2016 * Adds elements to the input $markContentArray based on the values from
2017 * the fields from $fieldList found in $row
2018 *
2019 * @param array $markContentArray Array with key/values being marker-strings/substitution values.
2020 * @param array $row An array with keys found in the $fieldList (typically a record) which values should be moved to the $markContentArray
2021 * @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)
2022 * @param boolean $nl2br If set, all values added to $markContentArray will be nl2br()'ed
2023 * @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 "###
2024 * @param boolean $HSC If set, all values are passed through htmlspecialchars() - RECOMMENDED to avoid most obvious XSS and maintain XHTML compliance.
2025 * @return array The modified $markContentArray
2026 */
2027 public function fillInMarkerArray(array $markContentArray, array $row, $fieldList = '', $nl2br = TRUE, $prefix = 'FIELD_', $HSC = FALSE) {
2028 if ($fieldList) {
2029 $fArr = GeneralUtility::trimExplode(',', $fieldList, TRUE);
2030 foreach ($fArr as $field) {
2031 $markContentArray['###' . $prefix . $field . '###'] = $nl2br ? nl2br($row[$field], !empty($GLOBALS['TSFE']->xhtmlDoctype)) : $row[$field];
2032 }
2033 } else {
2034 if (is_array($row)) {
2035 foreach ($row as $field => $value) {
2036 if (!\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($field)) {
2037 if ($HSC) {
2038 $value = htmlspecialchars($value);
2039 }
2040 $markContentArray['###' . $prefix . $field . '###'] = $nl2br ? nl2br($value, !empty($GLOBALS['TSFE']->xhtmlDoctype)) : $value;
2041 }
2042 }
2043 }
2044 }
2045 return $markContentArray;
2046 }
2047
2048 /**
2049 * Sets the current file object during iterations over files.
2050 *
2051 * @param \TYPO3\CMS\Core\Resource\File $fileObject The file object.
2052 */
2053 public function setCurrentFile($fileObject) {
2054 $this->currentFile = $fileObject;
2055 }
2056
2057 /**
2058 * Gets the current file object during iterations over files.
2059 *
2060 * @return \TYPO3\CMS\Core\Resource\File The current file object.
2061 */
2062 public function getCurrentFile() {
2063 return $this->currentFile;
2064 }
2065
2066 /***********************************************
2067 *
2068 * "stdWrap" + sub functions
2069 *
2070 ***********************************************/
2071 /**
2072 * The "stdWrap" function. This is the implementation of what is known as "stdWrap properties" in TypoScript.
2073 * Basically "stdWrap" performs some processing of a value based on properties in the input $conf array(holding the TypoScript "stdWrap properties")
2074 * 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.
2075 *
2076 * If $this->alternativeData is an array it's used instead of the $this->data array in ->getData
2077 *
2078 * @param string $content Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
2079 * @param array $conf TypoScript "stdWrap properties".
2080 * @return string The processed input value
2081 */
2082 public function stdWrap($content = '', $conf = array()) {
2083 if (count($this->stdWrapHookObjects)) {
2084 foreach ($this->stdWrapHookObjects as $hookObject) {
2085 if (is_callable(array($hookObject, 'stdWrapPreProcess'))) {
2086 $conf['stdWrapPreProcess'] = 1;
2087 }
2088 if (is_callable(array($hookObject, 'stdWrapOverride'))) {
2089 $conf['stdWrapOverride'] = 1;
2090 }
2091 if (is_callable(array($hookObject, 'stdWrapProcess'))) {
2092 $conf['stdWrapProcess'] = 1;
2093 }
2094 if (is_callable(array($hookObject, 'stdWrapPostProcess'))) {
2095 $conf['stdWrapPostProcess'] = 1;
2096 }
2097 }
2098 }
2099 if (is_array($conf) && count($conf)) {
2100 // Cache handling
2101 if (is_array($conf['cache.'])) {
2102 $conf['cache.']['key'] = $this->stdWrap($conf['cache.']['key'], $conf['cache.']['key.']);
2103 $conf['cache.']['tags'] = $this->stdWrap($conf['cache.']['tags'], $conf['cache.']['tags.']);
2104 $conf['cache.']['lifetime'] = $this->stdWrap($conf['cache.']['lifetime'], $conf['cache.']['lifetime.']);
2105 $conf['cacheRead'] = 1;
2106 $conf['cacheStore'] = 1;
2107 }
2108 // Check, which of the available stdWrap functions is needed for the current conf Array
2109 // and keep only those but still in the same order
2110 $sortedConf = array_intersect_key($this->stdWrapOrder, $conf);
2111 // Functions types that should not make use of nested stdWrap function calls to avoid conflicts with internal TypoScript used by these functions
2112 $stdWrapDisabledFunctionTypes = 'cObject,functionName,stdWrap';
2113 // Additional Array to check whether a function has already been executed
2114 $isExecuted = array();
2115 // Additional switch to make sure 'required', 'if' and 'fieldRequired'
2116 // will still stop rendering immediately in case they return FALSE
2117 $this->stdWrapRecursionLevel++;
2118 $this->stopRendering[$this->stdWrapRecursionLevel] = FALSE;
2119 // execute each function in the predefined order
2120 foreach ($sortedConf as $stdWrapName => $functionType) {
2121 // eliminate the second key of a pair 'key'|'key.' to make sure functions get called only once and check if rendering has been stopped
2122 if (!$isExecuted[$stdWrapName] && !$this->stopRendering[$this->stdWrapRecursionLevel]) {
2123 $functionName = rtrim($stdWrapName, '.');
2124 $functionProperties = $functionName . '.';
2125 // If there is any code one the next level, check if it contains "official" stdWrap functions
2126 // if yes, execute them first - will make each function stdWrap aware
2127 // so additional stdWrap calls within the functions can be removed, since the result will be the same
2128 // exception: the recursive stdWrap function and cObject will still be using their own stdWrap call, since it modifies the content and not a property
2129 if (count($conf[$functionProperties]) && !GeneralUtility::inList($stdWrapDisabledFunctionTypes, $functionType)) {
2130 if (array_intersect_key($this->stdWrapOrder, $conf[$functionProperties])) {
2131 $conf[$functionName] = $this->stdWrap($conf[$functionName], $conf[$functionProperties]);
2132 }
2133 }
2134 // Get just that part of $conf that is needed for the particular function
2135 $singleConf = array(
2136 $functionName => $conf[$functionName],
2137 $functionProperties => $conf[$functionProperties]
2138 );
2139 // In this special case 'spaceBefore' and 'spaceAfter' need additional stuff from 'space.''
2140 if ($functionName == 'spaceBefore' || $functionName == 'spaceAfter') {
2141 $singleConf['space.'] = $conf['space.'];
2142 }
2143 // Hand over the whole $conf array to the stdWrapHookObjects
2144 if ($functionType === 'hook') {
2145 $singleConf = $conf;
2146 }
2147 // Check if key is still containing something, since it might have been changed by next level stdWrap before
2148 if ((isset($conf[$functionName]) || $conf[$functionProperties]) && !($functionType == 'boolean' && !$conf[$functionName])) {
2149 // Add both keys - with and without the dot - to the set of executed functions
2150 $isExecuted[$functionName] = TRUE;
2151 $isExecuted[$functionProperties] = TRUE;
2152 // Call the function with the prefix stdWrap_ to make sure nobody can execute functions just by adding their name to the TS Array
2153 $functionName = 'stdWrap_' . $functionName;
2154 $content = $this->{$functionName}($content, $singleConf);
2155 } elseif ($functionType == 'boolean' && !$conf[$functionName]) {
2156 $isExecuted[$functionName] = TRUE;
2157 $isExecuted[$functionProperties] = TRUE;
2158 }
2159 }
2160 }
2161 unset($this->stopRendering[$this->stdWrapRecursionLevel]);
2162 $this->stdWrapRecursionLevel--;
2163 }
2164 return $content;
2165 }
2166
2167 /**
2168 * stdWrap pre process hook
2169 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2170 * this hook will execute functions before any other stdWrap function can modify anything
2171 *
2172 * @param string $content Input value undergoing processing in these functions.
2173 * @param array $conf All stdWrap properties, not just the ones for a particular function.
2174 * @return string The processed input value
2175 */
2176 public function stdWrap_stdWrapPreProcess($content = '', $conf = array()) {
2177 foreach ($this->stdWrapHookObjects as $hookObject) {
2178 $content = $hookObject->stdWrapPreProcess($content, $conf, $this);
2179 }
2180 return $content;
2181 }
2182
2183 /**
2184 * Check if content was cached before (depending on the given cache key)
2185 *
2186 * @param string $content Input value undergoing processing in these functions.
2187 * @param array $conf All stdWrap properties, not just the ones for a particular function.
2188 * @return string The processed input value
2189 */
2190 public function stdWrap_cacheRead($content = '', $conf = array()) {
2191 if (!empty($conf['cache.']['key'])) {
2192 /** @var $cacheFrontend \TYPO3\CMS\Core\Cache\Frontend\VariableFrontend */
2193 $cacheFrontend = $GLOBALS['typo3CacheManager']->getCache('cache_hash');
2194 if ($cacheFrontend && $cacheFrontend->has($conf['cache.']['key'])) {
2195 $content = $cacheFrontend->get($conf['cache.']['key']);
2196 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2197 }
2198 }
2199 return $content;
2200 }
2201
2202 /**
2203 * Add tags to page cache (comma-separated list)
2204 *
2205 * @param string $content Input value undergoing processing in these functions.
2206 * @param array $conf All stdWrap properties, not just the ones for a particular function.
2207 * @return string The processed input value
2208 */
2209 public function stdWrap_addPageCacheTags($content = '', $conf = array()) {
2210 $tags = isset($conf['addPageCacheTags.'])
2211 ? $this->stdWrap($conf['addPageCacheTags'], $conf['addPageCacheTags.'])
2212 : $conf['addPageCacheTags'];
2213 if (!empty($tags)) {
2214 $cacheTags = GeneralUtility::trimExplode(',', $tags, TRUE);
2215 $GLOBALS['TSFE']->addCacheTags($cacheTags);
2216 }
2217 return $content;
2218 }
2219
2220 /**
2221 * setContentToCurrent
2222 * actually it just does the contrary: Sets the value of 'current' based on current content
2223 *
2224 * @param string $content Input value undergoing processing in this function.
2225 * @param array $conf stdWrap properties for setContentToCurrent.
2226 * @return string The processed input value
2227 */
2228 public function stdWrap_setContentToCurrent($content = '', $conf = array()) {
2229 $this->data[$this->currentValKey] = $content;
2230 return $content;
2231 }
2232
2233 /**
2234 * setCurrent
2235 * Sets the value of 'current' based on the outcome of stdWrap operations
2236 *
2237 * @param string $content Input value undergoing processing in this function.
2238 * @param array $conf stdWrap properties for setCurrent.
2239 * @return string The processed input value
2240 */
2241 public function stdWrap_setCurrent($content = '', $conf = array()) {
2242 $this->data[$this->currentValKey] = $conf['setCurrent'];
2243 return $content;
2244 }
2245
2246 /**
2247 * lang
2248 * Translates content based on the language currently used by the FE
2249 *
2250 * @param string $content Input value undergoing processing in this function.
2251 * @param array $conf stdWrap properties for lang.
2252 * @return string The processed input value
2253 */
2254 public function stdWrap_lang($content = '', $conf = array()) {
2255 if (isset($conf['lang.']) && $GLOBALS['TSFE']->config['config']['language'] && isset($conf['lang.'][$GLOBALS['TSFE']->config['config']['language']])) {
2256 $content = $conf['lang.'][$GLOBALS['TSFE']->config['config']['language']];
2257 }
2258 return $content;
2259 }
2260
2261 /**
2262 * data
2263 * Gets content from different sources based on getText functions, makes use of alternativeData, when set
2264 *
2265 * @param string $content Input value undergoing processing in this function.
2266 * @param array $conf stdWrap properties for data.
2267 * @return string The processed input value
2268 */
2269 public function stdWrap_data($content = '', $conf = array()) {
2270 $content = $this->getData($conf['data'], is_array($this->alternativeData) ? $this->alternativeData : $this->data);
2271 // This must be unset directly after
2272 $this->alternativeData = '';
2273 return $content;
2274 }
2275
2276 /**
2277 * field
2278 * Gets content from a DB field
2279 *
2280 * @param string $content Input value undergoing processing in this function.
2281 * @param array $conf stdWrap properties for field.
2282 * @return string The processed input value
2283 */
2284 public function stdWrap_field($content = '', $conf = array()) {
2285 $content = $this->getFieldVal($conf['field']);
2286 return $content;
2287 }
2288
2289 /**
2290 * current
2291 * Gets content that has been perviously set as 'current'
2292 * Can be set via setContentToCurrent or setCurrent or will be set automatically i.e. inside the split function
2293 *
2294 * @param string $content Input value undergoing processing in this function.
2295 * @param array $conf stdWrap properties for current.
2296 * @return string The processed input value
2297 */
2298 public function stdWrap_current($content = '', $conf = array()) {
2299 $content = $this->data[$this->currentValKey];
2300 return $content;
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 $content = $this->cObjGetSingle($conf['cObject'], $conf['cObject.'], '/stdWrap/.cObject');
2314 return $content;
2315 }
2316
2317 /**
2318 * numRows
2319 * Counts the number of returned records of a DB operation
2320 * makes use of select internally
2321 *
2322 * @param string $content Input value undergoing processing in this function.
2323 * @param array $conf stdWrap properties for numRows.
2324 * @return string The processed input value
2325 */
2326 public function stdWrap_numRows($content = '', $conf = array()) {
2327 $content = $this->numRows($conf['numRows.']);
2328 return $content;
2329 }
2330
2331 /**
2332 * filelist
2333 * Will create a list of files based on some additional parameters
2334 *
2335 * @param string $content Input value undergoing processing in this function.
2336 * @param array $conf stdWrap properties for filelist.
2337 * @return string The processed input value
2338 */
2339 public function stdWrap_filelist($content = '', $conf = array()) {
2340 $content = $this->filelist($conf['filelist']);
2341 return $content;
2342 }
2343
2344 /**
2345 * preUserFunc
2346 * Will execute a user public function before the content will be modified by any other stdWrap function
2347 *
2348 * @param string $content Input value undergoing processing in this function.
2349 * @param array $conf stdWrap properties for preUserFunc.
2350 * @return string The processed input value
2351 */
2352 public function stdWrap_preUserFunc($content = '', $conf = array()) {
2353 $content = $this->callUserFunction($conf['preUserFunc'], $conf['preUserFunc.'], $content);
2354 return $content;
2355 }
2356
2357 /**
2358 * stdWrap override hook
2359 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2360 * this hook will execute functions on existing content but still before the content gets modified or replaced
2361 *
2362 * @param string $content Input value undergoing processing in these functions.
2363 * @param array $conf All stdWrap properties, not just the ones for a particular function.
2364 * @return string The processed input value
2365 */
2366 public function stdWrap_stdWrapOverride($content = '', $conf = array()) {
2367 foreach ($this->stdWrapHookObjects as $hookObject) {
2368 $content = $hookObject->stdWrapOverride($content, $conf, $this);
2369 }
2370 return $content;
2371 }
2372
2373 /**
2374 * override
2375 * Will override the current value of content with its own value'
2376 *
2377 * @param string $content Input value undergoing processing in this function.
2378 * @param array $conf stdWrap properties for override.
2379 * @return string The processed input value
2380 */
2381 public function stdWrap_override($content = '', $conf = array()) {
2382 if (trim($conf['override'])) {
2383 $content = $conf['override'];
2384 }
2385 return $content;
2386 }
2387
2388 /**
2389 * preIfEmptyListNum
2390 * Gets a value off a CSV list before the following ifEmpty check
2391 * 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
2392 *
2393 * @param string $content Input value undergoing processing in this function.
2394 * @param array $conf stdWrap properties for preIfEmptyListNum.
2395 * @return string The processed input value
2396 */
2397 public function stdWrap_preIfEmptyListNum($content = '', $conf = array()) {
2398 $content = $this->listNum($content, $conf['preIfEmptyListNum'], $conf['preIfEmptyListNum.']['splitChar']);
2399 return $content;
2400 }
2401
2402 /**
2403 * ifNull
2404 * Will set content to a replacement value in case the value of content is NULL
2405 *
2406 * @param string|NULL $content Input value undergoing processing in this function.
2407 * @param array $conf stdWrap properties for ifNull.
2408 * @return string|NULL The processed input value
2409 */
2410 public function stdWrap_ifNull($content = '', $conf = array()) {
2411 if ($content === NULL) {
2412 $content = $conf['ifNull'];
2413 }
2414 return $content;
2415 }
2416
2417 /**
2418 * ifEmpty
2419 * Will set content to a replacement value in case the trimmed value of content returns FALSE
2420 * 0 (zero) will be replaced as well
2421 *
2422 * @param string $content Input value undergoing processing in this function.
2423 * @param array $conf stdWrap properties for ifEmpty.
2424 * @return string The processed input value
2425 */
2426 public function stdWrap_ifEmpty($content = '', $conf = array()) {
2427 if (!trim($content)) {
2428 $content = $conf['ifEmpty'];
2429 }
2430 return $content;
2431 }
2432
2433 /**
2434 * ifBlank
2435 * Will set content to a replacement value in case the trimmed value of content has no length
2436 * 0 (zero) will not be replaced
2437 *
2438 * @param string $content Input value undergoing processing in this function.
2439 * @param array $conf stdWrap properties for ifBlank.
2440 * @return string The processed input value
2441 */
2442 public function stdWrap_ifBlank($content = '', $conf = array()) {
2443 if (!strlen(trim($content))) {
2444 $content = $conf['ifBlank'];
2445 }
2446 return $content;
2447 }
2448
2449 /**
2450 * listNum
2451 * Gets a value off a CSV list after ifEmpty check
2452 * Might return an empty value in case the CSV does not contain a value at the position given by listNum
2453 * Use preIfEmptyListNum to avoid that behaviour
2454 *
2455 * @param string $content Input value undergoing processing in this function.
2456 * @param array $conf stdWrap properties for listNum.
2457 * @return string The processed input value
2458 */
2459 public function stdWrap_listNum($content = '', $conf = array()) {
2460 $content = $this->listNum($content, $conf['listNum'], $conf['listNum.']['splitChar']);
2461 return $content;
2462 }
2463
2464 /**
2465 * trim
2466 * Cuts off any whitespace at the beginning and the end of the content
2467 *
2468 * @param string $content Input value undergoing processing in this function.
2469 * @param array $conf stdWrap properties for trim.
2470 * @return string The processed input value
2471 */
2472 public function stdWrap_trim($content = '', $conf = array()) {
2473 $content = trim($content);
2474 return $content;
2475 }
2476
2477 /**
2478 * strPad
2479 * Will return a string padded left/right/on both sides, based on configuration given as stdWrap properties
2480 *
2481 * @param string $content Input value undergoing processing in this function.
2482 * @param array $conf stdWrap properties for strPad.
2483 * @return string The processed input value
2484 */
2485 public function stdWrap_strPad($content = '', $conf = array()) {
2486 // Must specify a length in conf for this to make sense
2487 $length = 0;
2488 // Padding with space is PHP-default
2489 $padWith = ' ';
2490 // Padding on the right side is PHP-default
2491 $padType = STR_PAD_RIGHT;
2492 if (!empty($conf['strPad.']['length'])) {
2493 $length = isset($conf['strPad.']['length.']) ? $this->stdWrap($conf['strPad.']['length'], $conf['strPad.']['length.']) : $conf['strPad.']['length'];
2494 $length = intval($length);
2495 }
2496 if (isset($conf['strPad.']['padWith']) && strlen($conf['strPad.']['padWith']) > 0) {
2497 $padWith = isset($conf['strPad.']['padWith.']) ? $this->stdWrap($conf['strPad.']['padWith'], $conf['strPad.']['padWith.']) : $conf['strPad.']['padWith'];
2498 }
2499 if (!empty($conf['strPad.']['type'])) {
2500 $type = isset($conf['strPad.']['type.']) ? $this->stdWrap($conf['strPad.']['type'], $conf['strPad.']['type.']) : $conf['strPad.']['type'];
2501 if (strtolower($type) === 'left') {
2502 $padType = STR_PAD_LEFT;
2503 } elseif (strtolower($type) === 'both') {
2504 $padType = STR_PAD_BOTH;
2505 }
2506 }
2507 $content = str_pad($content, $length, $padWith, $padType);
2508 return $content;
2509 }
2510
2511 /**
2512 * stdWrap
2513 * A recursive call of the stdWrap function set
2514 * This enables the user to execute stdWrap functions in another than the predefined order
2515 * It modifies the content, not the property
2516 * while the new feature of chained stdWrap functions modifies the property and not the content
2517 *
2518 * @param string $content Input value undergoing processing in this function.
2519 * @param array $conf stdWrap properties for stdWrap.
2520 * @return string The processed input value
2521 */
2522 public function stdWrap_stdWrap($content = '', $conf = array()) {
2523 $content = $this->stdWrap($content, $conf['stdWrap.']);
2524 return $content;
2525 }
2526
2527 /**
2528 * stdWrap process hook
2529 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2530 * this hook executes functions directly after the recursive stdWrap function call but still before the content gets modified
2531 *
2532 * @param string $content Input value undergoing processing in these functions.
2533 * @param array $conf All stdWrap properties, not just the ones for a particular function.
2534 * @return string The processed input value
2535 */
2536 public function stdWrap_stdWrapProcess($content = '', $conf = array()) {
2537 foreach ($this->stdWrapHookObjects as $hookObject) {
2538 $content = $hookObject->stdWrapProcess($content, $conf, $this);
2539 }
2540 return $content;
2541 }
2542
2543 /**
2544 * required
2545 * Will immediately stop rendering and return an empty value
2546 * when there is no content at this point
2547 *
2548 * @param string $content Input value undergoing processing in this function.
2549 * @param array $conf stdWrap properties for required.
2550 * @return string The processed input value
2551 */
2552 public function stdWrap_required($content = '', $conf = array()) {
2553 if ((string) $content == '') {
2554 $content = '';
2555 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2556 }
2557 return $content;
2558 }
2559
2560 /**
2561 * if
2562 * Will immediately stop rendering and return an empty value
2563 * when the result of the checks returns FALSE
2564 *
2565 * @param string $content Input value undergoing processing in this function.
2566 * @param array $conf stdWrap properties for if.
2567 * @return string The processed input value
2568 */
2569 public function stdWrap_if($content = '', $conf = array()) {
2570 if (!$this->checkIf($conf['if.'])) {
2571 $content = '';
2572 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2573 }
2574 return $content;
2575 }
2576
2577 /**
2578 * fieldRequired
2579 * Will immediately stop rendering and return an empty value
2580 * when there is no content in the field given by fieldRequired
2581 *
2582 * @param string $content Input value undergoing processing in this function.
2583 * @param array $conf stdWrap properties for fieldRequired.
2584 * @return string The processed input value
2585 */
2586 public function stdWrap_fieldRequired($content = '', $conf = array()) {
2587 if (!trim($this->data[$conf['fieldRequired']])) {
2588 $content = '';
2589 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2590 }
2591 return $content;
2592 }
2593
2594 /**
2595 * csConv
2596 * Will convert the current chracter set of the content to the one given in csConv
2597 *
2598 * @param string $content Input value undergoing processing in this function.
2599 * @param array $conf stdWrap properties for csConv.
2600 * @return string The processed input value
2601 */
2602 public function stdWrap_csConv($content = '', $conf = array()) {
2603 $content = $GLOBALS['TSFE']->csConv($content, $conf['csConv']);
2604 return $content;
2605 }
2606
2607 /**
2608 * parseFunc
2609 * Will parse the content based on functions given as stdWrap properties
2610 * Heavily used together with RTE based content
2611 *
2612 * @param string $content Input value undergoing processing in this function.
2613 * @param array $conf stdWrap properties for parseFunc.
2614 * @return string The processed input value
2615 */
2616 public function stdWrap_parseFunc($content = '', $conf = array()) {
2617 $content = $this->parseFunc($content, $conf['parseFunc.'], $conf['parseFunc']);
2618 return $content;
2619 }
2620
2621 /**
2622 * HTMLparser
2623 * Will parse HTML content based on functions given as stdWrap properties
2624 * Heavily used together with RTE based content
2625 *
2626 * @param string $content Input value undergoing processing in this function.
2627 * @param array $conf stdWrap properties for HTMLparser.
2628 * @return string The processed input value
2629 */
2630 public function stdWrap_HTMLparser($content = '', $conf = array()) {
2631 if (is_array($conf['HTMLparser.'])) {
2632 $content = $this->HTMLparser_TSbridge($content, $conf['HTMLparser.']);
2633 }
2634 return $content;
2635 }
2636
2637 /**
2638 * split
2639 * Will split the content by a given token and treat the results separately
2640 * Automatically fills 'current' with a single result
2641 *
2642 * @param string $content Input value undergoing processing in this function.
2643 * @param array $conf stdWrap properties for split.
2644 * @return string The processed input value
2645 */
2646 public function stdWrap_split($content = '', $conf = array()) {
2647 $content = $this->splitObj($content, $conf['split.']);
2648 return $content;
2649 }
2650
2651 /**
2652 * replacement
2653 * Will execute replacements on the content (optionally with preg-regex)
2654 *
2655 * @param string $content Input value undergoing processing in this function.
2656 * @param array $conf stdWrap properties for replacement.
2657 * @return string The processed input value
2658 */
2659 public function stdWrap_replacement($content = '', $conf = array()) {
2660 $content = $this->replacement($content, $conf['replacement.']);
2661 return $content;
2662 }
2663
2664 /**
2665 * prioriCalc
2666 * Will use the content as a mathematical term and calculate the result
2667 * Can be set to 1 to just get a calculated value or 'intval' to get the integer of the result
2668 *
2669 * @param string $content Input value undergoing processing in this function.
2670 * @param array $conf stdWrap properties for prioriCalc.
2671 * @return string The processed input value
2672 */
2673 public function stdWrap_prioriCalc($content = '', $conf = array()) {
2674 $content = \TYPO3\CMS\Core\Utility\MathUtility::calculateWithParentheses($content);
2675 if ($conf['prioriCalc'] == 'intval') {
2676 $content = intval($content);
2677 }
2678 return $content;
2679 }
2680
2681 /**
2682 * char
2683 * Will return a character based on its position within the current character set
2684 *
2685 * @param string $content Input value undergoing processing in this function.
2686 * @param array $conf stdWrap properties for char.
2687 * @return string The processed input value
2688 */
2689 public function stdWrap_char($content = '', $conf = array()) {
2690 $content = chr(intval($conf['char']));
2691 return $content;
2692 }
2693
2694 /**
2695 * intval
2696 * Will return an integer value of the current content
2697 *
2698 * @param string $content Input value undergoing processing in this function.
2699 * @param array $conf stdWrap properties for intval.
2700 * @return string The processed input value
2701 */
2702 public function stdWrap_intval($content = '', $conf = array()) {
2703 $content = intval($content);
2704 return $content;
2705 }
2706
2707 /**
2708 * Will return a hashed value of the current content
2709 *
2710 * @param string $content Input value undergoing processing in this function.
2711 * @param array $conf stdWrap properties for hash.
2712 * @return string The processed input value
2713 * @link http://php.net/manual/de/function.hash-algos.php for a list of supported hash algorithms
2714 */
2715 public function stdWrap_hash($content = '', array $conf = array()) {
2716 $algorithm = isset($conf['hash.']) ? $this->stdWrap($conf['hash'], $conf['hash.']) : $conf['hash'];
2717 if (function_exists('hash') && in_array($algorithm, hash_algos())) {
2718 $content = hash($algorithm, $content);
2719 } else {
2720 // Non-existing hashing algorithm
2721 $content = '';
2722 }
2723 return $content;
2724 }
2725
2726 /**
2727 * stdWrap_round will return a rounded number with ceil(), floor() or round(), defaults to round()
2728 * Only the english number format is supported . (dot) as decimal point
2729 *
2730 * @param string $content Input value undergoing processing in this function.
2731 * @param array $conf stdWrap properties for round.
2732 * @return string The processed input value
2733 */
2734 public function stdWrap_round($content = '', $conf = array()) {
2735 $content = $this->round($content, $conf['round.']);
2736 return $content;
2737 }
2738
2739 /**
2740 * numberFormat
2741 * Will return a formatted number based on configuration given as stdWrap properties
2742 *
2743 * @param string $content Input value undergoing processing in this function.
2744 * @param array $conf stdWrap properties for numberFormat.
2745 * @return string The processed input value
2746 */
2747 public function stdWrap_numberFormat($content = '', $conf = array()) {
2748 $content = $this->numberFormat($content, $conf['numberFormat.']);
2749 return $content;
2750 }
2751
2752 /**
2753 * expandList
2754 * Will return a formatted number based on configuration given as stdWrap properties
2755 *
2756 * @param string $content Input value undergoing processing in this function.
2757 * @param array $conf stdWrap properties for expandList.
2758 * @return string The processed input value
2759 */
2760 public function stdWrap_expandList($content = '', $conf = array()) {
2761 $content = GeneralUtility::expandList($content);
2762 return $content;
2763 }
2764
2765 /**
2766 * date
2767 * Will return a formatted date based on configuration given according to PHP date/gmdate properties
2768 * Will return gmdate when the property GMT returns TRUE
2769 *
2770 * @param string $content Input value undergoing processing in this function.
2771 * @param array $conf stdWrap properties for date.
2772 * @return string The processed input value
2773 */
2774 public function stdWrap_date($content = '', $conf = array()) {
2775 // Check for zero length string to mimic default case of date/gmdate.
2776 $content = $content == '' ? $GLOBALS['EXEC_TIME'] : intval($content);
2777 $content = $conf['date.']['GMT'] ? gmdate($conf['date'], $content) : date($conf['date'], $content);
2778 return $content;
2779 }
2780
2781 /**
2782 * strftime
2783 * Will return a formatted date based on configuration given according to PHP strftime/gmstrftime properties
2784 * Will return gmstrftime when the property GMT returns TRUE
2785 *
2786 * @param string $content Input value undergoing processing in this function.
2787 * @param array $conf stdWrap properties for strftime.
2788 * @return string The processed input value
2789 */
2790 public function stdWrap_strftime($content = '', $conf = array()) {
2791 // Check for zero length string to mimic default case of strtime/gmstrftime
2792 $content = $content == '' ? $GLOBALS['EXEC_TIME'] : intval($content);
2793 $content = $conf['strftime.']['GMT'] ? gmstrftime($conf['strftime'], $content) : strftime($conf['strftime'], $content);
2794 $tmp_charset = $conf['strftime.']['charset'] ? $conf['strftime.']['charset'] : $GLOBALS['TSFE']->localeCharset;
2795 if ($tmp_charset) {
2796 $content = $GLOBALS['TSFE']->csConv($content, $tmp_charset);
2797 }
2798 return $content;
2799 }
2800
2801 /**
2802 * age
2803 * Will return the age of a given timestamp based on configuration given by stdWrap properties
2804 *
2805 * @param string $content Input value undergoing processing in this function.
2806 * @param array $conf stdWrap properties for age.
2807 * @return string The processed input value
2808 */
2809 public function stdWrap_age($content = '', $conf = array()) {
2810 $content = $this->calcAge($GLOBALS['EXEC_TIME'] - $content, $conf['age']);
2811 return $content;
2812 }
2813
2814 /**
2815 * case
2816 * Will transform the content to be upper or lower case only
2817 * Leaves HTML tags untouched
2818 *
2819 * @param string $content Input value undergoing processing in this function.
2820 * @param array $conf stdWrap properties for case.
2821 * @return string The processed input value
2822 */
2823 public function stdWrap_case($content = '', $conf = array()) {
2824 $content = $this->HTMLcaseshift($content, $conf['case']);
2825 return $content;
2826 }
2827
2828 /**
2829 * bytes
2830 * Will return the size of a given number in Bytes *
2831 *
2832 * @param string $content Input value undergoing processing in this function.
2833 * @param array $conf stdWrap properties for bytes.
2834 * @return string The processed input value
2835 */
2836 public function stdWrap_bytes($content = '', $conf = array()) {
2837 $content = GeneralUtility::formatSize($content, $conf['bytes.']['labels']);
2838 return $content;
2839 }
2840
2841 /**
2842 * substring
2843 * Will return a substring based on position information given by stdWrap properties
2844 *
2845 * @param string $content Input value undergoing processing in this function.
2846 * @param array $conf stdWrap properties for substring.
2847 * @return string The processed input value