Fixed bug #16456: When dbal is activated, styles.content.get (and others) doesn't...
[Packages/TYPO3.CMS.git] / typo3 / sysext / cms / tslib / class.tslib_content.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 1999-2010 Kasper Skårhøj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains classes for Content Rendering based on TypoScript Template configuration
29 *
30 * $Id$
31 * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
32 * XHTML compliant
33 *
34 * class tslib_cObj : All main TypoScript features, rendering of content objects (cObjects). This class is the backbone of TypoScript Template rendering.
35 * class tslib_controlTable : Makes a table CTABLE (TS cObject)
36 * class tslib_tableOffset : Makes a table-offset (TS)
37 * class tslib_frameset : Generates framesets (TS)
38 *
39 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
40 */
41 /**
42 * [CLASS/FUNCTION INDEX of SCRIPT]
43 *
44 *
45 *
46 * 256: class tslib_cObj
47 * 353: function start($data,$table='')
48 * 387: function setParent($data,$currentRecord)
49 *
50 * SECTION: CONTENT_OBJ:
51 * 412: function getCurrentVal()
52 * 423: function setCurrentVal($value)
53 * 436: function cObjGet($setup,$addKey='')
54 * 460: function cObjGetSingle($name,$conf,$TSkey='__')
55 *
56 * SECTION: Functions rendering content objects (cObjects)
57 * 629: function HTML($conf)
58 * 640: function TEXT($conf)
59 * 651: function CLEARGIF($conf)
60 * 670: function COBJ_ARRAY($conf,$ext='')
61 * 706: function USER($conf,$ext='')
62 * 733: function FILE($conf)
63 * 749: function IMAGE($conf)
64 * 768: function IMG_RESOURCE($conf)
65 * 780: function IMGTEXT($conf)
66 * 1203: function CONTENT($conf)
67 * 1290: function RECORDS($conf)
68 * 1370: function HMENU($conf)
69 * 1402: function CTABLE ($conf)
70 * 1440: function OTABLE ($conf)
71 * 1455: function COLUMNS ($conf)
72 * 1534: function HRULER ($conf)
73 * 1559: function CASEFUNC ($conf)
74 * 1584: function LOAD_REGISTER($conf,$name)
75 * 1624: function FORM($conf,$formData='')
76 * 2145: function SEARCHRESULT($conf)
77 * 2311: function PHP_SCRIPT($conf,$ext='')
78 * 2354: function TEMPLATE($conf)
79 * 2505: function MULTIMEDIA($conf)
80 *
81 * SECTION: Various helper functions for content objects:
82 * 2592: function getSlidePids($pidList, $pidConf)
83 * 2623: function getFieldDefaultValue($noValueInsert, $fieldName, $defaultVal)
84 * 2641: function cImage($file,$conf)
85 * 2669: function getBorderAttr($borderAttr)
86 * 2685: function imageLinkWrap($string,$imageFile,$conf)
87 * 2765: function fileResource($fName, $addParams='alt="" title=""')
88 * 2788: function lastChanged($tstamp)
89 * 2805: function linkWrap($content,$wrap)
90 * 2824: function getAltParam($conf, $longDesc=TRUE)
91 * 2859: function cleanFormName($name)
92 * 2875: function getATagParams($conf, $addGlobal=1)
93 *
94 * SECTION: HTML template processing functions
95 * 2922: function getSubpart($content, $marker)
96 * 2938: function substituteSubpart($content,$marker,$subpartContent,$recursive=1)
97 * 2951: function substituteMarker($content,$marker,$markContent)
98 * 2971: function substituteMarkerArrayCached($content,$markContentArray=array(),$subpartContentArray=array(),$wrappedSubpartContentArray=array())
99 * 3069: function substituteMarkerArray($content,$markContentArray,$wrap='',$uppercase=0)
100 * 3081: function substituteMarkerInObject(&$tree, $markContentArray)
101 * 3104: function fillInMarkerArray($markContentArray, $row, $fieldList='', $nl2br=TRUE, $prefix='FIELD_', $HSC=FALSE)
102 *
103 * SECTION: "stdWrap" + sub functions
104 * 3167: function stdWrap($content,$conf)
105 * 3364: function numRows($conf)
106 * 3388: function listNum($content,$listNum,$char)
107 * 3408: function checkIf($conf)
108 * 3471: function filelist($data)
109 * 3553: function clean_directory($theDir)
110 * 3571: function HTMLparser_TSbridge($theValue, $conf)
111 * 3585: function dataWrap($content,$wrap)
112 * 3598: function insertData($str)
113 * 3628: function prefixComment($str,$conf,$content)
114 * 3652: function substring($content,$options)
115 * 3670: function crop($content,$options)
116 * 3702: function removeBadHTML($text, $conf)
117 * 3746: function textStyle($theValue, $conf)
118 * 3813: function tableStyle($theValue, $conf)
119 * 3854: function addParams($content,$conf)
120 * 3895: function filelink($theValue, $conf)
121 * 3966: function locDataJU($jumpUrl,$conf)
122 * 3997: function calc($val)
123 * 4026: function calcIntExplode($delim, $string)
124 * 4046: function splitObj($value, $conf)
125 * 4108: function parseFunc($theValue, $conf, $ref='')
126 * 4218: function _parseFunc ($theValue, $conf)
127 * 4424: function encaps_lineSplit($theValue, $conf)
128 * 4507: function http_makelinks($data,$conf)
129 * 4574: function mailto_makelinks($data,$conf)
130 * 4617: function getImgResource($file,$fileArray)
131 *
132 * SECTION: Data retrieval etc.
133 * 4810: function getFieldVal($field)
134 * 4830: function getData($string,$fieldArray)
135 * 4975: function rootLineValue($key,$field,$slideBack=0,$altRootLine='')
136 * 4997: function getGlobal($var, $source=NULL)
137 * 5033: function getKey($key,$arr)
138 * 5056: function TCAlookup($inputValue,$conf)
139 *
140 * SECTION: Link functions (typolink)
141 * 5116: function typoLink($linktxt, $conf)
142 * 5481: function typoLink_URL($conf)
143 * 5499: function getTypoLink($label,$params,$urlParameters=array(),$target='')
144 * 5526: function getTypoLink_URL($params,$urlParameters=array(),$target='')
145 * 5538: function typolinkWrap($conf)
146 * 5551: function currentPageUrl($urlParameters=array(),$id=0)
147 * 5564: function getClosestMPvalueForPage($pageId, $raw=FALSE)
148 * 5619: function getMailTo($mailAddress,$linktxt,$initP='?')
149 * 5658: function getQueryArguments($conf,$overruleQueryArgs=array(),$forceArgs=FALSE)
150 *
151 * SECTION: Miscellaneous functions, stand alone
152 * 5754: function wrap($content,$wrap,$char='|')
153 * 5770: function noTrimWrap($content,$wrap)
154 * 5784: function wrapSpace($content, $wrap)
155 * 5810: function callUserFunction($funcName,$conf,$content)
156 * 5851: function processParams($params)
157 * 5869: function keywords($content)
158 * 5886: function caseshift($theValue, $case)
159 * 5911: function HTMLcaseshift($theValue, $case)
160 * 5940: function bytes($sizeInBytes,$labels)
161 * 5951: function calcAge($seconds,$labels)
162 * 5983: function sendNotifyEmail($msg, $recipients, $cc, $email_from, $email_fromName='', $replyTo='')
163 * 6010: function URLqMark($url,$params)
164 * 6026: function checkEmail($email)
165 * 6038: function clearTSProperties($TSArr,$propList)
166 * 6057: function mergeTSRef($confArr,$prop)
167 * 6080: function joinTSarrays($conf,$old_conf)
168 * 6103: function gifBuilderTextBox($gifbuilderConf, $conf, $text)
169 * 6159: function linebreaks($string,$chars,$maxLines=0)
170 * 6190: function getUpdateJS($dataArray, $formName, $arrPrefix, $fieldList)
171 *
172 * SECTION: Database functions, making of queries
173 * 6260: function DBgetDelete($table, $uid, $doExec=FALSE)
174 * 6292: function DBgetUpdate($table, $uid, $dataArr, $fieldList, $doExec=FALSE)
175 * 6334: function DBgetInsert($table, $pid, $dataArr, $fieldList, $doExec=FALSE)
176 * 6371: function DBmayFEUserEdit($table,$row, $feUserRow, $allowedGroups='',$feEditSelf=0)
177 * 6411: function DBmayFEUserEditSelect($table,$feUserRow,$allowedGroups='',$feEditSelf=0)
178 * 6451: function enableFields($table,$show_hidden=0)
179 * 6475: function getTreeList($id,$depth,$begin=0,$dontCheckEnableFields=FALSE,$addSelectFields='',$moreWhereClauses='', $prevId_array=array(), $recursionLevel=0)
180 * 6583: function whereSelectFromList($field,$value)
181 * 6601: function exec_mm_query($select,$local_table,$mm_table,$foreign_table,$whereClause='',$groupBy='',$orderBy='',$limit='')
182 * 6628: function exec_mm_query_uidList($select,$local_table_uidlist,$mm_table,$foreign_table='',$whereClause='',$groupBy='',$orderBy='',$limit='')
183 * 6649: function searchWhere($sw,$searchFieldList,$searchTable='')
184 * 6685: function exec_getQuery($table, $conf)
185 * 6703: function getQuery($table, $conf, $returnQueryArray=FALSE)
186 * 6783: function getWhere($table,$conf, $returnQueryArray=FALSE)
187 * 6878: function checkPidArray($listArr)
188 * 6902: function checkPid($uid)
189 *
190 * SECTION: Frontend editing functions
191 * 6959: function editPanel($content, $conf, $currentRecord='', $dataArr=array())
192 * 7146: function editIcons($content,$params, $conf=array(), $currentRecord='', $dataArr=array(),$addUrlParamStr='')
193 * 7228: function editPanelLinkWrap($string,$formName,$cmd,$currentRecord='',$confirm='',$nPid='')
194 * 7270: function editPanelLinkWrap_doWrap($string,$url,$currentRecord)
195 * 7298: function editPanelPreviewBorder($table,$row,$content,$thick,$conf=array())
196 * 7320: function isDisabled($table,$row)
197 *
198 *
199 * 7351: class tslib_frameset
200 * 7361: function make($setup)
201 * 7398: function frameParams($setup, $typeNum)
202 * 7426: function framesetParams($setup)
203 *
204 *
205 * 7459: class tslib_tableOffset
206 * 7471: function start($content,$offset)
207 *
208 *
209 * 7549: class tslib_controlTable
210 * 7584: function start($offset,$cMargins)
211 *
212 * TOTAL FUNCTIONS: 135
213 * (This index is automatically created/updated by the extension "extdeveval")
214 *
215 */
216
217
218
219 /**
220 * This class contains all main TypoScript features.
221 * This includes the rendering of TypoScript content objects (cObjects).
222 * Is the backbone of TypoScript Template rendering.
223 *
224 * There are lots of functions you can use from your include-scripts.
225 * The class "tslib_cObj" is normally instantiated and referred to as "cObj".
226 * 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.
227 *
228 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
229 * @package TYPO3
230 * @subpackage tslib
231 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&cHash=4ad9d7acb4
232 */
233 class tslib_cObj {
234
235 /**
236 * @var tslib_content_abstract
237 */
238 protected $contentObject;
239
240 var $align = array(
241 'center',
242 'right',
243 'left'
244 );
245
246 /**
247 * stdWrap functions in their correct order
248 *
249 * @see stdWrap()
250 */
251 var $stdWrapOrder = array(
252 'stdWrapPreProcess' => 'hook', // this is a placeholder for the first Hook
253 'setContentToCurrent' => 'boolean',
254 'setContentToCurrent.' => 'array',
255 'setCurrent' => 'string',
256 'setCurrent.' => 'array',
257 'lang.' => 'array',
258 'data' => 'getText',
259 'data.' => 'array',
260 'field' => 'fieldName',
261 'field.' => 'array',
262 'current' => 'boolean',
263 'current.' => 'array',
264 'cObject' => 'cObject',
265 'cObject.' => 'array',
266 'numRows.' => 'array',
267 'filelist' => 'dir',
268 'filelist.' => 'array',
269 'preUserFunc' => 'functionName',
270 'stdWrapOverride' => 'hook', // this is a placeholder for the second Hook
271 'override' => 'string',
272 'override.' => 'array',
273 'preIfEmptyListNum' => 'listNum',
274 'preIfEmptyListNum.' => 'array',
275 'ifEmpty' => 'string',
276 'ifEmpty.' => 'array',
277 'ifBlank' => 'string',
278 'ifBlank.' => 'array',
279 'listNum' => 'listNum',
280 'listNum.' => 'array',
281 'trim' => 'boolean',
282 'trim.' => 'array',
283 'stdWrap' => 'stdWrap',
284 'stdWrap.' => 'array',
285 'stdWrapProcess' => 'hook', // this is a placeholder for the third Hook
286 'required' => 'boolean',
287 'required.' => 'array',
288 'if.' => 'array',
289 'fieldRequired' => 'fieldName',
290 'fieldRequired.' => 'array',
291 'csConv' => 'string',
292 'csConv.' => 'array',
293 'parseFunc' => 'objectpath',
294 'parseFunc.' => 'array',
295 'HTMLparser' => 'boolean',
296 'HTMLparser.' => 'array',
297 'split.' => 'array',
298 'prioriCalc' => 'boolean',
299 'prioriCalc.' => 'array',
300 'char' => 'integer',
301 'char.' => 'array',
302 'intval' => 'boolean',
303 'intval.' => 'array',
304 'numberFormat.' => 'array',
305 'date' => 'dateconf',
306 'date.' => 'array',
307 'strftime' => 'strftimeconf',
308 'strftime.' => 'array',
309 'age' => 'boolean',
310 'age.' => 'array',
311 'case' => 'case',
312 'case.' => 'array',
313 'bytes' => 'boolean',
314 'bytes.' => 'array',
315 'substring' => 'parameters',
316 'substring.' => 'array',
317 'removeBadHTML' => 'boolean',
318 'removeBadHTML.' => 'array',
319 'cropHTML' => 'crop',
320 'cropHTML.' => 'array',
321 'stripHtml' => 'boolean',
322 'stripHtml.' => 'array',
323 'crop' => 'crop',
324 'crop.' => 'array',
325 'rawUrlEncode' => 'boolean',
326 'rawUrlEncode.' => 'array',
327 'htmlSpecialChars' => 'boolean',
328 'htmlSpecialChars.' => 'array',
329 'doubleBrTag' => 'string',
330 'doubleBrTag.' => 'array',
331 'br' => 'boolean',
332 'br.' => 'array',
333 'brTag' => 'string',
334 'brTag.' => 'array',
335 'encapsLines.' => 'array',
336 'keywords' => 'boolean',
337 'keywords.' => 'array',
338 'innerWrap' => 'wrap',
339 'innerWrap.' => 'array',
340 'innerWrap2' => 'wrap',
341 'innerWrap2.' => 'array',
342 'fontTag' => 'wrap',
343 'fontTag.' => 'array',
344 'addParams.' => 'array',
345 'textStyle.' => 'array',
346 'tableStyle.' => 'array',
347 'filelink.' => 'array',
348 'preCObject' => 'cObject',
349 'preCObject.' => 'array',
350 'postCObject' => 'cObject',
351 'postCObject.' => 'array',
352 'wrapAlign' => 'align',
353 'wrapAlign.' => 'array',
354 'typolink.' => 'array',
355 'TCAselectItem.' => 'array',
356 'space' => 'space',
357 'space.' => 'array',
358 'spaceBefore' => 'int',
359 'spaceBefore.' => 'array',
360 'spaceAfter' => 'int',
361 'spaceAfter.' => 'array',
362 'wrap' => 'wrap',
363 'wrap.' => 'array',
364 'noTrimWrap' => 'wrap',
365 'noTrimWrap.' => 'array',
366 'wrap2' => 'wrap',
367 'wrap2.' => 'array',
368 'dataWrap' => 'dataWrap',
369 'dataWrap.' => 'array',
370 'prepend' => 'cObject',
371 'prepend.' => 'array',
372 'append' => 'cObject',
373 'append.' => 'array',
374 'wrap3' => 'wrap',
375 'wrap3.' => 'array',
376 'outerWrap' => 'wrap',
377 'outerWrap.' => 'array',
378 'insertData' => 'boolean',
379 'insertData.' => 'array',
380 'offsetWrap' => 'space',
381 'offsetWrap.' => 'array',
382 'postUserFunc' => 'functionName',
383 'postUserFuncInt' => 'functionName',
384 'prefixComment' => 'string',
385 'prefixComment.' => 'array',
386 'editIcons' => 'string',
387 'editIcons.' => 'array',
388 'editPanel' => 'boolean',
389 'editPanel.' => 'array',
390 'stdWrapPostProcess' => 'hook', // this is a placeholder for the last Hook
391 'debug' => 'boolean',
392 'debug.' => 'array',
393 'debugFunc' => 'boolean',
394 'debugFunc.' => 'array',
395 'debugData' => 'boolean',
396 'debugData.' => 'array'
397 );
398
399 /**
400 * Holds ImageMagick parameters and extensions used for compression
401 *
402 * @see IMGTEXT()
403 *
404 * 0= Default
405 * 1= Dont change! (removes all parameters for the image_object!!)
406 * 1x = GIFs
407 * 2x = JPGs
408 */
409 var $image_compression = array(
410 10 => array(
411 'params' => '', 'ext' => 'gif'
412 ),
413 11 => array(
414 'params' => '-colors 128', 'ext' => 'gif'
415 ),
416 12 => array(
417 'params' => '-colors 64', 'ext' => 'gif'
418 ),
419 13 => array(
420 'params' => '-colors 32', 'ext' => 'gif'
421 ),
422 14 => array(
423 'params' => '-colors 16', 'ext' => 'gif'
424 ),
425 15 => array(
426 'params' => '-colors 8', 'ext' => 'gif'
427 ),
428
429 20 => array(
430 'params' => '-quality 100', 'ext' => 'jpg'
431 ),
432 21 => array(
433 'params' => '-quality 90', 'ext' => 'jpg'
434 ),
435 22 => array(
436 'params' => '-quality 80', 'ext' => 'jpg'
437 ),
438 23 => array(
439 'params' => '-quality 70', 'ext' => 'jpg'
440 ),
441 24 => array(
442 'params' => '-quality 60', 'ext' => 'jpg'
443 ),
444 25 => array(
445 'params' => '-quality 50', 'ext' => 'jpg'
446 ),
447 26 => array(
448 'params' => '-quality 40', 'ext' => 'jpg'
449 ),
450 27 => array(
451 'params' => '-quality 30', 'ext' => 'jpg'
452 ),
453 28 => array(
454 'params' => '-quality 20', 'ext' => 'jpg'
455 ),
456
457 30 => array(
458 'params' => '-colors 256', 'ext' => 'png'
459 ),
460 31 => array(
461 'params' => '-colors 128', 'ext' => 'png'
462 ),
463 32 => array(
464 'params' => '-colors 64', 'ext' => 'png'
465 ),
466 33 => array(
467 'params' => '-colors 32', 'ext' => 'png'
468 ),
469 34 => array(
470 'params' => '-colors 16', 'ext' => 'png'
471 ),
472 35 => array(
473 'params' => '-colors 8', 'ext' => 'png'
474 ),
475 39 => array(
476 'params' => '', 'ext' => 'png'
477 ),
478 );
479
480 /**
481 * ImageMagick parameters for image effects
482 *
483 * @see IMGTEXT()
484 */
485 var $image_effects = array(
486 1 => '-rotate 90',
487 2 => '-rotate 270',
488 3 => '-rotate 180',
489 10 => '-colorspace GRAY',
490 11 => '-sharpen 70',
491 20 => '-normalize',
492 23 => '-contrast',
493 25 => '-gamma 1.3',
494 26 => '-gamma 0.8'
495 );
496
497 /**
498 * Loaded with the current data-record.
499 *
500 * If the instance of this class is used to render records from the database those records are found in this array.
501 * The function stdWrap has TypoScript properties that fetch field-data from this array.
502 * @see init()
503 */
504 var $data = array();
505 protected $table = '';
506 var $oldData = array(); // Used for backup...
507 var $alternativeData = ''; // If this is set with an array before stdWrap, it's used instead of $this->data in the data-property in stdWrap
508 var $parameters = array(); // Used by the parseFunc function and is loaded with tag-parameters when parsing tags.
509 var $currentValKey = 'currentValue_kidjls9dksoje';
510 var $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.
511 var $currentRecordTotal = 0; // Set in cObj->RECORDS and cObj->CONTENT to the current number of records selected in a query.
512 var $currentRecordNumber = 0; // Incremented in cObj->RECORDS and cObj->CONTENT before each record rendering.
513 var $parentRecordNumber = 0; // Incremented in parent cObj->RECORDS and cObj->CONTENT before each record rendering.
514 var $parentRecord = array(); // If the tslib_cObj 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.
515 var $regObj; // 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.
516
517
518 // internal
519 var $INT_include = 0; // Is set to 1 if the instance of this cObj is executed from a PHP_SCRIPT_INT -include script (see pagegen, bottom of document)
520 var $checkPid_cache = array(); // 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.
521 var $checkPid_badDoktypeList = '255';
522 var $lastTypoLinkUrl = ''; // This will be set by typoLink() to the url of the most recent link created.
523 var $lastTypoLinkTarget = ''; // DO. link target.
524 var $lastTypoLinkLD = array();
525 var $substMarkerCache = array(); // Caching substituteMarkerArrayCached function
526 var $recordRegister = array(); // array that registers rendered content elements (or any table) to make sure they are not rendered recursively!
527 var $cObjHookObjectsArr = array(); // Containig hooks for userdefined cObjects
528 protected $stdWrapHookObjects = array(); // Containing hook objects for stdWrap
529 protected $getImgResourceHookObjects; // Containing hook objects for getImgResource
530
531 protected $contentObjects = array();
532
533 /**
534 * Set to TRUE by doConvertToUserIntObject() if USER object wants to become USER_INT
535 */
536 public $doConvertToUserIntObject = FALSE;
537
538 /**
539 * Indicates current object type. Can hold one of OBJECTTYPE_ constants or FALSE.
540 * The value is set and reset inside USER() function. Any time outside of
541 * USER() it is FALSE.
542 */
543 protected $userObjectType = FALSE;
544
545 /**
546 * Indicates that object type is USER.
547 *
548 * @see tslib_cObjh::$userObjectType
549 */
550 const OBJECTTYPE_USER_INT = 1;
551
552 /**
553 * Indicates that object type is USER.
554 *
555 * @see tslib_cObjh::$userObjectType
556 */
557 const OBJECTTYPE_USER = 2;
558
559 /**
560 * Class constructor.
561 * Well, it has to be called manually since it is not a real constructor function.
562 * 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.
563 *
564 * @param array $data the record data that is rendered.
565 * @param string $table the table that the data record is from.
566 * @return void
567 */
568 function start($data, $table = '') {
569 global $TYPO3_CONF_VARS;
570 $this->data = $data;
571 $this->table = $table;
572 $this->currentRecord = $table ? $table . ':' . $this->data['uid'] : '';
573 $this->parameters = array();
574 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClass'])) {
575 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClass'] as $classArr) {
576 $this->cObjHookObjectsArr[$classArr[0]] = t3lib_div::getUserObj($classArr[1]);
577 }
578 }
579
580 $this->stdWrapHookObjects = array();
581 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['stdWrap'])) {
582 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['stdWrap'] as $classData) {
583 $hookObject = t3lib_div::getUserObj($classData);
584
585 if (!($hookObject instanceof tslib_content_stdWrapHook)) {
586 throw new UnexpectedValueException(
587 '$hookObject must implement interface tslib_content_stdWrapHook',
588 1195043965
589 );
590 }
591
592 $this->stdWrapHookObjects[] = $hookObject;
593 }
594 }
595
596 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['postInit'])) {
597 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['postInit'] as $classData) {
598 $postInitializationProcessor = t3lib_div::getUserObj($classData);
599
600 if (!($postInitializationProcessor instanceof tslib_content_PostInitHook)) {
601 throw new UnexpectedValueException(
602 '$postInitializationProcessor must implement interface tslib_content_PostInitHook',
603 1274563549
604 );
605 }
606
607 $postInitializationProcessor->postProcessContentObjectInitialization($this);
608 }
609 }
610 }
611
612 /**
613 * Gets the 'getImgResource' hook objects.
614 * The first call initializes the accordant objects.
615 *
616 * @return array The 'getImgResource' hook objects (if any)
617 */
618 protected function getGetImgResourceHookObjects() {
619 if (!isset($this->getImgResourceHookObjects)) {
620 $this->getImgResourceHookObjects = array();
621
622 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getImgResource'])) {
623 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getImgResource'] as $classData) {
624 $hookObject = t3lib_div::getUserObj($classData);
625
626 if (!($hookObject instanceof tslib_cObj_getImgResourceHook)) {
627 throw new UnexpectedValueException(
628 '$hookObject must implement interface tslib_cObj_getImgResourceHook',
629 1218636383
630 );
631 }
632
633 $this->getImgResourceHookObjects[] = $hookObject;
634 }
635 }
636 }
637
638 return $this->getImgResourceHookObjects;
639 }
640
641 /**
642 * Sets the internal variable parentRecord with information about current record.
643 * If the tslib_cObj 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.
644 *
645 * @param array $data: The record array
646 * @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.
647 * @return void
648 * @access private
649 */
650 function setParent($data, $currentRecord) {
651 $this->parentRecord = array(
652 'data' => $data,
653 'currentRecord' => $currentRecord
654 );
655 }
656
657
658
659 /***********************************************
660 *
661 * CONTENT_OBJ:
662 *
663 ***********************************************/
664
665 /**
666 * Returns the "current" value.
667 * 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.
668 * It's like "load accumulator" in the good old C64 days... basically a "register" you can use as you like.
669 * 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.
670 *
671 * @return mixed The "current" value
672 */
673 function getCurrentVal() {
674 return $this->data[$this->currentValKey];
675 }
676
677 /**
678 * Sets the "current" value.
679 *
680 * @param mixed The variable that you want to set as "current"
681 * @return void
682 * @see getCurrentVal()
683 */
684 function setCurrentVal($value) {
685 $this->data[$this->currentValKey] = $value;
686 }
687
688 /**
689 * Rendering of a "numerical array" of cObjects from TypoScript
690 * Will call ->cObjGetSingle() for each cObject found and accumulate the output.
691 *
692 * @param array $setup: array with cObjects as values.
693 * @param string $addKey: A prefix for the debugging information
694 * @return string Rendered output from the cObjects in the array.
695 * @see cObjGetSingle()
696 */
697 function cObjGet($setup, $addKey = '') {
698 if (is_array($setup)) {
699 $sKeyArray = t3lib_TStemplate::sortedKeyList($setup);
700 $content = '';
701 foreach ($sKeyArray as $theKey) {
702 $theValue = $setup[$theKey];
703 if (intval($theKey) && !strstr($theKey, '.')) {
704 $conf = $setup[$theKey . '.'];
705 $content .= $this->cObjGetSingle($theValue, $conf, $addKey . $theKey); // Get the contentObject
706 }
707 }
708 return $content;
709 }
710 }
711
712 /**
713 * Renders a content object
714 *
715 * @param string The content object name, eg. "TEXT" or "USER" or "IMAGE"
716 * @param array The array with TypoScript properties for the content object
717 * @param string A string label used for the internal debugging tracking.
718 * @return string cObject output
719 * @example http://typo3.org/doc.0.html?&encryptionKey=&tx_extrepmgm_pi1[extUid]=267&tx_extrepmgm_pi1[tocEl]=153&cHash=7e74f4d331
720 */
721 function cObjGetSingle($name, $conf, $TSkey = '__') {
722 global $TYPO3_CONF_VARS;
723
724 $content = '';
725 // Checking that the function is not called eternally. This is done by interrupting at a depth of 100
726 $GLOBALS['TSFE']->cObjectDepthCounter--;
727 if ($GLOBALS['TSFE']->cObjectDepthCounter > 0) {
728 $name = trim($name);
729 if ($GLOBALS['TT']->LR)
730 $GLOBALS['TT']->push($TSkey, $name);
731
732 // Checking if the COBJ is a reference to another object. (eg. name of 'blabla.blabla = < styles.something')
733 if (substr($name, 0, 1) == '<') {
734 $key = trim(substr($name, 1));
735 $cF = t3lib_div::makeInstance('t3lib_TSparser');
736 // $name and $conf is loaded with the referenced values.
737 $old_conf = $conf;
738 list ($name, $conf) = $cF->getVal($key, $GLOBALS['TSFE']->tmpl->setup);
739 if (is_array($old_conf) && count($old_conf)) {
740 $conf = $this->joinTSarrays($conf, $old_conf);
741 }
742 // Getting the cObject
743 $GLOBALS['TT']->incStackPointer();
744 $content .= $this->cObjGetSingle($name, $conf, $key);
745 $GLOBALS['TT']->decStackPointer();
746 } else {
747
748 $hooked = FALSE;
749 // Application defined cObjects
750 foreach ($this->cObjHookObjectsArr as $cObjName => $hookObj) {
751 if (($name === $cObjName) && method_exists($hookObj, 'cObjGetSingleExt')) {
752 $content .= $hookObj->cObjGetSingleExt($name, $conf, $TSkey, $this);
753 $hooked = TRUE;
754 }
755 }
756 if (!$hooked) {
757 $contentObject = $this->getContentObject($name);
758 if ($contentObject) {
759 $content .= $contentObject->render($conf);
760 } else {
761 // call hook functions for extra processing
762 if ($name && is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClassDefault'])) {
763 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClassDefault'] as $classData) {
764 $hookObject = t3lib_div::getUserObj($classData);
765
766 if (!($hookObject instanceof tslib_content_cObjGetSingleHook)) {
767 throw new UnexpectedValueException(
768 '$hookObject must implement interface tslib_content_cObjGetSingleHook',
769 1195043731
770 );
771 }
772 /* @var $hookObject tslib_content_cObjGetSingleHook */
773 $content .= $hookObject->getSingleContentObject($name, (array) $conf, $TSkey, $this);
774 }
775 } else {
776 // log error in AdminPanel
777 $warning = sprintf('Content Object "%s" does not exist', $name);
778 $GLOBALS['TT']->setTSlogMessage($warning, 2);
779 }
780 }
781 }
782 }
783 if ($GLOBALS['TT']->LR)
784 $GLOBALS['TT']->pull($content);
785 }
786 // Increasing on exit...
787 $GLOBALS['TSFE']->cObjectDepthCounter++;
788 return $content;
789 }
790
791 /**
792 * Returns a new content object of type $name.
793 *
794 * @param string $name
795 * @return tslib_content_abstract
796 */
797 public function getContentObject($name) {
798 $classMapping = array(
799 'HTML' => 'Html',
800 'TEXT' => 'Text',
801 'CASE' => 'Case',
802 'CLEARGIF' => 'ClearGif',
803 'COBJ_ARRAY' => 'ContentObjectArray',
804 'COA' => 'ContentObjectArray',
805 'COA_INT' => 'ContentObjectArray_Internal',
806 'USER' => 'User',
807 'USER_INT' => 'User_Internal',
808 'FILE' => 'File',
809 'IMAGE' => 'Image',
810 'IMG_RESOURCE' => 'ImageResource',
811 'IMGTEXT' => 'ImageText',
812 'CONTENT' => 'Content',
813 'RECORDS' => 'Records',
814 'HMENU' => 'HierarchicalMenu',
815 'CTABLE' => 'ContentTable',
816 'OTABLE' => 'OffsetTable',
817 'COLUMNS' => 'Columns',
818 'HRULER' => 'HorizontalRuler',
819 'CASEFUNC' => 'Case',
820 'LOAD_REGISTER' => 'LoadRegister',
821 'RESTORE_REGISTER' => 'RestoreRegister',
822 'FORM' => 'Form',
823 'SEARCHRESULT' => 'SearchResult',
824 'PHP_SCRIPT' => 'PhpScript',
825 'PHP_SCRIPT_INT' => 'PhpScript_Internal',
826 'TEMPLATE' => 'Template',
827 'FLUIDTEMPLATE' => 'FluidTemplate',
828 'MULTIMEDIA' => 'Multimedia',
829 'MEDIA' => 'Media',
830 'SWFOBJECT' => 'ShockwaveFlashObject',
831 'QTOBJECT' => 'QuicktimeObject',
832 'SVG' => 'ScalableVectorGraphics',
833 'EDITPANEL' => 'EditPanel',
834 );
835 $name = $classMapping[$name];
836
837 if (!array_key_exists($name, $this->contentObjects)) {
838 try {
839 $this->contentObjects[$name] = t3lib_div::makeInstance('tslib_content_' . $name, $this);
840 } catch (ReflectionException $e) {
841 $this->contentObjects[$name] = NULL;
842 }
843 }
844 return $this->contentObjects[$name];
845 }
846
847
848 /********************************************
849 *
850 * Functions rendering content objects (cObjects)
851 *
852 ********************************************/
853
854 /**
855 * Rendering the cObject, HTML
856 *
857 * @param array array of TypoScript properties
858 * @return string Output
859 */
860 function HTML($conf) {
861 return $this->getContentObject('HTML')->render($conf);
862 }
863
864 /**
865 * Rendering the cObject, TEXT
866 *
867 * @param array array of TypoScript properties
868 * @return string Output
869 */
870 function TEXT($conf) {
871 return $this->getContentObject('TEXT')->render($conf);
872 }
873
874 /**
875 * Rendering the cObject, CLEARGIF
876 *
877 * @param array array of TypoScript properties
878 * @return string Output
879 */
880 function CLEARGIF($conf) {
881 return $this->getContentObject('CLEARGIF')->render($conf);
882 }
883
884 /**
885 * Rendering the cObject, COBJ_ARRAY / COA and COBJ_ARRAY_INT
886 *
887 * @param array array of TypoScript properties
888 * @param string If "INT" then the cObject is a "COBJ_ARRAY_INT" (non-cached), otherwise just "COBJ_ARRAY" (cached)
889 * @return string Output
890 */
891 function COBJ_ARRAY($conf, $ext = '') {
892 if ($ext === 'INT') {
893 return $this->getContentObject('COA_INT')->render($conf);
894 } else {
895 return $this->getContentObject('COA')->render($conf);
896 }
897 }
898
899 /**
900 * Rendering the cObject, USER and USER_INT
901 *
902 * @param array array of TypoScript properties
903 * @param string If "INT" then the cObject is a "USER_INT" (non-cached), otherwise just "USER" (cached)
904 * @return string Output
905 */
906 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('tslib_cObj::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 array of TypoScript properties
953 * @return string Output
954 */
955 function FILE($conf) {
956 return $this->getContentObject('FILE')->render($conf);
957 }
958
959 /**
960 * Rendering the cObject, IMAGE
961 *
962 * @param array array of TypoScript properties
963 * @return string Output
964 * @see cImage()
965 */
966 function IMAGE($conf) {
967 return $this->getContentObject('IMAGE')->render($conf);
968 }
969
970 /**
971 * Rendering the cObject, IMG_RESOURCE
972 *
973 * @param array array of TypoScript properties
974 * @return string Output
975 * @see getImgResource()
976 */
977 function IMG_RESOURCE($conf) {
978 return $this->getContentObject('IMG_RESOURCE')->render($conf);
979 }
980
981 /**
982 * Rendering the cObject, IMGTEXT
983 *
984 * @param array array of TypoScript properties
985 * @return string Output
986 */
987 function IMGTEXT($conf) {
988 return $this->getContentObject('IMGTEXT')->render($conf);
989 }
990
991 /**
992 * Rendering the cObject, CONTENT
993 *
994 * @param array array of TypoScript properties
995 * @return string Output
996 */
997 function CONTENT($conf) {
998 return $this->getContentObject('CONTENT')->render($conf);
999 }
1000
1001 /**
1002 * Rendering the cObject, RECORDS
1003 *
1004 * @param array array of TypoScript properties
1005 * @return string Output
1006 */
1007 function RECORDS($conf) {
1008 return $this->getContentObject('RECORDS')->render($conf);
1009 }
1010
1011 /**
1012 * Rendering the cObject, HMENU
1013 *
1014 * @param array array of TypoScript properties
1015 * @return string Output
1016 */
1017 function HMENU($conf) {
1018 return $this->getContentObject('HMENU')->render($conf);
1019 }
1020
1021 /**
1022 * Rendering the cObject, CTABLE
1023 *
1024 * @param array array of TypoScript properties
1025 * @return string Output
1026 */
1027 function CTABLE($conf) {
1028 return $this->getContentObject('CTABLE')->render($conf);
1029 }
1030
1031 /**
1032 * Rendering the cObject, OTABLE
1033 *
1034 * @param array array of TypoScript properties
1035 * @return string Output
1036 */
1037 function OTABLE($conf) {
1038 return $this->getContentObject('OTABLE')->render($conf);
1039 }
1040
1041 /**
1042 * Rendering the cObject, COLUMNS
1043 *
1044 * @param array array of TypoScript properties
1045 * @return string Output
1046 */
1047 function COLUMNS($conf) {
1048 return $this->getContentObject('COLUMNS')->render($conf);
1049 }
1050
1051 /**
1052 * Rendering the cObject, HRULER
1053 *
1054 * @param array array of TypoScript properties
1055 * @return string Output
1056 */
1057 function HRULER($conf) {
1058 return $this->getContentObject('HRULER')->render($conf);
1059 }
1060
1061 /**
1062 * Rendering the cObject, CASE
1063 *
1064 * @param array array of TypoScript properties
1065 * @return string Output
1066 */
1067 function CASEFUNC($conf) {
1068 return $this->getContentObject('CASE')->render($conf);
1069 }
1070
1071 /**
1072 * Rendering the cObject, LOAD_REGISTER and RESTORE_REGISTER
1073 * NOTICE: This cObject does NOT return any content since it just sets internal data based on the TypoScript properties.
1074 *
1075 * @param array array of TypoScript properties
1076 * @param string If "RESTORE_REGISTER" then the cObject rendered is "RESTORE_REGISTER", otherwise "LOAD_REGISTER"
1077 * @return string Empty string (the cObject only sets internal data!)
1078 */
1079 function LOAD_REGISTER($conf, $name) {
1080 if ($name === 'RESTORE_REGISTER') {
1081 return $this->getContentObject('RESTORE_REGISTER')->render($conf);
1082 } else {
1083 return $this->getContentObject('LOAD_REGISTER')->render($conf);
1084 }
1085 }
1086
1087 /**
1088 * Rendering the cObject, FORM
1089 *
1090 * @param array array of TypoScript properties
1091 * @param array Alternative formdata overriding whatever comes from TypoScript
1092 * @return string Output
1093 */
1094 function FORM($conf, $formData = '') {
1095 return $this->getContentObject('FORM')->render($conf);
1096 }
1097
1098 /**
1099 * Rendering the cObject, SEARCHRESULT
1100 *
1101 * @param array array of TypoScript properties
1102 * @return string Output
1103 */
1104 function SEARCHRESULT($conf) {
1105 return $this->getContentObject('SEARCHRESULT')->render($conf);
1106 }
1107
1108 /**
1109 * Rendering the cObject, PHP_SCRIPT, PHP_SCRIPT_INT and PHP_SCRIPT_EXT
1110 *
1111 * @param array array of TypoScript properties
1112 * @param string If "INT", then rendering "PHP_SCRIPT_INT"; If "EXT", then rendering "PHP_SCRIPT_EXT"; Default is rendering "PHP_SCRIPT" (cached)
1113 * @return string Output
1114 */
1115 function PHP_SCRIPT($conf, $ext = '') {
1116 if ($ext === 'INT' || $ext === 'EXT') {
1117 return $this->getContentObject('PHP_SCRIPT_INT')->render($conf, $ext);
1118 } else {
1119 return $this->getContentObject('PHP_SCRIPT')->render($conf);
1120 }
1121 }
1122
1123 /**
1124 * Rendering the cObject, TEMPLATE
1125 *
1126 * @param array array of TypoScript properties
1127 * @return string Output
1128 * @see substituteMarkerArrayCached()
1129 */
1130 function TEMPLATE($conf) {
1131 return $this->getContentObject('TEMPLATE')->render($conf);
1132 }
1133
1134 /**
1135 * Rendering the cObject, FLUIDTEMPLATE
1136 *
1137 * @param array array of TypoScript properties
1138 * @return string the HTML output
1139 * @author Steffen Ritter <info@steffen-ritter.net>
1140 * @author Benjamin Mack <benni@typo3.org>
1141 */
1142 protected function FLUIDTEMPLATE(array $conf) {
1143 return $this->getContentObject('FLUIDTEMPLATE')->render($conf);
1144 }
1145
1146 /**
1147 * Rendering the cObject, MULTIMEDIA
1148 *
1149 * @param array array of TypoScript properties
1150 * @return string Output
1151 */
1152 function MULTIMEDIA($conf) {
1153 return $this->getContentObject('MULTIMEDIA')->render($conf);
1154 }
1155
1156 /**
1157 * Rendering the cObject, MEDIA
1158 *
1159 * @param array array of TypoScript properties
1160 * @return string Output
1161 */
1162 public function MEDIA($conf) {
1163 return $this->getContentObject('MEDIA')->render($conf);
1164 }
1165
1166 /**
1167 * Rendering the cObject, SWFOBJECT
1168 *
1169 * @param array array of TypoScript properties
1170 * @return string Output
1171 */
1172 public function SWFOBJECT($conf) {
1173 return $this->getContentObject('SWFOBJECT')->render($conf);
1174 }
1175
1176 /**
1177 * Rendering the cObject, QTOBJECT
1178 *
1179 * @param array array of TypoScript properties
1180 * @return string Output
1181 */
1182 public function QTOBJECT($conf) {
1183 return $this->getContentObject('QTOBJECT')->render($conf);
1184 }
1185
1186 /**
1187 * Rendering the cObject, SVG
1188 *
1189 * @param array array of TypoScript properties
1190 * @return string Output
1191 */
1192 public function SVG($conf) {
1193 return $this->getContentObject('SVG')->render($conf);
1194 }
1195
1196 /************************************
1197 *
1198 * Various helper functions for content objects:
1199 *
1200 ************************************/
1201
1202
1203 /**
1204 * Converts a given config in Flexform to a conf-array
1205 * @param string Flexform data
1206 * @param array array to write the data into, by reference
1207 * @param boolean is set if called recursive. Don't call function with this parameter, it's used inside the function only
1208 * @access public
1209 *
1210 */
1211 public function readFlexformIntoConf($flexData, &$conf, $recursive = FALSE) {
1212 if ($recursive === FALSE) {
1213 $flexData = t3lib_div::xml2array($flexData, 'T3');
1214 }
1215
1216 if (is_array($flexData)) {
1217 if (isset($flexData['data']['sDEF']['lDEF'])) {
1218 $flexData = $flexData['data']['sDEF']['lDEF'];
1219 }
1220
1221 foreach ($flexData as $key => $value) {
1222 if (is_array($value['el']) && count($value['el']) > 0) {
1223 foreach ($value['el'] as $ekey => $element) {
1224 if (isset($element['vDEF'])) {
1225 $conf[$ekey] = $element['vDEF'];
1226 } else {
1227 if (is_array($element)) {
1228 $this->readFlexformIntoConf($element, $conf[$key][key($element)][$ekey], TRUE);
1229 } else {
1230 $this->readFlexformIntoConf($element, $conf[$key][$ekey], TRUE);
1231 }
1232 }
1233 }
1234 } else {
1235 $this->readFlexformIntoConf($value['el'], $conf[$key], TRUE);
1236 }
1237 if ($value['vDEF']) {
1238 $conf[$key] = $value['vDEF'];
1239 }
1240 }
1241 }
1242 }
1243
1244
1245 /**
1246 * Returns all parents of the given PID (Page UID) list
1247 *
1248 * @param string A list of page Content-Element PIDs (Page UIDs) / stdWrap
1249 * @param array stdWrap array for the list
1250 * @return string A list of PIDs
1251 * @access private
1252 */
1253 function getSlidePids($pidList, $pidConf) {
1254 $pidList = trim($this->stdWrap($pidList, $pidConf));
1255 if (!strcmp($pidList, '')) {
1256 $pidList = 'this';
1257 }
1258 if (trim($pidList)) {
1259 $listArr = t3lib_div::intExplode(',', str_replace('this', $GLOBALS['TSFE']->contentPid, $pidList));
1260 $listArr = $this->checkPidArray($listArr);
1261 }
1262 $pidList = array();
1263 if (is_array($listArr) && count($listArr)) {
1264 foreach ($listArr as $uid) {
1265 $page = $GLOBALS['TSFE']->sys_page->getPage($uid);
1266 if (!$page['is_siteroot']) {
1267 $pidList[] = $page['pid'];
1268 }
1269 }
1270 }
1271 return implode(',', $pidList);
1272 }
1273
1274 /**
1275 * Returns a default value for a form field in the FORM cObject.
1276 * Page CANNOT be cached because that would include the inserted value for the current user.
1277 *
1278 * @param boolean If noValueInsert OR if the no_cache flag for this page is NOT set, the original default value is returned.
1279 * @param string $fieldName: The POST var name to get default value for
1280 * @param string $defaultVal: The current default value
1281 * @return string The default value, either from INPUT var or the current default, based on whether caching is enabled or not.
1282 * @access private
1283 */
1284 function getFieldDefaultValue($noValueInsert, $fieldName, $defaultVal) {
1285 if (!$GLOBALS['TSFE']->no_cache || (!isset($_POST[$fieldName]) && !isset($_GET[$fieldName])) || $noValueInsert) {
1286 return $defaultVal;
1287 } else {
1288 return t3lib_div::_GP($fieldName);
1289 }
1290 }
1291
1292 /**
1293 * Returns a <img> tag with the image file defined by $file and processed according to the properties in the TypoScript array.
1294 * Mostly this function is a sub-function to the IMAGE function which renders the IMAGE cObject in TypoScript.
1295 * This function is called by "$this->cImage($conf['file'],$conf);" from IMAGE().
1296 *
1297 * @param string File TypoScript resource
1298 * @param array TypoScript configuration properties
1299 * @return string <img> tag, (possibly wrapped in links and other HTML) if any image found.
1300 * @access private
1301 * @see IMAGE()
1302 */
1303 function cImage($file, $conf) {
1304 $info = $this->getImgResource($file, $conf['file.']);
1305 $GLOBALS['TSFE']->lastImageInfo = $info;
1306 if (is_array($info)) {
1307 $info[3] = t3lib_div::png_to_gif_by_imagemagick($info[3]);
1308 $GLOBALS['TSFE']->imagesOnPage[] = $info[3]; // This array is used to collect the image-refs on the page...
1309
1310
1311 // Backwards compatibility if altText is not set and alttext is set
1312 // @deprecated since TYPO3 4.3, will be removed in TYPO3 4.6
1313 if (strlen($conf['alttext']) || is_array($conf['alttext.'])) {
1314 $GLOBALS['TSFE']->logDeprecatedTyposcript(
1315 'IMAGE.alttext',
1316 'use IMAGE.altText instead - src: ' . $info[3] . ' - original image: ' . $info['origFile']
1317 );
1318 if (!strlen($conf['altText']) && !is_array($conf['altText.'])) {
1319 $conf['altText'] = $conf['alttext'];
1320 $conf['altText.'] = $conf['alttext.'];
1321 }
1322 }
1323
1324 $altParam = $this->getAltParam($conf);
1325 $theValue = '<img src="' . htmlspecialchars($GLOBALS['TSFE']->absRefPrefix .
1326 t3lib_div::rawUrlEncodeFP($info[3])) . '" width="' . $info[0] . '" height="' . $info[1] . '"' .
1327 $this->getBorderAttr(' border="' . intval($conf['border']) . '"') .
1328 (($conf['params'] || is_array($conf['params.'])) ? ' ' . $this->stdWrap($conf['params'], $conf['params.']) : '') .
1329 ($altParam) . ' />';
1330 if ($conf['linkWrap']) {
1331 $theValue = $this->linkWrap($theValue, $conf['linkWrap']);
1332 } elseif ($conf['imageLinkWrap']) {
1333 $theValue = $this->imageLinkWrap($theValue, $info['origFile'], $conf['imageLinkWrap.']);
1334 }
1335 return $this->wrap($theValue, $conf['wrap']);
1336 }
1337 }
1338
1339 /**
1340 * Returns the 'border' attribute for an <img> tag only if the doctype is not xhtml_strict,xhtml_11 or xhtml_2
1341 * or if the config parameter 'disableImgBorderAttr' is not set.
1342 *
1343 * @param string the border attribute
1344 * @return string the border attribute
1345 */
1346 function getBorderAttr($borderAttr) {
1347 if (!t3lib_div::inList( 'xhtml_strict,xhtml_11,xhtml_2',
1348 $GLOBALS['TSFE']->xhtmlDoctype)
1349 && !$GLOBALS['TSFE']->config['config']['disableImgBorderAttr']) {
1350 return $borderAttr;
1351 }
1352 }
1353
1354 /**
1355 * Wraps the input string in link-tags that opens the image in a new window.
1356 *
1357 * @param string String to wrap, probably an <img> tag
1358 * @param string The original image file
1359 * @param array TypoScript properties for the "imageLinkWrap" function
1360 * @return string The input string, $string, wrapped as configured.
1361 * @see cImage()
1362 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=316&cHash=2848266da6
1363 */
1364 function imageLinkWrap($string, $imageFile, $conf) {
1365 $a1 = '';
1366 $a2 = '';
1367 $content = $string;
1368 if ($this->stdWrap($conf['enable'], $conf['enable.'])) {
1369 $content = $this->typolink($string, $conf['typolink.']);
1370 $imageFile = $this->stdWrap($imageFile, $conf['file.']);
1371
1372 // imageFileLink:
1373 if ($content == $string && @is_file($imageFile)) {
1374 $params = '';
1375 if ($conf['width']) {
1376 $params .= '&width=' . rawurlencode($conf['width']);
1377 }
1378 if ($conf['height']) {
1379 $params .= '&height=' . rawurlencode($conf['height']);
1380 }
1381 if ($conf['effects']) {
1382 $params .= '&effects=' . rawurlencode($conf['effects']);
1383 }
1384 if ($conf['sample']) {
1385 $params .= '&sample=1';
1386 }
1387 if ($conf['alternativeTempPath']) {
1388 $params .= '&alternativeTempPath=' . rawurlencode($conf['alternativeTempPath']);
1389 }
1390
1391 // includes lines above in cache
1392 $showPicContent = '
1393 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1394
1395 <html>
1396 <head>
1397 <title>' . htmlspecialchars($conf['title'] ? $conf['title'] : 'Image') . '</title>
1398 ' . ($conf['title'] ? '' : '<meta name="robots" content="noindex,follow" />') . '
1399 </head>
1400 ' . ($conf['bodyTag'] ? $conf['bodyTag'] : '<body>');
1401
1402 $wrapParts = explode('|', $conf['wrap']);
1403 $showPicContent .= trim($wrapParts[0]) . '###IMAGE###' . trim($wrapParts[1]);
1404 $showPicContent .= '
1405 </body>
1406 </html>';
1407 $contentHash = md5('showpic' . $showPicContent);
1408 t3lib_pageSelect::storeHash($contentHash, $showPicContent, 'showpic');
1409
1410 $md5_value = md5($imageFile . '|' . $conf['width'] . '|' . $conf['height'] . '|' .
1411 $conf['effects'] . '||||' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] . '|');
1412
1413 $params .= '&md5=' . $md5_value . '&contentHash=' . $contentHash;
1414 $url = $GLOBALS['TSFE']->absRefPrefix . 'index.php?eID=tx_cms_showpic&file=' . rawurlencode($imageFile) . $params;
1415
1416 if ($conf['directImageLink']) {
1417 $imgResourceConf = array(
1418 'file' => $imageFile,
1419 'file.' => $conf
1420 );
1421 $url = $this->IMG_RESOURCE($imgResourceConf);
1422 if (!$url) {
1423 // if no imagemagick / gm is available
1424 $url = $imageFile;
1425 }
1426 }
1427
1428 // Create TARGET-attribute only if the right doctype is used
1429 if (!t3lib_div::inList('xhtml_strict,xhtml_11,xhtml_2', $GLOBALS['TSFE']->xhtmlDoctype)) {
1430 if (isset($conf['target'])) {
1431 $target = sprintf(' target="%s"', $conf['target']);
1432 } else {
1433 $target = ' target="thePicture"';
1434 }
1435 } else {
1436 $target = '';
1437 }
1438 $conf['JSwindow'] = $this->stdWrap($conf['JSwindow'], $conf['JSwindow.']);
1439 if ($conf['JSwindow']) {
1440 if ($conf['JSwindow.']['altUrl'] || $conf['JSwindow.']['altUrl.']) {
1441 $altUrl = $this->stdWrap($conf['JSwindow.']['altUrl'], $conf['JSwindow.']['altUrl.']);
1442 if ($altUrl) {
1443 $url = $altUrl .
1444 ($conf['JSwindow.']['altUrl_noDefaultParams'] ? '' : '?file=' .
1445 rawurlencode($imageFile) . $params);
1446 }
1447 }
1448 $gifCreator = t3lib_div::makeInstance('tslib_gifbuilder');
1449 $gifCreator->init();
1450 $gifCreator->mayScaleUp = 0;
1451 $dims = $gifCreator->getImageScale($gifCreator->getImageDimensions($imageFile), $conf['width'], $conf['height'], '');
1452 $offset = t3lib_div::intExplode(',', $conf['JSwindow.']['expand'] . ',');
1453
1454 $a1 = '<a href="' . htmlspecialchars($url) . '" onclick="' .
1455 htmlspecialchars('openPic(\'' . $GLOBALS['TSFE']->baseUrlWrap($url) . '\',\'' .
1456 ($conf['JSwindow.']['newWindow'] ? md5($url) : 'thePicture') . '\',\'width=' .
1457 ($dims[0] + $offset[0]) . ',height=' . ($dims[1] + $offset[1]) .
1458 ',status=0,menubar=0\'); return false;') . '"' .
1459 $target . $GLOBALS['TSFE']->ATagParams . '>';
1460 $a2 = '</a>';
1461 $GLOBALS['TSFE']->setJS('openPic');
1462 } else {
1463 $conf['linkParams.']['parameter'] = $url;
1464 $string = $this->typoLink($string, $conf['linkParams.']);
1465 }
1466
1467 $string = $this->stdWrap($string, $conf['stdWrap.']);
1468
1469 $content = $a1 . $string . $a2;
1470 }
1471 }
1472
1473 return $content;
1474 }
1475
1476 /**
1477 * Returns content of a file. If it's an image the content of the file is not returned but rather an image tag is.
1478 *
1479 * @param string The filename, being a TypoScript resource data type
1480 * @param string Additional parameters (attributes). Default is empty alt and title tags.
1481 * @return string If jpg,gif,jpeg,png: returns image_tag with picture in. If html,txt: returns content string
1482 * @see FILE()
1483 */
1484 function fileResource($fName, $addParams = 'alt="" title=""') {
1485 $incFile = $GLOBALS['TSFE']->tmpl->getFileName($fName);
1486 if ($incFile) {
1487 $fileinfo = t3lib_div::split_fileref($incFile);
1488 if (t3lib_div::inList('jpg,gif,jpeg,png', $fileinfo['fileext'])) {
1489 $imgFile = $incFile;
1490 $imgInfo = @getImageSize($imgFile);
1491 return '<img src="' . $GLOBALS['TSFE']->absRefPrefix . $imgFile .
1492 '" width="' . $imgInfo[0] . '" height="' . $imgInfo[1] . '"' .
1493 $this->getBorderAttr(' border="0"') . ' ' . $addParams . ' />';
1494 } elseif (filesize($incFile) < 1024 * 1024) {
1495 return $GLOBALS['TSFE']->tmpl->fileContent($incFile);
1496 }
1497 }
1498 }
1499
1500 /**
1501 * Sets the SYS_LASTCHANGED timestamp if input timestamp is larger than current value.
1502 * The SYS_LASTCHANGED timestamp can be used by various caching/indexing applications to determine if the page has new content.
1503 * Therefore you should call this function with the last-changed timestamp of any element you display.
1504 *
1505 * @param integer Unix timestamp (number of seconds since 1970)
1506 * @return void
1507 * @see tslib_fe::setSysLastChanged()
1508 */
1509 function lastChanged($tstamp) {
1510 $tstamp = intval($tstamp);
1511 if ($tstamp > intval($GLOBALS['TSFE']->register['SYS_LASTCHANGED'])) {
1512 $GLOBALS['TSFE']->register['SYS_LASTCHANGED'] = $tstamp;
1513 }
1514 }
1515
1516 /**
1517 * Wraps the input string by the $wrap value and implements the "linkWrap" data type as well.
1518 * 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.
1519 *
1520 * @param string Input string
1521 * @param string A string where the first two parts separated by "|" (vertical line) will be wrapped around the input string
1522 * @return string Wrapped output string
1523 * @see wrap(), cImage(), FILE()
1524 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=282&cHash=831a95115d
1525 */
1526 function linkWrap($content, $wrap) {
1527 $wrapArr = explode('|', $wrap);
1528 if (preg_match('/\{([0-9]*)\}/', $wrapArr[0], $reg)) {
1529 if ($uid = $GLOBALS['TSFE']->tmpl->rootLine[$reg[1]]['uid']) {
1530 $wrapArr[0] = str_replace($reg[0], $uid, $wrapArr[0]);
1531 }
1532 }
1533 return trim($wrapArr[0]) . $content . trim($wrapArr[1]);
1534 }
1535
1536 /**
1537 * An abstraction method which creates an alt or title parameter for an HTML img, applet, area or input element and the FILE content element.
1538 * From the $conf array it implements the properties "altText", "titleText" and "longdescURL"
1539 *
1540 * @param array TypoScript configuration properties
1541 * @param boolean If set, the longdesc attribute will be generated - must only be used for img elements!
1542 * @return string Parameter string containing alt and title parameters (if any)
1543 * @see IMGTEXT(), FILE(), FORM(), cImage(), filelink()
1544 */
1545 function getAltParam($conf, $longDesc = TRUE) {
1546 $altText = trim($this->stdWrap($conf['altText'], $conf['altText.']));
1547 $titleText = trim($this->stdWrap($conf['titleText'], $conf['titleText.']));
1548 $longDesc = trim($this->stdWrap($conf['longdescURL'], $conf['longdescURL.']));
1549
1550 // "alt":
1551 $altParam = ' alt="' . htmlspecialchars($altText) . '"';
1552
1553 // "title":
1554 $emptyTitleHandling = 'useAlt';
1555 if ($conf['emptyTitleHandling']) {
1556 // choices: 'keepEmpty' | 'useAlt' | 'removeAttr'
1557 $emptyTitleHandling = $conf['emptyTitleHandling'];
1558 }
1559 if ($titleText || $emptyTitleHandling == 'keepEmpty') {
1560 $altParam .= ' title="' . htmlspecialchars($titleText) . '"';
1561 } elseif (!$titleText && $emptyTitleHandling == 'useAlt') {
1562 $altParam .= ' title="' . htmlspecialchars($altText) . '"';
1563 }
1564
1565 // "longDesc" URL
1566 if ($longDesc) {
1567 $altParam .= ' longdesc="' . htmlspecialchars(strip_tags($longDesc)) . '"';
1568 }
1569
1570 return $altParam;
1571 }
1572
1573 /**
1574 * Removes forbidden characters and spaces from name/id attributes in the form tag and formfields
1575 *
1576 * @param string Input string
1577 * @return string the cleaned string
1578 * @see FORM()
1579 */
1580 function cleanFormName($name) {
1581 // turn data[x][y] into data:x:y:
1582 $name = preg_replace('/\[|\]\[?/', ':', trim($name));
1583 // remove illegal chars like _
1584 return preg_replace('#[^:a-zA-Z0-9]#', '', $name);
1585 }
1586
1587 /**
1588 * An abstraction method to add parameters to an A tag.
1589 * Uses the ATagParams property.
1590 *
1591 * @param array TypoScript configuration properties
1592 * @param boolean If set, will add the global config.ATagParams to the link
1593 * @return string String containing the parameters to the A tag (if non empty, with a leading space)
1594 * @see IMGTEXT(), filelink(), makelinks(), typolink()
1595 */
1596 function getATagParams($conf, $addGlobal = 1) {
1597 $aTagParams = '';
1598 if ($conf['ATagParams.']) {
1599 $aTagParams = ' ' . $this->stdWrap($conf['ATagParams'], $conf['ATagParams.']);
1600 } elseif ($conf['ATagParams']) {
1601 $aTagParams = ' ' . $conf['ATagParams'];
1602 }
1603 if ($addGlobal) {
1604 $aTagParams = ' ' . trim($GLOBALS['TSFE']->ATagParams . $aTagParams);
1605 }
1606 return $aTagParams;
1607 }
1608
1609 /**
1610 * All extension links should ask this function for additional properties to their tags.
1611 * Designed to add for instance an "onclick" property for site tracking systems.
1612 *
1613 * @param string URL of the website
1614 * @return string the additional tag properties
1615 */
1616 function extLinkATagParams($URL, $TYPE) {
1617 $out = '';
1618
1619 if ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['extLinkATagParamsHandler']) {
1620 $extLinkATagParamsHandler = t3lib_div::getUserObj(
1621 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['extLinkATagParamsHandler']
1622 );
1623
1624 if (method_exists($extLinkATagParamsHandler, 'main')) {
1625 $out .= trim($extLinkATagParamsHandler->main($URL, $TYPE, $this));
1626 }
1627 }
1628
1629 return trim($out) ? ' ' . trim($out) : '';
1630 }
1631
1632
1633
1634 /***********************************************
1635 *
1636 * HTML template processing functions
1637 *
1638 ***********************************************/
1639
1640 /**
1641 * Returns a subpart from the input content stream.
1642 * A subpart is a part of the input stream which is encapsulated in a
1643 * string matching the input string, $marker. If this string is found
1644 * inside of HTML comment tags the start/end points of the content block
1645 * returned will be that right outside that comment block.
1646 * Example: The contennt string is
1647 * "Hello <!--###sub1### begin--> World. How are <!--###sub1### end--> you?"
1648 * If $marker is "###sub1###" then the content returned is
1649 * " World. How are ". The input content string could just as well have
1650 * been "Hello ###sub1### World. How are ###sub1### you?" and the result
1651 * would be the same
1652 * Wrapper for t3lib_parsehtml::getSubpart which behaves identical
1653 *
1654 * @param string The content stream, typically HTML template content.
1655 * @param string The marker string, typically on the form "###[the marker string]###"
1656 * @return string The subpart found, if found.
1657 * @see substituteSubpart(), t3lib_parsehtml::getSubpart()
1658 */
1659 public function getSubpart($content, $marker) {
1660 return t3lib_parsehtml::getSubpart($content, $marker);
1661 }
1662
1663 /**
1664 * Substitute subpart in input template stream.
1665 * This function substitutes a subpart in $content with the content of
1666 * $subpartContent.
1667 * Wrapper for t3lib_parsehtml::substituteSubpart which behaves identical
1668 *
1669 * @param string The content stream, typically HTML template content.
1670 * @param string The marker string, typically on the form "###[the marker string]###"
1671 * @param mixed 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.
1672 * @param boolean 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!
1673 * @return string The processed HTML content string.
1674 * @see getSubpart(), t3lib_parsehtml::substituteSubpart()
1675 */
1676 public function substituteSubpart($content, $marker, $subpartContent, $recursive = 1) {
1677 return t3lib_parsehtml::substituteSubpart($content, $marker, $subpartContent, $recursive);
1678 }
1679
1680 /**
1681 * Substitues multiple subparts at once
1682 *
1683 * @param string The content stream, typically HTML template content.
1684 * @param array 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.
1685 * @return string The processed HTML content string.
1686 */
1687 public function substituteSubpartArray($content, array $subpartsContent) {
1688 return t3lib_parsehtml::substituteSubpartArray($content, $subpartsContent);
1689 }
1690
1691 /**
1692 * Substitutes a marker string in the input content
1693 * (by a simple str_replace())
1694 *
1695 * @param string The content stream, typically HTML template content.
1696 * @param string The marker string, typically on the form "###[the marker string]###"
1697 * @param mixed The content to insert instead of the marker string found.
1698 * @return string The processed HTML content string.
1699 * @see substituteSubpart()
1700 */
1701 public function substituteMarker($content, $marker, $markContent) {
1702 return t3lib_parsehtml::substituteMarker($content, $marker, $markContent);
1703 }
1704
1705 /**
1706 * Multi substitution function with caching.
1707 *
1708 * This function should be a one-stop substitution function for working
1709 * with HTML-template. It does not substitute by str_replace but by
1710 * splitting. This secures that the value inserted does not themselves
1711 * contain markers or subparts.
1712 *
1713 * Note that the "caching" won't cache the content of the substition,
1714 * but only the splitting of the template in various parts. So if you
1715 * want only one cache-entry per template, make sure you always pass the
1716 * exact same set of marker/subpart keys. Else you will be flooding the
1717 * users cache table.
1718 *
1719 * This function takes three kinds of substitutions in one:
1720 * $markContentArray is a regular marker-array where the 'keys' are
1721 * substituted in $content with their values
1722 *
1723 * $subpartContentArray works exactly like markContentArray only is whole
1724 * subparts substituted and not only a single marker.
1725 *
1726 * $wrappedSubpartContentArray is an array of arrays with 0/1 keys where
1727 * the subparts pointed to by the main key is wrapped with the 0/1 value
1728 * alternating.
1729 *
1730 * @param string The content stream, typically HTML template content.
1731 * @param array Regular marker-array where the 'keys' are substituted in $content with their values
1732 * @param array Exactly like markContentArray only is whole subparts substituted and not only a single marker.
1733 * @param array 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.
1734 * @return string The output content stream
1735 * @see substituteSubpart(), substituteMarker(), substituteMarkerInObject(), TEMPLATE()
1736 */
1737 public function substituteMarkerArrayCached($content, array $markContentArray = NULL, array $subpartContentArray = NULL, array $wrappedSubpartContentArray = NULL) {
1738 $GLOBALS['TT']->push('substituteMarkerArrayCached');
1739
1740 // If not arrays then set them
1741 if (is_null($markContentArray))
1742 $markContentArray = array(); // Plain markers
1743 if (is_null($subpartContentArray))
1744 $subpartContentArray = array(); // Subparts being directly substituted
1745 if (is_null($wrappedSubpartContentArray))
1746 $wrappedSubpartContentArray = array(); // Subparts being wrapped
1747 // Finding keys and check hash:
1748 $sPkeys = array_keys($subpartContentArray);
1749 $wPkeys = array_keys($wrappedSubpartContentArray);
1750 $aKeys = array_merge(array_keys($markContentArray), $sPkeys, $wPkeys);
1751 if (!count($aKeys)) {
1752 $GLOBALS['TT']->pull();
1753 return $content;
1754 }
1755 asort($aKeys);
1756 $storeKey = md5('substituteMarkerArrayCached_storeKey:' . serialize(array(
1757 $content, $aKeys
1758 )));
1759 if ($this->substMarkerCache[$storeKey]) {
1760 $storeArr = $this->substMarkerCache[$storeKey];
1761 $GLOBALS['TT']->setTSlogMessage('Cached', 0);
1762 } else {
1763 $storeArrDat = $GLOBALS['TSFE']->sys_page->getHash($storeKey);
1764 if (!isset($storeArrDat)) {
1765 // Initialize storeArr
1766 $storeArr = array();
1767
1768 // Finding subparts and substituting them with the subpart as a marker
1769 foreach ($sPkeys as $sPK) {
1770 $content = $this->substituteSubpart($content, $sPK, $sPK);
1771 }
1772
1773 // Finding subparts and wrapping them with markers
1774 foreach ($wPkeys as $wPK) {
1775 $content = $this->substituteSubpart($content, $wPK, array(
1776 $wPK, $wPK
1777 ));
1778 }
1779
1780 // traverse keys and quote them for reg ex.
1781 foreach ($aKeys as $tK => $tV) {
1782 $aKeys[$tK] = preg_quote($tV, '/');
1783 }
1784 $regex = '/' . implode('|', $aKeys) . '/';
1785 // Doing regex's
1786 $storeArr['c'] = preg_split($regex, $content);
1787 preg_match_all($regex, $content, $keyList);
1788 $storeArr['k'] = $keyList[0];
1789 // Setting cache:
1790 $this->substMarkerCache[$storeKey] = $storeArr;
1791
1792 // Storing the cached data:
1793 $GLOBALS['TSFE']->sys_page->storeHash($storeKey, serialize($storeArr), 'substMarkArrayCached');
1794
1795 $GLOBALS['TT']->setTSlogMessage('Parsing', 0);
1796 } else {
1797 // Unserializing
1798 $storeArr = unserialize($storeArrDat);
1799 // Setting cache:
1800 $this->substMarkerCache[$storeKey] = $storeArr;
1801 $GLOBALS['TT']->setTSlogMessage('Cached from DB', 0);
1802 }
1803 }
1804
1805 // Substitution/Merging:
1806 // Merging content types together, resetting
1807 $valueArr = array_merge($markContentArray, $subpartContentArray, $wrappedSubpartContentArray);
1808
1809 $wSCA_reg = array();
1810 $content = '';
1811 // traversing the keyList array and merging the static and dynamic content
1812 foreach ($storeArr['k'] as $n => $keyN) {
1813 $content .= $storeArr['c'][$n];
1814 if (!is_array($valueArr[$keyN])) {
1815 $content .= $valueArr[$keyN];
1816 } else {
1817 $content .= $valueArr[$keyN][(intval($wSCA_reg[$keyN]) % 2)];
1818 $wSCA_reg[$keyN]++;
1819 }
1820 }
1821 $content .= $storeArr['c'][count($storeArr['k'])];
1822
1823 $GLOBALS['TT']->pull();
1824 return $content;
1825 }
1826
1827 /**
1828 * Traverses the input $markContentArray array and for each key the marker
1829 * by the same name (possibly wrapped and in upper case) will be
1830 * substituted with the keys value in the array.
1831 *
1832 * This is very useful if you have a data-record to substitute in some
1833 * content. In particular when you use the $wrap and $uppercase values to
1834 * pre-process the markers. Eg. a key name like "myfield" could effectively
1835 * be represented by the marker "###MYFIELD###" if the wrap value
1836 * was "###|###" and the $uppercase boolean TRUE.
1837 *
1838 * @param string The content stream, typically HTML template content.
1839 * @param array 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.
1840 * @param string A wrap value - [part 1] | [part 2] - for the markers before substitution
1841 * @param boolean If set, all marker string substitution is done with upper-case markers.
1842 * @param boolean If set, all unused marker are deleted.
1843 * @return string The processed output stream
1844 * @see substituteMarker(), substituteMarkerInObject(), TEMPLATE()
1845 */
1846 public function substituteMarkerArray($content, array $markContentArray, $wrap = '', $uppercase = FALSE, $deleteUnused = FALSE) {
1847 return t3lib_parsehtml::substituteMarkerArray($content, $markContentArray, $wrap, $uppercase, $deleteUnused);
1848 }
1849
1850 /**
1851 * Substitute marker array in an array of values
1852 *
1853 * @param mixed 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)
1854 * @param array 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.
1855 * @return mixed The processed input variable.
1856 * @see substituteMarker()
1857 */
1858 public function substituteMarkerInObject(&$tree, array $markContentArray) {
1859 if (is_array($tree)) {
1860 foreach ($tree as $key => $value) {
1861 $this->substituteMarkerInObject($tree[$key], $markContentArray);
1862 }
1863 } else {
1864 $tree = $this->substituteMarkerArray($tree, $markContentArray);
1865 }
1866
1867 return $tree;
1868 }
1869
1870 /**
1871 * Adds elements to the input $markContentArray based on the values from
1872 * the fields from $fieldList found in $row
1873 *
1874 * @param array array with key/values being marker-strings/substitution values.
1875 * @param array An array with keys found in the $fieldList (typically a record) which values should be moved to the $markContentArray
1876 * @param string 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)
1877 * @param boolean If set, all values added to $markContentArray will be nl2br()'ed
1878 * @param string 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 "###"
1879 * @param boolean If set, all values are passed through htmlspecialchars() - RECOMMENDED to avoid most obvious XSS and maintain XHTML compliance.
1880 * @return array The modified $markContentArray
1881 */
1882 public function fillInMarkerArray(array $markContentArray, array $row, $fieldList = '', $nl2br = TRUE, $prefix = 'FIELD_', $HSC = FALSE) {
1883 if ($fieldList) {
1884 $fArr = t3lib_div::trimExplode(',', $fieldList, 1);
1885 foreach ($fArr as $field) {
1886 $markContentArray['###' . $prefix . $field . '###'] = $nl2br ? nl2br($row[$field]) : $row[$field];
1887 }
1888 } else {
1889 if (is_array($row)) {
1890 foreach ($row as $field => $value) {
1891 if (!t3lib_div::testInt($field)) {
1892 if ($HSC) {
1893 $value = htmlspecialchars($value);
1894 }
1895
1896 $markContentArray['###' . $prefix . $field . '###'] = $nl2br ? nl2br($value) : $value;
1897 }
1898 }
1899 }
1900 }
1901
1902 return $markContentArray;
1903 }
1904
1905 /***********************************************
1906 *
1907 * "stdWrap" + sub functions
1908 *
1909 ***********************************************/
1910
1911 /**
1912 * The "stdWrap" function. This is the implementation of what is known as "stdWrap properties" in TypoScript.
1913 * Basically "stdWrap" performs some processing of a value based on properties in the input $conf array(holding the TypoScript "stdWrap properties")
1914 * 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.
1915 *
1916 * If $this->alternativeData is an array it's used instead of the $this->data array in ->getData
1917 *
1918 * @param string Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
1919 * @param array TypoScript "stdWrap properties".
1920 * @return string The processed input value
1921 */
1922 public function stdWrap($content = '', $conf = array()) {
1923 if (count($this->stdWrapHookObjects)) {
1924 foreach ($this->stdWrapHookObjects as $hookObject) {
1925 if (is_callable(array($hookObject, 'stdWrapPreProcess'))) {
1926 $conf['stdWrapPreProcess'] = 1;
1927 }
1928 ;
1929 if (is_callable(array($hookObject, 'stdWrapOverride'))) {
1930 $conf['stdWrapOverride'] = 1;
1931 }
1932 ;
1933 if (is_callable(array($hookObject, 'stdWrapProcess'))) {
1934 $conf['stdWrapProcess'] = 1;
1935 }
1936 ;
1937 if (is_callable(array($hookObject, 'stdWrapPostProcess'))) {
1938 $conf['stdWrapPostProcess'] = 1;
1939 }
1940 ;
1941 }
1942 }
1943 if (count($conf)) {
1944 // check, which of the available stdWrap functions is needed for the current conf Array
1945 // and keep only those but still in the same order
1946 $sortedConf = array_intersect_key($this->stdWrapOrder, $conf);
1947 // functions types that should not make use of nested stdWrap function calls to avoid conflicts with internal TypoScript used by these functions
1948 $stdWrapDisabledFunctionTypes = 'cObject,functionName,stdWrap';
1949 // additional Array to check whether a function has already been executed
1950 $isExecuted = array();
1951 // additional switch to make sure 'required', 'if' and 'fieldRequired'
1952 // will still stop rendering immediately in case they return false
1953
1954 $this->stdWrapRecursionLevel++;
1955 $this->stopRendering[$this->stdWrapRecursionLevel] = false;
1956
1957 // execute each funtion in the predefined order
1958 foreach ($sortedConf as $stdWrapName => $functionType) {
1959 // eliminate the second key of a pair 'key'|'key.' to make sure functions get called only once and check if rendering has been stopped
1960 if (!$isExecuted[$stdWrapName] &&
1961 !$this->stopRendering[$this->stdWrapRecursionLevel]) {
1962 $functionName = rtrim($stdWrapName, '.');
1963 $functionProperties = $functionName . '.';
1964 // if there is any code one the next level, check if it contains "official" stdWrap functions
1965 // if yes, execute them first - will make each function stdWrap aware
1966 // so additional stdWrap calls within the functions can be removed, since the result will be the same
1967 // exception: the recursive stdWrap function and cObject will still be using their own stdWrap call, since it modifies the content and not a property
1968 if (count($conf[$functionProperties]) &&
1969 !t3lib_div::inList($stdWrapDisabledFunctionTypes, $functionType)) {
1970 if (array_intersect_key($this->stdWrapOrder, $conf[$functionProperties])) {
1971 $conf[$functionName] = $this->stdWrap($conf[$functionName], $conf[$functionProperties]);
1972 }
1973 }
1974 // get just that part of $conf that is needed for the particular function
1975 $singleConf = array(
1976 $functionName => $conf[$functionName],
1977 $functionProperties => $conf[$functionProperties]
1978 );
1979
1980 // in this special case 'spaceBefore' and 'spaceAfter' need additional stuff from 'space.''
1981 if ($functionName == 'spaceBefore' || $functionName == 'spaceAfter') {
1982 $singleConf['space.'] = $conf['space.'];
1983 }
1984
1985 // hand over the whole $conf array to the stdWrapHookObjects
1986 if ($conf[$functionName] == 'stdWrapHookObject') {
1987 $singleConf = $conf;
1988 }
1989 // check if key is still containing something, since it might have been changed by next level stdWrap before
1990 if ((isset($conf[$functionName]) || $conf[$functionProperties]) &&
1991 !($functionType == 'boolean' && $conf[$functionName] === '0')) {
1992 //add both keys - with and without the dot - to the set of executed functions
1993 $isExecuted[$functionName] = true;
1994 $isExecuted[$functionProperties] = true;
1995 // call the function with the prefix stdWrap_ to make sure nobody can execute functions just by adding their name to the TS Array
1996 $functionName = 'stdWrap_' . $functionName;
1997 $content = $this->$functionName(
1998 $content,
1999 $singleConf
2000 );
2001 }
2002 }
2003 }
2004
2005 unset($this->stopRendering[$this->stdWrapRecursionLevel]);
2006 $this->stdWrapRecursionLevel--;
2007
2008 }
2009 return $content;
2010 }
2011
2012 /**
2013 * stdWrap pre process hook
2014 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2015 * this hook will execute functions before any other stdWrap function can modify anything
2016 *
2017 * @param string Input value undergoing processing in these functions.
2018 * @param array All stdWrap properties, not just the ones for a particular function.
2019 * @return string The processed input value
2020 */
2021 public function stdWrap_stdWrapPreProcess($content = '', $conf = array()) {
2022 foreach ($this->stdWrapHookObjects as $hookObject) {
2023 $content = $hookObject->stdWrapPreProcess($content, $conf, $this);
2024 }
2025 return $content;
2026 }
2027
2028 /**
2029 * setContentToCurrent
2030 * actually it just does the contrary: Sets the value of 'current' based on current content
2031 *
2032 * @param string Input value undergoing processing in this function.
2033 * @param array stdWrap properties for setContentToCurrent.
2034 * @return string The processed input value
2035 */
2036 public function stdWrap_setContentToCurrent($content = '', $conf = array()) {
2037 $this->data[$this->currentValKey] = $content;
2038 }
2039
2040 /**
2041 * setCurrent
2042 * Sets the value of 'current' based on the outcome of stdWrap operations
2043 *
2044 * @param string Input value undergoing processing in this function.
2045 * @param array stdWrap properties for setCurrent.
2046 * @return string The processed input value
2047 */
2048 public function stdWrap_setCurrent($content = '', $conf = array()) {
2049 $this->data[$this->currentValKey] = $conf['setCurrent'];
2050 }
2051
2052 /**
2053 * lang
2054 * Translates content based on the language currently used by the FE
2055 *
2056 * @param string Input value undergoing processing in this function.
2057 * @param array stdWrap properties for lang.
2058 * @return string The processed input value
2059 */
2060 public function stdWrap_lang($content = '', $conf = array()) {
2061 if (isset($conf['lang.']) && $GLOBALS['TSFE']->config['config']['language'] && isset($conf['lang.'][$GLOBALS['TSFE']->config['config']['language']])) {
2062 $content = $conf['lang.'][$GLOBALS['TSFE']->config['config']['language']];
2063 }
2064 return $content;
2065 }
2066
2067 /**
2068 * data
2069 * Gets content from different sources based on getText functions, makes use of alternativeData, when set
2070 *
2071 * @param string Input value undergoing processing in this function.
2072 * @param array stdWrap properties for data.
2073 * @return string The processed input value
2074 */
2075 public function stdWrap_data($content = '', $conf = array()) {
2076 $content = $this->getData($conf['data'], is_array($this->alternativeData) ? $this->alternativeData : $this->data);
2077 $this->alternativeData = ''; // This must be unset directly after
2078 return $content;
2079 }
2080
2081 /**
2082 * field
2083 * Gets content from a DB field
2084 *
2085 * @param string Input value undergoing processing in this function.
2086 * @param array stdWrap properties for field.
2087 * @return string The processed input value
2088 */
2089 public function stdWrap_field($content = '', $conf = array()) {
2090 $content = $this->getFieldVal($conf['field']);
2091 return $content;
2092 }
2093
2094 /**
2095 * current
2096 * Gets content that has been perviously set as 'current'
2097 * Can be set via setContentToCurrent or setCurrent or will be set automatically i.e. inside the split function
2098 *
2099 * @param string Input value undergoing processing in this function.
2100 * @param array stdWrap properties for current.
2101 * @return string The processed input value
2102 */
2103 public function stdWrap_current($content = '', $conf = array()) {
2104 $content = $this->data[$this->currentValKey];
2105 return $content;
2106 }
2107
2108 /**
2109 * cObject
2110 * Will replace the content with the value of a any official TypoScript cObject
2111 * like TEXT, COA, HMENU
2112 *
2113 * @param string Input value undergoing processing in this function.
2114 * @param array stdWrap properties for cObject.
2115 * @return string The processed input value
2116 */
2117 public function stdWrap_cObject($content = '', $conf = array()) {
2118 $content = $this->cObjGetSingle($conf['cObject'], $conf['cObject.'], '/stdWrap/.cObject');
2119 return $content;
2120 }
2121
2122 /**
2123 * numRows
2124 * Counts the number of returned records of a DB operation
2125 * makes use of select internally
2126 *
2127 * @param string Input value undergoing processing in this function.
2128 * @param array stdWrap properties for numRows.
2129 * @return string The processed input value
2130 */
2131 public function stdWrap_numRows($content = '', $conf = array()) {
2132 $content = $this->numRows($conf['numRows.']);
2133 return $content;
2134 }
2135
2136 /**
2137 * filelist
2138 * Will create a list of files based on some additional parameters
2139 *
2140 * @param string Input value undergoing processing in this function.
2141 * @param array stdWrap properties for filelist.
2142 * @return string The processed input value
2143 */
2144 public function stdWrap_filelist($content = '', $conf = array()) {
2145 $content = $this->filelist($conf['filelist']);
2146 return $content;
2147 }
2148
2149 /**
2150 * preUserFunc
2151 * Will execute a user public function before the content will be modified by any other stdWrap function
2152 *
2153 * @param string Input value undergoing processing in this function.
2154 * @param array stdWrap properties for preUserFunc.
2155 * @return string The processed input value
2156 */
2157 public function stdWrap_preUserFunc($content = '', $conf = array()) {
2158 $content = $this->callUserFunction($conf['preUserFunc'], $conf['preUserFunc.'], $content);
2159 return $content;
2160 }
2161
2162 /**
2163 * stdWrap override hook
2164 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2165 * this hook will execute functions on existing content but still before the content gets modified or replaced
2166 *
2167 * @param string Input value undergoing processing in these functions.
2168 * @param array All stdWrap properties, not just the ones for a particular function.
2169 * @return string The processed input value
2170 */
2171 public function stdWrap_stdWrapOverride($content = '', $conf = array()) {
2172 foreach ($this->stdWrapHookObjects as $hookObject) {
2173 $content = $hookObject->stdWrapOverride($content, $conf, $this);
2174 }
2175 return $content;
2176 }
2177
2178 /**
2179 * override
2180 * Will override the current value of content with its own value'
2181 *
2182 * @param string Input value undergoing processing in this function.
2183 * @param array stdWrap properties for override.
2184 * @return string The processed input value
2185 */
2186 public function stdWrap_override($content = '', $conf = array()) {
2187 if (trim($conf['override'])) {
2188 $content = $conf['override'];
2189 }
2190 return $content;
2191 }
2192
2193 /**
2194 * preIfEmptyListNum
2195 * Gets a value off a CSV list before the following ifEmpty check
2196 * 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
2197 *
2198 * @param string Input value undergoing processing in this function.
2199 * @param array stdWrap properties for preIfEmptyListNum.
2200 * @return string The processed input value
2201 */
2202 public function stdWrap_preIfEmptyListNum($content = '', $conf = array()) {
2203 $content = $this->listNum($content, $conf['preIfEmptyListNum'], $conf['preIfEmptyListNum.']['splitChar']);
2204 return $content;
2205 }
2206
2207 /**
2208 * ifEmpty
2209 * Will set content to a replacement value in case the trimmed value of content returns false
2210 * 0 (zero) will be replaced as well
2211 *
2212 * @param string Input value undergoing processing in this function.
2213 * @param array stdWrap properties for ifEmpty.
2214 * @return string The processed input value
2215 */
2216 public function stdWrap_ifEmpty($content = '', $conf = array()) {
2217 if (!trim($content)) {
2218 $content = $conf['ifEmpty'];
2219 }
2220 return $content;
2221 }
2222
2223 /**
2224 * ifBlank
2225 * Will set content to a replacement value in case the trimmed value of content has no length
2226 * 0 (zero) will not be replaced
2227 *
2228 * @param string Input value undergoing processing in this function.
2229 * @param array stdWrap properties for ifBlank.
2230 * @return string The processed input value
2231 */
2232 public function stdWrap_ifBlank($content = '', $conf = array()) {
2233 if (!strlen(trim($content))) {
2234 $content = $conf['ifBlank'];
2235 }
2236 return $content;
2237 }
2238
2239 /**
2240 * listNum
2241 * Gets a value off a CSV list after ifEmpty check
2242 * Might return an empty value in case the CSV does not contain a value at the position given by listNum
2243 * Use preIfEmptyListNum to avoid that behaviour
2244 *
2245 * @param string Input value undergoing processing in this function.
2246 * @param array stdWrap properties for listNum.
2247 * @return string The processed input value
2248 */
2249 public function stdWrap_listNum($content = '', $conf = array()) {
2250 $content = $this->listNum($content, $conf['listNum'], $conf['listNum.']['splitChar']);
2251 return $content;
2252 }
2253
2254 /**
2255 * trim
2256 * Cuts off any whitespace at the beginning and the end of the content
2257 *
2258 * @param string Input value undergoing processing in this function.
2259 * @param array stdWrap properties for trim.
2260 * @return string The processed input value
2261 */
2262 public function stdWrap_trim($content = '', $conf = array()) {
2263 $content = trim($content);
2264 return $content;
2265 }
2266
2267 /**
2268 * stdWrap
2269 * A recursive call of the stdWrap function set
2270 * This enables the user to execute stdWrap functions in another than the predefined order
2271 * It modifies the content, not the property
2272 * while the new feature of chained stdWrap functions modifies the property and not the content
2273 *
2274 * @param string Input value undergoing processing in this function.
2275 * @param array stdWrap properties for stdWrap.
2276 * @return string The processed input value
2277 */
2278 public function stdWrap_stdWrap($content = '', $conf = array()) {
2279 $content = $this->stdWrap($content, $conf['stdWrap.']);
2280 return $content;
2281 }
2282
2283 /**
2284 * stdWrap process hook
2285 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2286 * this hook executes functions directly after the recursive stdWrap function call but still before the content gets modified
2287 *
2288 * @param string Input value undergoing processing in these functions.
2289 * @param array All stdWrap properties, not just the ones for a particular function.
2290 * @return string The processed input value
2291 */
2292 public function stdWrap_stdWrapProcess($content = '', $conf = array()) {
2293 foreach ($this->stdWrapHookObjects as $hookObject) {
2294 $content = $hookObject->stdWrapProcess($content, $conf, $this);
2295 }
2296 return $content;
2297 }
2298
2299 /**
2300 * required
2301 * Will immediately stop rendering and return an empty value
2302 * when there is no content at this point
2303 *
2304 * @param string Input value undergoing processing in this function.
2305 * @param array stdWrap properties for required.
2306 * @return string The processed input value
2307 */
2308 public function stdWrap_required($content = '', $conf = array()) {
2309 if ((string) $content == '') {
2310 $content = '';
2311 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2312 }
2313 return $content;
2314 }
2315
2316 /**
2317 * if
2318 * Will immediately stop rendering and return an empty value
2319 * when the result of the checks returns false
2320 *
2321 * @param string Input value undergoing processing in this function.
2322 * @param array stdWrap properties for if.
2323 * @return string The processed input value
2324 */
2325 public function stdWrap_if($content = '', $conf = array()) {
2326 if (!$this->checkIf($conf['if.'])) {
2327 $content = '';
2328 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2329 }
2330 return $content;
2331 }
2332
2333 /**
2334 * fieldRequired
2335 * Will immediately stop rendering and return an empty value
2336 * when there is no content in the field given by fieldRequired
2337 *
2338 * @param string Input value undergoing processing in this function.
2339 * @param array stdWrap properties for fieldRequired.
2340 * @return string The processed input value
2341 */
2342 public function stdWrap_fieldRequired($content = '', $conf = array()) {
2343 if (!trim($this->data[$conf['fieldRequired']])) {
2344 $content = '';
2345 $this->stopRendering[$this->stdWrapRecursionLevel] = TRUE;
2346 }
2347 return $content;
2348 }
2349
2350 /**
2351 * csConv
2352 * Will convert the current chracter set of the content to the one given in csConv
2353 *
2354 * @param string Input value undergoing processing in this function.
2355 * @param array stdWrap properties for csConv.
2356 * @return string The processed input value
2357 */
2358 public function stdWrap_csConv($content = '', $conf = array()) {
2359 $content = $GLOBALS['TSFE']->csConv($content, $conf['csConv']);
2360 return $content;
2361 }
2362
2363 /**
2364 * parseFunc
2365 * Will parse the content based on functions given as stdWrap properties
2366 * Heavily used together with RTE based content
2367 *
2368 * @param string Input value undergoing processing in this function.
2369 * @param array stdWrap properties for parseFunc.
2370 * @return string The processed input value
2371 */
2372 public function stdWrap_parseFunc($content = '', $conf = array()) {
2373 $content = $this->parseFunc($content, $conf['parseFunc.'], $conf['parseFunc']);
2374 return $content;
2375 }
2376
2377 /**
2378 * HTMLparser
2379 * Will parse HTML content based on functions given as stdWrap properties
2380 * Heavily used together with RTE based content
2381 *
2382 * @param string Input value undergoing processing in this function.
2383 * @param array stdWrap properties for HTMLparser.
2384 * @return string The processed input value
2385 */
2386 public function stdWrap_HTMLparser($content = '', $conf = array()) {
2387 if (is_array($conf['HTMLparser.'])) {
2388 $content = $this->HTMLparser_TSbridge($content, $conf['HTMLparser.']);
2389 }
2390 return $content;
2391 }
2392
2393 /**
2394 * split
2395 * Will split the content by a given token and treat the results separately
2396 * Automatically fills 'current' with a single result
2397 *
2398 * @param string Input value undergoing processing in this function.
2399 * @param array stdWrap properties for split.
2400 * @return string The processed input value
2401 */
2402 public function stdWrap_split($content = '', $conf = array()) {
2403 $content = $this->splitObj($content, $conf['split.']);
2404 return $content;
2405 }
2406
2407 /**
2408 * prioriCalc
2409 * Will use the content as a mathematical term and calculate the result
2410 * Can be set to 1 to just get a calculated value or 'intval' to get the integer of the result
2411 *
2412 * @param string Input value undergoing processing in this function.
2413 * @param array stdWrap properties for prioriCalc.
2414 * @return string The processed input value
2415 */
2416 public function stdWrap_prioriCalc($content = '', $conf = array()) {
2417 $content = t3lib_div::calcParenthesis($content);
2418 if ($conf['prioriCalc'] == 'intval')
2419 $content = intval($content);
2420 return $content;
2421 }
2422
2423 /**
2424 * char
2425 * Will return a character based on its position within the current character set
2426 *
2427 * @param string Input value undergoing processing in this function.
2428 * @param array stdWrap properties for char.
2429 * @return string The processed input value
2430 */
2431 public function stdWrap_char($content = '', $conf = array()) {
2432 $content = chr(intval($conf['char']));
2433 return $content;
2434 }
2435
2436 /**
2437 * intval
2438 * Will return an integer value of the current content
2439 *
2440 * @param string Input value undergoing processing in this function.
2441 * @param array stdWrap properties for intval.
2442 * @return string The processed input value
2443 */
2444 public function stdWrap_intval($content = '', $conf = array()) {
2445 $content = intval($content);
2446 return $content;
2447 }
2448
2449 /**
2450 * numberFormat
2451 * Will return a formatted number based on configuration given as stdWrap properties
2452 *
2453 * @param string Input value undergoing processing in this function.
2454 * @param array stdWrap properties for numberFormat.
2455 * @return string The processed input value
2456 */
2457 public function stdWrap_numberFormat($content = '', $conf = array()) {
2458 $content = $this->numberFormat($content, $conf['numberFormat.']);
2459 return $content;
2460 }
2461
2462 /**
2463 * date
2464 * Will return a formatted date based on configuration given according to PHP date/gmdate properties
2465 * Will return gmdate when the property GMT returns true
2466 *
2467 * @param string Input value undergoing processing in this function.
2468 * @param array stdWrap properties for date.
2469 * @return string The processed input value
2470 */
2471 public function stdWrap_date($content = '', $conf = array()) {
2472 $content = ($conf['date.']['GMT'] ? gmdate($conf['date'], $content) : date($conf['date'], $content));
2473 return $content;
2474 }
2475
2476 /**
2477 * strftime
2478 * Will return a formatted date based on configuration given according to PHP strftime/gmstrftime properties
2479 * Will return gmstrftime when the property GMT returns true
2480 *
2481 * @param string Input value undergoing processing in this function.
2482 * @param array stdWrap properties for strftime.
2483 * @return string The processed input value
2484 */
2485 public function stdWrap_strftime($content = '', $conf = array()) {
2486 $content = ($conf['strftime.']['GMT'] ? gmstrftime($conf['strftime'], $content) : strftime($conf['strftime'], $content));
2487 $tmp_charset = $conf['strftime.']['charset'] ? $conf['strftime.']['charset'] : $GLOBALS['TSFE']->localeCharset;
2488 if ($tmp_charset) {
2489 $content = $GLOBALS['TSFE']->csConv($content, $tmp_charset);
2490 }
2491 return $content;
2492 }
2493
2494 /**
2495 * age
2496 * Will return the age of a given timestamp based on configuration given by stdWrap properties
2497 *
2498 * @param string Input value undergoing processing in this function.
2499 * @param array stdWrap properties for age.
2500 * @return string The processed input value
2501 */
2502 public function stdWrap_age($content = '', $conf = array()) {
2503 $content = $this->calcAge($GLOBALS['EXEC_TIME'] - $content, $conf['age']);
2504 return $content;
2505 }
2506
2507 /**
2508 * case
2509 * Will transform the content to be upper or lower case only
2510 * Leaves HTML tags untouched
2511 *
2512 * @param string Input value undergoing processing in this function.
2513 * @param array stdWrap properties for case.
2514 * @return string The processed input value
2515 */
2516 public function stdWrap_case($content = '', $conf = array()) {
2517 $content = $this->HTMLcaseshift($content, $conf['case']);
2518 return $content;
2519 }
2520
2521 /**
2522 * bytes
2523 * Will return the size of a given number in Bytes *
2524 *
2525 * @param string Input value undergoing processing in this function.
2526 * @param array stdWrap properties for bytes.
2527 * @return string The processed input value
2528 */
2529 public function stdWrap_bytes($content = '', $conf = array()) {
2530 $content = t3lib_div::formatSize($content, $conf['bytes.']['labels']);
2531 return $content;
2532 }
2533
2534 /**
2535 * substring
2536 * Will return a substring based on position information given by stdWrap properties
2537 *
2538 * @param string Input value undergoing processing in this function.
2539 * @param array stdWrap properties for substring.
2540 * @return string The processed input value
2541 */
2542 public function stdWrap_substring($content = '', $conf = array()) {
2543 $content = $this->substring($content, $conf['substring']);
2544 return $content;
2545 }
2546
2547 /**
2548 * removeBadHTML
2549 * Removes HTML tags based on stdWrap properties
2550 *
2551 * @param string Input value undergoing processing in this function.
2552 * @param array stdWrap properties for removeBadHTML.
2553 * @return string The processed input value
2554 */
2555 public function stdWrap_removeBadHTML($content = '', $conf = array()) {
2556 $content = $this->removeBadHTML($content, $conf['removeBadHTML.']);
2557 return $content;
2558 }
2559
2560 /**
2561 * cropHTML
2562 * Crops content to a given size while leaving HTML tags untouched
2563 *
2564 * @param string Input value undergoing processing in this function.
2565 * @param array stdWrap properties for cropHTML.
2566 * @return string The processed input value
2567 */
2568 public function stdWrap_cropHTML($content = '', $conf = array()) {
2569 $content = $this->cropHTML($content, $conf['cropHTML']);
2570 return $content;
2571 }
2572
2573 /**
2574 * stripHtml
2575 * Copmletely removes HTML tags from content
2576 *
2577 * @param string Input value undergoing processing in this function.
2578 * @param array stdWrap properties for stripHtml.
2579 * @return string The processed input value
2580 */
2581 public function stdWrap_stripHtml($content = '', $conf = array()) {
2582 $content = strip_tags($content);
2583 return $content;
2584 }
2585
2586 /**
2587 * cropHTML
2588 * Crops content to a given size without caring abhout HTML tags
2589 *
2590 * @param string Input value undergoing processing in this function.
2591 * @param array stdWrap properties for crop.
2592 * @return string The processed input value
2593 */
2594 public function stdWrap_crop($content = '', $conf = array()) {
2595 $content = $this->crop($content, $conf['crop']);
2596 return $content;
2597 }
2598
2599 /**
2600 * rawUrlEncode
2601 * Encodes content to be used within URLs
2602 *
2603 * @param string Input value undergoing processing in this function.
2604 * @param array stdWrap properties for rawUrlEncode.
2605 * @return string The processed input value
2606 */
2607 public function stdWrap_rawUrlEncode($content = '', $conf = array()) {
2608 $content = rawurlencode($content);
2609 return $content;
2610 }
2611
2612 /**
2613 * htmlSpecialChars
2614 * Transforms HTML tags to readable text by replacing special characters with their HTML entity
2615 * When preserveEntities returns true, existing entities will be left untouched
2616 *
2617 * @param string Input value undergoing processing in this function.
2618 * @param array stdWrap properties for htmlSpecalChars.
2619 * @return string The processed input value
2620 */
2621 public function stdWrap_htmlSpecialChars($content = '', $conf = array()) {
2622 $content = htmlSpecialChars($content);
2623 if ($conf['htmlSpecialChars.']['preserveEntities'])
2624 $content = t3lib_div::deHSCentities($content);
2625 return $content;
2626 }
2627
2628 /**
2629 * doubleBrTag
2630 * Searches for double line breaks and replaces them with the given value
2631 *
2632 * @param string Input value undergoing processing in this function.
2633 * @param array stdWrap properties for doubleBrTag.
2634 * @return string The processed input value
2635 */
2636 public function stdWrap_doubleBrTag($content = '', $conf = array()) {
2637 $content = preg_replace("/\r?\n[\t ]*\r?\n/", $conf['doubleBrTag'], $content);
2638 return $content;
2639 }
2640
2641 /**
2642 * br
2643 * Searches for single line breaks and replaces them with a <br /> tag
2644 *
2645 * @param string Input value undergoing processing in this function.
2646 * @param array stdWrap properties for br.
2647 * @return string The processed input value
2648 */
2649 public function stdWrap_br($content = '', $conf = array()) {
2650 $content = nl2br($content);
2651 return $content;
2652 }
2653
2654 /**
2655 * brTag
2656 * Searches for single line feeds and replaces them with the given value
2657 *
2658 * @param string Input value undergoing processing in this function.
2659 * @param array stdWrap properties for brTag.
2660 * @return string The processed input value
2661 */
2662 public function stdWrap_brTag($content = '', $conf = array()) {
2663 $content = str_replace(LF, $conf['brTag'], $content);
2664 return $content;
2665 }
2666
2667 /**
2668 * encapsLines
2669 * Modifies text blocks by searching for lines which are not surrounded by HTML tags yet
2670 * and wrapping them with values given by stdWrap properties
2671 *
2672 * @param string Input value undergoing processing in this function.
2673 * @param array stdWrap properties for erncapsLines.
2674 * @return string The processed input value
2675 */
2676 public function stdWrap_encapsLines($content = '', $conf = array()) {
2677 $content = $this->encaps_lineSplit($content, $conf['encapsLines.']);
2678 return $content;
2679 }
2680
2681 /**
2682 * keywords
2683 * Transforms content into a CSV list to be used i.e. as keywords within a meta tag
2684 *
2685 * @param string Input value undergoing processing in this function.
2686 * @param array stdWrap properties for keywords.
2687 * @return string The processed input value
2688 */
2689 public function stdWrap_keywords($content = '', $conf = array()) {
2690 $content = $this->keywords($content);
2691 return $content;
2692 }
2693
2694 /**
2695 * innerWrap
2696 * First of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2697 * See wrap
2698 *
2699 * @param string Input value undergoing processing in this function.
2700 * @param array stdWrap properties for innerWrap.
2701 * @return string The processed input value
2702 */
2703 public function stdWrap_innerWrap($content = '', $conf = array()) {
2704 $content = $this->wrap($content, $conf['innerWrap']);
2705 return $content;
2706 }
2707
2708 /**
2709 * innerWrap2
2710 * Second of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2711 * See wrap
2712 *
2713 * @param string Input value undergoing processing in this function.
2714 * @param array stdWrap properties for innerWrap2.
2715 * @return string The processed input value
2716 */
2717 public function stdWrap_innerWrap2($content = '', $conf = array()) {
2718 $content = $this->wrap($content, $conf['innerWrap2']);
2719 return $content;
2720 }
2721
2722 /**
2723 * fontTag
2724 * A wrap formerly used to apply font tags to format the content
2725 * Still used by lib.stdheader although real font tags are not state of the art anymore
2726 * See wrap
2727 *
2728 * @param string Input value undergoing processing in this function.
2729 * @param array stdWrap properties for fontTag.
2730 * @return string The processed input value
2731 */
2732 public function stdWrap_fontTag($content = '', $conf = array()) {
2733 $content = $this->wrap($content, $conf['fontTag']);
2734 return $content;
2735 }
2736
2737 /**
2738 * addParams
2739 * Adds tag attributes to any content that is a tag
2740 *
2741 * @param string Input value undergoing processing in this function.
2742 * @param array stdWrap properties for addParams.
2743 * @return string The processed input value
2744 */
2745 public function stdWrap_addParams($content = '', $conf = array()) {
2746 $content = $this->addParams($content, $conf['addParams.']);
2747 return $content;
2748 }
2749
2750 /**
2751 * textStyle
2752 * Wraps content in font tags
2753 * See wrap
2754 *
2755 * @param string Input value undergoing processing in this function.
2756 * @param array stdWrap properties for textStyle.
2757 * @return string The processed input value
2758 */
2759 public function stdWrap_textStyle($content = '', $conf = array()) {
2760 $content = $this->textStyle($content, $conf['textStyle.']);
2761 return $content;
2762 }
2763
2764 /**
2765 * tableStyle
2766 * Wraps content with table tags
2767 * See wrap
2768 *
2769 * @param string Input value undergoing processing in this function.
2770 * @param array stdWrap properties for tableStyle.
2771 * @return string The processed input value
2772 */
2773 public function stdWrap_tableStyle($content = '', $conf = array()) {
2774 $content = $this->tableStyle($content, $conf['tableStyle.']);
2775 return $content;
2776 }
2777
2778 /**
2779 * filelink
2780 * Used to make lists of links to files
2781 * See wrap
2782 *
2783 * @param string Input value undergoing processing in this function.
2784 * @param array stdWrap properties for filelink.
2785 * @return string The processed input value
2786 */
2787 public function stdWrap_filelink($content = '', $conf = array()) {
2788 $content = $this->filelink($content, $conf['filelink.']);
2789 return $content;
2790 }
2791
2792 /**
2793 * preCObject
2794 * A content object that is prepended to the current content but between the innerWraps and the rest of the wraps
2795 *
2796 * @param string Input value undergoing processing in this function.
2797 * @param array stdWrap properties for preCObject.
2798 * @return string The processed input value
2799 */
2800 public function stdWrap_preCObject($content = '', $conf = array()) {
2801 $content = $this->cObjGetSingle($conf['preCObject'], $conf['preCObject.'], '/stdWrap/.preCObject') . $content;
2802 return $content;
2803 }
2804
2805 /**
2806 * postCObject
2807 * A content object that is appended to the current content but between the innerWraps and the rest of the wraps
2808 *
2809 * @param string Input value undergoing processing in this function.
2810 * @param array stdWrap properties for postCObject.
2811 * @return string The processed input value
2812 */
2813 public function stdWrap_postCObject($content = '', $conf = array()) {
2814 $content .= $this->cObjGetSingle($conf['postCObject'], $conf['postCObject.'], '/stdWrap/.postCObject');
2815 return $content;
2816 }
2817
2818 /**
2819 * wrapAlign
2820 * Wraps content with a div container having the style attribute text-align set to the given value
2821 * See wrap
2822 *
2823 * @param string Input value undergoing processing in this function.
2824 * @param array stdWrap properties for wrapAlign.
2825 * @return string The processed input value
2826 */
2827 public function stdWrap_wrapAlign($content = '', $conf = array()) {
2828 $wrapAlign = trim($conf['wrapAlign']);
2829 if ($wrapAlign) {
2830 $content = $this->wrap($content, '<div style="text-align:' . $wrapAlign . ';">|</div>');
2831 }
2832 return $content;
2833 }
2834
2835 /**
2836 * typolink
2837 * Wraps the content with a link tag
2838 * URLs and other attributes are created automatically by the values given in the stdWrap properties
2839 * See wrap
2840 *
2841 * @param string Input value undergoing processing in this function.
2842 * @param array stdWrap properties for typolink.
2843 * @return string The processed input value
2844 */
2845 public function stdWrap_typolink($content = '', $conf = array()) {
2846 $content = $this->typolink($content, $conf['typolink.']);
2847 return $content;
2848 }
2849
2850 /**
2851 * TCAselectItem
2852 * Returns a list of options available for a given field in the DB which has to be of the type select
2853 *
2854 * @param string Input value undergoing processing in this function.
2855 * @param array stdWrap properties for TCAselectItem.
2856 * @return string The processed input value
2857 */
2858 public function stdWrap_TCAselectItem($content = '', $conf = array()) {
2859 if (is_array($conf['TCAselectItem.'])) {
2860 $content = $this->TCAlookup($content, $conf['TCAselectItem.']);
2861 }
2862 return $content;
2863 }
2864
2865 /**
2866 * spaceBefore
2867 * Will add space before the current content
2868 * By default this is done with a clear.gif but it can be done with CSS margins by setting the property space.useDiv to true
2869 *
2870 * @param string Input value undergoing processing in this function.
2871 * @param array stdWrap properties for spaceBefore and space.
2872 * @return string The processed input value
2873 */
2874 public function stdWrap_spaceBefore($content = '', $conf = array()) {
2875 $content = $this->wrapSpace($content, trim($conf['spaceBefore']) . '|', $conf['space.']);
2876 return $content;
2877 }
2878
2879 /**
2880 * spaceAfter
2881 * Will add space after the current content
2882 * By default this is done with a clear.gif but it can be done with CSS margins by setting the property space.useDiv to true
2883 *
2884 * @param string Input value undergoing processing in this function.
2885 * @param array stdWrap properties for spaceAfter and space.
2886 * @return string The processed input value
2887 */
2888 public function stdWrap_spaceAfter($content = '', $conf = array()) {
2889 $content = $this->wrapSpace($content, '|' . trim($conf['spaceAfter']), $conf['space.']);
2890 return $content;
2891 }
2892
2893 /**
2894 * space
2895 * Will add space before or after the current content
2896 * By default this is done with a clear.gif but it can be done with CSS margins by setting the property space.useDiv to true
2897 * See wrap
2898 *
2899 * @param string Input value undergoing processing in this function.
2900 * @param array stdWrap properties for space.
2901 * @return string The processed input value
2902 */
2903 public function stdWrap_space($content = '', $conf = array()) {
2904 $content = $this->wrapSpace($content, trim($conf['space']), $conf['space.']);
2905 return $content;
2906 }
2907
2908 /**
2909 * wrap
2910 * This is the "mother" of all wraps
2911 * Third of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2912 * Basically it will put additional content before and after the current content using a split character as a placeholder for the current content
2913 * The default split character is | but it can be replaced with other characters by the property splitChar
2914 * Any other wrap that does not have own splitChar settings will be using the default split char though
2915 *
2916 * @param string Input value undergoing processing in this function.
2917 * @param array stdWrap properties for wrap.
2918 * @return string The processed input value
2919 */
2920 public function stdWrap_wrap($content = '', $conf = array()) {
2921 $content = $this->wrap($content, $conf['wrap'], ($conf['wrap.']['splitChar'] ? $conf['wrap.']['splitChar'] : '|'));
2922 return $content;
2923 }
2924
2925 /**
2926 * noTrimWrap
2927 * Fourth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2928 * The major difference to any other wrap is, that this one can make use of whitespace without trimming *
2929 *
2930 * @param string Input value undergoing processing in this function.
2931 * @param array stdWrap properties for noTrimWrap.
2932 * @return string The processed input value
2933 */
2934 public function stdWrap_noTrimWrap($content = '', $conf = array()) {
2935 $content = $this->noTrimWrap($content, $conf['noTrimWrap']);
2936 return $content;
2937 }
2938
2939 /**
2940 * wrap2
2941 * Fifth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2942 * The default split character is | but it can be replaced with other characters by the property splitChar
2943 *
2944 * @param string Input value undergoing processing in this function.
2945 * @param array stdWrap properties for wrap2.
2946 * @return string The processed input value
2947 */
2948 public function stdWrap_wrap2($content = '', $conf = array()) {
2949 $content = $this->wrap($content, $conf['wrap2'], ($conf['wrap2.']['splitChar'] ? $conf['wrap2.']['splitChar'] : '|'));
2950 return $content;
2951 }
2952
2953 /**
2954 * dataWrap
2955 * Sixth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2956 * Can fetch additional content the same way data does (i.e. {field:whatever}) and apply it to the wrap before that is applied to the content
2957 *
2958 * @param string Input value undergoing processing in this function.
2959 * @param array stdWrap properties for dataWrap.
2960 * @return string The processed input value
2961 */
2962 public function stdWrap_dataWrap($content = '', $conf = array()) {
2963 $content = $this->dataWrap($content, $conf['dataWrap']);
2964 return $content;
2965 }
2966
2967 /**
2968 * prepend
2969 * A content object that will be prepended to the current content after most of the wraps have already been applied
2970 *
2971 * @param string Input value undergoing processing in this function.
2972 * @param array stdWrap properties for prepend.
2973 * @return string The processed input value
2974 */
2975 public function stdWrap_prepend($content = '', $conf = array()) {
2976 $content = $this->cObjGetSingle($conf['prepend'], $conf['prepend.'], '/stdWrap/.prepend') . $content;
2977 return $content;
2978 }
2979
2980 /**
2981 * append
2982 * A content object that will be appended to the current content after most of the wraps have already been applied
2983 *
2984 * @param string Input value undergoing processing in this function.
2985 * @param array stdWrap properties for append.
2986 * @return string The processed input value
2987 */
2988 public function stdWrap_append($content = '', $conf = array()) {
2989 $content .= $this->cObjGetSingle($conf['append'], $conf['append.'], '/stdWrap/.append');
2990 return $content;
2991 }
2992
2993 /**
2994 * wrap3
2995 * Seventh of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2996 * The default split character is | but it can be replaced with other characters by the property splitChar
2997 *
2998 * @param string Input value undergoing processing in this function.
2999 * @param array stdWrap properties for wrap3.
3000 * @return string The processed input value
3001 */
3002 public function stdWrap_wrap3($content = '', $conf = array()) {
3003 $content = $this->wrap($content, $conf['wrap3'], ($conf['wrap3.']['splitChar'] ? $conf['wrap3.']['splitChar'] : '|'));
3004 return $content;
3005 }
3006
3007 /**
3008 * outerWrap
3009 * Eighth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
3010 *
3011 * @param string Input value undergoing processing in this function.
3012 * @param array stdWrap properties for outerWrap.
3013 * @return string The processed input value
3014 */
3015 public function stdWrap_outerWrap($content = '', $conf = array()) {
3016 $content = $this->wrap($content, $conf['outerWrap']);
3017 return $content;
3018 }
3019
3020 /**
3021 * inserData
3022 * Can fetch additional content the same way data does and replaces any occurence of {field:whatever} with this content
3023 *
3024 * @param string Input value undergoing processing in this function.
3025 * @param array stdWrap properties for insertData.
3026 * @return string The processed input value
3027 */
3028 public function stdWrap_insertData($content = '', $conf = array()) {
3029 $content = $this->insertData($content);
3030 return $content;
3031 }
3032
3033 /**
3034 * offsetWrap
3035 * Creates a so called offset table around the content
3036 * Still here for historical reasons even not used too much nowadays
3037 *
3038 * @param string Input value undergoing processing in this function.
3039 * @param array stdWrap properties for offsetWrap.
3040 * @return string The processed input value
3041 */
3042 public function stdWrap_offsetWrap($content = '', $conf = array()) {
3043 $controlTable = t3lib_div::makeInstance('tslib_tableOffset');
3044 if ($conf['offsetWrap.']['tableParams'] || $conf['offsetWrap.']['tableParams.']) {
3045 $controlTable->tableParams = $this->stdWrap($conf['offsetWrap.']['tableParams'], $conf['offsetWrap.']['tableParams.']);
3046 }
3047 if ($conf['offsetWrap.']['tdParams'] || $conf['offsetWrap.']['tdParams.']) {
3048 $controlTable->tdParams = ' ' . $this->stdWrap($conf['offsetWrap.']['tdParams'], $conf['offsetWrap.']['tdParams.']);
3049 }
3050 $content = $controlTable->start($content, $conf['offsetWrap']);
3051 if ($conf['offsetWrap.']['stdWrap.']) {
3052 $content = $this->stdWrap($content, $conf['offsetWrap.']['stdWrap.']);
3053 }
3054 return $content;
3055 }
3056
3057 /**
3058 * postUserFunc
3059 * Will execute a user function after the content has been modified by any other stdWrap function
3060 *
3061 * @param string Input value undergoing processing in this function.
3062 * @param array stdWrap properties for postUserFunc.
3063 * @return string The processed input value
3064 */
3065 public function stdWrap_postUserFunc($content = '', $conf = array()) {
3066 $content = $this->callUserFunction($conf['postUserFunc'], $conf['postUserFunc.'], $content);
3067 return $content;
3068 }
3069
3070 /**
3071 * postUserFuncInt
3072 * Will execute a user function after the content has been created and each time it is fetched from Cache
3073 * The result of this function itself will not be cached
3074 *
3075 * @param string Input value undergoing processing in this function.
3076 * @param array stdWrap properties for postUserFuncInt.
3077 * @return string The processed input value
3078 */
3079 public function stdWrap_postUserFuncInt($content = '', $conf = array()) {
3080 $substKey = 'INT_SCRIPT.' . $GLOBALS['TSFE']->uniqueHash();
3081 $GLOBALS['TSFE']->config['INTincScript'][$substKey] = array(
3082 'content' => $content, 'postUserFunc' => $conf['postUserFuncInt'], 'conf' => $conf['postUserFuncInt.'], 'type' => 'POSTUSERFUNC', 'cObj' => serialize($this)
3083 );
3084 $content = '<!--' . $substKey . '-->';
3085 return $content;
3086 }
3087
3088 /**
3089 * prefixComment
3090 * Will add HTML comments to the content to make it easier to identify certain content elements within the HTML output later on
3091 *
3092 * @param string Input value undergoing processing in this function.
3093 * @param array stdWrap properties for prefixComment.
3094 * @return string The processed input value
3095 */
3096 public function stdWrap_prefixComment($content = '', $conf = array()) {
3097 if (!$GLOBALS['TSFE']->config['config']['disablePrefixComment']) {
3098 $content = $this->prefixComment($conf['prefixComment'], $conf['prefixComment.'], $content);
3099 }
3100 return $content;
3101 }
3102
3103 /**
3104 * editIcons
3105 * Will render icons for frontend editing as long as there is a BE user logged in
3106 *
3107 * @param string Input value undergoing processing in this function.
3108 * @param array stdWrap properties for editIcons.
3109 * @return string The processed input value
3110 */
3111 public function stdWrap_editIcons($content = '', $conf = array()) {
3112 if ($GLOBALS['TSFE']->beUserLogin) {
3113 $content = $this->editIcons($content, $conf['editIcons'], $conf['editIcons.']);
3114 }
3115 return $content;
3116 }
3117
3118 /**
3119 * editPanel
3120 * Will render the edit panel for frontend editing as long as there is a BE user logged in
3121 *
3122 * @param string Input value undergoing processing in this function.
3123 * @param array stdWrap properties for editPanel.
3124 * @return string The processed input value
3125 */
3126 public function stdWrap_editPanel($content = '', $conf = array()) {
3127 if ($GLOBALS['TSFE']->beUserLogin) {
3128 $content = $this->editPanel($content, $conf['editPanel.']);
3129 }
3130 return $content;
3131 }
3132
3133 /**
3134 * stdWrap post process hook
3135 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
3136 * this hook executes functions at after the content has been modified by the rest of the stdWrap functions but still before debugging
3137 *
3138 * @param string Input value undergoing processing in these functions.
3139 * @param array All stdWrap properties, not just the ones for a particular function.
3140 * @return string The processed input value
3141 */
3142 public function stdWrap_stdWrapPostProcess($content = '', $conf = array()) {
3143 foreach ($this->stdWrapHookObjects as $hookObject) {
3144 $content = $hookObject->stdWrapPostProcess($content, $conf, $this);
3145 }
3146 return $content;
3147 }
3148
3149 /**
3150 * debug
3151 * Will output the content as readable HTML code
3152 *
3153 * @param string Input value undergoing processing in this function.
3154 * @param array stdWrap properties for debug.
3155 * @return string The processed input value
3156 */
3157 public function stdWrap_debug($content = '', $conf = array()) {
3158 $content = '<pre>' . htmlspecialchars($content) . '</pre>';
3159 return $content;
3160 }
3161
3162 /**
3163 * debugFunc
3164 * Will output the content in a debug table
3165 *
3166 * @param string Input value undergoing processing in this function.
3167 * @param array stdWrap properties for debugFunc.
3168 * @return string The processed input value
3169 */
3170 public function stdWrap_debugFunc($content = '', $conf = array()) {
3171 debug($conf['debugFunc'] == 2 ? array(
3172 $content
3173 ) : $content);
3174 return $content;
3175 }
3176
3177 /**
3178 * debugData
3179 * Will output the data used by the current record in a debug table
3180 *
3181 * @param string Input value undergoing processing in this function.