tslib_cObj Class Reference

List of all members.

Public Member Functions
	start ($data, $table= '')
	__clone ()
	setParent ($data, $currentRecord)
	getCurrentVal ()
	setCurrentVal ($value)
	cObjGet ($setup, $addKey= '')
	cObjGetSingle ($name, $conf, $TSkey= '__')
	getContentObject ($name)
	HTML ($conf)
	TEXT ($conf)
	CLEARGIF ($conf)
	COBJ_ARRAY ($conf, $ext= '')
	USER ($conf, $ext= '')
	getUserObjectType ()
	setUserObjectType ($userObjectType)
	convertToUserIntObject ()
	FILE ($conf)
	IMAGE ($conf)
	IMG_RESOURCE ($conf)
	IMGTEXT ($conf)
	CONTENT ($conf)
	RECORDS ($conf)
	HMENU ($conf)
	CTABLE ($conf)
	OTABLE ($conf)
	COLUMNS ($conf)
	HRULER ($conf)
	CASEFUNC ($conf)
	LOAD_REGISTER ($conf, $name)
	FORM ($conf, $formData= '')
	SEARCHRESULT ($conf)
	PHP_SCRIPT ($conf, $ext= '')
	TEMPLATE ($conf)
	MULTIMEDIA ($conf)
	MEDIA ($conf)
	SWFOBJECT ($conf)
	QTOBJECT ($conf)
	SVG ($conf)
	readFlexformIntoConf ($flexData, &$conf, $recursive=FALSE)
	getSlidePids ($pidList, $pidConf)
	getFieldDefaultValue ($noValueInsert, $fieldName, $defaultVal)
	cImage ($file, $conf)
	getBorderAttr ($borderAttr)
	imageLinkWrap ($string, $imageFile, $conf)
	fileResource ($fName, $addParams= 'alt=""title=""')
	lastChanged ($tstamp)
	linkWrap ($content, $wrap)
	getAltParam ($conf, $longDesc=TRUE)
	cleanFormName ($name)
	getATagParams ($conf, $addGlobal=1)
	extLinkATagParams ($URL, $TYPE)
	getSubpart ($content, $marker)
	substituteSubpart ($content, $marker, $subpartContent, $recursive=1)
	substituteSubpartArray ($content, array $subpartsContent)
	substituteMarker ($content, $marker, $markContent)
	substituteMarkerArrayCached ($content, array $markContentArray=NULL, array $subpartContentArray=NULL, array $wrappedSubpartContentArray=NULL)
	substituteMarkerArray ($content, array $markContentArray, $wrap= '', $uppercase=FALSE, $deleteUnused=FALSE)
	substituteMarkerInObject (&$tree, array $markContentArray)
	fillInMarkerArray (array $markContentArray, array $row, $fieldList= '', $nl2br=TRUE, $prefix= 'FIELD_', $HSC=FALSE)
	stdWrap ($content= '', $conf=array())
	stdWrap_stdWrapPreProcess ($content= '', $conf=array())
	stdWrap_setContentToCurrent ($content= '', $conf=array())
	stdWrap_setCurrent ($content= '', $conf=array())
	stdWrap_lang ($content= '', $conf=array())
	stdWrap_data ($content= '', $conf=array())
	stdWrap_field ($content= '', $conf=array())
	stdWrap_current ($content= '', $conf=array())
	stdWrap_cObject ($content= '', $conf=array())
	stdWrap_numRows ($content= '', $conf=array())
	stdWrap_filelist ($content= '', $conf=array())
	stdWrap_preUserFunc ($content= '', $conf=array())
	stdWrap_stdWrapOverride ($content= '', $conf=array())
	stdWrap_override ($content= '', $conf=array())
	stdWrap_preIfEmptyListNum ($content= '', $conf=array())
	stdWrap_ifEmpty ($content= '', $conf=array())
	stdWrap_ifBlank ($content= '', $conf=array())
	stdWrap_listNum ($content= '', $conf=array())
	stdWrap_trim ($content= '', $conf=array())
	stdWrap_stdWrap ($content= '', $conf=array())
	stdWrap_stdWrapProcess ($content= '', $conf=array())
	stdWrap_required ($content= '', $conf=array())
	stdWrap_if ($content= '', $conf=array())
	stdWrap_fieldRequired ($content= '', $conf=array())
	stdWrap_csConv ($content= '', $conf=array())
	stdWrap_parseFunc ($content= '', $conf=array())
	stdWrap_HTMLparser ($content= '', $conf=array())
	stdWrap_split ($content= '', $conf=array())
	stdWrap_prioriCalc ($content= '', $conf=array())
	stdWrap_char ($content= '', $conf=array())
	stdWrap_intval ($content= '', $conf=array())
	stdWrap_numberFormat ($content= '', $conf=array())
	stdWrap_date ($content= '', $conf=array())
	stdWrap_strftime ($content= '', $conf=array())
	stdWrap_age ($content= '', $conf=array())
	stdWrap_case ($content= '', $conf=array())
	stdWrap_bytes ($content= '', $conf=array())
	stdWrap_substring ($content= '', $conf=array())
	stdWrap_removeBadHTML ($content= '', $conf=array())
	stdWrap_cropHTML ($content= '', $conf=array())
	stdWrap_stripHtml ($content= '', $conf=array())
	stdWrap_crop ($content= '', $conf=array())
	stdWrap_rawUrlEncode ($content= '', $conf=array())
	stdWrap_htmlSpecialChars ($content= '', $conf=array())
	stdWrap_doubleBrTag ($content= '', $conf=array())
	stdWrap_br ($content= '', $conf=array())
	stdWrap_brTag ($content= '', $conf=array())
	stdWrap_encapsLines ($content= '', $conf=array())
	stdWrap_keywords ($content= '', $conf=array())
	stdWrap_innerWrap ($content= '', $conf=array())
	stdWrap_innerWrap2 ($content= '', $conf=array())
	stdWrap_fontTag ($content= '', $conf=array())
	stdWrap_addParams ($content= '', $conf=array())
	stdWrap_textStyle ($content= '', $conf=array())
	stdWrap_tableStyle ($content= '', $conf=array())
	stdWrap_filelink ($content= '', $conf=array())
	stdWrap_preCObject ($content= '', $conf=array())
	stdWrap_postCObject ($content= '', $conf=array())
	stdWrap_wrapAlign ($content= '', $conf=array())
	stdWrap_typolink ($content= '', $conf=array())
	stdWrap_TCAselectItem ($content= '', $conf=array())
	stdWrap_spaceBefore ($content= '', $conf=array())
	stdWrap_spaceAfter ($content= '', $conf=array())
	stdWrap_space ($content= '', $conf=array())
	stdWrap_wrap ($content= '', $conf=array())
	stdWrap_noTrimWrap ($content= '', $conf=array())
	stdWrap_wrap2 ($content= '', $conf=array())
	stdWrap_dataWrap ($content= '', $conf=array())
	stdWrap_prepend ($content= '', $conf=array())
	stdWrap_append ($content= '', $conf=array())
	stdWrap_wrap3 ($content= '', $conf=array())
	stdWrap_outerWrap ($content= '', $conf=array())
	stdWrap_insertData ($content= '', $conf=array())
	stdWrap_offsetWrap ($content= '', $conf=array())
	stdWrap_postUserFunc ($content= '', $conf=array())
	stdWrap_postUserFuncInt ($content= '', $conf=array())
	stdWrap_prefixComment ($content= '', $conf=array())
	stdWrap_editIcons ($content= '', $conf=array())
	stdWrap_editPanel ($content= '', $conf=array())
	stdWrap_stdWrapPostProcess ($content= '', $conf=array())
	stdWrap_debug ($content= '', $conf=array())
	stdWrap_debugFunc ($content= '', $conf=array())
	stdWrap_debugData ($content= '', $conf=array())
	numRows ($conf)
	listNum ($content, $listNum, $char)
	checkIf ($conf)
	filelist ($data)
	clean_directory ($theDir)
	HTMLparser_TSbridge ($theValue, $conf)
	dataWrap ($content, $wrap)
	insertData ($str)
	prefixComment ($str, $conf, $content)
	substring ($content, $options)
	crop ($content, $options)
	cropHTML ($content, $options)
	removeBadHTML ($text, $conf)
	textStyle ($theValue, $conf)
	tableStyle ($theValue, $conf)
	addParams ($content, $conf)
	filelink ($theValue, $conf)
	locDataJU ($jumpUrl, $conf)
	calc ($val)
	calcIntExplode ($delim, $string)
	splitObj ($value, $conf)
	numberFormat ($content, $conf)
	parseFunc ($theValue, $conf, $ref= '')
	_parseFunc ($theValue, $conf)
	encaps_lineSplit ($theValue, $conf)
	http_makelinks ($data, $conf)
	mailto_makelinks ($data, $conf)
	getImgResource ($file, $fileArray)
	getFieldVal ($field)
	getData ($string, $fieldArray)
	rootLineValue ($key, $field, $slideBack=0, $altRootLine= '')
	getGlobal ($keyString, $source=NULL)
	getKey ($key, $arr)
	TCAlookup ($inputValue, $conf)
	typoLink ($linktxt, $conf)
	typoLink_URL ($conf)
	getTypoLink ($label, $params, $urlParameters=array(), $target= '')
	getTypoLink_URL ($params, $urlParameters=array(), $target= '')
	typolinkWrap ($conf)
	currentPageUrl ($urlParameters=array(), $id=0)
	getClosestMPvalueForPage ($pageId, $raw=FALSE)
	getMailTo ($mailAddress, $linktxt, $initP= '?')
	getQueryArguments ($conf, $overruleQueryArguments=array(), $forceOverruleArguments=FALSE)
	wrap ($content, $wrap, $char= '|')
	noTrimWrap ($content, $wrap)
	wrapSpace ($content, $wrap, array $conf=NULL)
	callUserFunction ($funcName, $conf, $content)
	processParams ($params)
	keywords ($content)
	caseshift ($theValue, $case)
	HTMLcaseshift ($theValue, $case)
	calcAge ($seconds, $labels)
	sendNotifyEmail ($msg, $recipients, $cc, $email_from, $email_fromName= '', $replyTo= '')
	URLqMark ($url, $params)
	clearTSProperties ($TSArr, $propList)
	mergeTSRef ($confArr, $prop)
	joinTSarrays ($conf, $old_conf)
	gifBuilderTextBox ($gifbuilderConf, $conf, $text)
	linebreaks ($string, $chars, $maxLines=0)
	getUpdateJS ($dataArray, $formName, $arrPrefix, $fieldList)
	includeLibs (array $config)
	DBgetDelete ($table, $uid, $doExec=FALSE)
	DBgetUpdate ($table, $uid, $dataArr, $fieldList, $doExec=FALSE)
	DBgetInsert ($table, $pid, $dataArr, $fieldList, $doExec=FALSE)
	DBmayFEUserEdit ($table, $row, $feUserRow, $allowedGroups= '', $feEditSelf=0)
	DBmayFEUserEditSelect ($table, $feUserRow, $allowedGroups= '', $feEditSelf=0)
	enableFields ($table, $show_hidden=0)
	getTreeList ($id, $depth, $begin=0, $dontCheckEnableFields=FALSE, $addSelectFields= '', $moreWhereClauses= '', array $prevId_array=array(), $recursionLevel=0)
	exec_mm_query ($select, $local_table, $mm_table, $foreign_table, $whereClause= '', $groupBy= '', $orderBy= '', $limit= '')
	exec_mm_query_uidList ($select, $local_table_uidlist, $mm_table, $foreign_table= '', $whereClause= '', $groupBy= '', $orderBy= '', $limit= '')
	searchWhere ($sw, $searchFieldList, $searchTable= '')
	exec_getQuery ($table, $conf)
	getQuery ($table, $conf, $returnQueryArray=FALSE)
	getWhere ($table, $conf, $returnQueryArray=FALSE)
	checkPidArray ($listArr)
	checkPid ($uid)
	getQueryMarkers ($table, $conf)
	editPanel ($content, $conf, $currentRecord= '', $dataArr=array())
	editIcons ($content, $params, array $conf=array(), $currentRecord= '', $dataArr=array(), $addUrlParamStr= '')
	isDisabled ($table, $row)
Public Attributes
	$align
	$stdWrapOrder
	$image_compression
	$image_effects
	$data = array()
	$oldData = array()
	$alternativeData = ''
	$parameters = array()
	$currentValKey = 'currentValue_kidjls9dksoje'
	$currentRecord = ''
	$currentRecordTotal = 0
	$currentRecordNumber = 0
	$parentRecordNumber = 0
	$parentRecord = array()
	$regObj
	$INT_include = 0
	$checkPid_cache = array()
	$checkPid_badDoktypeList = '255'
	$lastTypoLinkUrl = ''
	$lastTypoLinkTarget = ''
	$lastTypoLinkLD = array()
	$substMarkerCache = array()
	$recordRegister = array()
	$cObjHookObjectsArr = array()
	$doConvertToUserIntObject = FALSE
const	OBJECTTYPE_USER_INT = 1
const	OBJECTTYPE_USER = 2
Protected Member Functions
	getGetImgResourceHookObjects ()
	FLUIDTEMPLATE (array $conf)
	modifyImageMagickStripProfileParameters ($parameters, array $configuration)
	forceAbsoluteUrl ($url, array $configuration)
	isClassAvailable ($className, array $config=NULL)
Protected Attributes
	$table = ''
	$stdWrapHookObjects = array()
	$getImgResourceHookObjects
	$contentObjects = array()
	$userObjectType = FALSE

---

Detailed Description

Definition at line 232 of file class.tslib_content.php.

---

Member Function Documentation

tslib_cObj::__clone

(

)

Clone helper.

Resets the references to the TypoScript Content Object implementation objects of tslib_content_*. Otherwise they would still point to the original tslib_cObj instance's tslib_content_* instances, they in return would back-reference to the original tslib_cObj instance instead of the newly cloned tslib_cObj instance.

See also:

http://bugs.typo3.org/view.php?id=16568

Definition at line 620 of file class.tslib_content.php.

tslib_cObj::_parseFunc	(	$	theValue,
		$	conf
	)

Helper function for parseFunc()

Parameters:

string	The value to process.
array	TypoScript configuration for parseFunc

Returns:

string The processed value private

See also:

parseFunc()

Definition at line 4432 of file class.tslib_content.php.

References $currentValKey, $data, $GLOBALS, callUserFunction(), checkIf(), cObjGetSingle(), t3lib_div\get_tag_attributes(), http_makelinks(), t3lib_div\inList(), mailto_makelinks(), stdWrap(), and wrap().

Referenced by parseFunc().

tslib_cObj::addParams	(	$	content,
		$	conf
	)

Implements the TypoScript function "addParams"

Parameters:

string	The string with the HTML tag.
array	The TypoScript configuration properties

Returns:

string The modified string

Todo:

Make it XHTML compatible. Will not present "/>" endings of tags right now. Further getting the tagname might fail if it is not separated by a normal space from the attributes.

Definition at line 3944 of file class.tslib_content.php.

References $content, t3lib_div\get_tag_attributes(), t3lib_div\implodeAttributes(), and stdWrap().

Referenced by stdWrap_addParams().

tslib_cObj::calc

(

$

val

)

Performs basic mathematical evaluation of the input string. Does NOT take parathesis and operator precedence into account! (for that, see t3lib_div::calcPriority())

Parameters:

string

The string to evaluate. Example: "3+4*10/5" will generate "35". Only integer numbers can be used.

Returns:

integer The result (might be a float if you did a division of the numbers).

See also:

t3lib_div::calcPriority()

Definition at line 4155 of file class.tslib_content.php.

References $value, and t3lib_div\splitCalc().

Referenced by calcIntExplode(), checkIf(), listNum(), and tslib_menu\makeMenu().

