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 $classData . ' 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 $classData . ' 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 $conf['scriptSuffix'] = $ext;
1131 return $this->getContentObject('PHP_SCRIPT_INT')->render($conf);
1133 return $this->getContentObject('PHP_SCRIPT')->render($conf);
1138 * Rendering the cObject, TEMPLATE
1140 * @param array array of TypoScript properties
1141 * @return string Output
1142 * @see substituteMarkerArrayCached()
1144 function TEMPLATE($conf) {
1145 return $this->getContentObject('TEMPLATE')->render($conf);
1149 * Rendering the cObject, FLUIDTEMPLATE
1151 * @param array array of TypoScript properties
1152 * @return string the HTML output
1153 * @author Steffen Ritter <info@steffen-ritter.net>
1154 * @author Benjamin Mack <benni@typo3.org>
1156 protected function FLUIDTEMPLATE(array $conf) {
1157 return $this->getContentObject('FLUIDTEMPLATE')->render($conf);
1161 * Rendering the cObject, MULTIMEDIA
1163 * @param array array of TypoScript properties
1164 * @return string Output
1166 function MULTIMEDIA($conf) {
1167 return $this->getContentObject('MULTIMEDIA')->render($conf);
1171 * Rendering the cObject, MEDIA
1173 * @param array array of TypoScript properties
1174 * @return string Output
1176 public function MEDIA($conf) {
1177 return $this->getContentObject('MEDIA')->render($conf);
1181 * Rendering the cObject, SWFOBJECT
1183 * @param array array of TypoScript properties
1184 * @return string Output
1186 public function SWFOBJECT($conf) {
1187 return $this->getContentObject('SWFOBJECT')->render($conf);
1191 * Rendering the cObject, QTOBJECT
1193 * @param array array of TypoScript properties
1194 * @return string Output
1196 public function QTOBJECT($conf) {
1197 return $this->getContentObject('QTOBJECT')->render($conf);
1201 * Rendering the cObject, SVG
1203 * @param array array of TypoScript properties
1204 * @return string Output
1206 public function SVG($conf) {
1207 return $this->getContentObject('SVG')->render($conf);
1210 /************************************
1212 * Various helper functions for content objects:
1214 ************************************/
1218 * Converts a given config in Flexform to a conf-array
1219 * @param string Flexform data
1220 * @param array array to write the data into, by reference
1221 * @param boolean is set if called recursive. Don't call function with this parameter, it's used inside the function only
1225 public function readFlexformIntoConf($flexData, &$conf, $recursive = FALSE) {
1226 if ($recursive === FALSE) {
1227 $flexData = t3lib_div
::xml2array($flexData, 'T3');
1230 if (is_array($flexData)) {
1231 if (isset($flexData['data']['sDEF']['lDEF'])) {
1232 $flexData = $flexData['data']['sDEF']['lDEF'];
1235 foreach ($flexData as $key => $value) {
1236 if (is_array($value['el']) && count($value['el']) > 0) {
1237 foreach ($value['el'] as $ekey => $element) {
1238 if (isset($element['vDEF'])) {
1239 $conf[$ekey] = $element['vDEF'];
1241 if (is_array($element)) {
1242 $this->readFlexformIntoConf($element, $conf[$key][key($element)][$ekey], TRUE);
1244 $this->readFlexformIntoConf($element, $conf[$key][$ekey], TRUE);
1249 $this->readFlexformIntoConf($value['el'], $conf[$key], TRUE);
1251 if ($value['vDEF']) {
1252 $conf[$key] = $value['vDEF'];
1260 * Returns all parents of the given PID (Page UID) list
1262 * @param string A list of page Content-Element PIDs (Page UIDs) / stdWrap
1263 * @param array stdWrap array for the list
1264 * @return string A list of PIDs
1267 function getSlidePids($pidList, $pidConf) {
1268 $pidList = isset($pidConf)
1269 ?
trim($this->stdWrap($pidList, $pidConf))
1271 if (!strcmp($pidList, '')) {
1274 if (trim($pidList)) {
1275 $listArr = t3lib_div
::intExplode(',', str_replace('this', $GLOBALS['TSFE']->contentPid
, $pidList));
1276 $listArr = $this->checkPidArray($listArr);
1279 if (is_array($listArr) && count($listArr)) {
1280 foreach ($listArr as $uid) {
1281 $page = $GLOBALS['TSFE']->sys_page
->getPage($uid);
1282 if (!$page['is_siteroot']) {
1283 $pidList[] = $page['pid'];
1287 return implode(',', $pidList);
1291 * Returns a default value for a form field in the FORM cObject.
1292 * Page CANNOT be cached because that would include the inserted value for the current user.
1294 * @param boolean If noValueInsert OR if the no_cache flag for this page is NOT set, the original default value is returned.
1295 * @param string $fieldName: The POST var name to get default value for
1296 * @param string $defaultVal: The current default value
1297 * @return string The default value, either from INPUT var or the current default, based on whether caching is enabled or not.
1300 function getFieldDefaultValue($noValueInsert, $fieldName, $defaultVal) {
1301 if (!$GLOBALS['TSFE']->no_cache ||
(!isset($_POST[$fieldName]) && !isset($_GET[$fieldName])) ||
$noValueInsert) {
1304 return t3lib_div
::_GP($fieldName);
1309 * Returns a <img> tag with the image file defined by $file and processed according to the properties in the TypoScript array.
1310 * Mostly this function is a sub-function to the IMAGE function which renders the IMAGE cObject in TypoScript.
1311 * This function is called by "$this->cImage($conf['file'],$conf);" from IMAGE().
1313 * @param string File TypoScript resource
1314 * @param array TypoScript configuration properties
1315 * @return string <img> tag, (possibly wrapped in links and other HTML) if any image found.
1319 function cImage($file, $conf) {
1320 $info = $this->getImgResource($file, $conf['file.']);
1321 $GLOBALS['TSFE']->lastImageInfo
= $info;
1322 if (is_array($info)) {
1323 $info[3] = t3lib_div
::png_to_gif_by_imagemagick($info[3]);
1324 $GLOBALS['TSFE']->imagesOnPage
[] = $info[3]; // This array is used to collect the image-refs on the page...
1327 // Backwards compatibility if altText is not set and alttext is set
1328 // @deprecated since TYPO3 4.3, will be removed in TYPO3 4.6
1329 if (strlen($conf['alttext']) ||
is_array($conf['alttext.'])) {
1330 $GLOBALS['TSFE']->logDeprecatedTyposcript(
1332 'use IMAGE.altText instead - src: ' . $info[3] . ' - original image: ' . $info['origFile']
1334 if (!strlen($conf['altText']) && !is_array($conf['altText.'])) {
1335 $conf['altText'] = $conf['alttext'];
1336 $conf['altText.'] = $conf['alttext.'];
1340 $altParam = $this->getAltParam($conf);
1341 if($conf['params'] && !isset($conf['params.'])) {
1342 $params = ' ' . $conf['params'];
1344 $params = isset($conf['params.'])
1345 ?
' ' . $this->stdWrap($conf['params'], $conf['params.'])
1348 $theValue = '<img src="' . htmlspecialchars($GLOBALS['TSFE']->absRefPrefix
.
1349 t3lib_div
::rawUrlEncodeFP($info[3])) . '" width="' . $info[0] . '" height="' . $info[1] . '"' .
1350 $this->getBorderAttr(' border="' . intval($conf['border']) . '"') .
1352 ($altParam) . ' />';
1353 $linkWrap = isset($conf['linkWrap.'])
1354 ?
$this->stdWrap($conf['linkWrap'], $conf['linkWrap.'])
1355 : $conf['linkWrap'];
1357 $theValue = $this->linkWrap($theValue, $linkWrap);
1358 } elseif ($conf['imageLinkWrap']) {
1359 $theValue = $this->imageLinkWrap($theValue, $info['origFile'], $conf['imageLinkWrap.']);
1361 $wrap = isset($conf['wrap.'])
1362 ?
$this->stdWrap($conf['wrap'], $conf['wrap.'])
1365 $theValue = $this->wrap($theValue, $conf['wrap']);
1372 * Returns the 'border' attribute for an <img> tag only if the doctype is not xhtml_strict, xhtml_11, xhtml_2 or html5
1373 * or if the config parameter 'disableImgBorderAttr' is not set.
1375 * @param string the border attribute
1376 * @return string the border attribute
1378 function getBorderAttr($borderAttr) {
1379 if (! t3lib_div
::inList('xhtml_strict,xhtml_11,xhtml_2', $GLOBALS['TSFE']->xhtmlDoctype
) &&
1380 $GLOBALS['TSFE']->config
['config']['doctype'] != 'html5' &&
1381 ! $GLOBALS['TSFE']->config
['config']['disableImgBorderAttr']) {
1387 * Wraps the input string in link-tags that opens the image in a new window.
1389 * @param string String to wrap, probably an <img> tag
1390 * @param string The original image file
1391 * @param array TypoScript properties for the "imageLinkWrap" function
1392 * @return string The input string, $string, wrapped as configured.
1394 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=316&cHash=2848266da6
1396 function imageLinkWrap($string, $imageFile, $conf) {
1400 $enable = isset($conf['enable.'])
1401 ?
$this->stdWrap($conf['enable'], $conf['enable.'])
1404 $content = $this->typolink($string, $conf['typolink.']);
1405 if(isset($conf['file.'])) {
1406 $imageFile = $this->stdWrap($imageFile, $conf['file.']);
1410 if ($content == $string && @is_file
($imageFile)) {
1411 $parameterNames = array('width', 'height', 'effects', 'alternativeTempPath', 'bodyTag', 'title', 'wrap');
1412 $parameters = array();
1414 $sample = isset($conf['sample.'])
1415 ?
$this->stdWrap($conf['sample'], $conf['sample.'])
1418 $parameters['sample'] = 1;
1421 foreach ($parameterNames as $parameterName) {
1422 if(isset($conf[$parameterName.'.'])) {
1423 $conf[$parameterName] = $this->stdWrap($conf[$parameterName], $conf[$parameterName.'.']);
1425 if (isset($conf[$parameterName]) && $conf[$parameterName]) {
1426 $parameters[$parameterName] = $conf[$parameterName];
1430 $parametersEncoded = base64_encode(serialize($parameters));
1432 $md5_value = t3lib_div
::hmac(
1435 array($imageFile, $parametersEncoded)
1439 $params = '&md5=' . $md5_value;
1440 foreach (str_split($parametersEncoded, 64) as $index => $chunk) {
1441 $params .= '¶meters[' . $index . ']=' . rawurlencode($chunk);
1444 $url = $GLOBALS['TSFE']->absRefPrefix
. 'index.php?eID=tx_cms_showpic&file=' . rawurlencode($imageFile) . $params;
1446 $directImageLink = isset($conf['directImageLink.'])
1447 ?
$this->stdWrap($conf['directImageLink'], $conf['directImageLink.'])
1448 : $conf['directImageLink'];
1449 if ($directImageLink) {
1450 $imgResourceConf = array(
1451 'file' => $imageFile,
1454 $url = $this->IMG_RESOURCE($imgResourceConf);
1456 // if no imagemagick / gm is available
1461 // Create TARGET-attribute only if the right doctype is used
1462 if (!t3lib_div
::inList('xhtml_strict,xhtml_11,xhtml_2', $GLOBALS['TSFE']->xhtmlDoctype
)) {
1463 $target = isset($conf['target.'])
1464 ?
$this-stdWrap($conf['target'], $conf['target.'])
1467 $target = sprintf(' target="%s"', $target);
1469 $target = ' target="thePicture"';
1474 $conf['JSwindow'] = isset($conf['JSwindow.'])
1475 ?
$this->stdWrap($conf['JSwindow'], $conf['JSwindow.'])
1476 : $conf['JSwindow'];
1477 if ($conf['JSwindow']) {
1478 if ($conf['JSwindow.']['altUrl'] ||
$conf['JSwindow.']['altUrl.']) {
1479 $altUrl = isset($conf['JSwindow.']['altUrl.'])
1480 ?
$this->stdWrap($conf['JSwindow.']['altUrl'], $conf['JSwindow.']['altUrl.'])
1481 : $conf['JSwindow.']['altUrl'];
1484 ($conf['JSwindow.']['altUrl_noDefaultParams'] ?
'' : '?file=' .
1485 rawurlencode($imageFile) . $params);
1488 $gifCreator = t3lib_div
::makeInstance('tslib_gifbuilder');
1489 $gifCreator->init();
1490 $gifCreator->mayScaleUp
= 0;
1492 $dims = $gifCreator->getImageScale($gifCreator->getImageDimensions($imageFile), $conf['width'], $conf['height'], '');
1493 $JSwindowExpand = isset($conf['JSwindow.']['expand.'])
1494 ?
$this->stdWrap($conf['JSwindow.']['expand'], $conf['JSwindow.']['expand.'])
1495 : $conf['JSwindow.']['expand'];
1496 $offset = t3lib_div
::intExplode(',', $JSwindowExpand . ',');
1498 $newWindow = isset($conf['JSwindow.']['newWindow.'])
1499 ?
$this->stdWrap($conf['JSwindow.']['newWindow'], $conf['JSwindow.']['newWindow.'])
1500 : $conf['JSwindow.']['newWindow'];
1501 $a1 = '<a href="' . htmlspecialchars($url) . '" onclick="' .
1502 htmlspecialchars('openPic(\'' . $GLOBALS['TSFE']->baseUrlWrap($url) . '\',\'' .
1503 ($newWindow ?
md5($url) : 'thePicture') . '\',\'width=' .
1504 ($dims[0] +
$offset[0]) . ',height=' . ($dims[1] +
$offset[1]) .
1505 ',status=0,menubar=0\'); return false;') . '"' .
1506 $target . $GLOBALS['TSFE']->ATagParams
. '>';
1508 $GLOBALS['TSFE']->setJS('openPic');
1510 $conf['linkParams.']['parameter'] = $url;
1511 $string = $this->typoLink($string, $conf['linkParams.']);
1514 if(isset($conf['stdWrap.'])) {
1515 $string = $this->stdWrap($string, $conf['stdWrap.']);
1518 $content = $a1 . $string . $a2;
1526 * Returns content of a file. If it's an image the content of the file is not returned but rather an image tag is.
1528 * @param string The filename, being a TypoScript resource data type
1529 * @param string Additional parameters (attributes). Default is empty alt and title tags.
1530 * @return string If jpg,gif,jpeg,png: returns image_tag with picture in. If html,txt: returns content string
1533 function fileResource($fName, $addParams = 'alt="" title=""') {
1534 $incFile = $GLOBALS['TSFE']->tmpl
->getFileName($fName);
1536 $fileinfo = t3lib_div
::split_fileref($incFile);
1537 if (t3lib_div
::inList('jpg,gif,jpeg,png', $fileinfo['fileext'])) {
1538 $imgFile = $incFile;
1539 $imgInfo = @getImageSize
($imgFile);
1540 return '<img src="' . $GLOBALS['TSFE']->absRefPrefix
. $imgFile .
1541 '" width="' . $imgInfo[0] . '" height="' . $imgInfo[1] . '"' .
1542 $this->getBorderAttr(' border="0"') . ' ' . $addParams . ' />';
1543 } elseif (filesize($incFile) < 1024 * 1024) {
1544 return $GLOBALS['TSFE']->tmpl
->fileContent($incFile);
1550 * Sets the SYS_LASTCHANGED timestamp if input timestamp is larger than current value.
1551 * The SYS_LASTCHANGED timestamp can be used by various caching/indexing applications to determine if the page has new content.
1552 * Therefore you should call this function with the last-changed timestamp of any element you display.
1554 * @param integer Unix timestamp (number of seconds since 1970)
1556 * @see tslib_fe::setSysLastChanged()
1558 function lastChanged($tstamp) {
1559 $tstamp = intval($tstamp);
1560 if ($tstamp > intval($GLOBALS['TSFE']->register
['SYS_LASTCHANGED'])) {
1561 $GLOBALS['TSFE']->register
['SYS_LASTCHANGED'] = $tstamp;
1566 * Wraps the input string by the $wrap value and implements the "linkWrap" data type as well.
1567 * 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.
1569 * @param string Input string
1570 * @param string A string where the first two parts separated by "|" (vertical line) will be wrapped around the input string
1571 * @return string Wrapped output string
1572 * @see wrap(), cImage(), FILE()
1573 * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=282&cHash=831a95115d
1575 function linkWrap($content, $wrap) {
1576 $wrapArr = explode('|', $wrap);
1577 if (preg_match('/\{([0-9]*)\}/', $wrapArr[0], $reg)) {
1578 if ($uid = $GLOBALS['TSFE']->tmpl
->rootLine
[$reg[1]]['uid']) {
1579 $wrapArr[0] = str_replace($reg[0], $uid, $wrapArr[0]);
1582 return trim($wrapArr[0]) . $content . trim($wrapArr[1]);
1586 * An abstraction method which creates an alt or title parameter for an HTML img, applet, area or input element and the FILE content element.
1587 * From the $conf array it implements the properties "altText", "titleText" and "longdescURL"
1589 * @param array TypoScript configuration properties
1590 * @param boolean If set, the longdesc attribute will be generated - must only be used for img elements!
1591 * @return string Parameter string containing alt and title parameters (if any)
1592 * @see IMGTEXT(), FILE(), FORM(), cImage(), filelink()
1594 function getAltParam($conf, $longDesc = TRUE) {
1595 $altText = isset($conf['altText.'])
1596 ?
trim($this->stdWrap($conf['altText'], $conf['altText.']))
1597 : trim($conf['altText']);
1598 $titleText = isset($conf['titleText.'])
1599 ?
trim($this->stdWrap($conf['titleText'], $conf['titleText.']))
1600 : trim($conf['titleText']);
1601 $longDesc = isset($conf['longdescURL.'])
1602 ?
trim($this->stdWrap($conf['longdescURL'], $conf['longdescURL.']))
1603 : trim($conf['longdescURL']);
1606 $altParam = ' alt="' . htmlspecialchars($altText) . '"';
1609 $emptyTitleHandling = 'useAlt';
1610 $emptyTitleHandling = isset($conf['emptyTitleHandling.'])
1611 ?
$this->stdWrap($conf['emptyTitleHandling'], $conf['emptyTitleHandling.'])
1612 : $conf['emptyTitleHandling'];
1613 // choices: 'keepEmpty' | 'useAlt' | 'removeAttr'
1614 if ($titleText ||
$emptyTitleHandling == 'keepEmpty') {
1615 $altParam .= ' title="' . htmlspecialchars($titleText) . '"';
1616 } elseif (!$titleText && $emptyTitleHandling == 'useAlt') {
1617 $altParam .= ' title="' . htmlspecialchars($altText) . '"';
1622 $altParam .= ' longdesc="' . htmlspecialchars(strip_tags($longDesc)) . '"';
1629 * Removes forbidden characters and spaces from name/id attributes in the form tag and formfields
1631 * @param string Input string
1632 * @return string the cleaned string
1635 function cleanFormName($name) {
1636 // turn data[x][y] into data:x:y:
1637 $name = preg_replace('/\[|\]\[?/', ':', trim($name));
1638 // remove illegal chars like _
1639 return preg_replace('#[^:a-zA-Z0-9]#', '', $name);
1643 * An abstraction method to add parameters to an A tag.
1644 * Uses the ATagParams property.
1646 * @param array TypoScript configuration properties
1647 * @param boolean If set, will add the global config.ATagParams to the link
1648 * @return string String containing the parameters to the A tag (if non empty, with a leading space)
1649 * @see IMGTEXT(), filelink(), makelinks(), typolink()
1651 function getATagParams($conf, $addGlobal = 1) {
1653 if ($conf['ATagParams.']) {
1654 $aTagParams = ' ' . $this->stdWrap($conf['ATagParams'], $conf['ATagParams.']);
1655 } elseif ($conf['ATagParams']) {
1656 $aTagParams = ' ' . $conf['ATagParams'];
1659 $aTagParams = ' ' . trim($GLOBALS['TSFE']->ATagParams
. $aTagParams);
1665 * All extension links should ask this function for additional properties to their tags.
1666 * Designed to add for instance an "onclick" property for site tracking systems.
1668 * @param string URL of the website
1669 * @return string the additional tag properties
1671 function extLinkATagParams($URL, $TYPE) {
1674 if ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['extLinkATagParamsHandler']) {
1675 $extLinkATagParamsHandler = t3lib_div
::getUserObj(
1676 $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/class.tslib_content.php']['extLinkATagParamsHandler']
1679 if (method_exists($extLinkATagParamsHandler, 'main')) {
1680 $out .= trim($extLinkATagParamsHandler->main($URL, $TYPE, $this));
1684 return trim($out) ?
' ' . trim($out) : '';
1689 /***********************************************
1691 * HTML template processing functions
1693 ***********************************************/
1696 * Returns a subpart from the input content stream.
1697 * A subpart is a part of the input stream which is encapsulated in a
1698 * string matching the input string, $marker. If this string is found
1699 * inside of HTML comment tags the start/end points of the content block
1700 * returned will be that right outside that comment block.
1701 * Example: The contennt string is
1702 * "Hello <!--###sub1### begin--> World. How are <!--###sub1### end--> you?"
1703 * If $marker is "###sub1###" then the content returned is
1704 * " World. How are ". The input content string could just as well have
1705 * been "Hello ###sub1### World. How are ###sub1### you?" and the result
1707 * Wrapper for t3lib_parsehtml::getSubpart which behaves identical
1709 * @param string The content stream, typically HTML template content.
1710 * @param string The marker string, typically on the form "###[the marker string]###"
1711 * @return string The subpart found, if found.
1712 * @see substituteSubpart(), t3lib_parsehtml::getSubpart()
1714 public function getSubpart($content, $marker) {
1715 return t3lib_parsehtml
::getSubpart($content, $marker);
1719 * Substitute subpart in input template stream.
1720 * This function substitutes a subpart in $content with the content of
1722 * Wrapper for t3lib_parsehtml::substituteSubpart which behaves identical
1724 * @param string The content stream, typically HTML template content.
1725 * @param string The marker string, typically on the form "###[the marker string]###"
1726 * @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.
1727 * @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!
1728 * @return string The processed HTML content string.
1729 * @see getSubpart(), t3lib_parsehtml::substituteSubpart()
1731 public function substituteSubpart($content, $marker, $subpartContent, $recursive = 1) {
1732 return t3lib_parsehtml
::substituteSubpart($content, $marker, $subpartContent, $recursive);
1736 * Substitues multiple subparts at once
1738 * @param string The content stream, typically HTML template content.
1739 * @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.
1740 * @return string The processed HTML content string.
1742 public function substituteSubpartArray($content, array $subpartsContent) {
1743 return t3lib_parsehtml
::substituteSubpartArray($content, $subpartsContent);
1747 * Substitutes a marker string in the input content
1748 * (by a simple str_replace())
1750 * @param string The content stream, typically HTML template content.
1751 * @param string The marker string, typically on the form "###[the marker string]###"
1752 * @param mixed The content to insert instead of the marker string found.
1753 * @return string The processed HTML content string.
1754 * @see substituteSubpart()
1756 public function substituteMarker($content, $marker, $markContent) {
1757 return t3lib_parsehtml
::substituteMarker($content, $marker, $markContent);
1761 * Multi substitution function with caching.
1763 * This function should be a one-stop substitution function for working
1764 * with HTML-template. It does not substitute by str_replace but by
1765 * splitting. This secures that the value inserted does not themselves
1766 * contain markers or subparts.
1768 * Note that the "caching" won't cache the content of the substition,
1769 * but only the splitting of the template in various parts. So if you
1770 * want only one cache-entry per template, make sure you always pass the
1771 * exact same set of marker/subpart keys. Else you will be flooding the
1772 * users cache table.
1774 * This function takes three kinds of substitutions in one:
1775 * $markContentArray is a regular marker-array where the 'keys' are
1776 * substituted in $content with their values
1778 * $subpartContentArray works exactly like markContentArray only is whole
1779 * subparts substituted and not only a single marker.
1781 * $wrappedSubpartContentArray is an array of arrays with 0/1 keys where
1782 * the subparts pointed to by the main key is wrapped with the 0/1 value
1785 * @param string The content stream, typically HTML template content.
1786 * @param array Regular marker-array where the 'keys' are substituted in $content with their values
1787 * @param array Exactly like markContentArray only is whole subparts substituted and not only a single marker.
1788 * @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.
1789 * @return string The output content stream
1790 * @see substituteSubpart(), substituteMarker(), substituteMarkerInObject(), TEMPLATE()
1792 public function substituteMarkerArrayCached($content, array $markContentArray = NULL, array $subpartContentArray = NULL, array $wrappedSubpartContentArray = NULL) {
1793 $GLOBALS['TT']->push('substituteMarkerArrayCached');
1795 // If not arrays then set them
1796 if (is_null($markContentArray))
1797 $markContentArray = array(); // Plain markers
1798 if (is_null($subpartContentArray))
1799 $subpartContentArray = array(); // Subparts being directly substituted
1800 if (is_null($wrappedSubpartContentArray))
1801 $wrappedSubpartContentArray = array(); // Subparts being wrapped
1802 // Finding keys and check hash:
1803 $sPkeys = array_keys($subpartContentArray);
1804 $wPkeys = array_keys($wrappedSubpartContentArray);
1805 $aKeys = array_merge(array_keys($markContentArray), $sPkeys, $wPkeys);
1806 if (!count($aKeys)) {
1807 $GLOBALS['TT']->pull();
1811 $storeKey = md5('substituteMarkerArrayCached_storeKey:' . serialize(array(
1814 if ($this->substMarkerCache
[$storeKey]) {
1815 $storeArr = $this->substMarkerCache
[$storeKey];
1816 $GLOBALS['TT']->setTSlogMessage('Cached', 0);
1818 $storeArrDat = $GLOBALS['TSFE']->sys_page
->getHash($storeKey);
1819 if (!isset($storeArrDat)) {
1820 // Initialize storeArr
1821 $storeArr = array();
1823 // Finding subparts and substituting them with the subpart as a marker
1824 foreach ($sPkeys as $sPK) {
1825 $content = $this->substituteSubpart($content, $sPK, $sPK);
1828 // Finding subparts and wrapping them with markers
1829 foreach ($wPkeys as $wPK) {
1830 $content = $this->substituteSubpart($content, $wPK, array(
1835 // traverse keys and quote them for reg ex.
1836 foreach ($aKeys as $tK => $tV) {
1837 $aKeys[$tK] = preg_quote($tV, '/');
1839 $regex = '/' . implode('|', $aKeys) . '/';
1841 $storeArr['c'] = preg_split($regex, $content);
1842 preg_match_all($regex, $content, $keyList);
1843 $storeArr['k'] = $keyList[0];
1845 $this->substMarkerCache
[$storeKey] = $storeArr;
1847 // Storing the cached data:
1848 $GLOBALS['TSFE']->sys_page
->storeHash($storeKey, serialize($storeArr), 'substMarkArrayCached');
1850 $GLOBALS['TT']->setTSlogMessage('Parsing', 0);
1853 $storeArr = unserialize($storeArrDat);
1855 $this->substMarkerCache
[$storeKey] = $storeArr;
1856 $GLOBALS['TT']->setTSlogMessage('Cached from DB', 0);
1860 // Substitution/Merging:
1861 // Merging content types together, resetting
1862 $valueArr = array_merge($markContentArray, $subpartContentArray, $wrappedSubpartContentArray);
1864 $wSCA_reg = array();
1866 // traversing the keyList array and merging the static and dynamic content
1867 foreach ($storeArr['k'] as $n => $keyN) {
1868 $content .= $storeArr['c'][$n];
1869 if (!is_array($valueArr[$keyN])) {
1870 $content .= $valueArr[$keyN];
1872 $content .= $valueArr[$keyN][(intval($wSCA_reg[$keyN]) %
2)];
1876 $content .= $storeArr['c'][count($storeArr['k'])];
1878 $GLOBALS['TT']->pull();
1883 * Traverses the input $markContentArray array and for each key the marker
1884 * by the same name (possibly wrapped and in upper case) will be
1885 * substituted with the keys value in the array.
1887 * This is very useful if you have a data-record to substitute in some
1888 * content. In particular when you use the $wrap and $uppercase values to
1889 * pre-process the markers. Eg. a key name like "myfield" could effectively
1890 * be represented by the marker "###MYFIELD###" if the wrap value
1891 * was "###|###" and the $uppercase boolean TRUE.
1893 * @param string The content stream, typically HTML template content.
1894 * @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.
1895 * @param string A wrap value - [part 1] | [part 2] - for the markers before substitution
1896 * @param boolean If set, all marker string substitution is done with upper-case markers.
1897 * @param boolean If set, all unused marker are deleted.
1898 * @return string The processed output stream
1899 * @see substituteMarker(), substituteMarkerInObject(), TEMPLATE()
1901 public function substituteMarkerArray($content, array $markContentArray, $wrap = '', $uppercase = FALSE, $deleteUnused = FALSE) {
1902 return t3lib_parsehtml
::substituteMarkerArray($content, $markContentArray, $wrap, $uppercase, $deleteUnused);
1906 * Substitute marker array in an array of values
1908 * @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)
1909 * @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.
1910 * @return mixed The processed input variable.
1911 * @see substituteMarker()
1913 public function substituteMarkerInObject(&$tree, array $markContentArray) {
1914 if (is_array($tree)) {
1915 foreach ($tree as $key => $value) {
1916 $this->substituteMarkerInObject($tree[$key], $markContentArray);
1919 $tree = $this->substituteMarkerArray($tree, $markContentArray);
1926 * Adds elements to the input $markContentArray based on the values from
1927 * the fields from $fieldList found in $row
1929 * @param array array with key/values being marker-strings/substitution values.
1930 * @param array An array with keys found in the $fieldList (typically a record) which values should be moved to the $markContentArray
1931 * @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)
1932 * @param boolean If set, all values added to $markContentArray will be nl2br()'ed
1933 * @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 "###"
1934 * @param boolean If set, all values are passed through htmlspecialchars() - RECOMMENDED to avoid most obvious XSS and maintain XHTML compliance.
1935 * @return array The modified $markContentArray
1937 public function fillInMarkerArray(array $markContentArray, array $row, $fieldList = '', $nl2br = TRUE, $prefix = 'FIELD_', $HSC = FALSE) {
1939 $fArr = t3lib_div
::trimExplode(',', $fieldList, 1);
1940 foreach ($fArr as $field) {
1941 $markContentArray['###' . $prefix . $field . '###'] = $nl2br ?
nl2br($row[$field]) : $row[$field];
1944 if (is_array($row)) {
1945 foreach ($row as $field => $value) {
1946 if (!t3lib_div
::testInt($field)) {
1948 $value = htmlspecialchars($value);
1951 $markContentArray['###' . $prefix . $field . '###'] = $nl2br ?
nl2br($value) : $value;
1957 return $markContentArray;
1960 /***********************************************
1962 * "stdWrap" + sub functions
1964 ***********************************************/
1967 * The "stdWrap" function. This is the implementation of what is known as "stdWrap properties" in TypoScript.
1968 * Basically "stdWrap" performs some processing of a value based on properties in the input $conf array(holding the TypoScript "stdWrap properties")
1969 * 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.
1971 * If $this->alternativeData is an array it's used instead of the $this->data array in ->getData
1973 * @param string Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
1974 * @param array TypoScript "stdWrap properties".
1975 * @return string The processed input value
1977 public function stdWrap($content = '', $conf = array()) {
1978 if (count($this->stdWrapHookObjects
)) {
1979 foreach ($this->stdWrapHookObjects
as $hookObject) {
1980 if (is_callable(array($hookObject, 'stdWrapPreProcess'))) {
1981 $conf['stdWrapPreProcess'] = 1;
1984 if (is_callable(array($hookObject, 'stdWrapOverride'))) {
1985 $conf['stdWrapOverride'] = 1;
1988 if (is_callable(array($hookObject, 'stdWrapProcess'))) {
1989 $conf['stdWrapProcess'] = 1;
1992 if (is_callable(array($hookObject, 'stdWrapPostProcess'))) {
1993 $conf['stdWrapPostProcess'] = 1;
1998 if (is_array($conf) && count($conf)) {
1999 // check, which of the available stdWrap functions is needed for the current conf Array
2000 // and keep only those but still in the same order
2001 $sortedConf = array_intersect_key($this->stdWrapOrder
, $conf);
2002 // functions types that should not make use of nested stdWrap function calls to avoid conflicts with internal TypoScript used by these functions
2003 $stdWrapDisabledFunctionTypes = 'cObject,functionName,stdWrap';
2004 // additional Array to check whether a function has already been executed
2005 $isExecuted = array();
2006 // additional switch to make sure 'required', 'if' and 'fieldRequired'
2007 // will still stop rendering immediately in case they return false
2009 $this->stdWrapRecursionLevel++
;
2010 $this->stopRendering
[$this->stdWrapRecursionLevel
] = false;
2012 // execute each funtion in the predefined order
2013 foreach ($sortedConf as $stdWrapName => $functionType) {
2014 // eliminate the second key of a pair 'key'|'key.' to make sure functions get called only once and check if rendering has been stopped
2015 if (!$isExecuted[$stdWrapName] &&
2016 !$this->stopRendering
[$this->stdWrapRecursionLevel
]) {
2017 $functionName = rtrim($stdWrapName, '.');
2018 $functionProperties = $functionName . '.';
2019 // if there is any code one the next level, check if it contains "official" stdWrap functions
2020 // if yes, execute them first - will make each function stdWrap aware
2021 // so additional stdWrap calls within the functions can be removed, since the result will be the same
2022 // exception: the recursive stdWrap function and cObject will still be using their own stdWrap call, since it modifies the content and not a property
2023 if (count($conf[$functionProperties]) &&
2024 !t3lib_div
::inList($stdWrapDisabledFunctionTypes, $functionType)) {
2025 if (array_intersect_key($this->stdWrapOrder
, $conf[$functionProperties])) {
2026 $conf[$functionName] = $this->stdWrap($conf[$functionName], $conf[$functionProperties]);
2029 // get just that part of $conf that is needed for the particular function
2030 $singleConf = array(
2031 $functionName => $conf[$functionName],
2032 $functionProperties => $conf[$functionProperties]
2035 // in this special case 'spaceBefore' and 'spaceAfter' need additional stuff from 'space.''
2036 if ($functionName == 'spaceBefore' ||
$functionName == 'spaceAfter') {
2037 $singleConf['space.'] = $conf['space.'];
2040 // hand over the whole $conf array to the stdWrapHookObjects
2041 if ($conf[$functionName] == 'stdWrapHookObject') {
2042 $singleConf = $conf;
2044 // check if key is still containing something, since it might have been changed by next level stdWrap before
2045 if ((isset($conf[$functionName]) ||
$conf[$functionProperties]) &&
2046 !($functionType == 'boolean' && $conf[$functionName] === '0')) {
2047 //add both keys - with and without the dot - to the set of executed functions
2048 $isExecuted[$functionName] = true;
2049 $isExecuted[$functionProperties] = true;
2050 // call the function with the prefix stdWrap_ to make sure nobody can execute functions just by adding their name to the TS Array
2051 $functionName = 'stdWrap_' . $functionName;
2052 $content = $this->$functionName(
2060 unset($this->stopRendering
[$this->stdWrapRecursionLevel
]);
2061 $this->stdWrapRecursionLevel
--;
2068 * stdWrap pre process hook
2069 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2070 * this hook will execute functions before any other stdWrap function can modify anything
2072 * @param string Input value undergoing processing in these functions.
2073 * @param array All stdWrap properties, not just the ones for a particular function.
2074 * @return string The processed input value
2076 public function stdWrap_stdWrapPreProcess($content = '', $conf = array()) {
2077 foreach ($this->stdWrapHookObjects
as $hookObject) {
2078 $content = $hookObject->stdWrapPreProcess($content, $conf, $this);
2084 * setContentToCurrent
2085 * actually it just does the contrary: Sets the value of 'current' based on current content
2087 * @param string Input value undergoing processing in this function.
2088 * @param array stdWrap properties for setContentToCurrent.
2089 * @return string The processed input value
2091 public function stdWrap_setContentToCurrent($content = '', $conf = array()) {
2092 $this->data
[$this->currentValKey
] = $content;
2097 * Sets the value of 'current' based on the outcome of stdWrap operations
2099 * @param string Input value undergoing processing in this function.
2100 * @param array stdWrap properties for setCurrent.
2101 * @return string The processed input value
2103 public function stdWrap_setCurrent($content = '', $conf = array()) {
2104 $this->data
[$this->currentValKey
] = $conf['setCurrent'];
2109 * Translates content based on the language currently used by the FE
2111 * @param string Input value undergoing processing in this function.
2112 * @param array stdWrap properties for lang.
2113 * @return string The processed input value
2115 public function stdWrap_lang($content = '', $conf = array()) {
2116 if (isset($conf['lang.']) && $GLOBALS['TSFE']->config
['config']['language'] && isset($conf['lang.'][$GLOBALS['TSFE']->config
['config']['language']])) {
2117 $content = $conf['lang.'][$GLOBALS['TSFE']->config
['config']['language']];
2124 * Gets content from different sources based on getText functions, makes use of alternativeData, when set
2126 * @param string Input value undergoing processing in this function.
2127 * @param array stdWrap properties for data.
2128 * @return string The processed input value
2130 public function stdWrap_data($content = '', $conf = array()) {
2131 $content = $this->getData($conf['data'], is_array($this->alternativeData
) ?
$this->alternativeData
: $this->data
);
2132 $this->alternativeData
= ''; // This must be unset directly after
2138 * Gets content from a DB field
2140 * @param string Input value undergoing processing in this function.
2141 * @param array stdWrap properties for field.
2142 * @return string The processed input value
2144 public function stdWrap_field($content = '', $conf = array()) {
2145 $content = $this->getFieldVal($conf['field']);
2151 * Gets content that has been perviously set as 'current'
2152 * Can be set via setContentToCurrent or setCurrent or will be set automatically i.e. inside the split function
2154 * @param string Input value undergoing processing in this function.
2155 * @param array stdWrap properties for current.
2156 * @return string The processed input value
2158 public function stdWrap_current($content = '', $conf = array()) {
2159 $content = $this->data
[$this->currentValKey
];
2165 * Will replace the content with the value of a any official TypoScript cObject
2166 * like TEXT, COA, HMENU
2168 * @param string Input value undergoing processing in this function.
2169 * @param array stdWrap properties for cObject.
2170 * @return string The processed input value
2172 public function stdWrap_cObject($content = '', $conf = array()) {
2173 $content = $this->cObjGetSingle($conf['cObject'], $conf['cObject.'], '/stdWrap/.cObject');
2179 * Counts the number of returned records of a DB operation
2180 * makes use of select internally
2182 * @param string Input value undergoing processing in this function.
2183 * @param array stdWrap properties for numRows.
2184 * @return string The processed input value
2186 public function stdWrap_numRows($content = '', $conf = array()) {
2187 $content = $this->numRows($conf['numRows.']);
2193 * Will create a list of files based on some additional parameters
2195 * @param string Input value undergoing processing in this function.
2196 * @param array stdWrap properties for filelist.
2197 * @return string The processed input value
2199 public function stdWrap_filelist($content = '', $conf = array()) {
2200 $content = $this->filelist($conf['filelist']);
2206 * Will execute a user public function before the content will be modified by any other stdWrap function
2208 * @param string Input value undergoing processing in this function.
2209 * @param array stdWrap properties for preUserFunc.
2210 * @return string The processed input value
2212 public function stdWrap_preUserFunc($content = '', $conf = array()) {
2213 $content = $this->callUserFunction($conf['preUserFunc'], $conf['preUserFunc.'], $content);
2218 * stdWrap override hook
2219 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2220 * this hook will execute functions on existing content but still before the content gets modified or replaced
2222 * @param string Input value undergoing processing in these functions.
2223 * @param array All stdWrap properties, not just the ones for a particular function.
2224 * @return string The processed input value
2226 public function stdWrap_stdWrapOverride($content = '', $conf = array()) {
2227 foreach ($this->stdWrapHookObjects
as $hookObject) {
2228 $content = $hookObject->stdWrapOverride($content, $conf, $this);
2235 * Will override the current value of content with its own value'
2237 * @param string Input value undergoing processing in this function.
2238 * @param array stdWrap properties for override.
2239 * @return string The processed input value
2241 public function stdWrap_override($content = '', $conf = array()) {
2242 if (trim($conf['override'])) {
2243 $content = $conf['override'];
2250 * Gets a value off a CSV list before the following ifEmpty check
2251 * 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
2253 * @param string Input value undergoing processing in this function.
2254 * @param array stdWrap properties for preIfEmptyListNum.
2255 * @return string The processed input value
2257 public function stdWrap_preIfEmptyListNum($content = '', $conf = array()) {
2258 $content = $this->listNum($content, $conf['preIfEmptyListNum'], $conf['preIfEmptyListNum.']['splitChar']);
2264 * Will set content to a replacement value in case the trimmed value of content returns false
2265 * 0 (zero) will be replaced as well
2267 * @param string Input value undergoing processing in this function.
2268 * @param array stdWrap properties for ifEmpty.
2269 * @return string The processed input value
2271 public function stdWrap_ifEmpty($content = '', $conf = array()) {
2272 if (!trim($content)) {
2273 $content = $conf['ifEmpty'];
2280 * Will set content to a replacement value in case the trimmed value of content has no length
2281 * 0 (zero) will not be replaced
2283 * @param string Input value undergoing processing in this function.
2284 * @param array stdWrap properties for ifBlank.
2285 * @return string The processed input value
2287 public function stdWrap_ifBlank($content = '', $conf = array()) {
2288 if (!strlen(trim($content))) {
2289 $content = $conf['ifBlank'];
2296 * Gets a value off a CSV list after ifEmpty check
2297 * Might return an empty value in case the CSV does not contain a value at the position given by listNum
2298 * Use preIfEmptyListNum to avoid that behaviour
2300 * @param string Input value undergoing processing in this function.
2301 * @param array stdWrap properties for listNum.
2302 * @return string The processed input value
2304 public function stdWrap_listNum($content = '', $conf = array()) {
2305 $content = $this->listNum($content, $conf['listNum'], $conf['listNum.']['splitChar']);
2311 * Cuts off any whitespace at the beginning and the end of the content
2313 * @param string Input value undergoing processing in this function.
2314 * @param array stdWrap properties for trim.
2315 * @return string The processed input value
2317 public function stdWrap_trim($content = '', $conf = array()) {
2318 $content = trim($content);
2324 * A recursive call of the stdWrap function set
2325 * This enables the user to execute stdWrap functions in another than the predefined order
2326 * It modifies the content, not the property
2327 * while the new feature of chained stdWrap functions modifies the property and not the content
2329 * @param string Input value undergoing processing in this function.
2330 * @param array stdWrap properties for stdWrap.
2331 * @return string The processed input value
2333 public function stdWrap_stdWrap($content = '', $conf = array()) {
2334 $content = $this->stdWrap($content, $conf['stdWrap.']);
2339 * stdWrap process hook
2340 * can be used by extensions authors to modify the behaviour of stdWrap functions to their needs
2341 * this hook executes functions directly after the recursive stdWrap function call but still before the content gets modified
2343 * @param string Input value undergoing processing in these functions.
2344 * @param array All stdWrap properties, not just the ones for a particular function.
2345 * @return string The processed input value
2347 public function stdWrap_stdWrapProcess($content = '', $conf = array()) {
2348 foreach ($this->stdWrapHookObjects
as $hookObject) {
2349 $content = $hookObject->stdWrapProcess($content, $conf, $this);
2356 * Will immediately stop rendering and return an empty value
2357 * when there is no content at this point
2359 * @param string Input value undergoing processing in this function.
2360 * @param array stdWrap properties for required.
2361 * @return string The processed input value
2363 public function stdWrap_required($content = '', $conf = array()) {
2364 if ((string) $content == '') {
2366 $this->stopRendering
[$this->stdWrapRecursionLevel
] = TRUE;
2373 * Will immediately stop rendering and return an empty value
2374 * when the result of the checks returns false
2376 * @param string Input value undergoing processing in this function.
2377 * @param array stdWrap properties for if.
2378 * @return string The processed input value
2380 public function stdWrap_if($content = '', $conf = array()) {
2381 if (!$this->checkIf($conf['if.'])) {
2383 $this->stopRendering
[$this->stdWrapRecursionLevel
] = TRUE;
2390 * Will immediately stop rendering and return an empty value
2391 * when there is no content in the field given by fieldRequired
2393 * @param string Input value undergoing processing in this function.
2394 * @param array stdWrap properties for fieldRequired.
2395 * @return string The processed input value
2397 public function stdWrap_fieldRequired($content = '', $conf = array()) {
2398 if (!trim($this->data
[$conf['fieldRequired']])) {
2400 $this->stopRendering
[$this->stdWrapRecursionLevel
] = TRUE;
2407 * Will convert the current chracter set of the content to the one given in csConv
2409 * @param string Input value undergoing processing in this function.
2410 * @param array stdWrap properties for csConv.
2411 * @return string The processed input value
2413 public function stdWrap_csConv($content = '', $conf = array()) {
2414 $content = $GLOBALS['TSFE']->csConv($content, $conf['csConv']);
2420 * Will parse the content based on functions given as stdWrap properties
2421 * Heavily used together with RTE based content
2423 * @param string Input value undergoing processing in this function.
2424 * @param array stdWrap properties for parseFunc.
2425 * @return string The processed input value
2427 public function stdWrap_parseFunc($content = '', $conf = array()) {
2428 $content = $this->parseFunc($content, $conf['parseFunc.'], $conf['parseFunc']);
2434 * Will parse HTML content based on functions given as stdWrap properties
2435 * Heavily used together with RTE based content
2437 * @param string Input value undergoing processing in this function.
2438 * @param array stdWrap properties for HTMLparser.
2439 * @return string The processed input value
2441 public function stdWrap_HTMLparser($content = '', $conf = array()) {
2442 if (is_array($conf['HTMLparser.'])) {
2443 $content = $this->HTMLparser_TSbridge($content, $conf['HTMLparser.']);
2450 * Will split the content by a given token and treat the results separately
2451 * Automatically fills 'current' with a single result
2453 * @param string Input value undergoing processing in this function.
2454 * @param array stdWrap properties for split.
2455 * @return string The processed input value
2457 public function stdWrap_split($content = '', $conf = array()) {
2458 $content = $this->splitObj($content, $conf['split.']);
2464 * Will use the content as a mathematical term and calculate the result
2465 * Can be set to 1 to just get a calculated value or 'intval' to get the integer of the result
2467 * @param string Input value undergoing processing in this function.
2468 * @param array stdWrap properties for prioriCalc.
2469 * @return string The processed input value
2471 public function stdWrap_prioriCalc($content = '', $conf = array()) {
2472 $content = t3lib_div
::calcParenthesis($content);
2473 if ($conf['prioriCalc'] == 'intval')
2474 $content = intval($content);
2480 * Will return a character based on its position within the current character set
2482 * @param string Input value undergoing processing in this function.
2483 * @param array stdWrap properties for char.
2484 * @return string The processed input value
2486 public function stdWrap_char($content = '', $conf = array()) {
2487 $content = chr(intval($conf['char']));
2493 * Will return an integer value of the current content
2495 * @param string Input value undergoing processing in this function.
2496 * @param array stdWrap properties for intval.
2497 * @return string The processed input value
2499 public function stdWrap_intval($content = '', $conf = array()) {
2500 $content = intval($content);
2506 * Will return a formatted number based on configuration given as stdWrap properties
2508 * @param string Input value undergoing processing in this function.
2509 * @param array stdWrap properties for numberFormat.
2510 * @return string The processed input value
2512 public function stdWrap_numberFormat($content = '', $conf = array()) {
2513 $content = $this->numberFormat($content, $conf['numberFormat.']);
2519 * Will return a formatted date based on configuration given according to PHP date/gmdate properties
2520 * Will return gmdate when the property GMT returns true
2522 * @param string Input value undergoing processing in this function.
2523 * @param array stdWrap properties for date.
2524 * @return string The processed input value
2526 public function stdWrap_date($content = '', $conf = array()) {
2527 $content = ($conf['date.']['GMT'] ?
gmdate($conf['date'], $content) : date($conf['date'], $content));
2533 * Will return a formatted date based on configuration given according to PHP strftime/gmstrftime properties
2534 * Will return gmstrftime when the property GMT returns true
2536 * @param string Input value undergoing processing in this function.
2537 * @param array stdWrap properties for strftime.
2538 * @return string The processed input value
2540 public function stdWrap_strftime($content = '', $conf = array()) {
2541 $content = ($conf['strftime.']['GMT'] ?
gmstrftime($conf['strftime'], $content) : strftime($conf['strftime'], $content));
2542 $tmp_charset = $conf['strftime.']['charset'] ?
$conf['strftime.']['charset'] : $GLOBALS['TSFE']->localeCharset
;
2544 $content = $GLOBALS['TSFE']->csConv($content, $tmp_charset);
2551 * Will return the age of a given timestamp based on configuration given by stdWrap properties
2553 * @param string Input value undergoing processing in this function.
2554 * @param array stdWrap properties for age.
2555 * @return string The processed input value
2557 public function stdWrap_age($content = '', $conf = array()) {
2558 $content = $this->calcAge($GLOBALS['EXEC_TIME'] - $content, $conf['age']);
2564 * Will transform the content to be upper or lower case only
2565 * Leaves HTML tags untouched
2567 * @param string Input value undergoing processing in this function.
2568 * @param array stdWrap properties for case.
2569 * @return string The processed input value
2571 public function stdWrap_case($content = '', $conf = array()) {
2572 $content = $this->HTMLcaseshift($content, $conf['case']);
2578 * Will return the size of a given number in Bytes *
2580 * @param string Input value undergoing processing in this function.
2581 * @param array stdWrap properties for bytes.
2582 * @return string The processed input value
2584 public function stdWrap_bytes($content = '', $conf = array()) {
2585 $content = t3lib_div
::formatSize($content, $conf['bytes.']['labels']);
2591 * Will return a substring based on position information given by stdWrap properties
2593 * @param string Input value undergoing processing in this function.
2594 * @param array stdWrap properties for substring.
2595 * @return string The processed input value
2597 public function stdWrap_substring($content = '', $conf = array()) {
2598 $content = $this->substring($content, $conf['substring']);
2604 * Removes HTML tags based on stdWrap properties
2606 * @param string Input value undergoing processing in this function.
2607 * @param array stdWrap properties for removeBadHTML.
2608 * @return string The processed input value
2610 public function stdWrap_removeBadHTML($content = '', $conf = array()) {
2611 $content = $this->removeBadHTML($content, $conf['removeBadHTML.']);
2617 * Crops content to a given size while leaving HTML tags untouched
2619 * @param string Input value undergoing processing in this function.
2620 * @param array stdWrap properties for cropHTML.
2621 * @return string The processed input value
2623 public function stdWrap_cropHTML($content = '', $conf = array()) {
2624 $content = $this->cropHTML($content, $conf['cropHTML']);
2630 * Copmletely removes HTML tags from content
2632 * @param string Input value undergoing processing in this function.
2633 * @param array stdWrap properties for stripHtml.
2634 * @return string The processed input value
2636 public function stdWrap_stripHtml($content = '', $conf = array()) {
2637 $content = strip_tags($content);
2643 * Crops content to a given size without caring abhout HTML tags
2645 * @param string Input value undergoing processing in this function.
2646 * @param array stdWrap properties for crop.
2647 * @return string The processed input value
2649 public function stdWrap_crop($content = '', $conf = array()) {
2650 $content = $this->crop($content, $conf['crop']);
2656 * Encodes content to be used within URLs
2658 * @param string Input value undergoing processing in this function.
2659 * @param array stdWrap properties for rawUrlEncode.
2660 * @return string The processed input value
2662 public function stdWrap_rawUrlEncode($content = '', $conf = array()) {
2663 $content = rawurlencode($content);
2669 * Transforms HTML tags to readable text by replacing special characters with their HTML entity
2670 * When preserveEntities returns true, existing entities will be left untouched
2672 * @param string Input value undergoing processing in this function.
2673 * @param array stdWrap properties for htmlSpecalChars.
2674 * @return string The processed input value
2676 public function stdWrap_htmlSpecialChars($content = '', $conf = array()) {
2677 $content = htmlSpecialChars($content);
2678 if ($conf['htmlSpecialChars.']['preserveEntities'])
2679 $content = t3lib_div
::deHSCentities($content);
2685 * Searches for double line breaks and replaces them with the given value
2687 * @param string Input value undergoing processing in this function.
2688 * @param array stdWrap properties for doubleBrTag.
2689 * @return string The processed input value
2691 public function stdWrap_doubleBrTag($content = '', $conf = array()) {
2692 $content = preg_replace("/\r?\n[\t ]*\r?\n/", $conf['doubleBrTag'], $content);
2698 * Searches for single line breaks and replaces them with a <br /> tag
2700 * @param string Input value undergoing processing in this function.
2701 * @param array stdWrap properties for br.
2702 * @return string The processed input value
2704 public function stdWrap_br($content = '', $conf = array()) {
2705 $content = nl2br($content);
2711 * Searches for single line feeds and replaces them with the given value
2713 * @param string Input value undergoing processing in this function.
2714 * @param array stdWrap properties for brTag.
2715 * @return string The processed input value
2717 public function stdWrap_brTag($content = '', $conf = array()) {
2718 $content = str_replace(LF
, $conf['brTag'], $content);
2724 * Modifies text blocks by searching for lines which are not surrounded by HTML tags yet
2725 * and wrapping them with values given by stdWrap properties
2727 * @param string Input value undergoing processing in this function.
2728 * @param array stdWrap properties for erncapsLines.
2729 * @return string The processed input value
2731 public function stdWrap_encapsLines($content = '', $conf = array()) {
2732 $content = $this->encaps_lineSplit($content, $conf['encapsLines.']);
2738 * Transforms content into a CSV list to be used i.e. as keywords within a meta tag
2740 * @param string Input value undergoing processing in this function.
2741 * @param array stdWrap properties for keywords.
2742 * @return string The processed input value
2744 public function stdWrap_keywords($content = '', $conf = array()) {
2745 $content = $this->keywords($content);
2751 * First of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2754 * @param string Input value undergoing processing in this function.
2755 * @param array stdWrap properties for innerWrap.
2756 * @return string The processed input value
2758 public function stdWrap_innerWrap($content = '', $conf = array()) {
2759 $content = $this->wrap($content, $conf['innerWrap']);
2765 * Second of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2768 * @param string Input value undergoing processing in this function.
2769 * @param array stdWrap properties for innerWrap2.
2770 * @return string The processed input value
2772 public function stdWrap_innerWrap2($content = '', $conf = array()) {
2773 $content = $this->wrap($content, $conf['innerWrap2']);
2779 * A wrap formerly used to apply font tags to format the content
2780 * Still used by lib.stdheader although real font tags are not state of the art anymore
2783 * @param string Input value undergoing processing in this function.
2784 * @param array stdWrap properties for fontTag.
2785 * @return string The processed input value
2787 public function stdWrap_fontTag($content = '', $conf = array()) {
2788 $content = $this->wrap($content, $conf['fontTag']);
2794 * Adds tag attributes to any content that is a tag
2796 * @param string Input value undergoing processing in this function.
2797 * @param array stdWrap properties for addParams.
2798 * @return string The processed input value
2800 public function stdWrap_addParams($content = '', $conf = array()) {
2801 $content = $this->addParams($content, $conf['addParams.']);
2807 * Wraps content in font tags
2810 * @param string Input value undergoing processing in this function.
2811 * @param array stdWrap properties for textStyle.
2812 * @return string The processed input value
2814 public function stdWrap_textStyle($content = '', $conf = array()) {
2815 $content = $this->textStyle($content, $conf['textStyle.']);
2821 * Wraps content with table tags
2824 * @param string Input value undergoing processing in this function.
2825 * @param array stdWrap properties for tableStyle.
2826 * @return string The processed input value
2828 public function stdWrap_tableStyle($content = '', $conf = array()) {
2829 $content = $this->tableStyle($content, $conf['tableStyle.']);
2835 * Used to make lists of links to files
2838 * @param string Input value undergoing processing in this function.
2839 * @param array stdWrap properties for filelink.
2840 * @return string The processed input value
2842 public function stdWrap_filelink($content = '', $conf = array()) {
2843 $content = $this->filelink($content, $conf['filelink.']);
2849 * A content object that is prepended to the current content but between the innerWraps and the rest of the wraps
2851 * @param string Input value undergoing processing in this function.
2852 * @param array stdWrap properties for preCObject.
2853 * @return string The processed input value
2855 public function stdWrap_preCObject($content = '', $conf = array()) {
2856 $content = $this->cObjGetSingle($conf['preCObject'], $conf['preCObject.'], '/stdWrap/.preCObject') . $content;
2862 * A content object that is appended to the current content but between the innerWraps and the rest of the wraps
2864 * @param string Input value undergoing processing in this function.
2865 * @param array stdWrap properties for postCObject.
2866 * @return string The processed input value
2868 public function stdWrap_postCObject($content = '', $conf = array()) {
2869 $content .= $this->cObjGetSingle($conf['postCObject'], $conf['postCObject.'], '/stdWrap/.postCObject');
2875 * Wraps content with a div container having the style attribute text-align set to the given value
2878 * @param string Input value undergoing processing in this function.
2879 * @param array stdWrap properties for wrapAlign.
2880 * @return string The processed input value
2882 public function stdWrap_wrapAlign($content = '', $conf = array()) {
2883 $wrapAlign = trim($conf['wrapAlign']);
2885 $content = $this->wrap($content, '<div style="text-align:' . $wrapAlign . ';">|</div>');
2892 * Wraps the content with a link tag
2893 * URLs and other attributes are created automatically by the values given in the stdWrap properties
2896 * @param string Input value undergoing processing in this function.
2897 * @param array stdWrap properties for typolink.
2898 * @return string The processed input value
2900 public function stdWrap_typolink($content = '', $conf = array()) {
2901 $content = $this->typolink($content, $conf['typolink.']);
2907 * Returns a list of options available for a given field in the DB which has to be of the type select
2909 * @param string Input value undergoing processing in this function.
2910 * @param array stdWrap properties for TCAselectItem.
2911 * @return string The processed input value
2913 public function stdWrap_TCAselectItem($content = '', $conf = array()) {
2914 if (is_array($conf['TCAselectItem.'])) {
2915 $content = $this->TCAlookup($content, $conf['TCAselectItem.']);
2922 * Will add space before the current content
2923 * 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
2925 * @param string Input value undergoing processing in this function.
2926 * @param array stdWrap properties for spaceBefore and space.
2927 * @return string The processed input value
2929 public function stdWrap_spaceBefore($content = '', $conf = array()) {
2930 $content = $this->wrapSpace($content, trim($conf['spaceBefore']) . '|', $conf['space.']);
2936 * Will add space after the current content
2937 * 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
2939 * @param string Input value undergoing processing in this function.
2940 * @param array stdWrap properties for spaceAfter and space.
2941 * @return string The processed input value
2943 public function stdWrap_spaceAfter($content = '', $conf = array()) {
2944 $content = $this->wrapSpace($content, '|' . trim($conf['spaceAfter']), $conf['space.']);
2950 * Will add space before or after the current content
2951 * 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
2954 * @param string Input value undergoing processing in this function.
2955 * @param array stdWrap properties for space.
2956 * @return string The processed input value
2958 public function stdWrap_space($content = '', $conf = array()) {
2959 $content = $this->wrapSpace($content, trim($conf['space']), $conf['space.']);
2965 * This is the "mother" of all wraps
2966 * Third of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2967 * Basically it will put additional content before and after the current content using a split character as a placeholder for the current content
2968 * The default split character is | but it can be replaced with other characters by the property splitChar
2969 * Any other wrap that does not have own splitChar settings will be using the default split char though
2971 * @param string Input value undergoing processing in this function.
2972 * @param array stdWrap properties for wrap.
2973 * @return string The processed input value
2975 public function stdWrap_wrap($content = '', $conf = array()) {
2976 $content = $this->wrap($content, $conf['wrap'], ($conf['wrap.']['splitChar'] ?
$conf['wrap.']['splitChar'] : '|'));
2982 * Fourth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2983 * The major difference to any other wrap is, that this one can make use of whitespace without trimming *
2985 * @param string Input value undergoing processing in this function.
2986 * @param array stdWrap properties for noTrimWrap.
2987 * @return string The processed input value
2989 public function stdWrap_noTrimWrap($content = '', $conf = array()) {
2990 $content = $this->noTrimWrap($content, $conf['noTrimWrap']);
2996 * Fifth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
2997 * The default split character is | but it can be replaced with other characters by the property splitChar
2999 * @param string Input value undergoing processing in this function.
3000 * @param array stdWrap properties for wrap2.
3001 * @return string The processed input value
3003 public function stdWrap_wrap2($content = '', $conf = array()) {
3004 $content = $this->wrap($content, $conf['wrap2'], ($conf['wrap2.']['splitChar'] ?
$conf['wrap2.']['splitChar'] : '|'));
3010 * Sixth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
3011 * 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
3013 * @param string Input value undergoing processing in this function.
3014 * @param array stdWrap properties for dataWrap.
3015 * @return string The processed input value
3017 public function stdWrap_dataWrap($content = '', $conf = array()) {
3018 $content = $this->dataWrap($content, $conf['dataWrap']);
3024 * A content object that will be prepended to the current content after most of the wraps have already been applied
3026 * @param string Input value undergoing processing in this function.
3027 * @param array stdWrap properties for prepend.
3028 * @return string The processed input value
3030 public function stdWrap_prepend($content = '', $conf = array()) {
3031 $content = $this->cObjGetSingle($conf['prepend'], $conf['prepend.'], '/stdWrap/.prepend') . $content;
3037 * A content object that will be appended to the current content after most of the wraps have already been applied
3039 * @param string Input value undergoing processing in this function.
3040 * @param array stdWrap properties for append.
3041 * @return string The processed input value
3043 public function stdWrap_append($content = '', $conf = array()) {
3044 $content .= $this->cObjGetSingle($conf['append'], $conf['append.'], '/stdWrap/.append');
3050 * Seventh of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
3051 * The default split character is | but it can be replaced with other characters by the property splitChar
3053 * @param string Input value undergoing processing in this function.
3054 * @param array stdWrap properties for wrap3.
3055 * @return string The processed input value
3057 public function stdWrap_wrap3($content = '', $conf = array()) {
3058 $content = $this->wrap($content, $conf['wrap3'], ($conf['wrap3.']['splitChar'] ?
$conf['wrap3.']['splitChar'] : '|'));
3064 * Eighth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content
3066 * @param string Input value undergoing processing in this function.
3067 * @param array stdWrap properties for outerWrap.
3068 * @return string The processed input value
3070 public function stdWrap_outerWrap($content = '', $conf = array()) {
3071 $content = $this->wrap($content, $conf['outerWrap']);
3077 * Can fetch additional content the same way data does and replaces any occurence of {field:whatever} with this content
3079 * @param string Input value undergoing processing in this function.
3080 * @param array stdWrap properties for insertData.
3081 * @return string The processed input value
3083 public function stdWrap_insertData($content = '', $conf = array()) {
3084 $content = $this->insertData($content);
3090 * Creates a so called offset table around the content
3091 * Still here for historical reasons even not used too much nowadays
3093 * @param string Input value undergoing processing in this function.
3094 * @param array stdWrap properties for offsetWrap.
3095 * @return string The processed input value
3097 public function stdWrap_offsetWrap($content = '', $conf = array()) {
3098 $controlTable = t3lib_div
::makeInstance('tslib_tableOffset');
3099 if ($conf['offsetWrap.']['tableParams'] ||
$conf['offsetWrap.']['tableParams.']) {
3100 $controlTable->tableParams
= isset($conf['offsetWrap.']['tableParams.'])
3101 ?
$this->stdWrap($conf['offsetWrap.']['tableParams'], $conf['offsetWrap.']['tableParams.'])
3102 : $conf['offsetWrap.']['tableParams'];
3104 if ($conf['offsetWrap.']['tdParams'] ||
$conf['offsetWrap.']['tdParams.']) {
3105 $controlTable->tdParams
= ' ' . isset($conf['offsetWrap.']['tdParams.'])
3106 ?
$this->stdWrap($conf['offsetWrap.']['tdParams'], $conf['offsetWrap.']['tdParams.'])
3107 : $conf['offsetWrap.']['tdParams'];
3109 $content = $controlTable->start($content, $conf['offsetWrap']);
3110 if ($conf['offsetWrap.']['stdWrap.']) {
3111 $content = $this->stdWrap($content, $conf['offsetWrap.']['stdWrap.']);
3118 * Will execute a user function after the content has been modified by any other stdWrap function
3120 * @param string Input value undergoing processing in this function.
3121 * @param array stdWrap properties for postUserFunc.
3122 * @return string The processed input value
3124 public function stdWrap_postUserFunc($content = '', $conf = array()) {
3125 $content = $this->callUserFunction($conf['postUserFunc'], $conf['postUserFunc.'], $content);