2 /***************************************************************
5 * (c) 1999-2010 Kasper Skårhøj (kasperYYYY@typo3.com)
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.
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.
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.
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
28 * Contains classes for Content Rendering based on TypoScript Template configuration
31 * Revised for TYPO3 3.6 June/2003 by Kasper Skårhøj
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)
39 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
42 * [CLASS/FUNCTION INDEX of SCRIPT]
46 * 256: class tslib_cObj
47 * 353: function start($data,$table='')
48 * 387: function setParent($data,$currentRecord)
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='__')
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)
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)
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)
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)
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)
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)
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)
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)
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)
199 * 7351: class tslib_frameset
200 * 7361: function make($setup)
201 * 7398: function frameParams($setup, $typeNum)
202 * 7426: function framesetParams($setup)
205 * 7459: class tslib_tableOffset
206 * 7471: function start($content,$offset)
209 * 7549: class tslib_controlTable
210 * 7584: function start($offset,$cMargins)
212 * TOTAL FUNCTIONS: 135
213 * (This index is automatically created/updated by the extension "extdeveval")
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.
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.
228 * @author Kasper Skårhøj <kasperYYYY@typo3.com>
231 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&cHash=4ad9d7acb4
242 * stdWrap functions in their correct order
246 var $stdWrapOrder = array(
247 'stdWrapPreProcess' => 'hook', // this is a placeholder for the first Hook
248 'setContentToCurrent' => 'boolean',
249 'setContentToCurrent.' => 'array',
250 'setCurrent' => 'string',
251 'setCurrent.' => 'array',
255 'field' => 'fieldName',
257 'current' => 'boolean',
258 'current.' => 'array',
259 'cObject' => 'cObject',
260 'cObject.' => 'array',
261 'numRows.' => 'array',
263 'filelist.' => 'array',
264 'preUserFunc' => 'functionName',
265 'stdWrapOverride' => 'hook', // this is a placeholder for the second Hook
266 'override' => 'string',
267 'override.' => 'array',
268 'preIfEmptyListNum' => 'listNum',
269 'preIfEmptyListNum.' => 'array',
270 'ifEmpty' => 'string',
271 'ifEmpty.' => 'array',
272 'ifBlank' => 'string',
273 'ifBlank.' => 'array',
274 'listNum' => 'listNum',
275 'listNum.' => 'array',
278 'stdWrap' => 'stdWrap',
279 'stdWrap.' => 'array',
280 'stdWrapProcess' => 'hook', // this is a placeholder for the third Hook
281 'required' => 'boolean',
282 'required.' => 'array',
284 'fieldRequired' => 'fieldName',
285 'fieldRequired.' => 'array',
286 'csConv' => 'string',
287 'csConv.' => 'array',
288 'parseFunc' => 'objectpath',
289 'parseFunc.' => 'array',
290 'HTMLparser' => 'boolean',
291 'HTMLparser.' => 'array',
293 'prioriCalc' => 'boolean',
294 'prioriCalc.' => 'array',
297 'intval' => 'boolean',
298 'intval.' => 'array',
299 'numberFormat.' => 'array',
300 'date' => 'dateconf',
302 'strftime' => 'strftimeconf',
303 'strftime.' => 'array',
308 'bytes' => 'boolean',
310 'substring' => 'parameters',
311 'substring.' => 'array',
312 'removeBadHTML' => 'boolean',
313 'removeBadHTML.' => 'array',
314 'cropHTML' => 'crop',
315 'cropHTML.' => 'array',
316 'stripHtml' => 'boolean',
317 'stripHtml.' => 'array',
320 'rawUrlEncode' => 'boolean',
321 'rawUrlEncode.' => 'array',
322 'htmlSpecialChars' => 'boolean',
323 'htmlSpecialChars.' => 'array',
324 'doubleBrTag' => 'string',
325 'doubleBrTag.' => 'array',
330 'encapsLines.' => 'array',
331 'keywords' => 'boolean',
332 'keywords.' => 'array',
333 'innerWrap' => 'wrap',
334 'innerWrap.' => 'array',
335 'innerWrap2' => 'wrap',
336 'innerWrap2.' => 'array',
338 'fontTag.' => 'array',
339 'addParams.' => 'array',
340 'textStyle.' => 'array',
341 'tableStyle.' => 'array',
342 'filelink.' => 'array',
343 'preCObject' => 'cObject',
344 'preCObject.' => 'array',
345 'postCObject' => 'cObject',
346 'postCObject.' => 'array',
347 'wrapAlign' => 'align',
348 'wrapAlign.' => 'array',
349 'typolink.' => 'array',
350 'TCAselectItem.' => 'array',
353 'spaceBefore' => 'int',
354 'spaceBefore.' => 'array',
355 'spaceAfter' => 'int',
356 'spaceAfter.' => 'array',
359 'noTrimWrap' => 'wrap',
360 'noTrimWrap.' => 'array',
363 'dataWrap' => 'dataWrap',
364 'dataWrap.' => 'array',
365 'prepend' => 'cObject',
366 'prepend.' => 'array',
367 'append' => 'cObject',
368 'append.' => 'array',
371 'outerWrap' => 'wrap',
372 'outerWrap.' => 'array',
373 'insertData' => 'boolean',
374 'insertData.' => 'array',
375 'offsetWrap' => 'space',
376 'offsetWrap.' => 'array',
377 'postUserFunc' => 'functionName',
378 'postUserFuncInt' => 'functionName',
379 'prefixComment' => 'string',
380 'prefixComment.' => 'array',
381 'editIcons' => 'string',
382 'editIcons.' => 'array',
383 'editPanel' => 'boolean',
384 'editPanel.' => 'array',
385 'stdWrapPostProcess' => 'hook', // this is a placeholder for the last Hook
386 'debug' => 'boolean',
388 'debugFunc' => 'boolean',
389 'debugFunc.' => 'array',
390 'debugData' => 'boolean',
391 'debugData.' => 'array'
395 * Holds ImageMagick parameters and extensions used for compression
400 * 1= Dont change! (removes all parameters for the image_object!!)
404 var $image_compression = array(
406 'params' => '', 'ext' => 'gif'
409 'params' => '-colors 128', 'ext' => 'gif'
412 'params' => '-colors 64', 'ext' => 'gif'
415 'params' => '-colors 32', 'ext' => 'gif'
418 'params' => '-colors 16', 'ext' => 'gif'
421 'params' => '-colors 8', 'ext' => 'gif'
425 'params' => '-quality 100', 'ext' => 'jpg'
428 'params' => '-quality 90', 'ext' => 'jpg'
431 'params' => '-quality 80', 'ext' => 'jpg'
434 'params' => '-quality 70', 'ext' => 'jpg'
437 'params' => '-quality 60', 'ext' => 'jpg'
440 'params' => '-quality 50', 'ext' => 'jpg'
443 'params' => '-quality 40', 'ext' => 'jpg'
446 'params' => '-quality 30', 'ext' => 'jpg'
449 'params' => '-quality 20', 'ext' => 'jpg'
453 'params' => '-colors 256', 'ext' => 'png'
456 'params' => '-colors 128', 'ext' => 'png'
459 'params' => '-colors 64', 'ext' => 'png'
462 'params' => '-colors 32', 'ext' => 'png'
465 'params' => '-colors 16', 'ext' => 'png'
468 'params' => '-colors 8', 'ext' => 'png'
471 'params' => '', 'ext' => 'png'
476 * ImageMagick parameters for image effects
480 var $image_effects = array(
484 10 => '-colorspace GRAY',
493 * Loaded with the current data-record.
495 * If the instance of this class is used to render records from the database those records are found in this array.
496 * The function stdWrap has TypoScript properties that fetch field-data from this array.
500 protected $table = '';
501 var $oldData = array(); // Used for backup...
502 var $alternativeData = ''; // If this is set with an array before stdWrap, it's used instead of $this->data in the data-property in stdWrap
503 var $parameters = array(); // Used by the parseFunc function and is loaded with tag-parameters when parsing tags.
504 var $currentValKey = 'currentValue_kidjls9dksoje';
505 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.
506 var $currentRecordTotal = 0; // Set in cObj->RECORDS and cObj->CONTENT to the current number of records selected in a query.
507 var $currentRecordNumber = 0; // Incremented in cObj->RECORDS and cObj->CONTENT before each record rendering.
508 var $parentRecordNumber = 0; // Incremented in parent cObj->RECORDS and cObj->CONTENT before each record rendering.
509 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.
510 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.
514 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)
515 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.
516 var $checkPid_badDoktypeList = '255';
517 var $lastTypoLinkUrl = ''; // This will be set by typoLink() to the url of the most recent link created.
518 var $lastTypoLinkTarget = ''; // DO. link target.
519 var $lastTypoLinkLD = array();
520 var $substMarkerCache = array(); // Caching substituteMarkerArrayCached function
521 var $recordRegister = array(); // array that registers rendered content elements (or any table) to make sure they are not rendered recursively!
522 var $cObjHookObjectsArr = array(); // Containig hooks for userdefined cObjects
523 protected $stdWrapHookObjects = array(); // Containing hook objects for stdWrap
524 protected $getImgResourceHookObjects; // Containing hook objects for getImgResource
527 * @var array with members of tslib_content_abstract
529 protected $contentObjects = array();
532 * Set to TRUE by doConvertToUserIntObject() if USER object wants to become USER_INT
534 public $doConvertToUserIntObject = FALSE
;
537 * Indicates current object type. Can hold one of OBJECTTYPE_ constants or FALSE.
538 * The value is set and reset inside USER() function. Any time outside of
539 * USER() it is FALSE.
541 protected $userObjectType = FALSE
;
544 * Indicates that object type is USER.
546 * @see tslib_cObjh::$userObjectType
548 const OBJECTTYPE_USER_INT
= 1;
551 * Indicates that object type is USER.
553 * @see tslib_cObjh::$userObjectType
555 const OBJECTTYPE_USER
= 2;
559 * Well, it has to be called manually since it is not a real constructor function.
560 * 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.
562 * @param array $data the record data that is rendered.
563 * @param string $table the table that the data record is from.
566 function start($data, $table = '') {
567 global $TYPO3_CONF_VARS;
569 $this->table
= $table;
570 $this->currentRecord
= $table ?
$table . ':' . $this->data
['uid'] : '';
571 $this->parameters
= array();
572 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClass'])) {
573 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClass'] as $classArr) {
574 $this->cObjHookObjectsArr
[$classArr[0]] = t3lib_div
::getUserObj($classArr[1]);
578 $this->stdWrapHookObjects
= array();
579 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['stdWrap'])) {
580 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['stdWrap'] as $classData) {
581 $hookObject = t3lib_div
::getUserObj($classData);
583 if (!($hookObject instanceof tslib_content_stdWrapHook
)) {
584 throw new UnexpectedValueException(
585 '$hookObject must implement interface tslib_content_stdWrapHook',
590 $this->stdWrapHookObjects
[] = $hookObject;
594 if (is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['postInit'])) {
595 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['postInit'] as $classData) {
596 $postInitializationProcessor = t3lib_div
::getUserObj($classData);
598 if (!($postInitializationProcessor instanceof tslib_content_PostInitHook
)) {
599 throw new UnexpectedValueException(
600 '$postInitializationProcessor must implement interface tslib_content_PostInitHook',
605 $postInitializationProcessor->postProcessContentObjectInitialization($this);
613 * Resets the references to the TypoScript Content Object implementation
614 * objects of tslib_content_*. Otherwise they would still point to the
615 * original tslib_cObj instance's tslib_content_* instances, they in return
616 * would back-reference to the original tslib_cObj instance instead of the
617 * newly cloned tslib_cObj instance.
619 * @see http://bugs.typo3.org/view.php?id=16568
621 public function __clone() {
622 $this->contentObjects
= array();
626 * Gets the 'getImgResource' hook objects.
627 * The first call initializes the accordant objects.
629 * @return array The 'getImgResource' hook objects (if any)
631 protected function getGetImgResourceHookObjects() {
632 if (!isset($this->getImgResourceHookObjects
)) {
633 $this->getImgResourceHookObjects
= array();
635 if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getImgResource'])) {
636 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['getImgResource'] as $classData) {
637 $hookObject = t3lib_div
::getUserObj($classData);
639 if (!($hookObject instanceof tslib_cObj_getImgResourceHook
)) {
640 throw new UnexpectedValueException(
641 '$hookObject must implement interface tslib_cObj_getImgResourceHook',
646 $this->getImgResourceHookObjects
[] = $hookObject;
651 return $this->getImgResourceHookObjects
;
655 * Sets the internal variable parentRecord with information about current record.
656 * 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.
658 * @param array $data: The record array
659 * @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.
663 function setParent($data, $currentRecord) {
664 $this->parentRecord
= array(
666 'currentRecord' => $currentRecord
672 /***********************************************
676 ***********************************************/
679 * Returns the "current" value.
680 * 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.
681 * It's like "load accumulator" in the good old C64 days... basically a "register" you can use as you like.
682 * 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.
684 * @return mixed The "current" value
686 function getCurrentVal() {
687 return $this->data
[$this->currentValKey
];
691 * Sets the "current" value.
693 * @param mixed The variable that you want to set as "current"
695 * @see getCurrentVal()
697 function setCurrentVal($value) {
698 $this->data
[$this->currentValKey
] = $value;
702 * Rendering of a "numerical array" of cObjects from TypoScript
703 * Will call ->cObjGetSingle() for each cObject found and accumulate the output.
705 * @param array $setup: array with cObjects as values.
706 * @param string $addKey: A prefix for the debugging information
707 * @return string Rendered output from the cObjects in the array.
708 * @see cObjGetSingle()
710 function cObjGet($setup, $addKey = '') {
711 if (is_array($setup)) {
712 $sKeyArray = t3lib_TStemplate
::sortedKeyList($setup);
714 foreach ($sKeyArray as $theKey) {
715 $theValue = $setup[$theKey];
716 if (intval($theKey) && !strstr($theKey, '.')) {
717 $conf = $setup[$theKey . '.'];
718 $content .= $this->cObjGetSingle($theValue, $conf, $addKey . $theKey); // Get the contentObject
726 * Renders a content object
728 * @param string The content object name, eg. "TEXT" or "USER" or "IMAGE"
729 * @param array The array with TypoScript properties for the content object
730 * @param string A string label used for the internal debugging tracking.
731 * @return string cObject output
732 * @example http://typo3.org/doc.0.html?&encryptionKey=&tx_extrepmgm_pi1[extUid]=267&tx_extrepmgm_pi1[tocEl]=153&cHash=7e74f4d331
734 function cObjGetSingle($name, $conf, $TSkey = '__') {
735 global $TYPO3_CONF_VARS;
738 // Checking that the function is not called eternally. This is done by interrupting at a depth of 100
739 $GLOBALS['TSFE']->cObjectDepthCounter
--;
740 if ($GLOBALS['TSFE']->cObjectDepthCounter
> 0) {
742 if ($GLOBALS['TT']->LR
)
743 $GLOBALS['TT']->push($TSkey, $name);
745 // Checking if the COBJ is a reference to another object. (eg. name of 'blabla.blabla = < styles.something')
746 if (substr($name, 0, 1) == '<') {
747 $key = trim(substr($name, 1));
748 $cF = t3lib_div
::makeInstance('t3lib_TSparser');
749 // $name and $conf is loaded with the referenced values.
751 list ($name, $conf) = $cF->getVal($key, $GLOBALS['TSFE']->tmpl
->setup
);
752 if (is_array($old_conf) && count($old_conf)) {
753 $conf = $this->joinTSarrays($conf, $old_conf);
755 // Getting the cObject
756 $GLOBALS['TT']->incStackPointer();
757 $content .= $this->cObjGetSingle($name, $conf, $key);
758 $GLOBALS['TT']->decStackPointer();
762 // Application defined cObjects
763 foreach ($this->cObjHookObjectsArr
as $cObjName => $hookObj) {
764 if (($name === $cObjName) && method_exists($hookObj, 'cObjGetSingleExt')) {
765 $content .= $hookObj->cObjGetSingleExt($name, $conf, $TSkey, $this);
770 $contentObject = $this->getContentObject($name);
771 if ($contentObject) {
772 $content .= $contentObject->render($conf);
774 // call hook functions for extra processing
775 if ($name && is_array($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClassDefault'])) {
776 foreach ($TYPO3_CONF_VARS['SC_OPTIONS']['tslib/class.tslib_content.php']['cObjTypeAndClassDefault'] as $classData) {
777 $hookObject = t3lib_div
::getUserObj($classData);
779 if (!($hookObject instanceof tslib_content_cObjGetSingleHook
)) {
780 throw new UnexpectedValueException(
781 '$hookObject must implement interface tslib_content_cObjGetSingleHook',
785 /* @var $hookObject tslib_content_cObjGetSingleHook */
786 $content .= $hookObject->getSingleContentObject($name, (array) $conf, $TSkey, $this);
789 // log error in AdminPanel
790 $warning = sprintf('Content Object "%s" does not exist', $name);
791 $GLOBALS['TT']->setTSlogMessage($warning, 2);
796 if ($GLOBALS['TT']->LR
)
797 $GLOBALS['TT']->pull($content);
799 // Increasing on exit...
800 $GLOBALS['TSFE']->cObjectDepthCounter++
;
805 * Returns a new content object of type $name.
807 * @param string $name
808 * @return tslib_content_abstract
810 public function getContentObject($name) {
811 $classMapping = array(
815 'CLEARGIF' => 'ClearGif',
816 'COBJ_ARRAY' => 'ContentObjectArray',
817 'COA' => 'ContentObjectArray',
818 'COA_INT' => 'ContentObjectArrayInternal',
820 'USER_INT' => 'UserInternal',
823 'IMG_RESOURCE' => 'ImageResource',
824 'IMGTEXT' => 'ImageText',
825 'CONTENT' => 'Content',
826 'RECORDS' => 'Records',
827 'HMENU' => 'HierarchicalMenu',
828 'CTABLE' => 'ContentTable',
829 'OTABLE' => 'OffsetTable',
830 'COLUMNS' => 'Columns',
831 'HRULER' => 'HorizontalRuler',
832 'CASEFUNC' => 'Case',
833 'LOAD_REGISTER' => 'LoadRegister',
834 'RESTORE_REGISTER' => 'RestoreRegister',
836 'SEARCHRESULT' => 'SearchResult',
837 'PHP_SCRIPT' => 'PhpScript',
838 'PHP_SCRIPT_INT' => 'PhpScriptInternal',
839 'TEMPLATE' => 'Template',
840 'FLUIDTEMPLATE' => 'FluidTemplate',
841 'MULTIMEDIA' => 'Multimedia',
843 'SWFOBJECT' => 'ShockwaveFlashObject',
844 'QTOBJECT' => 'QuicktimeObject',
845 'SVG' => 'ScalableVectorGraphics',
846 'EDITPANEL' => 'EditPanel',
848 $name = $classMapping[$name];
850 if (!array_key_exists($name, $this->contentObjects
)) {
852 $this->contentObjects
[$name] = t3lib_div
::makeInstance('tslib_content_' . $name, $this);
853 } catch (ReflectionException
$e) {
854 $this->contentObjects
[$name] = NULL
;
857 return $this->contentObjects
[$name];
861 /********************************************
863 * Functions rendering content objects (cObjects)
865 ********************************************/
868 * Rendering the cObject, HTML
870 * @param array array of TypoScript properties
871 * @return string Output
873 function HTML($conf) {
874 return $this->getContentObject('HTML')->render($conf);
878 * Rendering the cObject, TEXT
880 * @param array array of TypoScript properties
881 * @return string Output
883 function TEXT($conf) {
884 return $this->getContentObject('TEXT')->render($conf);
888 * Rendering the cObject, CLEARGIF
890 * @param array array of TypoScript properties
891 * @return string Output
893 function CLEARGIF($conf) {
894 return $this->getContentObject('CLEARGIF')->render($conf);
898 * Rendering the cObject, COBJ_ARRAY / COA and COBJ_ARRAY_INT
900 * @param array array of TypoScript properties
901 * @param string If "INT" then the cObject is a "COBJ_ARRAY_INT" (non-cached), otherwise just "COBJ_ARRAY" (cached)
902 * @return string Output
904 function COBJ_ARRAY($conf, $ext = '') {
905 if ($ext === 'INT') {
906 return $this->getContentObject('COA_INT')->render($conf);
908 return $this->getContentObject('COA')->render($conf);
913 * Rendering the cObject, USER and USER_INT
915 * @param array array of TypoScript properties
916 * @param string If "INT" then the cObject is a "USER_INT" (non-cached), otherwise just "USER" (cached)
917 * @return string Output
919 function USER($conf, $ext = '') {
920 if ($ext === 'INT') {
921 return $this->getContentObject('USER_INT')->render($conf);
923 return $this->getContentObject('USER')->render($conf);
928 * Retrieves a type of object called as USER or USER_INT. Object can detect their
929 * type by using this call. It returns OBJECTTYPE_USER_INT or OBJECTTYPE_USER depending on the
930 * current object execution. In all other cases it will return FALSE to indicate
931 * a call out of context.
933 * @return mixed One of OBJECTTYPE_ class constants or FALSE
935 public function getUserObjectType() {
936 return $this->userObjectType
;
940 * Sets the user object type
942 * @param mixed $userObjectType
945 public function setUserObjectType($userObjectType) {
946 $this->userObjectType
= $userObjectType;
950 * Requests the current USER object to be converted to USER_INT.
954 public function convertToUserIntObject() {
955 if ($this->userObjectType
!== self
::OBJECTTYPE_USER
) {
956 $GLOBALS['TT']->setTSlogMessage('tslib_cObj::convertToUserIntObject() ' . 'is called in the wrong context or for the wrong object type', 2);
958 $this->doConvertToUserIntObject
= TRUE
;
963 * Rendering the cObject, FILE
965 * @param array array of TypoScript properties
966 * @return string Output
968 function FILE($conf) {
969 return $this->getContentObject('FILE')->render($conf);
973 * Rendering the cObject, IMAGE
975 * @param array array of TypoScript properties
976 * @return string Output
979 function IMAGE($conf) {
980 return $this->getContentObject('IMAGE')->render($conf);
984 * Rendering the cObject, IMG_RESOURCE
986 * @param array array of TypoScript properties
987 * @return string Output
988 * @see getImgResource()
990 function IMG_RESOURCE($conf) {
991 return $this->getContentObject('IMG_RESOURCE')->render($conf);
995 * Rendering the cObject, IMGTEXT
997 * @param array array of TypoScript properties
998 * @return string Output
1000 function IMGTEXT($conf) {
1001 return $this->getContentObject('IMGTEXT')->render($conf);
1005 * Rendering the cObject, CONTENT
1007 * @param array array of TypoScript properties
1008 * @return string Output
1010 function CONTENT($conf) {
1011 return $this->getContentObject('CONTENT')->render($conf);
1015 * Rendering the cObject, RECORDS
1017 * @param array array of TypoScript properties
1018 * @return string Output
1020 function RECORDS($conf) {
1021 return $this->getContentObject('RECORDS')->render($conf);
1025 * Rendering the cObject, HMENU
1027 * @param array array of TypoScript properties
1028 * @return string Output
1030 function HMENU($conf) {
1031 return $this->getContentObject('HMENU')->render($conf);
1035 * Rendering the cObject, CTABLE
1037 * @param array array of TypoScript properties
1038 * @return string Output
1040 function CTABLE($conf) {
1041 return $this->getContentObject('CTABLE')->render($conf);
1045 * Rendering the cObject, OTABLE
1047 * @param array array of TypoScript properties
1048 * @return string Output
1050 function OTABLE($conf) {
1051 return $this->getContentObject('OTABLE')->render($conf);
1055 * Rendering the cObject, COLUMNS
1057 * @param array array of TypoScript properties
1058 * @return string Output
1060 function COLUMNS($conf) {
1061 return $this->getContentObject('COLUMNS')->render($conf);
1065 * Rendering the cObject, HRULER
1067 * @param array array of TypoScript properties
1068 * @return string Output
1070 function HRULER($conf) {
1071 return $this->getContentObject('HRULER')->render($conf);
1075 * Rendering the cObject, CASE
1077 * @param array array of TypoScript properties
1078 * @return string Output
1080 function CASEFUNC($conf) {
1081 return $this->getContentObject('CASE')->render($conf);
1085 * Rendering the cObject, LOAD_REGISTER and RESTORE_REGISTER
1086 * NOTICE: This cObject does NOT return any content since it just sets internal data based on the TypoScript properties.
1088 * @param array array of TypoScript properties
1089 * @param string If "RESTORE_REGISTER" then the cObject rendered is "RESTORE_REGISTER", otherwise "LOAD_REGISTER"
1090 * @return string Empty string (the cObject only sets internal data!)
1092 function LOAD_REGISTER($conf, $name) {
1093 if ($name === 'RESTORE_REGISTER') {
1094 return $this->getContentObject('RESTORE_REGISTER')->render($conf);
1096 return $this->getContentObject('LOAD_REGISTER')->render($conf);
1101 * Rendering the cObject, FORM
1103 * @param array array of TypoScript properties
1104 * @param array Alternative formdata overriding whatever comes from TypoScript
1105 * @return string Output
1107 function FORM($conf, $formData = '') {
1108 return $this->getContentObject('FORM')->render($conf);
1112 * Rendering the cObject, SEARCHRESULT
1114 * @param array array of TypoScript properties
1115 * @return string Output
1117 function SEARCHRESULT($conf) {
1118 return $this->getContentObject('SEARCHRESULT')->render($conf);
1122 * Rendering the cObject, PHP_SCRIPT, PHP_SCRIPT_INT and PHP_SCRIPT_EXT
1124 * @param array array of TypoScript properties
1125 * @param string If "INT", then rendering "PHP_SCRIPT_INT"; If "EXT", then rendering "PHP_SCRIPT_EXT"; Default is rendering "PHP_SCRIPT" (cached)
1126 * @return string Output
1128 function PHP_SCRIPT($conf, $ext = '') {
1129 if ($ext === 'INT' ||
$ext === 'EXT') {
1130 return $this->getContentObject('PHP_SCRIPT_INT')->render($conf, $ext);
1132 return $this->getContentObject('PHP_SCRIPT')->render($conf);
1137 * Rendering the cObject, TEMPLATE
1139 * @param array array of TypoScript properties
1140 * @return string Output
1141 * @see substituteMarkerArrayCached()
1143 function TEMPLATE($conf) {
1144 return $this->getContentObject('TEMPLATE')->render($conf);
1148 * Rendering the cObject, FLUIDTEMPLATE
1150 * @param array array of TypoScript properties
1151 * @return string the HTML output
1152 * @author Steffen Ritter <info@steffen-ritter.net>
1153 * @author Benjamin Mack <benni@typo3.org>
1155 protected function FLUIDTEMPLATE(array $conf) {
1156 return $this->getContentObject('FLUIDTEMPLATE')->render($conf);
1160 * Rendering the cObject, MULTIMEDIA
1162 * @param array array of TypoScript properties
1163 * @return string Output
1165 function MULTIMEDIA($conf) {
1166 return $this->getContentObject('MULTIMEDIA')->render($conf);
1170 * Rendering the cObject, MEDIA
1172 * @param array array of TypoScript properties
1173 * @return string Output
1175 public function MEDIA($conf) {
1176 return $this->getContentObject('MEDIA')->render($conf);
1180 * Rendering the cObject, SWFOBJECT
1182 * @param array array of TypoScript properties
1183 * @return string Output
1185 public function SWFOBJECT($conf) {
1186 return $this->getContentObject('SWFOBJECT')->render($conf);
1190 * Rendering the cObject, QTOBJECT
1192 * @param array array of TypoScript properties
1193 * @return string Output
1195 public function QTOBJECT($conf) {
1196 return $this->getContentObject('QTOBJECT')->render($conf);
1200 * Rendering the cObject, SVG
1202 * @param array array of TypoScript properties
1203 * @return string Output
1205 public function SVG($conf) {
1206 return $this->getContentObject('SVG')->render($conf);
1209 /************************************
1211 * Various helper functions for content objects:
1213 ************************************/
1217 * Converts a given config in Flexform to a conf-array
1218 * @param string Flexform data
1219 * @param array array to write the data into, by reference
1220 * @param boolean is set if called recursive. Don't call function with this parameter, it's used inside the function only
1224 public function readFlexformIntoConf($flexData, &$conf, $recursive = FALSE
) {
1225 if ($recursive === FALSE
) {
1226 $flexData = t3lib_div
::xml2array($flexData, 'T3');
1229 if (is_array($flexData)) {
1230 if (isset($flexData['data']['sDEF']['lDEF'])) {
1231 $flexData = $flexData['data']['sDEF']['lDEF'];
1234 foreach ($flexData as $key => $value) {
1235 if (is_array($value['el']) && count($value['el']) > 0) {
1236 foreach ($value['el'] as $ekey => $element) {
1237 if (isset($element['vDEF'])) {
1238 $conf[$ekey] = $element['vDEF'];
1240 if (is_array($element)) {
1241 $this->readFlexformIntoConf($element, $conf[$key][key($element)][$ekey], TRUE
);
1243 $this->readFlexformIntoConf($element, $conf[$key][$ekey], TRUE
);
1248 $this->readFlexformIntoConf($value['el'], $conf[$key], TRUE
);
1250 if ($value['vDEF']) {
1251 $conf[$key] = $value['vDEF'];
1259 * Returns all parents of the given PID (Page UID) list
1261 * @param string A list of page Content-Element PIDs (Page UIDs) / stdWrap
1262 * @param array stdWrap array for the list
1263 * @return string A list of PIDs
1266 function getSlidePids($pidList, $pidConf) {
1267 $pidList = trim($this->stdWrap($pidList, $pidConf));
1268 if (!strcmp($pidList, '')) {
1271 if (trim($pidList)) {
1272 $listArr = t3lib_div
::intExplode(',', str_replace('this', $GLOBALS['TSFE']->contentPid
, $pidList));
1273 $listArr = $this->checkPidArray($listArr);
1276 if (is_array($listArr) && count($listArr)) {
1277 foreach ($listArr as $uid) {
1278 $page = $GLOBALS['TSFE']->sys_page
->getPage($uid);
1279 if (!$page['is_siteroot']) {
1280 $pidList[] = $page['pid'];
1284 return implode(',', $pidList);
1288 * Returns a default value for a form field in the FORM cObject.
1289 * Page CANNOT be cached because that would include the inserted value for the current user.
1291 * @param boolean If noValueInsert OR if the no_cache flag for this page is NOT set, the original default value is returned.
1292 * @param string $fieldName: The POST var name to get default value for
1293 * @param string $defaultVal: The current default value
1294 * @return string The default value, either from INPUT var or the current default, based on whether caching is enabled or not.
1297 function getFieldDefaultValue($noValueInsert, $fieldName, $defaultVal) {
1298 if (!$GLOBALS['TSFE']->no_cache ||
(!isset($_POST[$fieldName]) && !isset($_GET[$fieldName])) ||
$noValueInsert) {
1301 return t3lib_div
::_GP($fieldName);
1306 * Returns a <img> tag with the image file defined by $file and processed according to the properties in the TypoScript array.
1307 * Mostly this function is a sub-function to the IMAGE function which renders the IMAGE cObject in TypoScript.
1308 * This function is called by "$this->cImage($conf['file'],$conf);" from IMAGE().
1310 * @param string File TypoScript resource
1311 * @param array TypoScript configuration properties
1312 * @return string <img> tag, (possibly wrapped in links and other HTML) if any image found.
1316 function cImage($file, $conf) {
1317 $info = $this->getImgResource($file, $conf['file.']);
1318 $GLOBALS['TSFE']->lastImageInfo
= $info;
1319 if (is_array($info)) {
1320 $info[3] = t3lib_div
::png_to_gif_by_imagemagick($info[3]);
1321 $GLOBALS['TSFE']->imagesOnPage
[] = $info[3]; // This array is used to collect the image-refs on the page...
1324 // Backwards compatibility if altText is not set and alttext is set
1325 // @deprecated since TYPO3 4.3, will be removed in TYPO3 4.6
1326 if (strlen($conf['alttext']) ||
is_array($conf['alttext.'])) {
1327 $GLOBALS['TSFE']->logDeprecatedTyposcript(
1329 'use IMAGE.altText instead - src: ' . $info[3] . ' - original image: ' . $info['origFile']
1331 if (!strlen($conf['altText']) && !is_array($conf['altText.'])) {
1332 $conf['altText'] = $conf['alttext'];
1333 $conf['altText.'] = $conf['alttext.'];
1337 $altParam = $this->getAltParam($conf);
1338 $theValue = '<img src="' . htmlspecialchars($GLOBALS['TSFE']->absRefPrefix
.
1339 t3lib_div
::rawUrlEncodeFP($info[3])) . '" width="' . $info[0] . '" height="' . $info[1] . '"' .
1340 $this->getBorderAttr(' border="' . intval($conf['border']) . '"') .
1341 (($conf['params'] ||
is_array($conf['params.'])) ?
' ' . $this->stdWrap($conf['params'], $conf['params.']) : '') .
1342 ($altParam) . ' />';
1343 if ($conf['linkWrap']) {
1344 $theValue = $this->linkWrap($theValue, $conf['linkWrap']);
1345 } elseif ($conf['imageLinkWrap']) {
1346 $theValue = $this->imageLinkWrap($theValue, $info['origFile'], $conf['imageLinkWrap.']);
1348 return $this->wrap($theValue, $conf['wrap']);
1353 * Returns the 'border' attribute for an <img> tag only if the doctype is not xhtml_strict,xhtml_11 or xhtml_2
1354 * or if the config parameter 'disableImgBorderAttr' is not set.
1356 * @param string the border attribute
1357 * @return string the border attribute
1359 function getBorderAttr($borderAttr) {
1360 if (!t3lib_div
::inList( 'xhtml_strict,xhtml_11,xhtml_2',
1361 $GLOBALS['TSFE']->xhtmlDoctype
)
1362 && !$GLOBALS['TSFE']->config
['config']['disableImgBorderAttr']) {
1368 * Wraps the input string in link-tags that opens the image in a new window.
1370 * @param string String to wrap, probably an <img> tag
1371 * @param string The original image file
1372 * @param array TypoScript properties for the "imageLinkWrap" function
1373 * @return string The input string, $string, wrapped as configured.
1375 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=316&cHash=2848266da6
1377 function imageLinkWrap($string, $imageFile, $conf) {
1381 if ($this->stdWrap($conf['enable'], $conf['enable.'])) {
1382 $content = $this->typolink($string, $conf['typolink.']);
1383 $imageFile = $this->stdWrap($imageFile, $conf['file.']);
1386 if ($content == $string && @is_file
($imageFile)) {
1388 if ($conf['width']) {
1389 $params .= '&width=' . rawurlencode($conf['width']);
1391 if ($conf['height']) {
1392 $params .= '&height=' . rawurlencode($conf['height']);
1394 if ($conf['effects']) {
1395 $params .= '&effects=' . rawurlencode($conf['effects']);
1397 if ($conf['sample']) {
1398 $params .= '&sample=1';
1400 if ($conf['alternativeTempPath']) {
1401 $params .= '&alternativeTempPath=' . rawurlencode($conf['alternativeTempPath']);
1404 // includes lines above in cache
1406 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1410 <title>' . htmlspecialchars($conf['title'] ?
$conf['title'] : 'Image') . '</title>
1411 ' . ($conf['title'] ?
'' : '<meta name="robots" content="noindex,follow" />') . '
1413 ' . ($conf['bodyTag'] ?
$conf['bodyTag'] : '<body>');
1415 $wrapParts = explode('|', $conf['wrap']);
1416 $showPicContent .= trim($wrapParts[0]) . '###IMAGE###' . trim($wrapParts[1]);
1417 $showPicContent .= '
1420 $contentHash = md5('showpic' . $showPicContent);
1421 t3lib_pageSelect
::storeHash($contentHash, $showPicContent, 'showpic');
1423 $md5_value = md5($imageFile . '|' . $conf['width'] . '|' . $conf['height'] . '|' .
1424 $conf['effects'] . '||||' . $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] . '|');
1426 $params .= '&md5=' . $md5_value . '&contentHash=' . $contentHash;
1427 $url = $GLOBALS['TSFE']->absRefPrefix
. 'index.php?eID=tx_cms_showpic&file=' . rawurlencode($imageFile) . $params;
1429 if ($conf['directImageLink']) {
1430 $imgResourceConf = array(
1431 'file' => $imageFile,
1434 $url = $this->IMG_RESOURCE($imgResourceConf);
1436 // if no imagemagick / gm is available
1441 // Create TARGET-attribute only if the right doctype is used
1442 if (!t3lib_div
::inList('xhtml_strict,xhtml_11,xhtml_2', $GLOBALS['TSFE']->xhtmlDoctype
)) {
1443 if (isset($conf['target'])) {
1444 $target = sprintf(' target="%s"', $conf['target']);
1446 $target = ' target="thePicture"';
1451 $conf['JSwindow'] = $this->stdWrap($conf['JSwindow'], $conf['JSwindow.']);
1452 if ($conf['JSwindow']) {
1453 if ($conf['JSwindow.']['altUrl'] ||
$conf['JSwindow.']['altUrl.']) {
1454 $altUrl = $this->stdWrap($conf['JSwindow.']['altUrl'], $conf['JSwindow.']['altUrl.']);
1457 ($conf['JSwindow.']['altUrl_noDefaultParams'] ?
'' : '?file=' .
1458 rawurlencode($imageFile) . $params);
1461 $gifCreator = t3lib_div
::makeInstance('tslib_gifbuilder');
1462 $gifCreator->init();
1463 $gifCreator->mayScaleUp
= 0;
1464 $dims = $gifCreator->getImageScale($gifCreator->getImageDimensions($imageFile), $conf['width'], $conf['height'], '');
1465 $offset = t3lib_div
::intExplode(',', $conf['JSwindow.']['expand'] . ',');
1467 $a1 = '<a href="' . htmlspecialchars($url) . '" onclick="' .
1468 htmlspecialchars('openPic(\'' . $GLOBALS['TSFE']->baseUrlWrap($url) . '\',\'' .
1469 ($conf['JSwindow.']['newWindow'] ?
md5($url) : 'thePicture') . '\',\'width=' .
1470 ($dims[0] +
$offset[0]) . ',height=' . ($dims[1] +
$offset[1]) .
1471 ',status=0,menubar=0\'); return false;') . '"' .
1472 $target . $GLOBALS['TSFE']->ATagParams
. '>';
1474 $GLOBALS['TSFE']->setJS('openPic');
1476 $conf['linkParams.']['parameter'] = $url;
1477 $string = $this->typoLink($string, $conf['linkParams.']);
1480 $string = $this->stdWrap($string, $conf['stdWrap.']);
1482 $content = $a1 . $string . $a2;
1490 * Returns content of a file. If it's an image the content of the file is not returned but rather an image tag is.
1492 * @param string The filename, being a TypoScript resource data type
1493 * @param string Additional parameters (attributes). Default is empty alt and title tags.
1494 * @return string If jpg,gif,jpeg,png: returns image_tag with picture in. If html,txt: returns content string
1497 function fileResource($fName, $addParams = 'alt="" title=""') {
1498 $incFile = $GLOBALS['TSFE']->tmpl
->getFileName($fName);
1500 $fileinfo = t3lib_div
::split_fileref($incFile);
1501 if (t3lib_div
::inList('jpg,gif,jpeg,png', $fileinfo['fileext'])) {
1502 $imgFile = $incFile;
1503 $imgInfo = @getImageSize
($imgFile);
1504 return '<img src="' . $GLOBALS['TSFE']->absRefPrefix
. $imgFile .
1505 '" width="' . $imgInfo[0] . '" height="' . $imgInfo[1] . '"' .
1506 $this->getBorderAttr(' border="0"') . ' ' . $addParams . ' />';
1507 } elseif (filesize($incFile) < 1024 * 1024) {
1508 return $GLOBALS['TSFE']->tmpl
->fileContent($incFile);
1514 * Sets the SYS_LASTCHANGED timestamp if input timestamp is larger than current value.
1515 * The SYS_LASTCHANGED timestamp can be used by various caching/indexing applications to determine if the page has new content.
1516 * Therefore you should call this function with the last-changed timestamp of any element you display.
1518 * @param integer Unix timestamp (number of seconds since 1970)
1520 * @see tslib_fe::setSysLastChanged()
1522 function lastChanged($tstamp) {
1523 $tstamp = intval($tstamp);
1524 if ($tstamp > intval($GLOBALS['TSFE']->register
['SYS_LASTCHANGED'])) {
1525 $GLOBALS['TSFE']->register
['SYS_LASTCHANGED'] = $tstamp;
1530 * Wraps the input string by the $wrap value and implements the "linkWrap" data type as well.
1531 * 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.
1533 * @param string Input string
1534 * @param string A string where the first two parts separated by "|" (vertical line) will be wrapped around the input string
1535 * @return string Wrapped output string
1536 * @see wrap(), cImage(), FILE()
1537 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=282&cHash=831a95115d
1539 function linkWrap($content, $wrap) {
1540 $wrapArr = explode('|', $wrap);
1541 if (preg_match('/\{([0-9]*)\}/', $wrapArr[0], $reg)) {
1542 if ($uid = $GLOBALS['TSFE']->tmpl
->rootLine
[$reg[1]]['uid']) {
1543 $wrapArr[0] = str_replace($reg[0], $uid, $wrapArr[0]);
1546 return trim($wrapArr[0]) . $content . trim($wrapArr[1]);
1550 * An abstraction method which creates an alt or title parameter for an HTML img, applet, area or input element and the FILE content element.
1551 * From the $conf array it implements the properties "altText", "titleText" and "longdescURL"
1553 * @param array TypoScript configuration properties
1554 * @param boolean If set, the longdesc attribute will be generated - must only be used for img elements!
1555 * @return string Parameter string containing alt and title parameters (if any)
1556 * @see IMGTEXT(), FILE(), FORM(), cImage(), filelink()
1558 function getAltParam($conf, $longDesc = TRUE
) {
1559 $altText = trim($this->stdWrap($conf['altText'], $conf['altText.']));
1560 $titleText = trim($this->stdWrap($conf['titleText'], $conf['titleText.']));
1561 $longDesc = trim($this->stdWrap($conf['longdescURL'], $conf['longdescURL.']));
1564 $altParam = ' alt="' . htmlspecialchars($altText) . '"';
1567 $emptyTitleHandling = 'useAlt';
1568 if ($conf['emptyTitleHandling']) {
1569 // choices: 'keepEmpty' | 'useAlt' | 'removeAttr'
1570 $emptyTitleHandling = $conf['emptyTitleHandling'];
1572 if ($titleText ||
$emptyTitleHandling == 'keepEmpty') {
1573 $altParam .= ' title="' . htmlspecialchars($titleText) . '"';
1574 } elseif (!$titleText && $emptyTitleHandling == 'useAlt') {
1575 $altParam .= ' title="' . htmlspecialchars($altText) . '"';
1580 $altParam .= ' longdesc="' . htmlspecialchars(strip_tags($longDesc)) . '"';
1587 * Removes forbidden characters and spaces from name/id attributes in the form tag and formfields
1589 * @param string Input string
1590 * @return string the cleaned string
1593 function cleanFormName($name) {
1594 // turn data[x][y] into data:x:y:
1595 $name = preg_replace('/\[|\]\[?/', ':', trim($name));
1596 // remove illegal chars like _
1597 return preg_replace('#[^:a-zA-Z0-9]#', '', $name);
1601 * An abstraction method to add parameters to an A tag.
1602 * Uses the ATagParams property.
1604 * @param array TypoScript configuration properties
1605 * @param boolean If set, will add the global config.ATagParams to the link
1606 * @return string String containing the parameters to the A tag (if non empty, with a leading space)
1607 * @see IMGTEXT(), filelink(), makelinks(), typolink()
1609 function getATagParams($conf, $addGlobal = 1) {
1611 if ($conf['ATagParams.']) {
1612 $aTagParams = ' ' . $this->stdWrap($conf['ATagParams'], $conf['ATagParams.']);
1613 } elseif ($conf['ATagParams']) {
1614 $aTagParams = ' ' . $conf['ATagParams'];
1617 $aTagParams = ' ' . trim($GLOBALS['TSFE']->ATagParams
. $aTagParams);
1623 * All extension links should ask this function for additional properties to their tags.
1624 * Designed to add for instance an "onclick" property for site tracking systems.
1626 * @param string URL of the website
1627 * @return string the additional tag properties
1629 function extLinkATagParams($URL, $TYPE) {
1632 if ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['extLinkATagParamsHandler']) {
1633 $extLinkATagParamsHandler = t3lib_div
::getUserObj(
1634 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['extLinkATagParamsHandler']
1637 if (method_exists($extLinkATagParamsHandler, 'main')) {
1638 $out .= trim($extLinkATagParamsHandler->main($URL, $TYPE, $this));
1642 return trim($out) ?
' ' . trim($out) : '';
1647 /***********************************************
1649 * HTML template processing functions
1651 ***********************************************/
1654 * Returns a subpart from the input content stream.
1655 * A subpart is a part of the input stream which is encapsulated in a
1656 * string matching the input string, $marker. If this string is found
1657 * inside of HTML comment tags the start/end points of the content block
1658 * returned will be that right outside that comment block.
1659 * Example: The contennt string is
1660 * "Hello <!--###sub1### begin--> World. How are <!--###sub1### end--> you?"
1661 * If $marker is "###sub1###" then the content returned is
1662 * " World. How are ". The input content string could just as well have
1663 * been "Hello ###sub1### World. How are ###sub1### you?" and the result
1665 * Wrapper for t3lib_parsehtml::getSubpart which behaves identical
1667 * @param string The content stream, typically HTML template content.
1668 * @param string The marker string, typically on the form "###[the marker string]###"
1669 * @return string The subpart found, if found.
1670 * @see substituteSubpart(), t3lib_parsehtml::getSubpart()
1672 public function getSubpart($content, $marker) {
1673 return t3lib_parsehtml
::getSubpart($content, $marker);
1677 * Substitute subpart in input template stream.
1678 * This function substitutes a subpart in $content with the content of
1680 * Wrapper for t3lib_parsehtml::substituteSubpart which behaves identical
1682 * @param string The content stream, typically HTML template content.
1683 * @param string The marker string, typically on the form "###[the marker string]###"
1684 * @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.
1685 * @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!
1686 * @return string The processed HTML content string.
1687 * @see getSubpart(), t3lib_parsehtml::substituteSubpart()
1689 public function substituteSubpart($content, $marker, $subpartContent, $recursive = 1) {
1690 return t3lib_parsehtml
::substituteSubpart($content, $marker, $subpartContent, $recursive);
1694 * Substitues multiple subparts at once
1696 * @param string The content stream, typically HTML template content.
1697 * @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.
1698 * @return string The processed HTML content string.
1700 public function substituteSubpartArray($content, array $subpartsContent) {
1701 return t3lib_parsehtml
::substituteSubpartArray($content, $subpartsContent);
1705 * Substitutes a marker string in the input content
1706 * (by a simple str_replace())
1708 * @param string The content stream, typically HTML template content.
1709 * @param string The marker string, typically on the form "###[the marker string]###"
1710 * @param mixed The content to insert instead of the marker string found.
1711 * @return string The processed HTML content string.
1712 * @see substituteSubpart()
1714 public function substituteMarker($content, $marker, $markContent) {
1715 return t3lib_parsehtml
::substituteMarker($content, $marker, $markContent);
1719 * Multi substitution function with caching.
1721 * This function should be a one-stop substitution function for working
1722 * with HTML-template. It does not substitute by str_replace but by
1723 * splitting. This secures that the value inserted does not themselves
1724 * contain markers or subparts.
1726 * Note that the "caching" won't cache the content of the substition,
1727 * but only the splitting of the template in various parts. So if you
1728 * want only one cache-entry per template, make sure you always pass the
1729 * exact same set of marker/subpart keys. Else you will be flooding the
1730 * users cache table.
1732 * This function takes three kinds of substitutions in one:
1733 * $markContentArray is a regular marker-array where the 'keys' are
1734 * substituted in $content with their values
1736 * $subpartContentArray works exactly like markContentArray only is whole
1737 * subparts substituted and not only a single marker.
1739 * $wrappedSubpartContentArray is an array of arrays with 0/1 keys where
1740 * the subparts pointed to by the main key is wrapped with the 0/1 value
1743 * @param string The content stream, typically HTML template content.
1744 * @param array Regular marker-array where the 'keys' are substituted in $content with their values
1745 * @param array Exactly like markContentArray only is whole subparts substituted and not only a single marker.
1746 * @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.
1747 * @return string The output content stream
1748 * @see substituteSubpart(), substituteMarker(), substituteMarkerInObject(), TEMPLATE()
1750 public function substituteMarkerArrayCached($content, array $markContentArray = NULL
, array $subpartContentArray = NULL
, array $wrappedSubpartContentArray = NULL
) {
1751 $GLOBALS['TT']->push('substituteMarkerArrayCached');
1753 // If not arrays then set them
1754 if (is_null($markContentArray))
1755 $markContentArray = array(); // Plain markers
1756 if (is_null($subpartContentArray))
1757 $subpartContentArray = array(); // Subparts being directly substituted
1758 if (is_null($wrappedSubpartContentArray))
1759 $wrappedSubpartContentArray = array(); // Subparts being wrapped
1760 // Finding keys and check hash:
1761 $sPkeys = array_keys($subpartContentArray);
1762 $wPkeys = array_keys($wrappedSubpartContentArray);
1763 $aKeys = array_merge(array_keys($markContentArray), $sPkeys, $wPkeys);
1764 if (!count($aKeys)) {
1765 $GLOBALS['TT']->pull();
1769 $storeKey = md5('substituteMarkerArrayCached_storeKey:' . serialize(array(
1772 if ($this->substMarkerCache
[$storeKey]) {
1773 $storeArr = $this->substMarkerCache
[$storeKey];
1774 $GLOBALS['TT']->setTSlogMessage('Cached', 0);
1776 $storeArrDat = $GLOBALS['TSFE']->sys_page
->getHash($storeKey);
1777 if (!isset($storeArrDat)) {
1778 // Initialize storeArr
1779 $storeArr = array();
1781 // Finding subparts and substituting them with the subpart as a marker
1782 foreach ($sPkeys as $sPK) {
1783 $content = $this->substituteSubpart($content, $sPK, $sPK);
1786 // Finding subparts and wrapping them with markers
1787 foreach ($wPkeys as $wPK) {
1788 $content = $this->substituteSubpart($content, $wPK, array(
1793 // traverse keys and quote them for reg ex.
1794 foreach ($aKeys as $tK => $tV) {
1795 $aKeys[$tK] = preg_quote($tV, '/');
1797 $regex = '/' . implode('|', $aKeys) . '/';
1799 $storeArr['c'] = preg_split($regex, $content);
1800 preg_match_all($regex, $content, $keyList);
1801 $storeArr['k'] = $keyList[0];
1803 $this->substMarkerCache
[$storeKey] = $storeArr;
1805 // Storing the cached data:
1806 $GLOBALS['TSFE']->sys_page
->storeHash($storeKey, serialize($storeArr), 'substMarkArrayCached');
1808 $GLOBALS['TT']->setTSlogMessage('Parsing', 0);
1811 $storeArr = unserialize($storeArrDat);
1813 $this->substMarkerCache
[$storeKey] = $storeArr;
1814 $GLOBALS['TT']->setTSlogMessage('Cached from DB', 0);
1818 // Substitution/Merging:
1819 // Merging content types together, resetting
1820 $valueArr = array_merge($markContentArray, $subpartContentArray, $wrappedSubpartContentArray);
1822 $wSCA_reg = array();
1824 // traversing the keyList array and merging the static and dynamic content
1825 foreach ($storeArr['k'] as $n => $keyN) {
1826 $content .= $storeArr['c'][$n];
1827 if (!is_array($valueArr[$keyN])) {
1828 $content .= $valueArr[$keyN];
1830 $content .= $valueArr[$keyN][(intval($wSCA_reg[$keyN]) %
2)];
1834 $content .= $storeArr['c'][count($storeArr['k'])];
1836 $GLOBALS['TT']->pull();
1841 * Traverses the input $markContentArray array and for each key the marker
1842 * by the same name (possibly wrapped and in upper case) will be
1843 * substituted with the keys value in the array.
1845 * This is very useful if you have a data-record to substitute in some
1846 * content. In particular when you use the $wrap and $uppercase values to
1847 * pre-process the markers. Eg. a key name like "myfield" could effectively
1848 * be represented by the marker "###MYFIELD###" if the wrap value
1849 * was "###|###" and the $uppercase boolean TRUE.
1851 * @param string The content stream, typically HTML template content.
1852 * @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.
1853 * @param string A wrap value - [part 1] | [part 2] - for the markers before substitution
1854 * @param boolean If set, all marker string substitution is done with upper-case markers.
1855 * @param boolean If set, all unused marker are deleted.
1856 * @return string The processed output stream
1857 * @see substituteMarker(), substituteMarkerInObject(), TEMPLATE()
1859 public function substituteMarkerArray($content, array $markContentArray, $wrap = '', $uppercase = FALSE
, $deleteUnused = FALSE
) {
1860 return t3lib_parsehtml
::substituteMarkerArray($content, $markContentArray, $wrap, $uppercase, $deleteUnused);
1864 * Substitute marker array in an array of values
1866 * @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)
1867 * @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.
1868 * @return mixed The processed input variable.
1869 * @see substituteMarker()
1871 public function substituteMarkerInObject(&$tree, array $markContentArray) {
1872 if (is_array($tree)) {
1873 foreach ($tree as $key => $value) {
1874 $this->substituteMarkerInObject($tree[$key], $markContentArray);
1877 $tree = $this->substituteMarkerArray($tree, $markContentArray);
1884 * Adds elements to the input $markContentArray based on the values from
1885 * the fields from $fieldList found in $row
1887 * @param array array with key/values being marker-strings/substitution values.
1888 * @param array An array with keys found in the $fieldList (typically a record) which values should be moved to the $markContentArray
1889 * @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)
1890 * @param boolean If set, all values added to $markContentArray will be nl2br()'ed
1891 * @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 "###"
1892 * @param boolean If set, all values are passed through htmlspecialchars() - RECOMMENDED to avoid most obvious XSS and maintain XHTML compliance.
1893 * @return array The modified $markContentArray
1895 public function fillInMarkerArray(array $markContentArray, array $row, $fieldList = '', $nl2br = TRUE
, $prefix = 'FIELD_', $HSC = FALSE
) {
1897 $fArr = t3lib_div
::trimExplode(',', $fieldList, 1);
1898 foreach ($fArr as $field) {
1899 $markContentArray['###' . $prefix . $field . '###'] = $nl2br ?
nl2br($row[$field]) : $row[$field];
1902 if (is_array($row)) {
1903 foreach ($row as $field => $value) {
1904 if (!t3lib_div
::testInt($field)) {
1906 $value = htmlspecialchars($value);
1909 $markContentArray['###' . $prefix . $field . '###'] = $nl2br ?
nl2br($value) : $value;
1915 return $markContentArray;
1918 /***********************************************
1920 * "stdWrap" + sub functions
1922 ***********************************************/
1925 * The "stdWrap" function. This is the implementation of what is known as "stdWrap properties" in TypoScript.
1926 * Basically "stdWrap" performs some processing of a value based on properties in the input $conf array(holding the TypoScript "stdWrap properties")
1927 * 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.
1929 * If $this->alternativeData is an array it's used instead of the $this->data array in ->getData
1931 * @param string Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
1932 * @param array TypoScript "stdWrap properties".
1933 * @return string The processed input value
1935 public function stdWrap($content = '', $conf = array()) {
1936 if (count($this->stdWrapHookObjects
)) {
1937 foreach ($this->stdWrapHookObjects
as $hookObject) {
1938 if (is_callable(array($hookObject, 'stdWrapPreProcess'))) {
1939 $conf['stdWrapPreProcess'] = 1;
1942 if (is_callable(array($hookObject, 'stdWrapOverride'))) {
1943 $conf['stdWrapOverride'] = 1;
1946 if (is_callable(array($hookObject, 'stdWrapProcess'))) {
1947 $conf['stdWrapProcess'] = 1;
1950 if (is_callable(array($hookObject, 'stdWrapPostProcess'))) {
1951 $conf['stdWrapPostProcess'] = 1;
1956 if (is_array($conf) && count($conf)) {
1957 // check, which of the available stdWrap functions is needed for the current conf Array
1958 // and keep only those but still in the same order
1959 $sortedConf = array_intersect_key($this->stdWrapOrder
, $conf);
1960 // functions types that should not make use of nested stdWrap function calls to avoid conflicts with internal TypoScript used by these functions
1961 $stdWrapDisabledFunctionTypes = 'cObject,functionName,stdWrap';
1962 // additional Array to check whether a function has already been executed
1963 $isExecuted = array();
1964 // additional switch to make sure 'required', 'if' and 'fieldRequired'
1965 // will still stop rendering immediately in case they return false
1967 $this->stdWrapRecursionLevel++
;
1968 $this->stopRendering
[$this->stdWrapRecursionLevel
] = false
;
1970 // execute each funtion in the predefined order
1971 foreach ($sortedConf as $stdWrapName => $functionType) {
1972 // eliminate the second key of a pair 'key'|'key.' to make sure functions get called only once and check if rendering has been stopped
1973 if (!$isExecuted[$stdWrapName] &&
1974 !$this->stopRendering
[$this->stdWrapRecursionLevel
]) {
1975 $functionName = rtrim($stdWrapName, '.');
1976 $functionProperties = $functionName . '.';
1977 // if there is any code one the next level, check if it contains "official" stdWrap functions
1978 // if yes, execute them first - will make each function stdWrap aware
1979 // so additional stdWrap calls within the functions can be removed, since the result will be the same
1980 // exception: the recursive stdWrap function and cObject will still be using their own stdWrap call, since it modifies the content and not a property
1981 if (count($conf[$functionProperties]) &&
1982 !t3lib_div
::inList($stdWrapDisabledFunctionTypes, $functionType)) {
1983 if (array_intersect_key($this->stdWrapOrder
, $conf[$functionProperties])) {
1984 $conf[$functionName] = $this->stdWrap($conf[$functionName], $conf[$functionProperties]);
1987 // get just that part of $conf that is needed for the particular function
1988 $singleConf = array(
1989 $functionName => $conf[$functionName],
1990 $functionProperties => $conf[$functionProperties]
1993 // in this special case 'spaceBefore' and 'spaceAfter' need additional stuff from 'space.''
1994 if ($functionName == 'spaceBefore' ||
$functionName == 'spaceAfter') {
1995 $singleConf['space.'] = $conf['space.'];
1998 // hand over the whole $conf array to the stdWrapHookObjects
1999 if ($conf[$functionName] == 'stdWrapHookObject') {
2000 $singleConf = $conf;
2002 // check if key is still containing something, since it might have been changed by next level stdWrap before
2003 if ((isset($conf[$functionName]) ||
$conf[$functionProperties]) &&
2004 !($functionType == 'boolean' && $conf[$functionName] === '0')) {
2005 //add both keys - with and without the dot - to the set of executed functions
2006 $isExecuted[$functionName] = true
;
2007 $isExecuted[$functionProperties] = true
;
2008 // call the function with the prefix stdWrap_ to make sure nobody can execute functions just by adding their name to the TS Array
2009 $functionName = 'stdWrap_' . $functionName;
2010 $content = $this->$functionName(
2018 unset($this->stopRendering
[$this->stdWrapRecursionLevel
]);
2019 $this->stdWrapRecursionLevel
--;
2026 * stdWrap pre process hook
2027 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2028 * this hook will execute functions before any other stdWrap function can modify anything
2030 * @param string Input value undergoing processing in these functions.
2031 * @param array All stdWrap properties, not just the ones for a particular function.
2032 * @return string The processed input value
2034 public function stdWrap_stdWrapPreProcess($content = '', $conf = array()) {
2035 foreach ($this->stdWrapHookObjects
as $hookObject) {
2036 $content = $hookObject->stdWrapPreProcess($content, $conf, $this);
2042 * setContentToCurrent
2043 * actually it just does the contrary: Sets the value of 'current' based on current content
2045 * @param string Input value undergoing processing in this function.
2046 * @param array stdWrap properties for setContentToCurrent.
2047 * @return string The processed input value
2049 public function stdWrap_setContentToCurrent($content = '', $conf = array()) {
2050 $this->data
[$this->currentValKey
] = $content;
2055 * Sets the value of 'current' based on the outcome of stdWrap operations
2057 * @param string Input value undergoing processing in this function.
2058 * @param array stdWrap properties for setCurrent.
2059 * @return string The processed input value
2061 public function stdWrap_setCurrent($content = '', $conf = array()) {
2062 $this->data
[$this->currentValKey
] = $conf['setCurrent'];
2067 * Translates content based on the language currently used by the FE
2069 * @param string Input value undergoing processing in this function.
2070 * @param array stdWrap properties for lang.
2071 * @return string The processed input value
2073 public function stdWrap_lang($content = '', $conf = array()) {
2074 if (isset($conf['lang.']) && $GLOBALS['TSFE']->config
['config']['language'] && isset($conf['lang.'][$GLOBALS['TSFE']->config
['config']['language']])) {
2075 $content = $conf['lang.'][$GLOBALS['TSFE']->config
['config']['language']];
2082 * Gets content from different sources based on getText functions, makes use of alternativeData, when set
2084 * @param string Input value undergoing processing in this function.
2085 * @param array stdWrap properties for data.
2086 * @return string The processed input value
2088 public function stdWrap_data($content = '', $conf = array()) {
2089 $content = $this->getData($conf['data'], is_array($this->alternativeData
) ?
$this->alternativeData
: $this->data
);
2090 $this->alternativeData
= ''; // This must be unset directly after
2096 * Gets content from a DB field
2098 * @param string Input value undergoing processing in this function.
2099 * @param array stdWrap properties for field.
2100 * @return string The processed input value
2102 public function stdWrap_field($content = '', $conf = array()) {
2103 $content = $this->getFieldVal($conf['field']);
2109 * Gets content that has been perviously set as 'current'
2110 * Can be set via setContentToCurrent or setCurrent or will be set automatically i.e. inside the split function
2112 * @param string Input value undergoing processing in this function.
2113 * @param array stdWrap properties for current.
2114 * @return string The processed input value
2116 public function stdWrap_current($content = '', $conf = array()) {
2117 $content = $this->data
[$this->currentValKey
];
2123 * Will replace the content with the value of a any official TypoScript cObject
2124 * like TEXT, COA, HMENU
2126 * @param string Input value undergoing processing in this function.
2127 * @param array stdWrap properties for cObject.
2128 * @return string The processed input value
2130 public function stdWrap_cObject($content = '', $conf = array()) {
2131 $content = $this->cObjGetSingle($conf['cObject'], $conf['cObject.'], '/stdWrap/.cObject');
2137 * Counts the number of returned records of a DB operation
2138 * makes use of select internally
2140 * @param string Input value undergoing processing in this function.
2141 * @param array stdWrap properties for numRows.
2142 * @return string The processed input value
2144 public function stdWrap_numRows($content = '', $conf = array()) {
2145 $content = $this->numRows($conf['numRows.']);
2151 * Will create a list of files based on some additional parameters
2153 * @param string Input value undergoing processing in this function.
2154 * @param array stdWrap properties for filelist.
2155 * @return string The processed input value
2157 public function stdWrap_filelist($content = '', $conf = array()) {
2158 $content = $this->filelist($conf['filelist']);
2164 * Will execute a user public function before the content will be modified by any other stdWrap function
2166 * @param string Input value undergoing processing in this function.
2167 * @param array stdWrap properties for preUserFunc.
2168 * @return string The processed input value
2170 public function stdWrap_preUserFunc($content = '', $conf = array()) {
2171 $content = $this->callUserFunction($conf['preUserFunc'], $conf['preUserFunc.'], $content);
2176 * stdWrap override hook
2177 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2178 * this hook will execute functions on existing content but still before the content gets modified or replaced
2180 * @param string Input value undergoing processing in these functions.
2181 * @param array All stdWrap properties, not just the ones for a particular function.
2182 * @return string The processed input value
2184 public function stdWrap_stdWrapOverride($content = '', $conf = array()) {
2185 foreach ($this->stdWrapHookObjects
as $hookObject) {
2186 $content = $hookObject->stdWrapOverride($content, $conf, $this);
2193 * Will override the current value of content with its own value'
2195 * @param string Input value undergoing processing in this function.
2196 * @param array stdWrap properties for override.
2197 * @return string The processed input value
2199 public function stdWrap_override($content = '', $conf = array()) {
2200 if (trim($conf['override'])) {
2201 $content = $conf['override'];
2208 * Gets a value off a CSV list before the following ifEmpty check
2209 * 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
2211 * @param string Input value undergoing processing in this function.
2212 * @param array stdWrap properties for preIfEmptyListNum.
2213 * @return string The processed input value
2215 public function stdWrap_preIfEmptyListNum($content = '', $conf = array()) {
2216 $content = $this->listNum($content, $conf['preIfEmptyListNum'], $conf['preIfEmptyListNum.']['splitChar']);
2222 * Will set content to a replacement value in case the trimmed value of content returns false
2223 * 0 (zero) will be replaced as well
2225 * @param string Input value undergoing processing in this function.
2226 * @param array stdWrap properties for ifEmpty.
2227 * @return string The processed input value
2229 public function stdWrap_ifEmpty($content = '', $conf = array()) {
2230 if (!trim($content)) {
2231 $content = $conf['ifEmpty'];
2238 * Will set content to a replacement value in case the trimmed value of content has no length
2239 * 0 (zero) will not be replaced
2241 * @param string Input value undergoing processing in this function.
2242 * @param array stdWrap properties for ifBlank.
2243 * @return string The processed input value
2245 public function stdWrap_ifBlank($content = '', $conf = array()) {
2246 if (!strlen(trim($content))) {
2247 $content = $conf['ifBlank'];
2254 * Gets a value off a CSV list after ifEmpty check
2255 * Might return an empty value in case the CSV does not contain a value at the position given by listNum
2256 * Use preIfEmptyListNum to avoid that behaviour
2258 * @param string Input value undergoing processing in this function.
2259 * @param array stdWrap properties for listNum.
2260 * @return string The processed input value
2262 public function stdWrap_listNum($content = '', $conf = array()) {
2263 $content = $this->listNum($content, $conf['listNum'], $conf['listNum.']['splitChar']);
2269 * Cuts off any whitespace at the beginning and the end of the content
2271 * @param string Input value undergoing processing in this function.
2272 * @param array stdWrap properties for trim.
2273 * @return string The processed input value
2275 public function stdWrap_trim($content = '', $conf = array()) {
2276 $content = trim($content);
2282 * A recursive call of the stdWrap function set
2283 * This enables the user to execute stdWrap functions in another than the predefined order
2284 * It modifies the content, not the property
2285 * while the new feature of chained stdWrap functions modifies the property and not the content
2287 * @param string Input value undergoing processing in this function.
2288 * @param array stdWrap properties for stdWrap.
2289 * @return string The processed input value
2291 public function stdWrap_stdWrap($content = '', $conf = array()) {
2292 $content = $this->stdWrap($content, $conf['stdWrap.']);
2297 * stdWrap process hook
2298 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2299 * this hook executes functions directly after the recursive stdWrap function call but still before the content gets modified
2301 * @param string Input value undergoing processing in these functions.
2302 * @param array All stdWrap properties, not just the ones for a particular function.
2303 * @return string The processed input value
2305 public function stdWrap_stdWrapProcess($content = '', $conf = array()) {
2306 foreach ($this->stdWrapHookObjects
as $hookObject) {
2307 $content = $hookObject->stdWrapProcess($content, $conf, $this);
2314 * Will immediately stop rendering and return an empty value
2315 * when there is no content at this point
2317 * @param string Input value undergoing processing in this function.
2318 * @param array stdWrap properties for required.
2319 * @return string The processed input value
2321 public function stdWrap_required($content = '', $conf = array()) {
2322 if ((string) $content == '') {
2324 $this->stopRendering
[$this->stdWrapRecursionLevel
] = TRUE
;
2331 * Will immediately stop rendering and return an empty value
2332 * when the result of the checks returns false
2334 * @param string Input value undergoing processing in this function.
2335 * @param array stdWrap properties for if.
2336 * @return string The processed input value
2338 public function stdWrap_if($content = '', $conf = array()) {
2339 if (!$this->checkIf($conf['if.'])) {
2341 $this->stopRendering
[$this->stdWrapRecursionLevel
] = TRUE
;
2348 * Will immediately stop rendering and return an empty value
2349 * when there is no content in the field given by fieldRequired
2351 * @param string Input value undergoing processing in this function.
2352 * @param array stdWrap properties for fieldRequired.
2353 * @return string The processed input value
2355 public function stdWrap_fieldRequired($content = '', $conf = array()) {
2356 if (!trim($this->data
[$conf['fieldRequired']])) {
2358 $this->stopRendering
[$this->stdWrapRecursionLevel
] = TRUE
;
2365 * Will convert the current chracter set of the content to the one given in csConv
2367 * @param string Input value undergoing processing in this function.
2368 * @param array stdWrap properties for csConv.
2369 * @return string The processed input value
2371 public function stdWrap_csConv($content = '', $conf = array()) {
2372 $content = $GLOBALS['TSFE']->csConv($content, $conf['csConv']);
2378 * Will parse the content based on functions given as stdWrap properties
2379 * Heavily used together with RTE based content
2381 * @param string Input value undergoing processing in this function.
2382 * @param array stdWrap properties for parseFunc.
2383 * @return string The processed input value
2385 public function stdWrap_parseFunc($content = '', $conf = array()) {
2386 $content = $this->parseFunc($content, $conf['parseFunc.'], $conf['parseFunc']);
2392 * Will parse HTML content based on functions given as stdWrap properties
2393 * Heavily used together with RTE based content
2395 * @param string Input value undergoing processing in this function.
2396 * @param array stdWrap properties for HTMLparser.
2397 * @return string The processed input value
2399 public function stdWrap_HTMLparser($content = '', $conf = array()) {
2400 if (is_array($conf['HTMLparser.'])) {
2401 $content = $this->HTMLparser_TSbridge($content, $conf['HTMLparser.']);
2408 * Will split the content by a given token and treat the results separately
2409 * Automatically fills 'current' with a single result
2411 * @param string Input value undergoing processing in this function.
2412 * @param array stdWrap properties for split.
2413 * @return string The processed input value
2415 public function stdWrap_split($content = '', $conf = array()) {
2416 $content = $this->splitObj($content, $conf['split.']);
2422 * Will use the content as a mathematical term and calculate the result
2423 * Can be set to 1 to just get a calculated value or 'intval' to get the integer of the result
2425 * @param string Input value undergoing processing in this function.
2426 * @param array stdWrap properties for prioriCalc.
2427 * @return string The processed input value
2429 public function stdWrap_prioriCalc($content = '', $conf = array()) {
2430 $content = t3lib_div
::calcParenthesis($content);
2431 if ($conf['prioriCalc'] == 'intval')
2432 $content = intval($content);
2438 * Will return a character based on its position within the current character set
2440 * @param string Input value undergoing processing in this function.
2441 * @param array stdWrap properties for char.
2442 * @return string The processed input value
2444 public function stdWrap_char($content = '', $conf = array()) {
2445 $content = chr(intval($conf['char']));
2451 * Will return an integer value of the current content
2453 * @param string Input value undergoing processing in this function.
2454 * @param array stdWrap properties for intval.
2455 * @return string The processed input value
2457 public function stdWrap_intval($content = '', $conf = array()) {
2458 $content = intval($content);
2464 * Will return a formatted number based on configuration given as stdWrap properties
2466 * @param string Input value undergoing processing in this function.
2467 * @param array stdWrap properties for numberFormat.
2468 * @return string The processed input value
2470 public function stdWrap_numberFormat($content = '', $conf = array()) {
2471 $content = $this->numberFormat($content, $conf['numberFormat.']);
2477 * Will return a formatted date based on configuration given according to PHP date/gmdate properties
2478 * Will return gmdate when the property GMT returns true
2480 * @param string Input value undergoing processing in this function.
2481 * @param array stdWrap properties for date.
2482 * @return string The processed input value
2484 public function stdWrap_date($content = '', $conf = array()) {
2485 $content = ($conf['date.']['GMT'] ?
gmdate($conf['date'], $content) : date($conf['date'], $content));
2491 * Will return a formatted date based on configuration given according to PHP strftime/gmstrftime properties
2492 * Will return gmstrftime when the property GMT returns true
2494 * @param string Input value undergoing processing in this function.
2495 * @param array stdWrap properties for strftime.
2496 * @return string The processed input value
2498 public function stdWrap_strftime($content = '', $conf = array()) {
2499 $content = ($conf['strftime.']['GMT'] ?
gmstrftime($conf['strftime'], $content) : strftime($conf['strftime'], $content));
2500 $tmp_charset = $conf['strftime.']['charset'] ?
$conf['strftime.']['charset'] : $GLOBALS['TSFE']->localeCharset
;
2502 $content = $GLOBALS['TSFE']->csConv($content, $tmp_charset);
2509 * Will return the age of a given timestamp based on configuration given by stdWrap properties
2511 * @param string Input value undergoing processing in this function.
2512 * @param array stdWrap properties for age.
2513 * @return string The processed input value
2515 public function stdWrap_age($content = '', $conf = array()) {
2516 $content = $this->calcAge($GLOBALS['EXEC_TIME'] - $content, $conf['age']);
2522 * Will transform the content to be upper or lower case only
2523 * Leaves HTML tags untouched
2525 * @param string Input value undergoing processing in this function.
2526 * @param array stdWrap properties for case.
2527 * @return string The processed input value
2529 public function stdWrap_case($content = '', $conf = array()) {
2530 $content = $this->HTMLcaseshift($content, $conf['case']);
2536 * Will return the size of a given number in Bytes *
2538 * @param string Input value undergoing processing in this function.
2539 * @param array stdWrap properties for bytes.
2540 * @return string The processed input value
2542 public function stdWrap_bytes($content = '', $conf = array()) {
2543 $content = t3lib_div
::formatSize($content, $conf['bytes.']['labels']);
2549 * Will return a substring based on position information given by stdWrap properties
2551 * @param string Input value undergoing processing in this function.
2552 * @param array stdWrap properties for substring.
2553 * @return string The processed input value
2555 public function stdWrap_substring($content = '', $conf = array()) {
2556 $content = $this->substring($content, $conf['substring']);
2562 * Removes HTML tags based on stdWrap properties
2564 * @param string Input value undergoing processing in this function.
2565 * @param array stdWrap properties for removeBadHTML.
2566 * @return string The processed input value
2568 public function stdWrap_removeBadHTML($content = '', $conf = array()) {
2569 $content = $this->removeBadHTML($content, $conf['removeBadHTML.']);
2575 * Crops content to a given size while leaving HTML tags untouched
2577 * @param string Input value undergoing processing in this function.
2578 * @param array stdWrap properties for cropHTML.
2579 * @return string The processed input value
2581 public function stdWrap_cropHTML($content = '', $conf = array()) {
2582 $content = $this->cropHTML($content, $conf['cropHTML']);
2588 * Copmletely removes HTML tags from content
2590 * @param string Input value undergoing processing in this function.
2591 * @param array stdWrap properties for stripHtml.
2592 * @return string The processed input value
2594 public function stdWrap_stripHtml($content = '', $conf = array()) {
2595 $content = strip_tags($content);
2601 * Crops content to a given size without caring abhout HTML tags
2603 * @param string Input value undergoing processing in this function.
2604 * @param array stdWrap properties for crop.
2605 * @return string The processed input value
2607 public function stdWrap_crop($content = '', $conf = array()) {
2608 $content = $this->crop($content, $conf['crop']);
2614 * Encodes content to be used within URLs
2616 * @param string Input value undergoing processing in this function.
2617 * @param array stdWrap properties for rawUrlEncode.
2618 * @return string The processed input value
2620 public function stdWrap_rawUrlEncode($content = '', $conf = array()) {
2621 $content = rawurlencode($content);
2627 * Transforms HTML tags to readable text by replacing special characters with their HTML entity
2628 * When preserveEntities returns true, existing entities will be left untouched
2630 * @param string Input value undergoing processing in this function.
2631 * @param array stdWrap properties for htmlSpecalChars.
2632 * @return string The processed input value
2634 public function stdWrap_htmlSpecialChars($content = '', $conf = array()) {
2635 $content = htmlSpecialChars($content);
2636 if ($conf['htmlSpecialChars.']['preserveEntities'])
2637 $content = t3lib_div
::deHSCentities($content);
2643 * Searches for double line breaks and replaces them with the given value
2645 * @param string Input value undergoing processing in this function.
2646 * @param array stdWrap properties for doubleBrTag.
2647 * @return string The processed input value
2649 public function stdWrap_doubleBrTag($content = '', $conf = array()) {
2650 $content = preg_replace("/\r?\n[\t ]*\r?\n/", $conf['doubleBrTag'], $content);
2656 * Searches for single line breaks and replaces them with a <br /> tag
2658 * @param string Input value undergoing processing in this function.
2659 * @param array stdWrap properties for br.
2660 * @return string The processed input value
2662 public function stdWrap_br($content = '', $conf = array()) {
2663 $content = nl2br($content);
2669 * Searches for single line feeds and replaces them with the given value
2671 * @param string Input value undergoing processing in this function.
2672 * @param array stdWrap properties for brTag.
2673 * @return string The processed input value
2675 public function stdWrap_brTag($content = '', $conf = array()) {
2676 $content = str_replace(LF
, $conf['brTag'], $content);
2682 * Modifies text blocks by searching for lines which are not surrounded by HTML tags yet
2683 * and wrapping them with values given by stdWrap properties
2685 * @param string Input value undergoing processing in this function.
2686 * @param array stdWrap properties for erncapsLines.
2687 * @return string The processed input value
2689 public function stdWrap_encapsLines($content = '', $conf = array()) {
2690 $content = $this->encaps_lineSplit($content, $conf['encapsLines.']);
2696 * Transforms content into a CSV list to be used i.e. as keywords within a meta tag
2698 * @param string Input value undergoing processing in this function.
2699 * @param array stdWrap properties for keywords.
2700 * @return string The processed input value
2702 public function stdWrap_keywords($content = '', $conf = array()) {
2703 $content = $this->keywords($content);
2709 * First of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2712 * @param string Input value undergoing processing in this function.
2713 * @param array stdWrap properties for innerWrap.
2714 * @return string The processed input value
2716 public function stdWrap_innerWrap($content = '', $conf = array()) {
2717 $content = $this->wrap($content, $conf['innerWrap']);
2723 * Second of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2726 * @param string Input value undergoing processing in this function.
2727 * @param array stdWrap properties for innerWrap2.
2728 * @return string The processed input value
2730 public function stdWrap_innerWrap2($content = '', $conf = array()) {
2731 $content = $this->wrap($content, $conf['innerWrap2']);
2737 * A wrap formerly used to apply font tags to format the content
2738 * Still used by lib.stdheader although real font tags are not state of the art anymore
2741 * @param string Input value undergoing processing in this function.
2742 * @param array stdWrap properties for fontTag.
2743 * @return string The processed input value
2745 public function stdWrap_fontTag($content = '', $conf = array()) {
2746 $content = $this->wrap($content, $conf['fontTag']);
2752 * Adds tag attributes to any content that is a tag
2754 * @param string Input value undergoing processing in this function.
2755 * @param array stdWrap properties for addParams.
2756 * @return string The processed input value
2758 public function stdWrap_addParams($content = '', $conf = array()) {
2759 $content = $this->addParams($content, $conf['addParams.']);
2765 * Wraps content in font tags
2768 * @param string Input value undergoing processing in this function.
2769 * @param array stdWrap properties for textStyle.
2770 * @return string The processed input value
2772 public function stdWrap_textStyle($content = '', $conf = array()) {
2773 $content = $this->textStyle($content, $conf['textStyle.']);
2779 * Wraps content with table tags
2782 * @param string Input value undergoing processing in this function.
2783 * @param array stdWrap properties for tableStyle.
2784 * @return string The processed input value
2786 public function stdWrap_tableStyle($content = '', $conf = array()) {
2787 $content = $this->tableStyle($content, $conf['tableStyle.']);
2793 * Used to make lists of links to files
2796 * @param string Input value undergoing processing in this function.
2797 * @param array stdWrap properties for filelink.
2798 * @return string The processed input value
2800 public function stdWrap_filelink($content = '', $conf = array()) {
2801 $content = $this->filelink($content, $conf['filelink.']);
2807 * A content object that is prepended to the current content but between the innerWraps and the rest of the wraps
2809 * @param string Input value undergoing processing in this function.
2810 * @param array stdWrap properties for preCObject.
2811 * @return string The processed input value
2813 public function stdWrap_preCObject($content = '', $conf = array()) {
2814 $content = $this->cObjGetSingle($conf['preCObject'], $conf['preCObject.'], '/stdWrap/.preCObject') . $content;
2820 * A content object that is appended to the current content but between the innerWraps and the rest of the wraps
2822 * @param string Input value undergoing processing in this function.
2823 * @param array stdWrap properties for postCObject.
2824 * @return string The processed input value
2826 public function stdWrap_postCObject($content = '', $conf = array()) {
2827 $content .= $this->cObjGetSingle($conf['postCObject'], $conf['postCObject.'], '/stdWrap/.postCObject');
2833 * Wraps content with a div container having the style attribute text-align set to the given value
2836 * @param string Input value undergoing processing in this function.
2837 * @param array stdWrap properties for wrapAlign.
2838 * @return string The processed input value
2840 public function stdWrap_wrapAlign($content = '', $conf = array()) {
2841 $wrapAlign = trim($conf['wrapAlign']);
2843 $content = $this->wrap($content, '<div style="text-align:' . $wrapAlign . ';">|</div>');
2850 * Wraps the content with a link tag
2851 * URLs and other attributes are created automatically by the values given in the stdWrap properties
2854 * @param string Input value undergoing processing in this function.
2855 * @param array stdWrap properties for typolink.
2856 * @return string The processed input value
2858 public function stdWrap_typolink($content = '', $conf = array()) {
2859 $content = $this->typolink($content, $conf['typolink.']);
2865 * Returns a list of options available for a given field in the DB which has to be of the type select
2867 * @param string Input value undergoing processing in this function.
2868 * @param array stdWrap properties for TCAselectItem.
2869 * @return string The processed input value
2871 public function stdWrap_TCAselectItem($content = '', $conf = array()) {
2872 if (is_array($conf['TCAselectItem.'])) {
2873 $content = $this->TCAlookup($content, $conf['TCAselectItem.']);
2880 * Will add space before the current content
2881 * 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 * @param string Input value undergoing processing in this function.
2884 * @param array stdWrap properties for spaceBefore and space.
2885 * @return string The processed input value
2887 public function stdWrap_spaceBefore($content = '', $conf = array()) {
2888 $content = $this->wrapSpace($content, trim($conf['spaceBefore']) . '|', $conf['space.']);
2894 * Will add space after the current content
2895 * 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 * @param string Input value undergoing processing in this function.
2898 * @param array stdWrap properties for spaceAfter and space.
2899 * @return string The processed input value
2901 public function stdWrap_spaceAfter($content = '', $conf = array()) {
2902 $content = $this->wrapSpace($content, '|' . trim($conf['spaceAfter']), $conf['space.']);
2908 * Will add space before or after the current content
2909 * 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
2912 * @param string Input value undergoing processing in this function.
2913 * @param array stdWrap properties for space.
2914 * @return string The processed input value
2916 public function stdWrap_space($content = '', $conf = array()) {
2917 $content = $this->wrapSpace($content, trim($conf['space']), $conf['space.']);
2923 * This is the "mother" of all wraps
2924 * Third of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2925 * Basically it will put additional content before and after the current content using a split character as a placeholder for the current content
2926 * The default split character is | but it can be replaced with other characters by the property splitChar
2927 * Any other wrap that does not have own splitChar settings will be using the default split char though
2929 * @param string Input value undergoing processing in this function.
2930 * @param array stdWrap properties for wrap.
2931 * @return string The processed input value
2933 public function stdWrap_wrap($content = '', $conf = array()) {
2934 $content = $this->wrap($content, $conf['wrap'], ($conf['wrap.']['splitChar'] ?
$conf['wrap.']['splitChar'] : '|'));
2940 * Fourth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2941 * The major difference to any other wrap is, that this one can make use of whitespace without trimming *
2943 * @param string Input value undergoing processing in this function.
2944 * @param array stdWrap properties for noTrimWrap.
2945 * @return string The processed input value
2947 public function stdWrap_noTrimWrap($content = '', $conf = array()) {
2948 $content = $this->noTrimWrap($content, $conf['noTrimWrap']);
2954 * Fifth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2955 * The default split character is | but it can be replaced with other characters by the property splitChar
2957 * @param string Input value undergoing processing in this function.
2958 * @param array stdWrap properties for wrap2.
2959 * @return string The processed input value
2961 public function stdWrap_wrap2($content = '', $conf = array()) {
2962 $content = $this->wrap($content, $conf['wrap2'], ($conf['wrap2.']['splitChar'] ?
$conf['wrap2.']['splitChar'] : '|'));
2968 * Sixth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2969 * 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
2971 * @param string Input value undergoing processing in this function.
2972 * @param array stdWrap properties for dataWrap.
2973 * @return string The processed input value
2975 public function stdWrap_dataWrap($content = '', $conf = array()) {
2976 $content = $this->dataWrap($content, $conf['dataWrap']);
2982 * A content object that will be prepended to the current content after most of the wraps have already been applied
2984 * @param string Input value undergoing processing in this function.
2985 * @param array stdWrap properties for prepend.
2986 * @return string The processed input value
2988 public function stdWrap_prepend($content = '', $conf = array()) {
2989 $content = $this->cObjGetSingle($conf['prepend'], $conf['prepend.'], '/stdWrap/.prepend') . $content;
2995 * A content object that will be appended to the current content after most of the wraps have already been applied
2997 * @param string Input value undergoing processing in this function.
2998 * @param array stdWrap properties for append.
2999 * @return string The processed input value
3001 public function stdWrap_append($content = '', $conf = array()) {
3002 $content .= $this->cObjGetSingle($conf['append'], $conf['append.'], '/stdWrap/.append');
3008 * Seventh of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
3009 * The default split character is | but it can be replaced with other characters by the property splitChar
3011 * @param string Input value undergoing processing in this function.
3012 * @param array stdWrap properties for wrap3.
3013 * @return string The processed input value
3015 public function stdWrap_wrap3($content = '', $conf = array()) {
3016 $content = $this->wrap($content, $conf['wrap3'], ($conf['wrap3.']['splitChar'] ?
$conf['wrap3.']['splitChar'] : '|'));
3022 * Eighth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
3024 * @param string Input value undergoing processing in this function.
3025 * @param array stdWrap properties for outerWrap.
3026 * @return string The processed input value
3028 public function stdWrap_outerWrap($content = '', $conf = array()) {
3029 $content = $this->wrap($content, $conf['outerWrap']);
3035 * Can fetch additional content the same way data does and replaces any occurence of {field:whatever} with this content
3037 * @param string Input value undergoing processing in this function.
3038 * @param array stdWrap properties for insertData.
3039 * @return string The processed input value
3041 public function stdWrap_insertData($content = '', $conf = array()) {
3042 $content = $this->insertData($content);
3048 * Creates a so called offset table around the content
3049 * Still here for historical reasons even not used too much nowadays
3051 * @param string Input value undergoing processing in this function.
3052 * @param array stdWrap properties for offsetWrap.
3053 * @return string The processed input value
3055 public function stdWrap_offsetWrap($content = '', $conf = array()) {
3056 $controlTable = t3lib_div
::makeInstance('tslib_tableOffset');
3057 if ($conf['offsetWrap.']['tableParams'] ||
$conf['offsetWrap.']['tableParams.']) {
3058 $controlTable->tableParams
= $this->stdWrap($conf['offsetWrap.']['tableParams'], $conf['offsetWrap.']['tableParams.']);
3060 if ($conf['offsetWrap.']['tdParams'] ||
$conf['offsetWrap.']['tdParams.']) {
3061 $controlTable->tdParams
= ' ' . $this->stdWrap($conf['offsetWrap.']['tdParams'], $conf['offsetWrap.']['tdParams.']);
3063 $content = $controlTable->start($content, $conf['offsetWrap']);
3064 if ($conf['offsetWrap.']['stdWrap.']) {
3065 $content = $this->stdWrap($content, $conf['offsetWrap.']['stdWrap.']);
3072 * Will execute a user function after the content has been modified by any other stdWrap function
3074 * @param string Input value undergoing processing in this function.
3075 * @param array stdWrap properties for postUserFunc.
3076 * @return string The processed input value
3078 public function stdWrap_postUserFunc($content = '', $conf = array()) {
3079 $content = $this->callUserFunction($conf['postUserFunc'], $conf['postUserFunc.'], $content);
3085 * Will execute a user function after the content has been created and each time it is fetched from Cache
3086 * The result of this function itself will not be cached
3088 * @param string Input value undergoing processing in this function.
3089 * @param array stdWrap properties for postUserFuncInt.
3090 * @return string The processed input value
3092 public function stdWrap_postUserFuncInt($content = '', $conf = array()) {
3093 $substKey = 'INT_SCRIPT.' . $GLOBALS['TSFE']->uniqueHash();
3094 $GLOBALS['TSFE']->config
['INTincScript'][$substKey] = array(
3095 'content' => $content, 'postUserFunc' => $conf['postUserFuncInt'], 'conf' => $conf['postUserFuncInt.'], 'type' => 'POSTUSERFUNC', 'cObj' => serialize($this)
3097 $content = '<!--' . $substKey . '-->';
3103 * Will add HTML comments to the content to make it easier to identify certain content elements within the HTML output later on
3105 * @param string Input value undergoing processing in this function.
3106 * @param array stdWrap properties for prefixComment.
3107 * @return string The processed input value
3109 public function stdWrap_prefixComment($content = '', $conf = array()) {
3110 if (!$GLOBALS['TSFE']->config
['config']['disablePrefixComment']) {
3111 $content = $this->prefixComment($conf['prefixComment'], $conf['prefixComment.'], $content);
3118 * Will render icons for frontend editing as long as there is a BE user logged in
3120 * @param string Input value undergoing processing in this function.
3121 * @param array stdWrap properties for editIcons.
3122 * @return string The processed input value
3124 public function stdWrap_editIcons($content = '', $conf = array()) {
3125 if ($GLOBALS['TSFE']->beUserLogin
) {
3126 $content = $this->editIcons($content, $conf['editIcons'], $conf['editIcons.']);
3133 * Will render the edit panel for frontend editing as long as there is a BE user logged in
3135 * @param string Input value undergoing processing in this function.
3136 * @param array stdWrap properties for editPanel.
3137 * @return string The processed input value
3139 public function stdWrap_editPanel($content = '', $conf = array()) {
3140 if ($GLOBALS['TSFE']->beUserLogin
) {
3141 $content = $this->editPanel($content, $conf['editPanel.']);
3147 * stdWrap post process hook
3148 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
3149 * this hook executes functions at after the content has been modified by the rest of the stdWrap functions but still before debugging
3151 * @param string Input value undergoing processing in these functions.
3152 * @param array All stdWrap properties, not just the ones for a particular function.
3153 * @return string The processed input value
3155 public function stdWrap_stdWrapPostProcess($content = '', $conf = array()) {
3156 foreach ($this->stdWrapHookObjects
as $hookObject) {
3157 $content = $hookObject->stdWrapPostProcess($content, $conf, $this);
3164 * Will output the content as readable HTML code
3166 * @param string Input value undergoing processing in this function.
3167 * @param array stdWrap properties for debug.
3168 * @return string The processed input value
3170 public function stdWrap_debug($content = '', $conf = array()) {
3171 $content = '<pre>' . htmlspecialchars($content) . '</pre>';
3177 * Will output the content in a debug table
3179 * @param string Input value undergoing processing in this function.
3180 * @param array stdWrap properties for debugFunc.
3181 * @return string The processed input value