tslib_cObj::calcAge	(	$	seconds,
		$	labels
	)

Returns the 'age' of the tstamp $seconds

Parameters:

	integer	Seconds to return age for. Example: "70" => "1 min", "3601" => "1 hrs"
string	$labels	are the labels of the individual units. Defaults to : ' min| hrs| days| yrs'

Returns:

string The formatted string

Definition at line 6438 of file class.tslib_content.php.

References t3lib_div\testInt().

Referenced by stdWrap_age().

tslib_cObj::calcIntExplode	(	$	delim,
		$	string
	)

This explodes a comma-list into an array where the values are parsed through tslib_cObj::calc() and intval() (so you are sure to have integers in the output array) Used to split and calculate min and max values for GMENUs.

Parameters:

string	Delimited to explode by
string	The string with parts in (where each part is evaluated by ->calc())

Returns:

array And array with evaluated values.

See also:

calc(), tslib_gmenu::makeGifs()

Definition at line 4192 of file class.tslib_content.php.

References calc().

tslib_cObj::callUserFunction	(	$	funcName,
		$	conf,
		$	content
	)

Calling a user function/class-method Notice: For classes the instantiated object will have the internal variable, $cObj, set to be a reference to $this (the parent/calling object).

Parameters:

string	The functionname, eg "user_myfunction" or "user_myclass->main". Notice that there are rules for the names of functions/classes you can instantiate. If a function cannot be called for some reason it will be seen in the TypoScript log in the AdminPanel.
array	The TypoScript configuration to pass the function
string	The content string to pass the function

Returns:

string The return content from the function call. Should probably be a string.

See also:

USER(), stdWrap(), typoLink(), _parseFunc()

Definition at line 6314 of file class.tslib_content.php.

References $content, $GLOBALS, isClassAvailable(), t3lib_div\isFirstPartOfStr(), and t3lib_div\makeInstance().

Referenced by _parseFunc(), stdWrap_postUserFunc(), stdWrap_preUserFunc(), and typoLink().

tslib_cObj::CASEFUNC

(

$

conf

)

Rendering the cObject, CASE

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1079 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::caseshift	(	$	theValue,
		$	case
	)

Changing character case of a string, converting typically used western charset characters as well.

Parameters:

string	The string to change case for.
string	The direction; either "upper" or "lower"

Returns:

string

See also:

HTMLcaseshift()

Definition at line 6390 of file class.tslib_content.php.

References $GLOBALS.

Referenced by HTMLcaseshift().

tslib_cObj::checkIf

(

$

conf

)

Compares values together based on the settings in the input TypoScript array and returns TRUE or FALSE based on the comparison result. Implements the "if" function in TYPO3 TypoScript

Parameters:

array

TypoScript properties defining what to compare

Returns:

boolean

See also:

HMENU(), CASEFUNC(), IMAGE(), COLUMN(), stdWrap(), _parseFunc()

Definition at line 3306 of file class.tslib_content.php.

References $value, calc(), t3lib_div\inList(), and stdWrap().

Referenced by _parseFunc(), and stdWrap_if().

tslib_cObj::checkPid

(

$

uid

)

Checks if a page UID is available due to enableFields() AND the list of bad doktype numbers ($this->checkPid_badDoktypeList)

Parameters:

integer

Page UID to test

Returns:

boolean True if OK private

See also:

getWhere(), checkPidArray()

Definition at line 7580 of file class.tslib_content.php.

References $GLOBALS.

tslib_cObj::checkPidArray

(

$

listArr

)

Removes Page UID numbers from the input array which are not available due to enableFields() or the list of bad doktype numbers ($this->checkPid_badDoktypeList)

Parameters:

array

array of Page UID numbers for select and for which pages with enablefields and bad doktypes should be removed.

Returns:

array Returns the array of remaining page UID numbers private

See also:

getWhere(),checkPid()

Definition at line 7551 of file class.tslib_content.php.

References $GLOBALS, $res, and $row.

Referenced by getSlidePids().

tslib_cObj::cImage	(	$	file,
		$	conf
	)

Returns a tag with the image file defined by $file and processed according to the properties in the TypoScript array. Mostly this function is a sub-function to the IMAGE function which renders the IMAGE cObject in TypoScript. This function is called by "$this->cImage($conf['file'],$conf);" from IMAGE().

Parameters:

string	File TypoScript resource
array	TypoScript configuration properties

Returns:

string tag, (possibly wrapped in links and other HTML) if any image found. private

See also:

IMAGE()

Definition at line 1318 of file class.tslib_content.php.

References $GLOBALS, getAltParam(), getBorderAttr(), getImgResource(), imageLinkWrap(), linkWrap(), t3lib_div\png_to_gif_by_imagemagick(), t3lib_div\rawUrlEncodeFP(), stdWrap(), and wrap().

tslib_cObj::clean_directory

(

$

theDir

)

Cleans $theDir for slashes in the end of the string and returns the new path, if it exists on the server.

Parameters:

string

Absolute path to directory

Returns:

string The directory path if it existed as was valid to access. private

See also:

filelist()

Definition at line 3477 of file class.tslib_content.php.

References t3lib_div\isAbsPath(), and t3lib_div\validPathStr().

Referenced by filelist().

tslib_cObj::cleanFormName

(

$

name

)

Removes forbidden characters and spaces from name/id attributes in the form tag and formfields

Parameters:

string

Input string

Returns:

string the cleaned string

See also:

FORM()

Definition at line 1632 of file class.tslib_content.php.

tslib_cObj::CLEARGIF

(

$

conf

)

Rendering the cObject, CLEARGIF

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 892 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::clearTSProperties	(	$	TSArr,
		$	propList
	)

Clears TypoScript properties listed in $propList from the input TypoScript array.

Parameters:

array	TypoScript array of values/properties
string	List of properties to clear both value/properties for. Eg. "myprop,another_property"

Returns:

array The TypoScript array

See also:

gifBuilderTextBox()

Definition at line 6527 of file class.tslib_content.php.

Referenced by gifBuilderTextBox().

tslib_cObj::COBJ_ARRAY	(	$	conf,
		$	ext = ''
	)

Rendering the cObject, COBJ_ARRAY / COA and COBJ_ARRAY_INT

Parameters:

array	array of TypoScript properties
string	If "INT" then the cObject is a "COBJ_ARRAY_INT" (non-cached), otherwise just "COBJ_ARRAY" (cached)

Returns:

string Output

Definition at line 903 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::cObjGet	(	$	setup,
		$	addKey = ''
	)

Rendering of a "numerical array" of cObjects from TypoScript Will call ->cObjGetSingle() for each cObject found and accumulate the output.

Parameters:

array	$setup,:	array with cObjects as values.
string	$addKey,:	A prefix for the debugging information

Returns:

string Rendered output from the cObjects in the array.

See also:

cObjGetSingle()

Definition at line 709 of file class.tslib_content.php.

References $content, cObjGetSingle(), and t3lib_TStemplate\sortedKeyList().

Referenced by splitObj().

tslib_cObj::cObjGetSingle	(	$	name,
		$	conf,
		$	TSkey = '__'
	)

Renders a content object

Parameters:

string	The content object name, eg. "TEXT" or "USER" or "IMAGE"
array	The array with TypoScript properties for the content object
string	A string label used for the internal debugging tracking.

Returns:

string cObject output

Definition at line 732 of file class.tslib_content.php.

References $content, $GLOBALS, $TYPO3_CONF_VARS, getContentObject(), t3lib_div\getUserObj(), joinTSarrays(), and t3lib_div\makeInstance().

Referenced by _parseFunc(), cObjGet(), filelink(), stdWrap_append(), stdWrap_cObject(), stdWrap_postCObject(), stdWrap_preCObject(), and stdWrap_prepend().

tslib_cObj::COLUMNS

(

$

conf

)

Rendering the cObject, COLUMNS

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1059 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::CONTENT

(

$

conf

)

Rendering the cObject, CONTENT

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1009 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::convertToUserIntObject

(

)

Requests the current USER object to be converted to USER_INT.

Returns:

void

Definition at line 953 of file class.tslib_content.php.

References $GLOBALS.

tslib_cObj::crop	(	$	content,
		$	options
	)

Implements the stdWrap property "crop" which is a modified "substr" function allowing to limit a string lenght to a certain number of chars (from either start or end of string) and having a pre/postfix applied if the string really was cropped.

Parameters:

string	The string to perform the operation on
string	The parameters splitted by "|": First parameter is the max number of chars of the string. Negative value means cropping from end of string. Second parameter is the pre/postfix string to apply if cropping occurs. Third parameter is a boolean value. If set then crop will be applied at nearest space.

Returns:

string The processed input value. private

See also:

stdWrap()

Definition at line 3591 of file class.tslib_content.php.

References $content, and $GLOBALS.

Referenced by stdWrap_crop().

tslib_cObj::cropHTML	(	$	content,
		$	options
	)

Implements the stdWrap property "cropHTML" which is a modified "substr" function allowing to limit a string length to a certain number of chars (from either start or end of string) and having a pre/postfix applied if the string really was cropped.

Compared to stdWrap.crop it respects HTML tags and entities.

Parameters:

string	The string to perform the operation on
string	The parameters splitted by "|": First parameter is the max number of chars of the string. Negative value means cropping from end of string. Second parameter is the pre/postfix string to apply if cropping occurs. Third parameter is a boolean value. If set then crop will be applied at nearest space.

Returns:

string The processed input value. private

See also:

stdWrap()

Definition at line 3630 of file class.tslib_content.php.

References $content, and $GLOBALS.

Referenced by stdWrap_cropHTML().

tslib_cObj::CTABLE

(

$

conf

)

Rendering the cObject, CTABLE

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1039 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::currentPageUrl	(	$	urlParameters = array(),
		$	id = 0
	)

Returns the current page URL

Parameters:

array	Optionally you can specify additional URL parameters. An array with key/value pairs representing URL parameters to set. Values NOT URL-encoded yet.
integer	An alternative ID to the current id ($GLOBALS['TSFE']->id)

Returns:

string The URL

See also:

getTypoLink_URL()

Definition at line 6073 of file class.tslib_content.php.

References $GLOBALS, and getTypoLink_URL().

tslib_cObj::dataWrap	(	$	content,
		$	wrap
	)

Wrapping input value in a regular "wrap" but parses the wrapping value first for "insertData" codes.

Parameters:

string	Input string being wrapped
string	The wrap string, eg. "<strong></strong>" or more likely here '| ' which will wrap the input string in a tag linking to the current page.

Returns:

string Output string wrapped in the wrapping value.

See also:

insertData(), stdWrap()

Definition at line 3508 of file class.tslib_content.php.

References $content, insertData(), and wrap().

Referenced by stdWrap_dataWrap().

tslib_cObj::DBgetDelete	(	$	table,
		$	uid,
		$	doExec = FALSE
	)

Returns an UPDATE/DELETE sql query which will "delete" the record. If the $TCA config for the table tells us to NOT "physically" delete the record but rather set the "deleted" field to "1" then an UPDATE query is returned doing just that. Otherwise it truely is a DELETE query.

Parameters:

string	The table name, should be in $TCA
integer	The UID of the record from $table which we are going to delete
boolean	If set, the query is executed. IT'S HIGHLY RECOMMENDED TO USE THIS FLAG to execute the query directly!!!

Returns:

string The query, ready to execute unless $doExec was TRUE in which case the return value is FALSE.

See also:

DBgetUpdate(), DBgetInsert(), user_feAdmin

Definition at line 6770 of file class.tslib_content.php.

References $GLOBALS, and $table.

tslib_cObj::DBgetInsert	(	$	table,
		$	pid,
		$	dataArr,
		$	fieldList,
		$	doExec = FALSE
	)

Returns an INSERT sql query which automatically added "system-fields" according to $TCA Automatically fields for "tstamp", "crdate", "cruser_id", "fe_cruser_id" and "fe_crgroup_id" is updated if they are configured in the "ctrl" part of $TCA. The "pid" field is overridden by the input $pid value if >= 0 (zero). "uid" can never be set as a field NOTICE: From TYPO3 3.6.0 this function ALWAYS adds slashes to values inserted in the query.

Parameters:

string	The table name, should be in $TCA
integer	The PID value for the record to insert
array	The data array where key/value pairs are fieldnames/values for the record to insert
string	Comma list of fieldnames which are allowed to be inserted. Only values from the data record for fields in this list will be inserted!!
boolean	If set, the query is executed. IT'S HIGHLY RECOMMENDED TO USE THIS FLAG to execute the query directly!!!

Returns:

string The query, ready to execute unless $doExec was TRUE in which case the return value is FALSE.

See also:

DBgetUpdate(), DBgetDelete(), user_feAdmin

Definition at line 6848 of file class.tslib_content.php.

References $GLOBALS, $pid, $table, t3lib_div\inList(), and t3lib_div\trimExplode().

tslib_cObj::DBgetUpdate	(	$	table,
		$	uid,
		$	dataArr,
		$	fieldList,
		$	doExec = FALSE
	)

Returns an UPDATE sql query. If a "tstamp" field is configured for the $table tablename in $TCA then that field is automatically updated to the current time. Notice: It is YOUR responsibility to make sure the data being updated is valid according the tablefield types etc. Also no logging is performed of the update. It's just a nice general usage API function for creating a quick query. NOTICE: From TYPO3 3.6.0 this function ALWAYS adds slashes to values inserted in the query.

Parameters:

string	The table name, should be in $TCA
integer	The UID of the record from $table which we are going to update
array	The data array where key/value pairs are fieldnames/values for the record to update.
string	Comma list of fieldnames which are allowed to be updated. Only values from the data record for fields in this list will be updated!!
boolean	If set, the query is executed. IT'S HIGHLY RECOMMENDED TO USE THIS FLAG to execute the query directly!!!

Returns:

string The query, ready to execute unless $doExec was TRUE in which case the return value is FALSE.

See also:

DBgetInsert(), DBgetDelete(), user_feAdmin

Definition at line 6806 of file class.tslib_content.php.

References $GLOBALS, $table, t3lib_div\inList(), and t3lib_div\trimExplode().

tslib_cObj::DBmayFEUserEdit	(	$	table,
		$	row,
		$	feUserRow,
		$	allowedGroups = '',
		$	feEditSelf = 0
	)

Checks if a frontend user is allowed to edit a certain record

Parameters:

string	The table name, found in $TCA
array	The record data array for the record in question
array	The array of the fe_user which is evaluated, typ. $GLOBALS['TSFE']->fe_user->user
string	Commalist of the only fe_groups uids which may edit the record. If not set, then the usergroup field of the fe_user is used.
boolean	True, if the fe_user may edit his own fe_user record.

Returns:

boolean

See also:

user_feAdmin

Definition at line 6908 of file class.tslib_content.php.

References $GLOBALS, $row, $table, t3lib_div\inList(), and t3lib_div\trimExplode().

tslib_cObj::DBmayFEUserEditSelect	(	$	table,
		$	feUserRow,
		$	allowedGroups = '',
		$	feEditSelf = 0
	)

Returns part of a where clause for selecting records from the input table name which the user may edit. Conceptually close to the function DBmayFEUserEdit(); It does the same thing but not for a single record, rather for a select query selecting all records which the user HAS access to.

Parameters:

string	The table name
array	The array of the fe_user which is evaluated, typ. $GLOBALS['TSFE']->fe_user->user
string	Commalist of the only fe_groups uids which may edit the record. If not set, then the usergroup field of the fe_user is used.
boolean	True, if the fe_user may edit his own fe_user record.

Returns:

string The where clause part. ALWAYS returns a string. If no access at all, then " AND 1=0"

See also:

DBmayFEUserEdit(), user_feAdmin::displayEditScreen()

Definition at line 6954 of file class.tslib_content.php.

References $GLOBALS, $table, t3lib_div\intExplode(), and t3lib_div\trimExplode().

