Documentation TYPO3 par Ameos

Disponible dans d'autres versions de TYPO3 -> 3.7.0 3.8.1 4.0.0 4.0.1 4.1.0 <- Available in other TYPO3 versions

tslib_cObj Class Reference


Public Member Functions
	start ($data, $table='')
	setParent ($data, $currentRecord)
	getCurrentVal ()
	setCurrentVal ($value)
	cObjGet ($setup, $addKey='')
	cObjGetSingle ($name, $conf, $TSkey='__')
	HTML ($conf)
	TEXT ($conf)
	CLEARGIF ($conf)
	COBJ_ARRAY ($conf, $ext='')
	USER ($conf, $ext='')
	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)
	netprintApplication_offsiteLinkWrap ($str, $imgConf, $conf)
	getFieldDefaultValue ($noValueInsert, $fieldName, $defaultVal)
	cImage ($file, $conf)
	imageLinkWrap ($string, $imageFile, $conf)
	fileResource ($fName, $addParams='alt=""title=""')
	lastChanged ($tstamp)
	linkWrap ($content, $wrap)
	getAltParam ($conf)
	getSubpart ($content, $marker)
	substituteSubpart ($content, $marker, $subpartContent, $recursive=1)
	substituteMarker ($content, $marker, $markContent)
	substituteMarkerArrayCached ($content, $markContentArray=array(), $subpartContentArray=array(), $wrappedSubpartContentArray=array())
	substituteMarkerArray ($content, $markContentArray, $wrap='', $uppercase=0)
	substituteMarkerInObject (&$tree, $markContentArray)
	fillInMarkerArray ($markContentArray, $row, $fieldList='', $nl2br=TRUE, $prefix='FIELD_', $HSC=FALSE)
	stdWrap ($content, $conf)
	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)
	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)
	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 ($var, $source=NULL)
	getKey ($key, $arr)
	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)
	wrap ($content, $wrap, $char='\|')
	noTrimWrap ($content, $wrap)
	wrapSpace ($content, $wrap)
	callUserFunction ($funcName, $conf, $content)
	processParams ($params)
	keywords ($content)
	caseshift ($theValue, $case)
	HTMLcaseshift ($theValue, $case)
	bytes ($sizeInBytes, $labels)
	calcAge ($seconds, $labels)
	sendNotifyEmail ($msg, $recipients, $cc, $email_from, $email_fromName='', $replyTo='')
	URLqMark ($url, $params)
	checkEmail ($email)
	clearTSProperties ($TSArr, $propList)
	mergeTSRef ($confArr, $prop)
	joinTSarrays ($conf, $old_conf)
	gifBuilderTextBox ($gifbuilderConf, $conf, $text)
	linebreaks ($string, $chars, $maxLines=0)
	getUpdateJS ($dataArray, $formName, $arrPrefix, $fieldList)
	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='', $prevId_array=array(), $recursionLevel=0)
	whereSelectFromList ($field, $value)
	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)
	editPanel ($content, $conf, $currentRecord='', $dataArr=array())
	editIcons ($content, $params, $conf=array(), $currentRecord='', $dataArr=array(), $addUrlParamStr='')
	editPanelLinkWrap ($string, $formName, $cmd, $currentRecord='', $confirm='')
	editPanelLinkWrap_doWrap ($string, $url, $currentRecord)
	editPanelPreviewBorder ($table, $row, $content, $thick)
	isDisabled ($table, $row)
	start ($data, $table='')
	setParent ($data, $currentRecord)
	getCurrentVal ()
	setCurrentVal ($value)
	cObjGet ($setup, $addKey='')
	cObjGetSingle ($name, $conf, $TSkey='__')
	HTML ($conf)
	TEXT ($conf)
	CLEARGIF ($conf)
	COBJ_ARRAY ($conf, $ext='')
	USER ($conf, $ext='')
	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)
	netprintApplication_offsiteLinkWrap ($str, $imgConf, $conf)
	getFieldDefaultValue ($noValueInsert, $fieldName, $defaultVal)
	cImage ($file, $conf)
	imageLinkWrap ($string, $imageFile, $conf)
	fileResource ($fName, $addParams='alt=""title=""')
	lastChanged ($tstamp)
	linkWrap ($content, $wrap)
	getAltParam ($conf)
	getSubpart ($content, $marker)
	substituteSubpart ($content, $marker, $subpartContent, $recursive=1)
	substituteMarker ($content, $marker, $markContent)
	substituteMarkerArrayCached ($content, $markContentArray=array(), $subpartContentArray=array(), $wrappedSubpartContentArray=array())
	substituteMarkerArray ($content, $markContentArray, $wrap='', $uppercase=0)
	substituteMarkerInObject (&$tree, $markContentArray)
	fillInMarkerArray ($markContentArray, $row, $fieldList='', $nl2br=TRUE, $prefix='FIELD_', $HSC=FALSE)
	stdWrap ($content, $conf)
	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)
	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)
	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 ($var, $source=NULL)
	getKey ($key, $arr)
	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)
	wrap ($content, $wrap, $char='\|')
	noTrimWrap ($content, $wrap)
	wrapSpace ($content, $wrap)
	callUserFunction ($funcName, $conf, $content)
	processParams ($params)
	keywords ($content)
	caseshift ($theValue, $case)
	HTMLcaseshift ($theValue, $case)
	bytes ($sizeInBytes, $labels)
	calcAge ($seconds, $labels)
	sendNotifyEmail ($msg, $recipients, $cc, $email_from, $email_fromName='', $replyTo='')
	URLqMark ($url, $params)
	checkEmail ($email)
	clearTSProperties ($TSArr, $propList)
	mergeTSRef ($confArr, $prop)
	joinTSarrays ($conf, $old_conf)
	gifBuilderTextBox ($gifbuilderConf, $conf, $text)
	linebreaks ($string, $chars, $maxLines=0)
	getUpdateJS ($dataArray, $formName, $arrPrefix, $fieldList)
	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='', $prevId_array=array(), $recursionLevel=0)
	whereSelectFromList ($field, $value)
	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)
	editPanel ($content, $conf, $currentRecord='', $dataArr=array())
	editIcons ($content, $params, $conf=array(), $currentRecord='', $dataArr=array(), $addUrlParamStr='')
	editPanelLinkWrap ($string, $formName, $cmd, $currentRecord='', $confirm='')
	editPanelLinkWrap_doWrap ($string, $url, $currentRecord)
	editPanelPreviewBorder ($table, $row, $content, $thick)
	isDisabled ($table, $row)