tslib_cObj::editIcons	(	$	content,
		$	params,
		array $	conf = array(),
		$	currentRecord = '',
		$	dataArr = array(),
		$	addUrlParamStr = ''
	)

Adds an edit icon to the content string. The edit icon links to alt_doc.php with proper parameters for editing the table/fields of the context. This implements TYPO3 context sensitive editing facilities. Only backend users will have access (if properly configured as well).

Parameters:

string	The content to which the edit icons should be appended
string	The parameters defining which table and fields to edit. Syntax is [tablename]:[fieldname],[fieldname],[fieldname],... OR [fieldname],[fieldname],[fieldname],... (basically "[tablename]:" is optional, default table is the one of the "current record" used in the function). The fieldlist is sent as "&columnsOnly=" parameter to alt_doc.php
array	TypoScript properties for configuring the edit icons.
string	The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
array	Alternative data array to use. Default is $this->data
string	Additional URL parameters for the link pointing to alt_doc.php

Returns:

string The input content string, possibly with edit icons added (not necessarily in the end but just after the last string of normal content.

Definition at line 7716 of file class.tslib_content.php.

References $content, and $GLOBALS.

Referenced by stdWrap_editIcons().

tslib_cObj::editPanel	(	$	content,
		$	conf,
		$	currentRecord = '',
		$	dataArr = array()
	)

Generates the "edit panels" which can be shown for a page or records on a page when the Admin Panel is enabled for a backend users surfing the frontend. With the "edit panel" the user will see buttons with links to editing, moving, hiding, deleting the element This function is used for the cObject EDITPANEL and the stdWrap property ".editPanel"

Parameters:

string	A content string containing the content related to the edit panel. For cObject "EDITPANEL" this is empty but not so for the stdWrap property. The edit panel is appended to this string and returned.
array	TypoScript configuration properties for the editPanel
string	The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
array	Alternative data array to use. Default is $this->data

Returns:

string The input content string with the editPanel appended. This function returns only an edit panel appended to the content string if a backend user is logged in (and has the correct permissions). Otherwise the content string is directly returned.

Definition at line 7686 of file class.tslib_content.php.

References $content, and $GLOBALS.

Referenced by stdWrap_editPanel().

tslib_cObj::enableFields	(	$	table,
		$	show_hidden = 0
	)

Returns a part of a WHERE clause which will filter out records with start/end times or hidden/fe_groups fields set to values that should de-select them according to the current time, preview settings or user login. Definitely a frontend function. THIS IS A VERY IMPORTANT FUNCTION: Basically you must add the output from this function for EVERY select query you create for selecting records of tables in your own applications - thus they will always be filtered according to the "enablefields" configured in TCA Simply calls t3lib_pageSelect::enableFields() BUT will send the show_hidden flag along! This means this function will work in conjunction with the preview facilities of the frontend engine/Admin Panel.

Parameters:

string	The table for which to get the where clause
boolean	If set, then you want NOT to filter out hidden records. Otherwise hidden record are filtered based on the current preview settings.

Returns:

string The part of the where clause on the form " AND [fieldname]=0 AND ...". Eg. " AND hidden=0 AND starttime < 123345567"

See also:

t3lib_pageSelect::enableFields()

Definition at line 7001 of file class.tslib_content.php.

References $GLOBALS, and $table.

Referenced by tslib_menu\makeMenu(), and typoLink().

tslib_cObj::encaps_lineSplit	(	$	theValue,
		$	conf
	)

Lets you split the content by LF and proces each line independently. Used to format content made with the RTE.

Parameters:

string	The input value
array	TypoScript options

Returns:

string The processed input value being returned; Splitted lines imploded by LF again. private

Definition at line 4655 of file class.tslib_content.php.

References t3lib_div\get_tag_attributes(), t3lib_div\implodeAttributes(), t3lib_div\revExplode(), stdWrap(), t3lib_div\trimExplode(), and wrap().

Referenced by stdWrap_encapsLines().

tslib_cObj::exec_getQuery	(	$	table,
		$	conf
	)

Executes a SELECT query for records from $table and with conditions based on the configuration in the $conf array This function is preferred over ->getQuery() if you just need to create and then execute a query.

Parameters:

string	The table name
array	The TypoScript configuration properties

Returns:

mixed A SQL result pointer

See also:

getQuery()

Definition at line 7308 of file class.tslib_content.php.

References $GLOBALS.

Referenced by numRows().

tslib_cObj::exec_mm_query	(	$	select,
		$	local_table,
		$	mm_table,
		$	foreign_table,
		$	whereClause = '',
		$	groupBy = '',
		$	orderBy = '',
		$	limit = ''
	)

Executes a SELECT query for joining three tables according to the MM-relation standards used for tables configured in $TCA. That means MM-joins where the join table has the fields "uid_local" and "uid_foreign"

Parameters:

string	List of fields to select
string	The local table
string	The join-table; The "uid_local" field of this table will be matched with $local_table's "uid" field.
string	Optionally: The foreign table; The "uid" field of this table will be matched with $mm_table's "uid_foreign" field. If you set this field to blank the join will be over only the $local_table and $mm_table
string	Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
string	Optional GROUP BY field(s), if none, supply blank string.
string	Optional ORDER BY field(s), if none, supply blank string.
string	Optional LIMIT value ([begin,]max), if none, supply blank string.

Returns:

pointer SQL result pointer

See also:

mm_query_uidList()

Definition at line 7223 of file class.tslib_content.php.

tslib_cObj::exec_mm_query_uidList	(	$	select,
		$	local_table_uidlist,
		$	mm_table,
		$	foreign_table = '',
		$	whereClause = '',
		$	groupBy = '',
		$	orderBy = '',
		$	limit = ''
	)

Executes a SELECT query for joining two tables according to the MM-relation standards used for tables configured in $TCA. That means MM-joins where the join table has the fields "uid_local" and "uid_foreign" The two tables joined is the join table ($mm_table) and the foreign table ($foreign_table) - so the "local table" is not included but instead you can supply a list of UID integers from the local table to match in the join-table.

Parameters:

string	List of fields to select
string	List of UID integers, eg. "1,2,3,456"
string	The join-table; The "uid_local" field of this table will be matched with the list of UID numbers from $local_table_uidlist
string	Optionally: The foreign table; The "uid" field of this table will be matched with $mm_table's "uid_foreign" field. If you set this field to blank only records from the $mm_table is returned. No join performed.
string	Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
string	Optional GROUP BY field(s), if none, supply blank string.
string	Optional ORDER BY field(s), if none, supply blank string.
string	Optional LIMIT value ([begin,]max), if none, supply blank string.

Returns:

pointer SQL result pointer

See also:

mm_query()

Definition at line 7251 of file class.tslib_content.php.

tslib_cObj::extLinkATagParams	(	$	URL,
		$	TYPE
	)

All extension links should ask this function for additional properties to their tags. Designed to add for instance an "onclick" property for site tracking systems.

Parameters:

string

URL of the website

Returns:

string the additional tag properties

Definition at line 1668 of file class.tslib_content.php.

References $GLOBALS, and t3lib_div\getUserObj().

Referenced by http_makelinks(), and typoLink().

tslib_cObj::FILE

(

$

conf

)

Rendering the cObject, FILE

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 967 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::filelink	(	$	theValue,
		$	conf
	)

Creates a list of links to files. Implements the stdWrap property "filelink"

Parameters:

string	The filename to link to, possibly prefixed with $conf[path]
array	TypoScript parameters for the TypoScript function ->filelink

Returns:

string The link to the file possibly with icons, thumbnails, size in bytes shown etc. private

See also:

stdWrap()

Definition at line 3994 of file class.tslib_content.php.

References $GLOBALS, cObjGetSingle(), getAltParam(), getATagParams(), getBorderAttr(), t3lib_div\inList(), locDataJU(), t3lib_div\shortMD5(), t3lib_extMgm\siteRelPath(), t3lib_div\split_fileref(), stdWrap(), typoLink(), and wrap().

Referenced by stdWrap_filelink().

tslib_cObj::filelist

(

$

data

)

Reads a directory for files and returns the filepaths in a string list separated by comma. Implements the stdWrap property "filelist"

Parameters:

string

The command which contains information about what files/directory listing to return. See the "filelist" property of stdWrap for details.

Returns:

string Comma list of files. private

See also:

stdWrap()

Definition at line 3391 of file class.tslib_content.php.

References $data, $GLOBALS, $items, clean_directory(), t3lib_div\inList(), t3lib_div\isFirstPartOfStr(), t3lib_div\split_fileref(), and t3lib_div\uniqueList().

Referenced by stdWrap_filelist().

tslib_cObj::fileResource	(	$	fName,
		$	addParams = 'alt="" title=""'
	)

Returns content of a file. If it's an image the content of the file is not returned but rather an image tag is.

Parameters:

string	The filename, being a TypoScript resource data type
string	Additional parameters (attributes). Default is empty alt and title tags.

Returns:

string If jpg,gif,jpeg,png: returns image_tag with picture in. If html,txt: returns content string

See also:

FILE()

Definition at line 1531 of file class.tslib_content.php.

References $GLOBALS, getBorderAttr(), t3lib_div\inList(), and t3lib_div\split_fileref().

tslib_cObj::fillInMarkerArray	(	array $	markContentArray,
		array $	row,
		$	fieldList = '',
		$	nl2br = TRUE,
		$	prefix = 'FIELD_',
		$	HSC = FALSE
	)

Adds elements to the input $markContentArray based on the values from the fields from $fieldList found in $row

Parameters:

array	array with key/values being marker-strings/substitution values.
array	An array with keys found in the $fieldList (typically a record) which values should be moved to the $markContentArray
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)
boolean	If set, all values added to $markContentArray will be nl2br()'ed
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 "###"
boolean	If set, all values are passed through htmlspecialchars() - RECOMMENDED to avoid most obvious XSS and maintain XHTML compliance.

Returns:

array The modified $markContentArray

Definition at line 1934 of file class.tslib_content.php.

References $value, t3lib_div\testInt(), and t3lib_div\trimExplode().

tslib_cObj::FLUIDTEMPLATE

(

array $

conf

)

[protected]

Rendering the cObject, FLUIDTEMPLATE

Parameters:

array

array of TypoScript properties

Returns:

string the HTML output

Author:

Steffen Ritter info@.nosp@m.stef.nosp@m.fen-r.nosp@m.itte.nosp@m.r.net

Benjamin Mack benni.nosp@m.@typ.nosp@m.o3.or.nosp@m.g

Definition at line 1155 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::forceAbsoluteUrl	(	$	url,
		array $	configuration
	)		[protected]

Forces a given URL to be absolute.

Parameters:

string	$url	The URL to be forced to be absolute
array	$configuration	TypoScript configuration of typolink

Returns:

string The absolute URL

Definition at line 5961 of file class.tslib_content.php.

References t3lib_div\getIndpEnv().

Referenced by typoLink().

tslib_cObj::FORM	(	$	conf,
		$	formData = ''
	)

Rendering the cObject, FORM

Parameters:

array	array of TypoScript properties
array	Alternative formdata overriding whatever comes from TypoScript

Returns:

string Output

Definition at line 1106 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::getAltParam	(	$	conf,
		$	longDesc = TRUE
	)

An abstraction method which creates an alt or title parameter for an HTML img, applet, area or input element and the FILE content element. From the $conf array it implements the properties "altText", "titleText" and "longdescURL"

Parameters:

array	TypoScript configuration properties
boolean	If set, the longdesc attribute will be generated - must only be used for img elements!

Returns:

string Parameter string containing alt and title parameters (if any)

See also:

IMGTEXT(), FILE(), FORM(), cImage(), filelink()

Definition at line 1591 of file class.tslib_content.php.

References stdWrap().

Referenced by cImage(), and filelink().

tslib_cObj::getATagParams	(	$	conf,
		$	addGlobal = 1
	)

An abstraction method to add parameters to an A tag. Uses the ATagParams property.

Parameters:

array	TypoScript configuration properties
boolean	If set, will add the global config.ATagParams to the link

Returns:

string String containing the parameters to the A tag (if non empty, with a leading space)

See also:

IMGTEXT(), filelink(), makelinks(), typolink()

Definition at line 1648 of file class.tslib_content.php.

References $GLOBALS, and stdWrap().

Referenced by filelink(), http_makelinks(), mailto_makelinks(), and typoLink().

tslib_cObj::getBorderAttr

(

$

borderAttr

)

Returns the 'border' attribute for an tag only if the doctype is not xhtml_strict, xhtml_11, xhtml_2 or html5 or if the config parameter 'disableImgBorderAttr' is not set.

Parameters:

string

the border attribute

Returns:

string the border attribute

Definition at line 1377 of file class.tslib_content.php.

References $GLOBALS, and t3lib_div\inList().

Referenced by cImage(), filelink(), fileResource(), and wrapSpace().

tslib_cObj::getClosestMPvalueForPage	(	$	pageId,
		$	raw = FALSE
	)

Returns the &MP variable value for a page id. The function will do its best to find a MP value that will keep the page id inside the current Mount Point rootline if any.

Parameters:

integer	page id
boolean	If TRUE, the MPvalue is returned raw. Normally it is encoded as &MP=... variable

Returns:

string MP value, prefixed with &MP= (depending on $raw)

See also:

typolink()

Definition at line 6086 of file class.tslib_content.php.

References $GLOBALS.

Referenced by typoLink().

tslib_cObj::getContentObject

(

$

name

)

Returns a new content object of type $name.

Parameters:

string

$name

Returns:

tslib_content_abstract

Definition at line 808 of file class.tslib_content.php.

References t3lib_div\makeInstance().

Referenced by CASEFUNC(), CLEARGIF(), COBJ_ARRAY(), cObjGetSingle(), COLUMNS(), CONTENT(), CTABLE(), FILE(), FLUIDTEMPLATE(), FORM(), HMENU(), HRULER(), HTML(), IMAGE(), IMG_RESOURCE(), IMGTEXT(), LOAD_REGISTER(), MEDIA(), MULTIMEDIA(), OTABLE(), PHP_SCRIPT(), QTOBJECT(), RECORDS(), SEARCHRESULT(), SVG(), SWFOBJECT(), TEMPLATE(), TEXT(), and USER().

tslib_cObj::getCurrentVal

(

)

Returns the "current" value. 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. It's like "load accumulator" in the good old C64 days... basically a "register" you can use as you like. 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.

Returns:

mixed The "current" value

Definition at line 685 of file class.tslib_content.php.

References $currentValKey.

tslib_cObj::getData	(	$	string,
		$	fieldArray
	)

Implements the TypoScript data type "getText". This takes a string with parameters and based on those a value from somewhere in the system is returned.

Parameters:

string	The parameter string, eg. "field : title" or "field : navtitle // field : title" (in the latter case and example of how the value is FIRST splitted by "//" is shown)
mixed	Alternative field array; If you set this to an array this variable will be used to look up values for the "field" key. Otherwise the current page record in $GLOBALS['TSFE']->page is used.

Returns:

string The value fetched

See also:

getFieldVal()

Definition at line 5150 of file class.tslib_content.php.

References $currentValKey, $GLOBALS, $parentRecordNumber, $TYPO3_CONF_VARS, t3lib_div\_GET(), t3lib_div\_POST(), t3lib_div\array_merge_recursive_overrule(), t3lib_div\deprecationLog(), getGlobal(), t3lib_div\getIndpEnv(), getKey(), t3lib_div\getUserObj(), rootLineValue(), t3lib_div\trimExplode(), and t3lib_utility_Debug\viewArray().

Referenced by insertData(), and stdWrap_data().

tslib_cObj::getFieldDefaultValue	(	$	noValueInsert,
		$	fieldName,
		$	defaultVal
	)

Returns a default value for a form field in the FORM cObject. Page CANNOT be cached because that would include the inserted value for the current user.

Parameters:

	boolean	If noValueInsert OR if the no_cache flag for this page is NOT set, the original default value is returned.
string	$fieldName,:	The POST var name to get default value for
string	$defaultVal,:	The current default value

Returns:

string The default value, either from INPUT var or the current default, based on whether caching is enabled or not. private

Definition at line 1299 of file class.tslib_content.php.

References $GLOBALS, and t3lib_div\_GP().

tslib_cObj::getFieldVal

(

$

field

)

Returns the value for the field from $this->data. If "//" is found in the $field value that token will split the field values apart and the first field having a non-blank value will be returned.

Parameters:

string

The fieldname, eg. "title" or "navtitle // title" (in the latter case the value of $this->data[navtitle] is returned if not blank, otherwise $this->data[title] will be)

Returns:

string

Definition at line 5130 of file class.tslib_content.php.

References t3lib_div\trimExplode().

Referenced by stdWrap_field().

tslib_cObj::getGetImgResourceHookObjects

(

)

[protected]

Gets the 'getImgResource' hook objects. The first call initializes the accordant objects.

Returns:

array The 'getImgResource' hook objects (if any)

Definition at line 630 of file class.tslib_content.php.

References $getImgResourceHookObjects, $GLOBALS, and t3lib_div\getUserObj().

Referenced by getImgResource().

tslib_cObj::getGlobal	(	$	keyString,
		$	source = NULL
	)

Return global variable where the input string $var defines array keys separated by "|" Example: $var = "HTTP_SERVER_VARS | something" will return the value $GLOBALS['HTTP_SERVER_VARS']['something'] value

Parameters:

string	Global var key, eg. "HTTP_GET_VAR" or "HTTP_GET_VARS|id" to get the GET parameter "id" back.
array	Alternative array than $GLOBAL to get variables from.

Returns:

mixed Whatever value. If none, then blank string.

See also:

getData()

Definition at line 5318 of file class.tslib_content.php.

References $GLOBALS, and $value.

Referenced by getData().

tslib_cObj::getImgResource	(	$	file,
		$	fileArray
	)

Creates and returns a TypoScript "imgResource". The value ($file) can either be a file reference (TypoScript resource) or the string "GIFBUILDER". In the first case a current image is returned, possibly scaled down or otherwise processed. In the latter case a GIFBUILDER image is returned; This means an image is made by TYPO3 from layers of elements as GIFBUILDER defines. In the function IMG_RESOURCE() this function is called like $this->getImgResource($conf['file'],$conf['file.']);

Parameters:

string	A "imgResource" TypoScript data type. Either a TypoScript file resource or the string GIFBUILDER. See description above.
array	TypoScript properties for the imgResource type

Returns:

array Returns info-array. info[origFile] = original file.

See also:

IMG_RESOURCE(), cImage(), tslib_gifBuilder

Definition at line 4887 of file class.tslib_content.php.

References $GLOBALS, getGetImgResourceHookObjects(), t3lib_div\inList(), t3lib_div\intInRange(), t3lib_div\makeInstance(), modifyImageMagickStripProfileParameters(), t3lib_div\shortMD5(), t3lib_div\split_fileref(), and stdWrap().

Referenced by cImage().

tslib_cObj::getKey	(	$	key,
		$	arr
	)

Processing of key values pointing to entries in $arr; Here negative values are converted to positive keys pointer to an entry in the array but from behind (based on the negative value). Example: entrylevel = -1 means that entryLevel ends up pointing at the outermost-level, -2 means the level before the outermost...

Parameters:

integer	The integer to transform
array	array in which the key should be found.

Returns:

integer The processed integer key value. private

See also:

getData()

Definition at line 5352 of file class.tslib_content.php.

Referenced by getData(), tslib_menu\makeMenu(), and tslib_menu\start().

tslib_cObj::getMailTo	(	$	mailAddress,
		$	linktxt,
		$	initP = '?'
	)

Creates a href attibute for given $mailAddress. The function uses spamProtectEmailAddresses and Jumpurl functionality for encoding the mailto statement. If spamProtectEmailAddresses is disabled, it'll just return a string like "mailto:user@example.tld".

Parameters:

string	Email address
string	Link text, default will be the email address.
string	Initial link parameters, only used if Jumpurl functionality is enabled. Example: ?id=5&type=0

Returns:

string Returns a numerical array with two elements: 1) $mailToUrl, string ready to be inserted into the href attribute of the tag, b) $linktxt: The string between starting and ending tag.

Definition at line 6143 of file class.tslib_content.php.

References $GLOBALS.

Referenced by mailto_makelinks(), and typoLink().

tslib_cObj::getQuery	(	$	table,
		$	conf,
		$	returnQueryArray = FALSE
	)

Creates and returns a SELECT query for records from $table and with conditions based on the configuration in the $conf array Implements the "select" function in TypoScript

Parameters:

string	See ->exec_getQuery()
array	See ->exec_getQuery()
boolean	If set, the function will return the query not as a string but array with the various parts. RECOMMENDED!

Returns:

mixed A SELECT query if $returnQueryArray is FALSE, otherwise the SELECT query in an array as parts. private

See also:

CONTENT(), numRows()

Definition at line 7325 of file class.tslib_content.php.

References $GLOBALS, $query, $res, $row, $value, and t3lib_div\intInRange().

tslib_cObj::getQueryArguments	(	$	conf,
		$	overruleQueryArguments = array(),
		$	forceOverruleArguments = FALSE
	)

Gets the query arguments and assembles them for URLs. Arguments may be removed or set, depending on configuration.

Parameters:

string	Configuration
array	Multidimensional key/value pairs that overrule incoming query arguments
boolean	If set, key/value pairs not in the query but the overrule array will be set

Returns:

string The URL query part (starting with a &)

Definition at line 6187 of file class.tslib_content.php.

References t3lib_div\_GET(), t3lib_div\_POST(), t3lib_div\array_merge_recursive_overrule(), t3lib_div\arrayDiffAssocRecursive(), t3lib_div\explodeUrl2Array(), t3lib_div\getIndpEnv(), and t3lib_div\implodeArrayForUrl().

Referenced by typoLink().

tslib_cObj::getQueryMarkers	(	$	table,
		$	conf
	)

Builds list of marker values for handling PDO-like parameter markers in select parts. Marker values support stdWrap functionality thus allowing a way to use stdWrap functionality in various properties of 'select' AND prevents SQL-injection problems by quoting and escaping of numeric values, strings, NULL values and comma separated lists.

Parameters:

string	$table	Table to select records from
array	$conf	Select part of CONTENT definition

Returns:

array List of values to replace markers with private

See also:

getQuery()

Definition at line 7604 of file class.tslib_content.php.

References $GLOBALS, and t3lib_div\trimExplode().

tslib_cObj::getSlidePids	(	$	pidList,
		$	pidConf
	)

Returns all parents of the given PID (Page UID) list

Parameters:

string	A list of page Content-Element PIDs (Page UIDs) / stdWrap
array	stdWrap array for the list

Returns:

string A list of PIDs private

Definition at line 1266 of file class.tslib_content.php.

References $GLOBALS, checkPidArray(), t3lib_div\intExplode(), and stdWrap().

tslib_cObj::getSubpart	(	$	content,
		$	marker
	)

Returns a subpart from the input content stream. A subpart is a part of the input stream which is encapsulated in a string matching the input string, $marker. If this string is found inside of HTML comment tags the start/end points of the content block returned will be that right outside that comment block. Example: The contennt string is "Hello <!--###sub1### begin--> World. How are <!--###sub1### end--> you?" If $marker is "###sub1###" then the content returned is " World. How are ". The input content string could just as well have been "Hello ###sub1### World. How are ###sub1### you?" and the result would be the same Wrapper for t3lib_parsehtml::getSubpart which behaves identical

Parameters:

string	The content stream, typically HTML template content.
string	The marker string, typically on the form "###[the marker string]###"

Returns:

string The subpart found, if found.

See also:

substituteSubpart(), t3lib_parsehtml::getSubpart()

Definition at line 1711 of file class.tslib_content.php.

References $content.

tslib_cObj::getTreeList	(	$	id,
		$	depth,
		$	begin = 0,
		$	dontCheckEnableFields = FALSE,
		$	addSelectFields = '',
		$	moreWhereClauses = '',
		array $	prevId_array = array(),
		$	recursionLevel = 0
	)

Generates a list of Page-uid's from $id. List does not include $id itself (unless the id specified is negative in which case it does!) The only pages WHICH PREVENTS DECENDING in a branch are

• deleted pages,
• pages in a recycler (doktype = 255) or of the Backend User Section (doktpe = 6) type
• pages that has the extendToSubpages set, WHERE start/endtime, hidden and fe_users would hide the records. Apart from that, pages with enable-fields excluding them, will also be removed. HOWEVER $dontCheckEnableFields set will allow enableFields-excluded pages to be included anyway - including extendToSubpages sections! Mount Pages are also descended but notice that these ID numbers are not useful for links unless the correct MPvar is set.

Parameters:

	integer	The id of the start page from which point in the page tree to decend. IF NEGATIVE the id itself is included in the end of the list (only if $begin is 0) AND the output does NOT contain a last comma. Recommended since it will resolve the input ID for mount pages correctly and also check if the start ID actually exists!
	integer	The number of levels to decend. If you want to decend infinitely, just set this to 100 or so. Should be at least "1" since zero will just make the function return (no decend...)
integer	$begin	is an optional integer that determines at which level in the tree to start collecting uid's. Zero means 'start right away', 1 = 'next level and out'
	boolean	See function description
	string	Additional fields to select. Syntax: ",[fieldname],[fieldname],..."
	string	Additional where clauses. Syntax: " AND [fieldname]=[value] AND ..."
	array	array of IDs from previous recursions. In order to prevent infinite loops with mount pages.
	integer	Internal: Zero for the first recursion, incremented for each recursive call.

Returns:

string Returns the list with a comma in the end (if any pages selected and not if $id is negative and $id is added itself) - which means the input page id can comfortably be appended to the output string if you need it to.

See also:

tslib_fe::checkEnableFields(), tslib_fe::checkPagerecordForIncludeSection()

Definition at line 7034 of file class.tslib_content.php.

References $GLOBALS, and $parameters.

Referenced by tslib_menu\makeMenu().

tslib_cObj::getTypoLink	(	$	label,
		$	params,
		$	urlParameters = array(),
		$	target = ''
	)

Returns a linked string made from typoLink parameters.

This function takes $label as a string, wraps it in a link-tag based on the $params string, which should contain data like that you would normally pass to the popular <LINK>-tag in the TSFE. Optionally you can supply $urlParameters which is an array with key/value pairs that are rawurlencoded and appended to the resulting url.

Parameters:

string	Text string being wrapped by the link.
string	Link parameter; eg. "123" for page id, "kasperYYYY@typo3.com" for email address, "http://...." for URL, "fileadmin/blabla.txt" for file.
array	An array with key/value pairs representing URL parameters to set. Values NOT URL-encoded yet.
string	Specific target set, if any. (Default is using the current)

Returns:

string The wrapped $label-text string

See also:

getTypoLink_URL()

Definition at line 6020 of file class.tslib_content.php.

References t3lib_div\implodeArrayForUrl().

Referenced by getTypoLink_URL().

tslib_cObj::getTypoLink_URL	(	$	params,
		$	urlParameters = array(),
		$	target = ''
	)

Returns the URL of a "typolink" create from the input parameter string, url-parameters and target

Parameters:

string	Link parameter; eg. "123" for page id, "kasperYYYY@typo3.com" for email address, "http://...." for URL, "fileadmin/blabla.txt" for file.
array	An array with key/value pairs representing URL parameters to set. Values NOT URL-encoded yet.
string	Specific target set, if any. (Default is using the current)

Returns:

string The URL

See also:

getTypoLink()

Definition at line 6048 of file class.tslib_content.php.

References $lastTypoLinkUrl, and getTypoLink().

Referenced by currentPageUrl(), and typoLink().

tslib_cObj::getUpdateJS	(	$	dataArray,
		$	formName,
		$	arrPrefix,
		$	fieldList
	)

Returns a JavaScript <script> section with some function calls to JavaScript functions from "t3lib/jsfunc.updateform.js" (which is also included by setting a reference in $GLOBALS['TSFE']->additionalHeaderData['JSincludeFormupdate']) The JavaScript codes simply transfers content into form fields of a form which is probably used for editing information by frontend users. Used by fe_adminLib.inc.

Parameters:

array	Data array which values to load into the form fields from $formName (only field names found in $fieldList)
string	The form name
string	A prefix for the data array
string	The list of fields which are loaded

Returns:

string private

See also:

user_feAdmin::displayCreateScreen()

Definition at line 6677 of file class.tslib_content.php.

References $GLOBALS, $value, t3lib_div\createVersionNumberedFilename(), t3lib_div\quoteJSvalue(), and t3lib_div\trimExplode().

tslib_cObj::getUserObjectType

(

)

Retrieves a type of object called as USER or USER_INT. Object can detect their type by using this call. It returns OBJECTTYPE_USER_INT or OBJECTTYPE_USER depending on the current object execution. In all other cases it will return FALSE to indicate a call out of context.

Returns:

mixed One of OBJECTTYPE_ class constants or FALSE

Definition at line 934 of file class.tslib_content.php.

References $userObjectType.

tslib_cObj::getWhere	(	$	table,
		$	conf,
		$	returnQueryArray = FALSE
	)

Helper function for getQuery(), creating the WHERE clause of the SELECT query

Parameters:

string	The table name
array	The TypoScript configuration properties
boolean	If set, the function will return the query not as a string but array with the various parts. RECOMMENDED!

Returns:

mixed A WHERE clause based on the relevant parts of the TypoScript properties for a "select" function in TypoScript, see link. If $returnQueryArray is FALSE the where clause is returned as a string with WHERE, GROUP BY and ORDER BY parts, otherwise as an array with these parts. private

See also:

getQuery()

Definition at line 7446 of file class.tslib_content.php.

References $GLOBALS, $query, $TCA, and t3lib_div\intExplode().

tslib_cObj::gifBuilderTextBox	(	$	gifbuilderConf,
		$	conf,
		$	text
	)

This function creates a number of TEXT-objects in a Gifbuilder configuration in order to create a text-field like thing. Used with the script tslib/media/scripts/postit.inc

Parameters:

array	TypoScript properties for Gifbuilder - TEXT GIFBUILDER objects are added to this array and returned.
array	TypoScript properties for this function
string	The text string to write onto the GIFBUILDER file

Returns:

array The modified $gifbuilderConf array

See also:

media/scripts/postit.inc

Definition at line 6591 of file class.tslib_content.php.

References clearTSProperties(), and linebreaks().

tslib_cObj::HMENU

(

$

conf

)

Rendering the cObject, HMENU

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1029 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::HRULER

(

$

conf

)

Rendering the cObject, HRULER

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1069 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::HTML

(

$

conf

)

Rendering the cObject, HTML

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 872 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::HTMLcaseshift	(	$	theValue,
		$	case
	)

Shifts the case of characters outside of HTML tags in the input string

Parameters:

string	The string to change case for.
string	The direction; either "upper" or "lower"

Returns:

string

See also:

caseshift()

Definition at line 6411 of file class.tslib_content.php.

References caseshift().

Referenced by stdWrap_case(), and textStyle().

tslib_cObj::HTMLparser_TSbridge	(	$	theValue,
		$	conf
	)

Passes the input value, $theValue, to an instance of "t3lib_parsehtml" together with the TypoScript options which are first converted from a TS style array to a set of arrays with options for the t3lib_parsehtml class.

Parameters:

string	The value to parse by the class "t3lib_parsehtml"
array	TypoScript properties for the parser. See link.

Returns:

string Return value.

See also:

stdWrap(), t3lib_parsehtml::HTMLparserConfig(), t3lib_parsehtml::HTMLcleaner()