Public Attributes
	$align = Array ('center', 'right', 'left')
	$caseConvStrings
	$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 = ''
	$substMarkerCache = array()
	$recordRegister = array()

Detailed Description

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

Member Function Documentation

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 3984 of file class.tslib_content.php.
References t3lib_div::get_tag_attributes(), and t3lib_div::inList().

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. &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=325&cHash=ae4272e694

Definition at line 3628 of file class.tslib_content.php.
References t3lib_div::get_tag_attributes(), and t3lib_div::implodeAttributes().

tslib_cObj::bytes ( $ sizeInBytes,

$ labels

)

Formats a number to GB, Mb or Kb or just bytes

Parameters:

integer Number of bytes to format.

string Labels for bytes, kilo, mega and giga separated by vertical bar (|) and possibly encapsulated in "". Eg: " | K| M| G" (which is the default value)

Returns:
string

See also:
t3lib_div::formatSize(), stdWrap() Use t3lib_div::formatSize() instead

Definition at line 5421 of file class.tslib_content.php.
References t3lib_div::formatSize().

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 3769 of file class.tslib_content.php.
References t3lib_div::splitCalc().

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 5432 of file class.tslib_content.php.
References t3lib_div::testInt().

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 3798 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 5291 of file class.tslib_content.php.
References t3lib_div::isFirstPartOfStr(), and t3lib_div::makeInstanceClassName().

tslib_cObj::CASEFUNC ( $ conf )

Rendering the cObject, CASE

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=364&cHash=cffedd09e3

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

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 5367 of file class.tslib_content.php.

tslib_cObj::checkEmail ( $ email )

Checking syntax of input email address

Parameters:

string Input string to evaluate

Returns:
boolean Returns true if the $email address (input string) is valid; Has a "@", domain name with at least one period and only allowed a-z characters.

See also:
t3lib_div::validEmail()

Definition at line 5506 of file class.tslib_content.php.
References t3lib_div::validEmail().

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 &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=320&cHash=da01618eab HMENU(), CASEFUNC(), IMAGE(), COLUMN(), stdWrap(), _parseFunc()