Definition at line 3494 of file class.tslib_content.php.

References t3lib_div\makeInstance().

Referenced by stdWrap_HTMLparser().

tslib_cObj::http_makelinks	(	$	data,
		$	conf
	)

Finds URLS in text and makes it to a real link. Will find all strings prefixed with "http://" in the $data string and make them into a link, linking to the URL we should have found.

Parameters:

string	The string in which to search for "http://"
array	Configuration for makeLinks, see link

Returns:

string The processed input string, being returned.

See also:

_parseFunc()

Definition at line 4765 of file class.tslib_content.php.

References $data, $GLOBALS, $res, extLinkATagParams(), getATagParams(), stdWrap(), and wrap().

Referenced by _parseFunc().

tslib_cObj::IMAGE

(

$

conf

)

Rendering the cObject, IMAGE

Parameters:

array

array of TypoScript properties

Returns:

string Output

See also:

cImage()

Definition at line 978 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::imageLinkWrap	(	$	string,
		$	imageFile,
		$	conf
	)

Wraps the input string in link-tags that opens the image in a new window.

Parameters:

string	String to wrap, probably an tag
string	The original image file
array	TypoScript properties for the "imageLinkWrap" function

Returns:

string The input string, $string, wrapped as configured.

See also:

cImage()

Definition at line 1394 of file class.tslib_content.php.

References $content, $GLOBALS, $parameters, t3lib_div\hmac(), IMG_RESOURCE(), t3lib_div\inList(), t3lib_div\intExplode(), t3lib_div\makeInstance(), stdWrap(), and typoLink().

Referenced by cImage().

tslib_cObj::IMG_RESOURCE

(

$

conf

)

Rendering the cObject, IMG_RESOURCE

Parameters:

array

array of TypoScript properties

Returns:

string Output

See also:

getImgResource()

Definition at line 989 of file class.tslib_content.php.

References getContentObject().

Referenced by imageLinkWrap().

tslib_cObj::IMGTEXT

(

$

conf

)

Rendering the cObject, IMGTEXT

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 999 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::includeLibs

(

array $

config

)

Includes resources if the config property 'includeLibs' is set.

Parameters:

array

$config,:

TypoScript configuration

Returns:

boolean Whether a configuration for including libs was found and processed

Definition at line 6708 of file class.tslib_content.php.

References $GLOBALS, and t3lib_div\trimExplode().

Referenced by isClassAvailable().

tslib_cObj::insertData

(

$

str

)

Implements the "insertData" property of stdWrap meaning that if strings matching {...} is found in the input string they will be substituted with the return value from getData (datatype) which is passed the content of the curly braces. Example: If input string is "This is the page title: {page:title}" then the part, '{page:title}', will be substituted with the current pages title field value.

Parameters:

string

Input value

Returns:

string Processed input value

See also:

getData(), stdWrap(), dataWrap()

Definition at line 3520 of file class.tslib_content.php.

References getData().

Referenced by dataWrap(), prefixComment(), and stdWrap_insertData().

tslib_cObj::isClassAvailable	(	$	className,
		array $	config = NULL
	)		[protected]

Checks whether a PHP class is available. If the check fails, the method tries to determine the correct includeLibs to make the class available automatically.

TypoScript example that can cause this: | plugin.tx_myext_pi1 = USER | plugin.tx_myext_pi1 { | includeLibs = EXT:myext/pi1/class.tx_myext_pi1.php | userFunc = tx_myext_pi1->main | } | 10 = USER | 10.userFunc = tx_myext_pi1->renderHeader

Parameters:

string	$className,:	The name of the PHP class to be checked
array	$config,:	TypoScript configuration (naturally of a USER or COA cObject)

Returns:

boolean Whether the class is available This method was introduced in TYPO3 4.3 and can be removed if the autoload was integrated

Definition at line 6739 of file class.tslib_content.php.

References $GLOBALS, and includeLibs().

Referenced by callUserFunction().

tslib_cObj::isDisabled	(	$	table,
		$	row
	)

Returns TRUE if the input table/row would be hidden in the frontend (according nto the current time and simulate user group)

Parameters:

string	The table name
array	The data record

Returns:

boolean private

See also:

editPanelPreviewBorder()

Definition at line 7750 of file class.tslib_content.php.

References $GLOBALS, $row, and $TCA.

tslib_cObj::joinTSarrays	(	$	conf,
		$	old_conf
	)

Merges two TypoScript propery array, overlaing the $old_conf onto the $conf array

Parameters:

array	TypoScript property array, the "base"
array	TypoScript property array, the "overlay"

Returns:

array The resulting array

See also:

mergeTSRef(), tx_tstemplatestyler_modfunc1::joinTSarrays()

Definition at line 6569 of file class.tslib_content.php.

Referenced by cObjGetSingle(), and mergeTSRef().

tslib_cObj::keywords

(

$

content

)

Cleans up a string of keywords. Keywords at splitted by "," (comma) ";" (semi colon) and linebreak

Parameters:

string

String of keywords

Returns:

string Cleaned up string, keywords will be separated by a comma only.

Definition at line 6374 of file class.tslib_content.php.

References $content.

Referenced by tslib_menu\makeMenu(), and stdWrap_keywords().

tslib_cObj::lastChanged

(

$

tstamp

)

Sets the SYS_LASTCHANGED timestamp if input timestamp is larger than current value. The SYS_LASTCHANGED timestamp can be used by various caching/indexing applications to determine if the page has new content. Therefore you should call this function with the last-changed timestamp of any element you display.

Parameters:

integer

Unix timestamp (number of seconds since 1970)

Returns:

void

See also:

tslib_fe::setSysLastChanged()

Definition at line 1556 of file class.tslib_content.php.

References $GLOBALS.

tslib_cObj::linebreaks	(	$	string,
		$	chars,
		$	maxLines = 0
	)

Splits a text string into lines and returns an array with these lines but a max number of lines.

Parameters:

string	The string to break
integer	Max number of characters per line.
integer	Max number of lines in all.

Returns:

array array with lines. private

See also:

gifBuilderTextBox()

Definition at line 6646 of file class.tslib_content.php.

Referenced by gifBuilderTextBox().

tslib_cObj::linkWrap	(	$	content,
		$	wrap
	)

Wraps the input string by the $wrap value and implements the "linkWrap" data type as well. 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.

Parameters:

string	Input string
string	A string where the first two parts separated by "|" (vertical line) will be wrapped around the input string

Returns:

string Wrapped output string

See also:

wrap(), cImage(), FILE()

Definition at line 1572 of file class.tslib_content.php.

References $content, and $GLOBALS.

Referenced by cImage().

tslib_cObj::listNum	(	$	content,
		$	listNum,
		$	char
	)

Exploding a string by the $char value (if integer its an ASCII value) and returning index $listNum

Parameters:

string	String to explode
string	Index-number. You can place the word "last" in it and it will be substituted with the pointer to the last value. You can use math operators like "+-/*" (passed to calc())
string	Either a string used to explode the content string or an integer value which will then be changed into a character, eg. "10" for a linebreak char.

Returns:

string

Definition at line 3287 of file class.tslib_content.php.

References $content, calc(), and t3lib_div\testInt().

Referenced by stdWrap_listNum(), and stdWrap_preIfEmptyListNum().

tslib_cObj::LOAD_REGISTER	(	$	conf,
		$	name
	)

Rendering the cObject, LOAD_REGISTER and RESTORE_REGISTER NOTICE: This cObject does NOT return any content since it just sets internal data based on the TypoScript properties.

Parameters:

array	array of TypoScript properties
string	If "RESTORE_REGISTER" then the cObject rendered is "RESTORE_REGISTER", otherwise "LOAD_REGISTER"

Returns:

string Empty string (the cObject only sets internal data!)

Definition at line 1091 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::locDataJU	(	$	jumpUrl,
		$	conf
	)

Returns a URL parameter string setting parameters for secure downloads by "jumpurl". Helper function for filelink()

Parameters:

string	The URL to jump to, basically the filepath
array	TypoScript properties for the "jumpurl.secure" property of "filelink"

Returns:

string URL parameters like "&juSecure=1....." private

See also:

filelink()

Definition at line 4124 of file class.tslib_content.php.

References $currentRecord, $GLOBALS, t3lib_div\hmac(), and t3lib_div\trimExplode().

Referenced by filelink(), and typoLink().

tslib_cObj::mailto_makelinks	(	$	data,
		$	conf
	)

Will find all strings prefixed with "mailto:" in the $data string and make them into a link, linking to the email address they point to.

Parameters:

string	The string in which to search for "mailto:"
array	Configuration for makeLinks, see link

Returns:

string The processed input string, being returned.

See also:

_parseFunc()

Definition at line 4838 of file class.tslib_content.php.

References $data, $GLOBALS, $res, getATagParams(), getMailTo(), stdWrap(), and wrap().

Referenced by _parseFunc().

tslib_cObj::MEDIA

(

$

conf

)

Rendering the cObject, MEDIA

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1175 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::mergeTSRef	(	$	confArr,
		$	prop
	)

Resolves a TypoScript reference value to the full set of properties BUT overridden with any local properties set. So the reference is resolved but overlaid with local TypoScript properties of the reference value.

Parameters:

array	The TypoScript array
string	The property name: If this value is a reference (eg. " < plugins.tx_something") then the reference will be retrieved and inserted at that position (into the properties only, not the value...) AND overlaid with the old properties if any.

Returns:

array The modified TypoScript array

See also:

user_plaintext::typolist(),user_plaintext::typohead()

Definition at line 6546 of file class.tslib_content.php.

References $GLOBALS, joinTSarrays(), and t3lib_div\makeInstance().

Referenced by parseFunc().

tslib_cObj::modifyImageMagickStripProfileParameters	(	$	parameters,
		array $	configuration
	)		[protected]

Modifies the parameters for ImageMagick for stripping of profile information.

Parameters:

string	$parameters,:	The parameters to be modified (if required)
array	$configuration,:	The TypoScript configuration of [IMAGE].file
	string	The modified parameters

Definition at line 5103 of file class.tslib_content.php.

References $GLOBALS, and $parameters.

Referenced by getImgResource().

tslib_cObj::MULTIMEDIA

(

$

conf

)

Rendering the cObject, MULTIMEDIA

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1165 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::noTrimWrap	(	$	content,
		$	wrap
	)

Wrapping a string, preserving whitespace in wrap value. Notice that the wrap value uses part 1/2 to wrap (and not 0/1 which wrap() does)

Parameters:

string	The content to wrap, eg. "HELLO WORLD"
string	The wrap value, eg. " | <strong> | </strong>"

Returns:

string Wrapped input string, eg. " <strong> HELLO WORD </strong>"

See also:

wrap()

Definition at line 6260 of file class.tslib_content.php.

References $content.

Referenced by stdWrap_noTrimWrap().

tslib_cObj::numberFormat	(	$	content,
		$	conf
	)

Implements the stdWrap property "numberFormat" This is a Wrapper function for php's number_format()

Parameters:

float	Value to process
array	TypoScript Configuration for numberFormat

Returns:

string The formated number

Definition at line 4292 of file class.tslib_content.php.

References $content, and stdWrap().

Referenced by stdWrap_numberFormat().

tslib_cObj::numRows

(

$

conf

)

Returns number of rows selected by the query made by the properties set. Implements the stdWrap "numRows" property

Parameters:

array

TypoScript properties for the property (see link to "numRows")

Returns:

integer The number of rows found by the select (FALSE on error) private

See also:

stdWrap()

Definition at line 3263 of file class.tslib_content.php.

References $GLOBALS, $res, $row, and exec_getQuery().

Referenced by stdWrap_numRows().

tslib_cObj::OTABLE

(

$

conf

)

Rendering the cObject, OTABLE

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1049 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::parseFunc	(	$	theValue,
		$	conf,
		$	ref = ''
	)

Implements the stdWrap property, "parseFunc". This is a function with a lot of interesting uses. In classic TypoScript this is used to process text from the bodytext field; This included highlighting of search words, changing http:// and mailto: prefixed strings into links, parsing <typolist>, <typohead> and <typocode> tags etc. It is still a very important function for processing of bodytext which is normally stored in the database in a format which is not fully ready to be outputted. This situation has not become better by having a RTE around...

This function is actually just splitting the input content according to the configuration of "external blocks". This means that before the input string is actually "parsed" it will be splitted into the parts configured to BE parsed (while other parts/blocks should NOT be parsed). Therefore the actual processing of the parseFunc properties goes on in ->_parseFunc()

Parameters:

string	The value to process.
array	TypoScript configuration for parseFunc
string	Reference to get configuration from. Eg. "< lib.parseFunc" which means that the configuration of the object path "lib.parseFunc" will be retrieved and MERGED with what is in $conf!

Returns:

string The processed value

See also:

_parseFunc()

Definition at line 4325 of file class.tslib_content.php.

References _parseFunc(), t3lib_div\makeInstance(), mergeTSRef(), stdWrap(), t3lib_div\trimExplode(), and wrap().

Referenced by stdWrap_parseFunc().

tslib_cObj::PHP_SCRIPT	(	$	conf,
		$	ext = ''
	)

Rendering the cObject, PHP_SCRIPT, PHP_SCRIPT_INT and PHP_SCRIPT_EXT

Parameters:

array	array of TypoScript properties
string	If "INT", then rendering "PHP_SCRIPT_INT"; If "EXT", then rendering "PHP_SCRIPT_EXT"; Default is rendering "PHP_SCRIPT" (cached)

Returns:

string Output

Definition at line 1127 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::prefixComment	(	$	str,
		$	conf,
		$	content
	)

Returns a HTML comment with the second part of input string (divided by "|") where first part is an integer telling how many trailing tabs to put before the comment on a new line. Notice; this function (used by stdWrap) can be disabled by a "config.disablePrefixComment" setting in TypoScript.

Parameters:

string	Input value
array	TypoScript Configuration (not used at this point.)
string	The content to wrap the comment around.

Returns:

string Processed input value

See also:

stdWrap()

Definition at line 3550 of file class.tslib_content.php.

References $content, and insertData().

Referenced by stdWrap_prefixComment().

tslib_cObj::processParams

(

$

params

)

Parses a set of text lines with "[parameters] = [values]" into an array with parameters as keys containing the value If lines are empty or begins with "/" or "#" then they are ignored.

Parameters:

string

Text which the parameters

Returns:

array array with the parameters as key/value pairs

Definition at line 6356 of file class.tslib_content.php.

References t3lib_div\inList(), and t3lib_div\trimExplode().

tslib_cObj::QTOBJECT

(

$

conf

)

Rendering the cObject, QTOBJECT

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1195 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::readFlexformIntoConf	(	$	flexData,
		&$	conf,
		$	recursive = FALSE
	)

Converts a given config in Flexform to a conf-array

Parameters:

string	Flexform data
array	array to write the data into, by reference
boolean	is set if called recursive. Don't call function with this parameter, it's used inside the function only public

Definition at line 1224 of file class.tslib_content.php.

References $value, and t3lib_div\xml2array().

tslib_cObj::RECORDS

(

$

conf

)

Rendering the cObject, RECORDS

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1019 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::removeBadHTML	(	$	text,
		$	conf
	)

Function for removing malicious HTML code when you want to provide some HTML code user-editable. The purpose is to avoid XSS attacks and the code will be continously modified to remove such code. For a complete reference with javascript-on-events, see http://www.wdvl.com/Authoring/JavaScript/Events/events_target.html

Parameters:

string	Input string to be cleaned.
array	TypoScript configuration.

Returns:

string Return string

Author:

Thomas Bley (all from moregroupware cvs code / readmessage.inc.php, published under gpl by Thomas)

Kasper Sk�rh�j

Definition at line 3762 of file class.tslib_content.php.

Referenced by stdWrap_removeBadHTML().