Definition at line 3185 of file class.tslib_content.php.
References t3lib_div::inList().

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 6367 of file class.tslib_content.php.

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 6344 of file class.tslib_content.php.

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 2470 of file class.tslib_content.php.
References t3lib_div::png_to_gif_by_imagemagick().

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 3327 of file class.tslib_content.php.
References t3lib_div::isAbsPath(), and t3lib_div::validPathStr().

tslib_cObj::CLEARGIF ( $ conf )

Rendering the cObject, CLEARGIF

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=355&cHash=70c0f19915

Definition at line 604 of file class.tslib_content.php.
References stdWrap(), and wrap().

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 5518 of file class.tslib_content.php.

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 &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=351&cHash=a09db0329c

Definition at line 623 of file class.tslib_content.php.
References checkIf(), cObjGet(), stdWrap(), and wrap().

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 412 of file class.tslib_content.php.
References cObjGetSingle(), and t3lib_TStemplate::sortedKeyList().

tslib_cObj::COLUMNS ( $ conf )

Rendering the cObject, COLUMNS

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=361&cHash=7e4e228cad

Definition at line 1355 of file class.tslib_content.php.
References t3lib_div::intInRange().

tslib_cObj::CONTENT ( $ conf )

Rendering the cObject, CONTENT

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=356&cHash=9f3b5c6ba2

Definition at line 1129 of file class.tslib_content.php.
References t3lib_div::makeInstance().

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.

Returns:
string The processed input value. private

See also:
stdWrap()

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

tslib_cObj::CTABLE ( $ conf )

Rendering the cObject, CTABLE

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=359&cHash=2e0065b4e7

Definition at line 1302 of file class.tslib_content.php.
References t3lib_div::makeInstance().

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 5146 of file class.tslib_content.php.

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. "" 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 3359 of file class.tslib_content.php.

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 5739 of file class.tslib_content.php.

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 5813 of file class.tslib_content.php.
References 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 5771 of file class.tslib_content.php.
References 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 5850 of file class.tslib_content.php.
References 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 5890 of file class.tslib_content.php.
References t3lib_div::intExplode(), and t3lib_div::trimExplode().