tslib_cObj::rootLineValue	(	$	key,
		$	field,
		$	slideBack = 0,
		$	altRootLine = ''
	)

Returns a value from the current rootline (site) from $GLOBALS['TSFE']->tmpl->rootLine;

Parameters:

string	Which level in the root line
string	The field in the rootline record to return (a field from the pages table)
boolean	If set, then we will traverse through the rootline from outer level towards the root level until the value found is TRUE
mixed	If you supply an array for this it will be used as an alternative root line array

Returns:

string The value from the field of the rootline. private

See also:

getData()

Definition at line 5295 of file class.tslib_content.php.

References $GLOBALS.

Referenced by getData().

tslib_cObj::SEARCHRESULT

(

$

conf

)

Rendering the cObject, SEARCHRESULT

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1116 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::searchWhere	(	$	sw,
		$	searchFieldList,
		$	searchTable = ''
	)

Generates a search where clause based on the input search words (AND operation - all search words must be found in record.) Example: The $sw is "content management, system" (from an input form) and the $searchFieldList is "bodytext,header" then the output will be ' AND (bodytext LIKE "%content%" OR header LIKE "%content%") AND (bodytext LIKE "%management%" OR header LIKE "%management%") AND (bodytext LIKE "%system%" OR header LIKE "%system%")'

Parameters:

string	The search words. These will be separated by space and comma.
string	The fields to search in
string	The table name you search in (recommended for DBAL compliance. Will be prepended field names as well)

Returns:

string The WHERE clause.

Definition at line 7273 of file class.tslib_content.php.

tslib_cObj::sendNotifyEmail	(	$	msg,
		$	recipients,
		$	cc,
		$	email_from,
		$	email_fromName = '',
		$	replyTo = ''
	)

Sending a notification email using $GLOBALS['TSFE']->plainMailEncoded()

Parameters:

string	The message content. If blank, no email is sent.
string	Comma list of recipient email addresses
string	Email address of recipient of an extra mail. The same mail will be sent ONCE more; not using a CC header but sending twice.
string	"From" email address
string	Optional "From" name
string	Optional "Reply-To" header email address.

Returns:

boolean Returns TRUE if sent

Definition at line 6478 of file class.tslib_content.php.

References $GLOBALS, and t3lib_div\trimExplode().

tslib_cObj::setCurrentVal

(

$

value

)

Sets the "current" value.

Parameters:

mixed

The variable that you want to set as "current"

Returns:

void

See also:

getCurrentVal()

Definition at line 696 of file class.tslib_content.php.

References $currentValKey, and $value.

tslib_cObj::setParent	(	$	data,
		$	currentRecord
	)

Sets the internal variable parentRecord with information about current record. 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.

Parameters:

array	$data,:	The record array
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.

Returns:

void private

Definition at line 662 of file class.tslib_content.php.

References $currentRecord, and $data.

tslib_cObj::setUserObjectType

(

$

userObjectType

)

Sets the user object type

Parameters:

mixed

$userObjectType

Returns:

void

Definition at line 944 of file class.tslib_content.php.

References $userObjectType.

tslib_cObj::splitObj	(	$	value,
		$	conf
	)

Implements the "split" property of stdWrap; Splits a string based on a token (given in TypoScript properties), sets the "current" value to each part and then renders a content object pointer to by a number. In classic TypoScript (like 'content (default)'/'styles.content (default)') this is used to render tables, splitting rows and cells by tokens and putting them together again wrapped in

tags etc. Implements the "optionSplit" processing of the TypoScript options for each splitted value to parse.

Parameters:

string	The string value to explode by $conf[token] and process each part
array	TypoScript properties for "split"

Returns:

string Compiled result private

See also:

stdWrap(), t3lib_menu::procesItemStates()

Definition at line 4211 of file class.tslib_content.php.

References $content, $currentValKey, $GLOBALS, $value, cObjGet(), stdWrap(), t3lib_div\testInt(), and wrap().

Referenced by stdWrap_split().

tslib_cObj::start	(	$	data,
		$	table = ''
	)

Class constructor. Well, it has to be called manually since it is not a real constructor function. 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.

Parameters:

array	$data	the record data that is rendered.
string	$table	the table that the data record is from.

Returns:

void

Definition at line 565 of file class.tslib_content.php.

References $data, $table, $TYPO3_CONF_VARS, and t3lib_div\getUserObj().

tslib_cObj::stdWrap	(	$	content = '',
		$	conf = array()
	)

The "stdWrap" function. This is the implementation of what is known as "stdWrap properties" in TypoScript. Basically "stdWrap" performs some processing of a value based on properties in the input $conf array(holding the TypoScript "stdWrap properties") 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.

If $this->alternativeData is an array it's used instead of the $this->data array in ->getData

Parameters:

string	Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
array	TypoScript "stdWrap properties".

Returns:

string The processed input value

Definition at line 1974 of file class.tslib_content.php.

References $content, and t3lib_div\inList().

Referenced by _parseFunc(), addParams(), checkIf(), cImage(), encaps_lineSplit(), filelink(), getAltParam(), getATagParams(), getImgResource(), getSlidePids(), http_makelinks(), imageLinkWrap(), mailto_makelinks(), numberFormat(), parseFunc(), splitObj(), stdWrap_offsetWrap(), stdWrap_stdWrap(), tableStyle(), textStyle(), and typoLink().

tslib_cObj::stdWrap_addParams	(	$	content = '',
		$	conf = array()
	)

addParams Adds tag attributes to any content that is a tag

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for addParams.

Returns:

string The processed input value

Definition at line 2799 of file class.tslib_content.php.

References $content, and addParams().

tslib_cObj::stdWrap_age	(	$	content = '',
		$	conf = array()
	)

age Will return the age of a given timestamp based on configuration given by stdWrap properties

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for age.

Returns:

string The processed input value

Definition at line 2556 of file class.tslib_content.php.

References $content, $GLOBALS, and calcAge().

tslib_cObj::stdWrap_append	(	$	content = '',
		$	conf = array()
	)

append A content object that will be appended to the current content after most of the wraps have already been applied

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for append.

Returns:

string The processed input value

Definition at line 3042 of file class.tslib_content.php.

References $content, and cObjGetSingle().

tslib_cObj::stdWrap_br	(	$	content = '',
		$	conf = array()
	)

br Searches for single line breaks and replaces them with a
tag

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for br.

Returns:

string The processed input value

Definition at line 2703 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_brTag	(	$	content = '',
		$	conf = array()
	)

brTag Searches for single line feeds and replaces them with the given value

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for brTag.

Returns:

string The processed input value

Definition at line 2716 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_bytes	(	$	content = '',
		$	conf = array()
	)

bytes Will return the size of a given number in Bytes *

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for bytes.

Returns:

string The processed input value

Definition at line 2583 of file class.tslib_content.php.

References $content, and t3lib_div\formatSize().

tslib_cObj::stdWrap_case	(	$	content = '',
		$	conf = array()
	)

case Will transform the content to be upper or lower case only Leaves HTML tags untouched

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for case.

Returns:

string The processed input value

Definition at line 2570 of file class.tslib_content.php.

References $content, and HTMLcaseshift().

tslib_cObj::stdWrap_char	(	$	content = '',
		$	conf = array()
	)

char Will return a character based on its position within the current character set

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for char.

Returns:

string The processed input value

Definition at line 2485 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_cObject	(	$	content = '',
		$	conf = array()
	)

cObject Will replace the content with the value of a any official TypoScript cObject like TEXT, COA, HMENU

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for cObject.

Returns:

string The processed input value

Definition at line 2171 of file class.tslib_content.php.

References $content, and cObjGetSingle().

tslib_cObj::stdWrap_crop	(	$	content = '',
		$	conf = array()
	)

cropHTML Crops content to a given size without caring abhout HTML tags

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for crop.

Returns:

string The processed input value

Definition at line 2648 of file class.tslib_content.php.

References $content, and crop().

tslib_cObj::stdWrap_cropHTML	(	$	content = '',
		$	conf = array()
	)

cropHTML Crops content to a given size while leaving HTML tags untouched

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for cropHTML.

Returns:

string The processed input value

Definition at line 2622 of file class.tslib_content.php.

References $content, and cropHTML().

tslib_cObj::stdWrap_csConv	(	$	content = '',
		$	conf = array()
	)

csConv Will convert the current chracter set of the content to the one given in csConv

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for csConv.

Returns:

string The processed input value

Definition at line 2412 of file class.tslib_content.php.

References $content, and $GLOBALS.

tslib_cObj::stdWrap_current	(	$	content = '',
		$	conf = array()
	)

current Gets content that has been perviously set as 'current' Can be set via setContentToCurrent or setCurrent or will be set automatically i.e. inside the split function

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for current.

Returns:

string The processed input value

Definition at line 2157 of file class.tslib_content.php.

References $content, and $currentValKey.

tslib_cObj::stdWrap_data	(	$	content = '',
		$	conf = array()
	)

data Gets content from different sources based on getText functions, makes use of alternativeData, when set

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for data.

Returns:

string The processed input value

Definition at line 2129 of file class.tslib_content.php.

References $content, and getData().

tslib_cObj::stdWrap_dataWrap	(	$	content = '',
		$	conf = array()
	)

dataWrap Sixth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content 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

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for dataWrap.

Returns:

string The processed input value

Definition at line 3016 of file class.tslib_content.php.

References $content, and dataWrap().

tslib_cObj::stdWrap_date	(	$	content = '',
		$	conf = array()
	)

date Will return a formatted date based on configuration given according to PHP date/gmdate properties Will return gmdate when the property GMT returns true

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for date.

Returns:

string The processed input value

Definition at line 2525 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_debug	(	$	content = '',
		$	conf = array()
	)

debug Will output the content as readable HTML code

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for debug.

Returns:

string The processed input value

Definition at line 3218 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_debugData	(	$	content = '',
		$	conf = array()
	)

debugData Will output the data used by the current record in a debug table

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for debugData.

Returns:

string The processed input value

Definition at line 3246 of file class.tslib_content.php.

References $content, and debug().

tslib_cObj::stdWrap_debugFunc	(	$	content = '',
		$	conf = array()
	)

debugFunc Will output the content in a debug table

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for debugFunc.

Returns:

string The processed input value

Definition at line 3231 of file class.tslib_content.php.

References $content, and debug().

tslib_cObj::stdWrap_doubleBrTag	(	$	content = '',
		$	conf = array()
	)

doubleBrTag Searches for double line breaks and replaces them with the given value

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for doubleBrTag.

Returns:

string The processed input value

Definition at line 2690 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_editIcons	(	$	content = '',
		$	conf = array()
	)

editIcons Will render icons for frontend editing as long as there is a BE user logged in

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for editIcons.

Returns:

string The processed input value

Definition at line 3169 of file class.tslib_content.php.

References $content, $GLOBALS, and editIcons().

tslib_cObj::stdWrap_editPanel	(	$	content = '',
		$	conf = array()
	)

editPanel Will render the edit panel for frontend editing as long as there is a BE user logged in

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for editPanel.

Returns:

string The processed input value

Definition at line 3187 of file class.tslib_content.php.

References $content, $GLOBALS, and editPanel().

tslib_cObj::stdWrap_encapsLines	(	$	content = '',
		$	conf = array()
	)

encapsLines Modifies text blocks by searching for lines which are not surrounded by HTML tags yet and wrapping them with values given by stdWrap properties

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for erncapsLines.

Returns:

string The processed input value

Definition at line 2730 of file class.tslib_content.php.

References $content, and encaps_lineSplit().

tslib_cObj::stdWrap_field	(	$	content = '',
		$	conf = array()
	)

field Gets content from a DB field

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for field.

Returns:

string The processed input value

Definition at line 2143 of file class.tslib_content.php.

References $content, and getFieldVal().

tslib_cObj::stdWrap_fieldRequired	(	$	content = '',
		$	conf = array()
	)

fieldRequired Will immediately stop rendering and return an empty value when there is no content in the field given by fieldRequired

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for fieldRequired.

Returns:

string The processed input value

Definition at line 2396 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_filelink	(	$	content = '',
		$	conf = array()
	)

filelink Used to make lists of links to files See wrap

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for filelink.

Returns:

string The processed input value

Definition at line 2841 of file class.tslib_content.php.

References $content, and filelink().

tslib_cObj::stdWrap_filelist	(	$	content = '',
		$	conf = array()
	)

filelist Will create a list of files based on some additional parameters

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for filelist.

Returns:

string The processed input value

Definition at line 2198 of file class.tslib_content.php.

References $content, and filelist().

tslib_cObj::stdWrap_fontTag	(	$	content = '',
		$	conf = array()
	)

fontTag A wrap formerly used to apply font tags to format the content Still used by lib.stdheader although real font tags are not state of the art anymore See wrap

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for fontTag.

Returns:

string The processed input value

Definition at line 2786 of file class.tslib_content.php.

References $content, and wrap().

tslib_cObj::stdWrap_HTMLparser	(	$	content = '',
		$	conf = array()
	)

HTMLparser Will parse HTML content based on functions given as stdWrap properties Heavily used together with RTE based content

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for HTMLparser.

Returns:

string The processed input value

Definition at line 2440 of file class.tslib_content.php.

References $content, and HTMLparser_TSbridge().

tslib_cObj::stdWrap_htmlSpecialChars	(	$	content = '',
		$	conf = array()
	)

htmlSpecialChars Transforms HTML tags to readable text by replacing special characters with their HTML entity When preserveEntities returns true, existing entities will be left untouched

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for htmlSpecalChars.

Returns:

string The processed input value

Definition at line 2675 of file class.tslib_content.php.

References $content, and t3lib_div\deHSCentities().

tslib_cObj::stdWrap_if	(	$	content = '',
		$	conf = array()
	)

if Will immediately stop rendering and return an empty value when the result of the checks returns false

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for if.

Returns:

string The processed input value

Definition at line 2379 of file class.tslib_content.php.

References $content, and checkIf().

tslib_cObj::stdWrap_ifBlank	(	$	content = '',
		$	conf = array()
	)

ifBlank Will set content to a replacement value in case the trimmed value of content has no length 0 (zero) will not be replaced

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for ifBlank.

Returns:

string The processed input value

Definition at line 2286 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_ifEmpty	(	$	content = '',
		$	conf = array()
	)

ifEmpty Will set content to a replacement value in case the trimmed value of content returns false 0 (zero) will be replaced as well

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for ifEmpty.

Returns:

string The processed input value

Definition at line 2270 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_innerWrap	(	$	content = '',
		$	conf = array()
	)

innerWrap First of a set of different wraps which will be applied in a certain order before or after other functions that modify the content See wrap

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for innerWrap.

Returns:

string The processed input value

Definition at line 2757 of file class.tslib_content.php.

References $content, and wrap().

tslib_cObj::stdWrap_innerWrap2	(	$	content = '',
		$	conf = array()
	)

innerWrap2 Second of a set of different wraps which will be applied in a certain order before or after other functions that modify the content See wrap

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for innerWrap2.

Returns:

string The processed input value

Definition at line 2771 of file class.tslib_content.php.

References $content, and wrap().

tslib_cObj::stdWrap_insertData	(	$	content = '',
		$	conf = array()
	)

inserData Can fetch additional content the same way data does and replaces any occurence of {field:whatever} with this content

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for insertData.

Returns:

string The processed input value

Definition at line 3082 of file class.tslib_content.php.

References $content, and insertData().

tslib_cObj::stdWrap_intval	(	$	content = '',
		$	conf = array()
	)

intval Will return an integer value of the current content

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for intval.

Returns:

string The processed input value

Definition at line 2498 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_keywords	(	$	content = '',
		$	conf = array()
	)

keywords Transforms content into a CSV list to be used i.e. as keywords within a meta tag

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for keywords.

Returns:

string The processed input value

Definition at line 2743 of file class.tslib_content.php.

References $content, and keywords().

tslib_cObj::stdWrap_lang	(	$	content = '',
		$	conf = array()
	)

lang Translates content based on the language currently used by the FE

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for lang.

Returns:

string The processed input value

Definition at line 2114 of file class.tslib_content.php.

References $content, and $GLOBALS.

tslib_cObj::stdWrap_listNum	(	$	content = '',
		$	conf = array()
	)

listNum Gets a value off a CSV list after ifEmpty check Might return an empty value in case the CSV does not contain a value at the position given by listNum Use preIfEmptyListNum to avoid that behaviour

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for listNum.

Returns:

string The processed input value

Definition at line 2303 of file class.tslib_content.php.

References $content, and listNum().

tslib_cObj::stdWrap_noTrimWrap	(	$	content = '',
		$	conf = array()
	)

noTrimWrap Fourth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content The major difference to any other wrap is, that this one can make use of whitespace without trimming *

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for noTrimWrap.

Returns:

string The processed input value

Definition at line 2988 of file class.tslib_content.php.

References $content, and noTrimWrap().

tslib_cObj::stdWrap_numberFormat	(	$	content = '',
		$	conf = array()
	)

numberFormat Will return a formatted number based on configuration given as stdWrap properties

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for numberFormat.

Returns:

string The processed input value

Definition at line 2511 of file class.tslib_content.php.

References $content, and numberFormat().

tslib_cObj::stdWrap_numRows	(	$	content = '',
		$	conf = array()
	)

numRows Counts the number of returned records of a DB operation makes use of select internally

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for numRows.

Returns:

string The processed input value

Definition at line 2185 of file class.tslib_content.php.

References $content, and numRows().

tslib_cObj::stdWrap_offsetWrap	(	$	content = '',
		$	conf = array()
	)

offsetWrap Creates a so called offset table around the content Still here for historical reasons even not used too much nowadays

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for offsetWrap.

Returns:

string The processed input value

Definition at line 3096 of file class.tslib_content.php.

References $content, t3lib_div\makeInstance(), and stdWrap().

tslib_cObj::stdWrap_outerWrap	(	$	content = '',
		$	conf = array()
	)

outerWrap Eighth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for outerWrap.

Returns:

string The processed input value

Definition at line 3069 of file class.tslib_content.php.

References $content, and wrap().

tslib_cObj::stdWrap_override	(	$	content = '',
		$	conf = array()
	)

override Will override the current value of content with its own value'

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for override.

Returns:

string The processed input value

Definition at line 2240 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_parseFunc	(	$	content = '',
		$	conf = array()
	)

parseFunc Will parse the content based on functions given as stdWrap properties Heavily used together with RTE based content

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for parseFunc.

Returns:

string The processed input value

Definition at line 2426 of file class.tslib_content.php.

References $content, and parseFunc().

tslib_cObj::stdWrap_postCObject	(	$	content = '',
		$	conf = array()
	)

postCObject A content object that is appended to the current content but between the innerWraps and the rest of the wraps

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for postCObject.

Returns:

string The processed input value

Definition at line 2867 of file class.tslib_content.php.

References $content, and cObjGetSingle().

tslib_cObj::stdWrap_postUserFunc	(	$	content = '',
		$	conf = array()
	)

postUserFunc Will execute a user function after the content has been modified by any other stdWrap function

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for postUserFunc.

Returns:

string The processed input value

Definition at line 3123 of file class.tslib_content.php.

References $content, and callUserFunction().

tslib_cObj::stdWrap_postUserFuncInt	(	$	content = '',
		$	conf = array()
	)

postUserFuncInt Will execute a user function after the content has been created and each time it is fetched from Cache The result of this function itself will not be cached

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for postUserFuncInt.

Returns:

string The processed input value

Definition at line 3137 of file class.tslib_content.php.

References $content, and $GLOBALS.

tslib_cObj::stdWrap_preCObject	(	$	content = '',
		$	conf = array()
	)

preCObject A content object that is prepended to the current content but between the innerWraps and the rest of the wraps

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for preCObject.

Returns:

string The processed input value

Definition at line 2854 of file class.tslib_content.php.

References $content, and cObjGetSingle().

tslib_cObj::stdWrap_prefixComment	(	$	content = '',
		$	conf = array()
	)

prefixComment Will add HTML comments to the content to make it easier to identify certain content elements within the HTML output later on

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for prefixComment.

Returns:

string The processed input value

Definition at line 3154 of file class.tslib_content.php.

References $content, $GLOBALS, and prefixComment().

tslib_cObj::stdWrap_preIfEmptyListNum	(	$	content = '',
		$	conf = array()
	)

preIfEmptyListNum Gets a value off a CSV list before the following ifEmpty check 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

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for preIfEmptyListNum.

Returns:

string The processed input value

Definition at line 2256 of file class.tslib_content.php.

References $content, and listNum().

tslib_cObj::stdWrap_prepend	(	$	content = '',
		$	conf = array()
	)

prepend A content object that will be prepended to the current content after most of the wraps have already been applied

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for prepend.

Returns:

string The processed input value

Definition at line 3029 of file class.tslib_content.php.

References $content, and cObjGetSingle().

tslib_cObj::stdWrap_preUserFunc	(	$	content = '',
		$	conf = array()
	)

preUserFunc Will execute a user public function before the content will be modified by any other stdWrap function

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for preUserFunc.

Returns:

string The processed input value

Definition at line 2211 of file class.tslib_content.php.

References $content, and callUserFunction().

tslib_cObj::stdWrap_prioriCalc	(	$	content = '',
		$	conf = array()
	)

prioriCalc Will use the content as a mathematical term and calculate the result Can be set to 1 to just get a calculated value or 'intval' to get the integer of the result

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for prioriCalc.

Returns:

string The processed input value

Definition at line 2470 of file class.tslib_content.php.

References $content, and t3lib_div\calcParenthesis().

tslib_cObj::stdWrap_rawUrlEncode	(	$	content = '',
		$	conf = array()
	)

rawUrlEncode Encodes content to be used within URLs

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for rawUrlEncode.

Returns:

string The processed input value

Definition at line 2661 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_removeBadHTML	(	$	content = '',
		$	conf = array()
	)

removeBadHTML Removes HTML tags based on stdWrap properties

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for removeBadHTML.

Returns:

string The processed input value

Definition at line 2609 of file class.tslib_content.php.

References $content, and removeBadHTML().

tslib_cObj::stdWrap_required	(	$	content = '',
		$	conf = array()
	)

required Will immediately stop rendering and return an empty value when there is no content at this point

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for required.

Returns:

string The processed input value

Definition at line 2362 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_setContentToCurrent	(	$	content = '',
		$	conf = array()
	)

setContentToCurrent actually it just does the contrary: Sets the value of 'current' based on current content

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for setContentToCurrent.

Returns:

string The processed input value

Definition at line 2088 of file class.tslib_content.php.

References $content, and $currentValKey.

tslib_cObj::stdWrap_setCurrent	(	$	content = '',
		$	conf = array()
	)

setCurrent Sets the value of 'current' based on the outcome of stdWrap operations

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for setCurrent.

Returns:

string The processed input value

Definition at line 2101 of file class.tslib_content.php.

References $content, and $currentValKey.

tslib_cObj::stdWrap_space	(	$	content = '',
		$	conf = array()
	)

space Will add space before or after the current content 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 See wrap

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for space.

Returns:

string The processed input value

Definition at line 2957 of file class.tslib_content.php.

References $content, and wrapSpace().

tslib_cObj::stdWrap_spaceAfter	(	$	content = '',
		$	conf = array()
	)

spaceAfter Will add space after the current content 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

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for spaceAfter and space.

Returns:

string The processed input value

Definition at line 2942 of file class.tslib_content.php.

References $content, and wrapSpace().

tslib_cObj::stdWrap_spaceBefore	(	$	content = '',
		$	conf = array()
	)

spaceBefore Will add space before the current content 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

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for spaceBefore and space.

Returns:

string The processed input value

Definition at line 2928 of file class.tslib_content.php.

References $content, and wrapSpace().

tslib_cObj::stdWrap_split	(	$	content = '',
		$	conf = array()
	)

split Will split the content by a given token and treat the results separately Automatically fills 'current' with a single result

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for split.

Returns:

string The processed input value

Definition at line 2456 of file class.tslib_content.php.

References $content, and splitObj().

tslib_cObj::stdWrap_stdWrap	(	$	content = '',
		$	conf = array()
	)

stdWrap A recursive call of the stdWrap function set This enables the user to execute stdWrap functions in another than the predefined order It modifies the content, not the property while the new feature of chained stdWrap functions modifies the property and not the content

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for stdWrap.

Returns:

string The processed input value

Definition at line 2332 of file class.tslib_content.php.

References $content, and stdWrap().

tslib_cObj::stdWrap_stdWrapOverride	(	$	content = '',
		$	conf = array()
	)

stdWrap override hook can be used by extensions authors to modify the behaviour of stdWrap functions to their needs this hook will execute functions on existing content but still before the content gets modified or replaced

Parameters:

string	Input value undergoing processing in these functions.
array	All stdWrap properties, not just the ones for a particular function.

Returns:

string The processed input value

Definition at line 2225 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_stdWrapPostProcess	(	$	content = '',
		$	conf = array()
	)

stdWrap post process hook can be used by extensions authors to modify the behaviour of stdWrap functions to their needs this hook executes functions at after the content has been modified by the rest of the stdWrap functions but still before debugging

Parameters:

string	Input value undergoing processing in these functions.
array	All stdWrap properties, not just the ones for a particular function.

Returns:

string The processed input value

Definition at line 3203 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_stdWrapPreProcess	(	$	content = '',
		$	conf = array()
	)

stdWrap pre process hook can be used by extensions authors to modify the behaviour of stdWrap functions to their needs this hook will execute functions before any other stdWrap function can modify anything

Parameters:

string	Input value undergoing processing in these functions.
array	All stdWrap properties, not just the ones for a particular function.

Returns:

string The processed input value

Definition at line 2073 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_stdWrapProcess	(	$	content = '',
		$	conf = array()
	)

stdWrap process hook can be used by extensions authors to modify the behaviour of stdWrap functions to their needs this hook executes functions directly after the recursive stdWrap function call but still before the content gets modified

Parameters:

string	Input value undergoing processing in these functions.
array	All stdWrap properties, not just the ones for a particular function.

Returns:

string The processed input value

Definition at line 2346 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_strftime	(	$	content = '',
		$	conf = array()
	)

strftime Will return a formatted date based on configuration given according to PHP strftime/gmstrftime properties Will return gmstrftime when the property GMT returns true

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for strftime.

Returns:

string The processed input value

Definition at line 2539 of file class.tslib_content.php.

References $content, and $GLOBALS.

tslib_cObj::stdWrap_stripHtml	(	$	content = '',
		$	conf = array()
	)

stripHtml Copmletely removes HTML tags from content

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for stripHtml.

Returns:

string The processed input value

Definition at line 2635 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_substring	(	$	content = '',
		$	conf = array()
	)

substring Will return a substring based on position information given by stdWrap properties

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for substring.

Returns:

string The processed input value

Definition at line 2596 of file class.tslib_content.php.

References $content, and substring().

tslib_cObj::stdWrap_tableStyle	(	$	content = '',
		$	conf = array()
	)

tableStyle Wraps content with table tags See wrap

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for tableStyle.

Returns:

string The processed input value

Definition at line 2827 of file class.tslib_content.php.

References $content, and tableStyle().

tslib_cObj::stdWrap_TCAselectItem	(	$	content = '',
		$	conf = array()
	)

TCAselectItem Returns a list of options available for a given field in the DB which has to be of the type select

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for TCAselectItem.

Returns:

string The processed input value

Definition at line 2912 of file class.tslib_content.php.

References $content, and TCAlookup().

tslib_cObj::stdWrap_textStyle	(	$	content = '',
		$	conf = array()
	)

textStyle Wraps content in font tags See wrap

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for textStyle.

Returns:

string The processed input value

Definition at line 2813 of file class.tslib_content.php.

References $content, and textStyle().

tslib_cObj::stdWrap_trim	(	$	content = '',
		$	conf = array()
	)

trim Cuts off any whitespace at the beginning and the end of the content

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for trim.

Returns:

string The processed input value

Definition at line 2316 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_typolink	(	$	content = '',
		$	conf = array()
	)

typolink Wraps the content with a link tag URLs and other attributes are created automatically by the values given in the stdWrap properties See wrap

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for typolink.

Returns:

string The processed input value

Definition at line 2899 of file class.tslib_content.php.

References $content.

tslib_cObj::stdWrap_wrap	(	$	content = '',
		$	conf = array()
	)

wrap This is the "mother" of all wraps Third of a set of different wraps which will be applied in a certain order before or after other functions that modify the content Basically it will put additional content before and after the current content using a split character as a placeholder for the current content The default split character is | but it can be replaced with other characters by the property splitChar Any other wrap that does not have own splitChar settings will be using the default split char though

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for wrap.

Returns:

string The processed input value

Definition at line 2974 of file class.tslib_content.php.

References $content, and wrap().

tslib_cObj::stdWrap_wrap2	(	$	content = '',
		$	conf = array()
	)

wrap2 Fifth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content The default split character is | but it can be replaced with other characters by the property splitChar

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for wrap2.

Returns:

string The processed input value

Definition at line 3002 of file class.tslib_content.php.

References $content, and wrap().

tslib_cObj::stdWrap_wrap3	(	$	content = '',
		$	conf = array()
	)

wrap3 Seventh of a set of different wraps which will be applied in a certain order before or after other functions that modify the content The default split character is | but it can be replaced with other characters by the property splitChar

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for wrap3.

Returns:

string The processed input value

Definition at line 3056 of file class.tslib_content.php.

References $content, and wrap().

tslib_cObj::stdWrap_wrapAlign	(	$	content = '',
		$	conf = array()
	)

wrapAlign Wraps content with a div container having the style attribute text-align set to the given value See wrap

Parameters:

string	Input value undergoing processing in this function.
array	stdWrap properties for wrapAlign.

Returns:

string The processed input value

Definition at line 2881 of file class.tslib_content.php.

References $content, and wrap().

tslib_cObj::substituteMarker	(	$	content,
		$	marker,
		$	markContent
	)

Substitutes a marker string in the input content (by a simple str_replace())

Parameters:

string	The content stream, typically HTML template content.
string	The marker string, typically on the form "###[the marker string]###"
mixed	The content to insert instead of the marker string found.

Returns:

string The processed HTML content string.

See also:

substituteSubpart()

Definition at line 1753 of file class.tslib_content.php.

References $content.

tslib_cObj::substituteMarkerArray	(	$	content,
		array $	markContentArray,
		$	wrap = '',
		$	uppercase = FALSE,
		$	deleteUnused = FALSE
	)

Traverses the input $markContentArray array and for each key the marker by the same name (possibly wrapped and in upper case) will be substituted with the keys value in the array.

This is very useful if you have a data-record to substitute in some content. In particular when you use the $wrap and $uppercase values to pre-process the markers. Eg. a key name like "myfield" could effectively be represented by the marker "###MYFIELD###" if the wrap value was "###|###" and the $uppercase boolean TRUE.

Parameters:

string	The content stream, typically HTML template content.
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.
string	A wrap value - [part 1] | [part 2] - for the markers before substitution
boolean	If set, all marker string substitution is done with upper-case markers.
boolean	If set, all unused marker are deleted.

Returns:

string The processed output stream

See also:

substituteMarker(), substituteMarkerInObject(), TEMPLATE()

Definition at line 1898 of file class.tslib_content.php.

References $content.

Referenced by substituteMarkerInObject().

tslib_cObj::substituteMarkerArrayCached	(	$	content,
		array $	markContentArray = NULL,
		array $	subpartContentArray = NULL,
		array $	wrappedSubpartContentArray = NULL
	)

Multi substitution function with caching.

This function should be a one-stop substitution function for working with HTML-template. It does not substitute by str_replace but by splitting. This secures that the value inserted does not themselves contain markers or subparts.

Note that the "caching" won't cache the content of the substition, but only the splitting of the template in various parts. So if you want only one cache-entry per template, make sure you always pass the exact same set of marker/subpart keys. Else you will be flooding the users cache table.

This function takes three kinds of substitutions in one: $markContentArray is a regular marker-array where the 'keys' are substituted in $content with their values

$subpartContentArray works exactly like markContentArray only is whole subparts substituted and not only a single marker.

$wrappedSubpartContentArray is 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.

Parameters:

string	The content stream, typically HTML template content.
array	Regular marker-array where the 'keys' are substituted in $content with their values
array	Exactly like markContentArray only is whole subparts substituted and not only a single marker.
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.

Returns:

string The output content stream

See also:

substituteSubpart(), substituteMarker(), substituteMarkerInObject(), TEMPLATE()

Definition at line 1789 of file class.tslib_content.php.

References $content, $GLOBALS, and substituteSubpart().

tslib_cObj::substituteMarkerInObject	(	&$	tree,
		array $	markContentArray
	)

Substitute marker array in an array of values

Parameters:

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)
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.

Returns:

mixed The processed input variable.

See also:

substituteMarker()

Definition at line 1910 of file class.tslib_content.php.

References $value, and substituteMarkerArray().

tslib_cObj::substituteSubpart	(	$	content,
		$	marker,
		$	subpartContent,
		$	recursive = 1
	)

Substitute subpart in input template stream. This function substitutes a subpart in $content with the content of $subpartContent. Wrapper for t3lib_parsehtml::substituteSubpart which behaves identical

Parameters:

string	The content stream, typically HTML template content.
string	The marker string, typically on the form "###[the marker string]###"
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.
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!

Returns:

string The processed HTML content string.

See also:

getSubpart(), t3lib_parsehtml::substituteSubpart()

Definition at line 1728 of file class.tslib_content.php.

References $content.

Referenced by substituteMarkerArrayCached().

tslib_cObj::substituteSubpartArray	(	$	content,
		array $	subpartsContent
	)

Substitues multiple subparts at once

Parameters:

string	The content stream, typically HTML template content.
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.

Returns:

string The processed HTML content string.

Definition at line 1739 of file class.tslib_content.php.

References $content.

tslib_cObj::substring	(	$	content,
		$	options
	)

Implements the stdWrap property "substring" which is basically a TypoScript implementation of the PHP function, substr()

Parameters:

string	The string to perform the operation on
string	The parameters to substring, given as a comma list of integers where the first and second number is passed as arg 1 and 2 to substr().

Returns:

string The processed input value. private

See also:

stdWrap()

Definition at line 3573 of file class.tslib_content.php.

References $content, $GLOBALS, and t3lib_div\intExplode().

Referenced by stdWrap_substring().

tslib_cObj::SVG

(

$

conf

)

Rendering the cObject, SVG

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1205 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::SWFOBJECT

(

$

conf

)

Rendering the cObject, SWFOBJECT

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 1185 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::tableStyle	(	$	theValue,
		$	conf
	)

Implements the stdWrap property "tableStyle"; Basically this generates a

with properties which is wrapped around the input value.

Parameters:

string	The input value
array	TypoScript properties for the "TypoScript function" '->textStyle'

Returns:

string The processed output value private

See also:

stdWrap()

Definition at line 3890 of file class.tslib_content.php.

References $align, stdWrap(), and wrap().

Referenced by stdWrap_tableStyle().

tslib_cObj::TCAlookup	(	$	inputValue,
		$	conf
	)

Looks up the incoming value in the defined TCA configuration Works only with TCA-type 'select' and options defined in 'items'

Parameters:

mixed	Comma-separated list of values to look up
array	TS-configuration array, see TSref for details

Returns:

string String of translated values, seperated by $delimiter. If no matches were found, the input value is simply returned.

Todo:

It would be nice it this function basically looked up any type of value, db-relations etc.

Definition at line 5375 of file class.tslib_content.php.

References $GLOBALS, $table, $TCA, $value, t3lib_div\loadTCA(), and t3lib_div\trimExplode().

Referenced by stdWrap_TCAselectItem().

tslib_cObj::TEMPLATE

(

$

conf

)

Rendering the cObject, TEMPLATE

Parameters:

array

array of TypoScript properties

Returns:

string Output

See also:

substituteMarkerArrayCached()

Definition at line 1143 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::TEXT

(

$

conf

)

Rendering the cObject, TEXT

Parameters:

array

array of TypoScript properties

Returns:

string Output

Definition at line 882 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::textStyle	(	$	theValue,
		$	conf
	)

Implements the stdWrap property "textStyle"; This generates a <font>-tag (and a

-tag for align-attributes) which is wrapped around the input value.

Parameters:

string	The input value
array	TypoScript properties for the "TypoScript function" '->textStyle'

Returns:

string The processed output value private

See also:

stdWrap()

Definition at line 3792 of file class.tslib_content.php.

References $align, HTMLcaseshift(), stdWrap(), and wrap().

Referenced by stdWrap_textStyle().

tslib_cObj::typoLink	(	$	linktxt,
		$	conf
	)

Implements the "typolink" property of stdWrap (and others) Basically the input string, $linktext, is (typically) wrapped in a -tag linking to some page, email address, file or URL based on a parameter defined by the configuration array $conf. This function is best used from internal functions as is. There are some API functions defined after this function which is more suited for general usage in external applications. Generally the concept "typolink" should be used in your own applications as an API for making links to pages with parameters and more. The reason for this is that you will then automatically make links compatible with all the centralized functions for URL simulation and manipulation of parameters into hashes and more. For many more details on the parameters and how they are intepreted, please see the link to TSref below.

Parameters:

string	The string (text) to link
array	TypoScript configuration (see link below)

Returns:

string A link-wrapped string.

See also:

stdWrap(), tslib_pibase::pi_linkTP()

Definition at line 5425 of file class.tslib_content.php.

References $data, $GLOBALS, $lastTypoLinkLD, $lastTypoLinkTarget, $lastTypoLinkUrl, $pid, $res, $row, callUserFunction(), t3lib_pageSelect\DOKTYPE_SHORTCUT, enableFields(), extLinkATagParams(), forceAbsoluteUrl(), t3lib_div\generateCHash(), getATagParams(), getClosestMPvalueForPage(), t3lib_div\getIndpEnv(), getMailTo(), getQueryArguments(), getTypoLink_URL(), t3lib_div\getUserObj(), t3lib_div\inList(), locDataJU(), t3lib_pageSelect\SHORTCUT_MODE_NONE, stdWrap(), t3lib_div\testInt(), t3lib_div\trimExplode(), t3lib_div\unQuoteFilenames(), URLqMark(), and wrap().

Referenced by filelink(), and imageLinkWrap().

tslib_cObj::typoLink_URL

(

$

conf

)

Based on the input "TypoLink" TypoScript configuration this will return the generated URL

Parameters:

array

TypoScript properties for "typolink"

Returns:

string The URL of the link-tag that typolink() would by itself return

See also:

typoLink()

Definition at line 6002 of file class.tslib_content.php.

References $lastTypoLinkUrl.

tslib_cObj::typolinkWrap

(

$

conf

)

Generates a typolink and returns the two link tags - start and stop - in an array

Parameters:

array

"typolink" TypoScript properties

Returns:

array An array with two values in key 0+1, each value being the start and close -tag of the typolink properties being inputted in $conf

See also:

typolink()

Definition at line 6060 of file class.tslib_content.php.

tslib_cObj::URLqMark	(	$	url,
		$	params
	)

Checks if $url has a '?' in it and if not, a '?' is inserted between $url and $params, which are anyway concatenated and returned

Parameters:

string	Input URL
string	URL parameters

Returns:

string

Definition at line 6511 of file class.tslib_content.php.

Referenced by typoLink().

tslib_cObj::USER	(	$	conf,
		$	ext = ''
	)

Rendering the cObject, USER and USER_INT

Parameters:

array	array of TypoScript properties
string	If "INT" then the cObject is a "USER_INT" (non-cached), otherwise just "USER" (cached)

Returns:

string Output

Definition at line 918 of file class.tslib_content.php.

References getContentObject().

tslib_cObj::wrap	(	$	content,
		$	wrap,
		$	char = '|'
	)

Wrapping a string. Implements the TypoScript "wrap" property. Example: $content = "HELLO WORLD" and $wrap = "<strong> | </strong>", result: "<strong>HELLO WORLD</strong>"

Parameters:

string	The content to wrap
string	The wrap value, eg. "<strong> | </strong>"
string	The char used to split the wrapping value, default is "|"

Returns:

string Wrapped input string

See also:

noTrimWrap()

Definition at line 6243 of file class.tslib_content.php.

References $content.

Referenced by _parseFunc(), cImage(), dataWrap(), encaps_lineSplit(), filelink(), http_makelinks(), mailto_makelinks(), parseFunc(), splitObj(), stdWrap_fontTag(), stdWrap_innerWrap(), stdWrap_innerWrap2(), stdWrap_outerWrap(), stdWrap_wrap(), stdWrap_wrap2(), stdWrap_wrap3(), stdWrap_wrapAlign(), tableStyle(), textStyle(), and typoLink().

tslib_cObj::wrapSpace	(	$	content,
		$	wrap,
		array $	conf = NULL
	)

Adds space above/below the input HTML string. It is done by adding a clear-gif and
tag before and/or after the content.

Parameters:

string	The content to add space above/below to.
string	A value like "10 | 20" where the first part denotes the space BEFORE and the second part denotes the space AFTER (in pixels)
array	Configuration from TypoScript

Returns:

string Wrapped string

Definition at line 6276 of file class.tslib_content.php.

References $content, $GLOBALS, and getBorderAttr().

Referenced by stdWrap_space(), stdWrap_spaceAfter(), and stdWrap_spaceBefore().

---

Member Data Documentation

tslib_cObj::$align

Initial value:

 array(
        'center',
        'right',
        'left'
    )

Definition at line 234 of file class.tslib_content.php.

Referenced by tableStyle(), and textStyle().

tslib_cObj::$alternativeData = ''

Definition at line 501 of file class.tslib_content.php.

tslib_cObj::$checkPid_badDoktypeList = '255'

Definition at line 515 of file class.tslib_content.php.

tslib_cObj::$checkPid_cache = array()

Definition at line 514 of file class.tslib_content.php.

tslib_cObj::$cObjHookObjectsArr = array()

Definition at line 521 of file class.tslib_content.php.

tslib_cObj::$contentObjects = array() [protected]

Definition at line 528 of file class.tslib_content.php.

tslib_cObj::$currentRecord = ''

Definition at line 504 of file class.tslib_content.php.

Referenced by locDataJU(), and setParent().

tslib_cObj::$currentRecordNumber = 0

Definition at line 506 of file class.tslib_content.php.

tslib_cObj::$currentRecordTotal = 0

Definition at line 505 of file class.tslib_content.php.

tslib_cObj::$currentValKey = 'currentValue_kidjls9dksoje'

Definition at line 503 of file class.tslib_content.php.

Referenced by _parseFunc(), getCurrentVal(), getData(), setCurrentVal(), splitObj(), stdWrap_current(), stdWrap_setContentToCurrent(), and stdWrap_setCurrent().

tslib_cObj::$data = array()

Loaded with the current data-record.

If the instance of this class is used to render records from the database those records are found in this array. The function stdWrap has TypoScript properties that fetch field-data from this array.

See also:

init()

Definition at line 498 of file class.tslib_content.php.

Referenced by _parseFunc(), filelist(), http_makelinks(), mailto_makelinks(), setParent(), start(), and typoLink().

tslib_cObj::$doConvertToUserIntObject = FALSE

Set to TRUE by doConvertToUserIntObject() if USER object wants to become USER_INT

Definition at line 533 of file class.tslib_content.php.

tslib_cObj::$getImgResourceHookObjects [protected]

Definition at line 523 of file class.tslib_content.php.

Referenced by getGetImgResourceHookObjects().

tslib_cObj::$image_compression

Holds ImageMagick parameters and extensions used for compression

See also:

IMGTEXT()

0= Default 1= Dont change! (removes all parameters for the image_object!!) 1x = GIFs 2x = JPGs

Definition at line 403 of file class.tslib_content.php.

tslib_cObj::$image_effects

Initial value:

 array(
        1 => '-rotate 90',
        2 => '-rotate 270',
        3 => '-rotate 180',
        10 => '-colorspace GRAY',
        11 => '-sharpen 70',
        20 => '-normalize',
        23 => '-contrast',
        25 => '-gamma 1.3',
        26 => '-gamma 0.8'
    )

ImageMagick parameters for image effects

See also:

IMGTEXT()

Definition at line 479 of file class.tslib_content.php.

tslib_cObj::$INT_include = 0

Definition at line 513 of file class.tslib_content.php.

tslib_cObj::$lastTypoLinkLD = array()

Definition at line 518 of file class.tslib_content.php.

Referenced by typoLink().

tslib_cObj::$lastTypoLinkTarget = ''

Definition at line 517 of file class.tslib_content.php.

Referenced by typoLink().

tslib_cObj::$lastTypoLinkUrl = ''

Definition at line 516 of file class.tslib_content.php.

Referenced by getTypoLink_URL(), typoLink(), and typoLink_URL().

tslib_cObj::$oldData = array()

Definition at line 500 of file class.tslib_content.php.

tslib_cObj::$parameters = array()

Definition at line 502 of file class.tslib_content.php.

Referenced by getTreeList(), imageLinkWrap(), and modifyImageMagickStripProfileParameters().

tslib_cObj::$parentRecord = array()

Definition at line 508 of file class.tslib_content.php.

tslib_cObj::$parentRecordNumber = 0

Definition at line 507 of file class.tslib_content.php.

Referenced by getData().

tslib_cObj::$recordRegister = array()

Definition at line 520 of file class.tslib_content.php.

tslib_cObj::$regObj

Definition at line 509 of file class.tslib_content.php.

tslib_cObj::$stdWrapHookObjects = array() [protected]

Definition at line 522 of file class.tslib_content.php.

tslib_cObj::$stdWrapOrder

stdWrap functions in their correct order

See also:

stdWrap()

Definition at line 245 of file class.tslib_content.php.

tslib_cObj::$substMarkerCache = array()

Definition at line 519 of file class.tslib_content.php.

tslib_cObj::$table = '' [protected]

Definition at line 499 of file class.tslib_content.php.

Referenced by DBgetDelete(), DBgetInsert(), DBgetUpdate(), DBmayFEUserEdit(), DBmayFEUserEditSelect(), enableFields(), start(), and TCAlookup().

tslib_cObj::$userObjectType = FALSE [protected]

Indicates current object type. Can hold one of OBJECTTYPE_ constants or FALSE. The value is set and reset inside USER() function. Any time outside of USER() it is FALSE.

Definition at line 540 of file class.tslib_content.php.

Referenced by getUserObjectType(), and setUserObjectType().

const tslib_cObj::OBJECTTYPE_USER = 2

Indicates that object type is USER.

See also:

tslib_cObjh::$userObjectType

Definition at line 554 of file class.tslib_content.php.

Referenced by Tx_Extbase_MVC_Web_FrontendRequestHandler\handleRequest(), and tslib_content_User\render().

const tslib_cObj::OBJECTTYPE_USER_INT = 1

Indicates that object type is USER.

See also:

tslib_cObjh::$userObjectType

Definition at line 547 of file class.tslib_content.php.

Referenced by tslib_content_UserInternal\render().

---

The documentation for this class was generated from the following file:

• typo3/sysext/cms/tslib/class.tslib_content.php