tslib_cObj::editIcons ( $ content,

$ params,

$ 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 6588 of file class.tslib_content.php.
References t3lib_div::_GP(), t3lib_div::getIndpEnv(), t3lib_BEfunc::getRecord(), and t3lib_div::trimExplode().

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. &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=375&cHash=7d8915d508

Definition at line 6423 of file class.tslib_content.php.
References t3lib_div::_GP(), t3lib_div::_POST(), t3lib_div::fixed_lgd(), t3lib_div::makeInstance(), and t3lib_div::trimExplode().

tslib_cObj::editPanelLinkWrap ( $ string,

$ formName,

$ cmd,

$ currentRecord = '',

$ confirm = ''

)

Helper function for editPanel() which wraps icons in the panel in a link with the action of the panel. The links are for some of them not simple hyperlinks but onclick-actions which submits a little form which the panel is wrapped in.

Parameters:

string The string to wrap in a link, typ. and image used as button in the edit panel.

string The name of the form wrapping the edit panel.

string The command of the link. There is a predefined list available: edit, new, up, down etc.

string The "table:uid" of the record being processed by the panel.

string Text string with confirmation message; If set a confirm box will be displayed before carrying out the action (if Yes is pressed)

Returns:
string A tag wrapped string. private

See also:
editPanel(), editIcons(), t3lib_tsfeBeUserAuth::extEditAction()

Definition at line 6653 of file class.tslib_content.php.
References t3lib_div::_GP(), t3lib_div::getIndpEnv(), and t3lib_div::testInt().

tslib_cObj::editPanelLinkWrap_doWrap ( $ string,

$ url,

$ currentRecord

)

Creates a link to a script (eg. typo3/alt_doc.php or typo3/db_new.php) which either opens in the current frame OR in a pop-up window.

Parameters:

string The string to wrap in a link, typ. and image used as button in the edit panel.

string The URL of the link. Should be absolute if supposed to work with <base> path set.

string The "table:uid" of the record being processed by the panel.

Returns:
string A tag wrapped string. private

See also:
editPanelLinkWrap()

Definition at line 6693 of file class.tslib_content.php.
References t3lib_div::getIndpEnv().

tslib_cObj::editPanelPreviewBorder ( $ table,

$ row,

$ content,

$ thick

)

Wraps the input content string in a table with a gray border if the table/row combination evaluates to being disabled/hidden. Used for marking previewed records in the frontend.

Parameters:

string The table name

array The data record from $table

string The content string to wrap

integer The thickness of the border

Returns:
string The input string wrapped in a table with a border color of cccccc and thickness = $thick private

See also:
editPanel()

Definition at line 6720 of file class.tslib_content.php.
References t3lib_div::intInRange().

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 NOT [fieldname] AND ...". Eg. " AND NOT hidden AND starttime < 123345567"

See also:
t3lib_pageSelect::enableFields()

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

tslib_cObj::encaps_lineSplit ( $ theValue,

$ conf

)

Lets you split the content by chr(10) 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 chr(10) again. private &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=323&cHash=a19312be78

Definition at line 4186 of file class.tslib_content.php.
References t3lib_div::get_tag_attributes(), t3lib_div::implodeAttributes(), t3lib_div::revExplode(), and t3lib_div::trimExplode().

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 6153 of file class.tslib_content.php.

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 the 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 6072 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 the 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 6099 of file class.tslib_content.php.

tslib_cObj::FILE ( $ conf )

Rendering the cObject, FILE

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=352&cHash=379c60f8bc

Definition at line 686 of file class.tslib_content.php.
References fileResource(), getAltParam(), linkWrap(), stdWrap(), and wrap().

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 &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=326&cHash=5618043c18 stdWrap()

Definition at line 3671 of file class.tslib_content.php.
References t3lib_div::inList(), and t3lib_div::split_fileref().

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 3248 of file class.tslib_content.php.
References t3lib_div::inList(), t3lib_div::split_fileref(), and t3lib_div::uniqueList().

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 2568 of file class.tslib_content.php.
References t3lib_div::inList(), and t3lib_div::split_fileref().

tslib_cObj::fillInMarkerArray ( $ markContentArray,

$ 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 2916 of file class.tslib_content.php.
References t3lib_div::testInt(), and t3lib_div::trimExplode().

tslib_cObj::FORM ( $ conf,

$ formData = ''

)

Rendering the cObject, FORM
Note on $formData: In the optional $formData array each entry represents a line in the ordinary setup. In those entries each entry (0,1,2...) represents a space normally divided by the '|' line.
$formData [] = array('Name:', 'name=input, 25 ', 'Default value....'); $formData [] = array('Email:', 'email=input, 25 ', 'Default value for email....');

corresponds to the $conf['data'] value being : Name:|name=input, 25 |Default value....||Email:|email=input, 25 |Default value for email....

If $formData is an array the value of $conf['data'] is ignored.

Parameters:

array Array of TypoScript properties

array Alternative formdata overriding whatever comes from TypoScript

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=367&cHash=bbc518d930

Definition at line 1524 of file class.tslib_content.php.
References t3lib_div::formatForTextarea(), t3lib_div::intInRange(), and t3lib_TStemplate::sortedKeyList().

tslib_cObj::getAltParam ( $ conf )

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

Parameters:

array TypoScript configuration properties

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

See also:
IMGTEXT(), cImage()

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

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 5159 of file class.tslib_content.php.

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 388 of file class.tslib_content.php.

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 &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=282&cHash=831a95115d getFieldVal()

Definition at line 4580 of file class.tslib_content.php.
References t3lib_div::_GP(), t3lib_div::getIndpEnv(), t3lib_div::trimExplode(), and t3lib_div::view_array().

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 2452 of file class.tslib_content.php.
References 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 4560 of file class.tslib_content.php.

tslib_cObj::getGlobal ( $ var,

$ source = NULL

)

Returns a value from the array, $GLOBALS where the input key, $val, is splitted by "|" first and each part points to a key in the $GLOBALS array. Example: $var = "HTTP_SERVER_VARS | something" will return the value $GLOBALS['HTTP_SERVER_VARS']['something'] value

Parameters:

string Key, see description of functon

array If you want another array that $GLOBALS used, then just put it in here!

Returns:
mixed Value from $GLOBALS private

See also:
getData()

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

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. &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=315&cHash=63b593a934 IMG_RESOURCE(), cImage(), tslib_gifBuilder

Definition at line 4388 of file class.tslib_content.php.
References t3lib_div::inList(), t3lib_div::makeInstance(), t3lib_div::shortMD5(), and t3lib_div::split_fileref().

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 4754 of file class.tslib_content.php.

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() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=318&cHash=a98cb4e7e6

Definition at line 6171 of file class.tslib_content.php.
References t3lib_div::intInRange().

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  World. How are  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

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 2683 of file class.tslib_content.php.

tslib_cObj::getTreeList ( $ id,

$ depth,

$ begin = 0,

$ dontCheckEnableFields = FALSE,

$ addSelectFields = '',

$ moreWhereClauses = '',

$ 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 or of the Backend User Section 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 5954 of file class.tslib_content.php.
References getTreeList().

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 5091 of file class.tslib_content.php.

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 5121 of file class.tslib_content.php.

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 5670 of file class.tslib_content.php.
References t3lib_div::trimExplode().

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 &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=318&cHash=a98cb4e7e6 getQuery()

Definition at line 6250 of file class.tslib_content.php.
References 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 5583 of file class.tslib_content.php.

tslib_cObj::HMENU ( $ conf )

Rendering the cObject, HMENU

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=358&cHash=5400c1c06a

Definition at line 1270 of file class.tslib_content.php.
References t3lib_div::inList(), and t3lib_div::makeInstance().

tslib_cObj::HRULER ( $ conf )

Rendering the cObject, HRULER

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=362&cHash=2a462aa084

Definition at line 1434 of file class.tslib_content.php.
References t3lib_div::intInRange().

tslib_cObj::HTML ( $ conf )

Rendering the cObject, HTML

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=349&cHash=d3fd0c70b4

Definition at line 582 of file class.tslib_content.php.
References stdWrap().

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 5392 of file class.tslib_content.php.

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. &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=330&cHash=664e0296bf stdWrap(), t3lib_parsehtml::HTMLparserConfig(), t3lib_parsehtml::HTMLcleaner()

Definition at line 3345 of file class.tslib_content.php.
References t3lib_div::makeInstance().

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. &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=328&cHash=c1135706d7 _parseFunc()

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

tslib_cObj::IMAGE ( $ conf )

Rendering the cObject, IMAGE

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=353&cHash=440681ea56 cImage()

Definition at line 702 of file class.tslib_content.php.
References checkIf(), cImage(), and stdWrap().

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() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=316&cHash=2848266da6

Definition at line 2503 of file class.tslib_content.php.
References t3lib_div::intExplode(), and t3lib_div::makeInstance().

tslib_cObj::IMG_RESOURCE ( $ conf )

Rendering the cObject, IMG_RESOURCE

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=354&cHash=46f9299706 getImgResource()

Definition at line 721 of file class.tslib_content.php.
References getImgResource(), and stdWrap().

tslib_cObj::IMGTEXT ( $ conf )

Rendering the cObject, IMGTEXT

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=363&cHash=cf2969bce1

Definition at line 733 of file class.tslib_content.php.
References $align, cObjGet(), cObjGetSingle(), t3lib_div::intInRange(), stdWrap(), and t3lib_div::trimExplode().

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() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=314&cHash=02ab044c7b

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

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 6737 of file class.tslib_content.php.

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 5560 of file class.tslib_content.php.

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 5350 of file class.tslib_content.php.

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 2591 of file class.tslib_content.php.

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 5639 of file class.tslib_content.php.

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() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=282&cHash=831a95115d

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

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 3165 of file class.tslib_content.php.
References t3lib_div::testInt().

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!) &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=365&cHash=4935524e2e http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=366&cHash=4f9485e8cc

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

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 3738 of file class.tslib_content.php.
References t3lib_div::trimExplode().

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. &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=328&cHash=c1135706d7 _parseFunc()

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

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 5537 of file class.tslib_content.php.
References t3lib_div::makeInstance().

tslib_cObj::MULTIMEDIA ( $ conf )

Rendering the cObject, MULTIMEDIA

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=374&cHash=efd88ab4a9

Definition at line 2322 of file class.tslib_content.php.
References t3lib_div::inList(), and t3lib_div::split_fileref().

tslib_cObj::netprintApplication_offsiteLinkWrap ( $ str,

$ imgConf,

$ conf

)

Creates a link to a netprint application on another website (where the "netprint" extension is running") Related to the extension "netprint"

Parameters:

string The input string to add the link to.

array Array with information about the image.

array TypoScript properties for the netprint application.

Returns:
string The input string possibly with the netprint link before/after private

Definition at line 2411 of file class.tslib_content.php.
References t3lib_div::getIndpEnv(), and t3lib_div::makeInstance().

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

Returns:
string Wrapped input string, eg. " HELLO WORD "

See also:
wrap()

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

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 private &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=317&cHash=e28e53e634 http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=318&cHash=a98cb4e7e6 stdWrap()

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

tslib_cObj::OTABLE ( $ conf )

Rendering the cObject, OTABLE

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=360&cHash=02c9552d38

Definition at line 1340 of file class.tslib_content.php.
References t3lib_div::makeInstance().

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 &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=327&cHash=33331f0396 _parseFunc()

Definition at line 3874 of file class.tslib_content.php.
References t3lib_div::makeInstance(), and t3lib_div::trimExplode().

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 &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=370&cHash=aa107f2ad8 http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=371&cHash=53f71d025e http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=372&cHash=91fe391e1c

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

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 3402 of file class.tslib_content.php.

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 5332 of file class.tslib_content.php.
References t3lib_div::inList(), and t3lib_div::trimExplode().

tslib_cObj::RECORDS ( $ conf )

Rendering the cObject, RECORDS

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=357&cHash=303e959472

Definition at line 1192 of file class.tslib_content.php.
References t3lib_div::makeInstance().

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 3476 of file class.tslib_content.php.

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 4707 of file class.tslib_content.php.

tslib_cObj::SEARCHRESULT ( $ conf )

Rendering the cObject, SEARCHRESULT

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=368&cHash=d00731cd7b

Definition at line 1963 of file class.tslib_content.php.
References t3lib_div::_GP(), t3lib_div::_POST(), t3lib_div::intInRange(), t3lib_div::makeInstance(), and t3lib_div::testInt().

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 6120 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 5463 of file class.tslib_content.php.
References 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 399 of file class.tslib_content.php.

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 363 of file class.tslib_content.php.
References $currentRecord, and $data.

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() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=319&cHash=1871864c8f

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

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 348 of file class.tslib_content.php.
References $data.

tslib_cObj::stdWrap ( $ content,

$ conf

)

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 &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=314&cHash=02ab044c7b

Definition at line 2979 of file class.tslib_content.php.
References t3lib_div::calcParenthesis(), t3lib_div::deHSCentities(), and t3lib_div::makeInstance().

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 2754 of file class.tslib_content.php.

tslib_cObj::substituteMarkerArray ( $ content,

$ markContentArray,

$ wrap = '',

$ uppercase = 0

)

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.

Returns:
string The processed output stream

See also:
substituteMarker(), substituteMarkerInObject(), TEMPLATE()

Definition at line 2872 of file class.tslib_content.php.
References t3lib_div::trimExplode().

tslib_cObj::substituteMarkerArrayCached ( $ content,

$ markContentArray = array(),

$ subpartContentArray = array(),

$ wrappedSubpartContentArray = array()

)

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. 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 2774 of file class.tslib_content.php.

tslib_cObj::substituteMarkerInObject ( &$ tree,

$ 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 2893 of file class.tslib_content.php.

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.

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 2712 of file class.tslib_content.php.

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 3426 of file class.tslib_content.php.
References t3lib_div::intExplode().

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() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=324&cHash=34410ebff3

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

tslib_cObj::TEMPLATE ( $ conf )

Rendering the cObject, TEMPLATE

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=373&cHash=109a171b1e substituteMarkerArrayCached()

Definition at line 2171 of file class.tslib_content.php.
References t3lib_div::makeInstance().

tslib_cObj::TEXT ( $ conf )

Rendering the cObject, TEXT

Parameters:

array Array of TypoScript properties

Returns:
string Output &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=350&cHash=b49de28f83

Definition at line 593 of file class.tslib_content.php.
References stdWrap().

tslib_cObj::textStyle ( $ theValue,

$ conf

)

Implements the stdWrap property "textStyle"; This generates a -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() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=322&cHash=a14b745a18

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

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() &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=321&cHash=59bd727a5e

Definition at line 4806 of file class.tslib_content.php.
References t3lib_div::inList(), t3lib_div::testInt(), and t3lib_div::trimExplode().

tslib_cObj::typoLink_URL ( $ conf )

Based on the input "TypoLink" TypoScript configuration this will return the generated URL
'
See also:
typoLink()

Parameters:

array TypoScript properties for "typolink"

Returns:
string The URL of the link-tag that typolink() would by itself return

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

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 5133 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 5490 of file class.tslib_content.php.

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 &tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=369&cHash=b623aca0a9

Definition at line 659 of file class.tslib_content.php.
References callUserFunction().

tslib_cObj::whereSelectFromList ( $ field,

$ value

)

Returns a part for a WHERE clause (without preceeding operator) which will select records based on the presence of a certain string in a string-list inside the record. Example: If you have a record with a field, "usergroup" and that field might contain a list like "1,2,3" (with no spaces between the values) then you can select all records having eg. "2" in this list by calling this function. This is regardless of whether the number "2" is in the start, end or middle of the list - or the only value at all.

Parameters:

string The field name to look in

string The value to look for.

Returns:
string Use $GLOBALS['TYPO3_DB']->listQuery() directly!

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

tslib_cObj::wrap ( $ content,

$ wrap,

$ char = '|'

)

Wrapping a string. Implements the TypoScript "wrap" property. Example: $content = "HELLO WORLD" and $wrap = " | ", result: "HELLO WORLD"

Parameters:

string The content to wrap

string The wrap value, eg. " | "

string The char used to split the wrapping value, default is "|"

Returns:
string Wrapped input string

See also:
noTrimWrap()

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

tslib_cObj::wrapSpace ( $ content,

$ wrap

)

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)

Returns:
string Wrapped string

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

Member Data Documentation

tslib_cObj::$caseConvStrings

Initial value:
array( 'áéúíâêûôîæøåäöü', 'ÁÉÚÍÄËÜÖÏÆØÅÄÖÜ' )

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

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 318 of file class.tslib_content.php.
Referenced by setParent(), and start().

tslib_cObj::$image_compression

Initial value:
Array( 10 => Array('params'=>'', 'ext'=>'gif'), 11 => Array('params'=>'-colors 128', 'ext'=>'gif'), 12 => Array('params'=>'-colors 64', 'ext'=>'gif'), 13 => Array('params'=>'-colors 32', 'ext'=>'gif'), 14 => Array('params'=>'-colors 16', 'ext'=>'gif'), 15 => Array('params'=>'-colors 8', 'ext'=>'gif'), 30 => Array('params'=>'-colors 256', 'ext'=>'png'), 31 => Array('params'=>'-colors 128', 'ext'=>'png'), 32 => Array('params'=>'-colors 64', 'ext'=>'png'), 33 => Array('params'=>'-colors 32', 'ext'=>'png'), 34 => Array('params'=>'-colors 16', 'ext'=>'png'), 35 => Array('params'=>'-colors 8', 'ext'=>'png'), 39 => Array('params'=>'', 'ext'=>'png'), 20 => Array('params'=>'-quality 100', 'ext'=>'jpg'), 21 => Array('params'=>'-quality 90', 'ext'=>'jpg'), 22 => Array('params'=>'-quality 80', 'ext'=>'jpg'), 23 => Array('params'=>'-quality 70', 'ext'=>'jpg'), 24 => Array('params'=>'-quality 60', 'ext'=>'jpg'), 25 => Array('params'=>'-quality 50', 'ext'=>'jpg'), 26 => Array('params'=>'-quality 40', 'ext'=>'jpg'), 27 => Array('params'=>'-quality 30', 'ext'=>'jpg'), 28 => Array('params'=>'-quality 20', 'ext'=>'jpg') )
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 267 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 299 of file class.tslib_content.php.

The documentation for this class was generated from the following files:

typo3_src-3.7.0/tslib/class.tslib_content.php
typo3_src-3.7.0/typo3/sysext/cms/tslib/class.tslib_content.php

Généré par Les experts TYPO3 avec doxygen

1.4.6

Documentation TYPO3 par Ameos

tslib_cObj Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation