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)
	getBorderAttr ($borderAttr)
	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)
	getMailTo ($mailAddress, $linktxt, $initP='?')
	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, $conf=array())
	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)
	getBorderAttr ($borderAttr)
	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)
	getMailTo ($mailAddress, $linktxt, $initP='?')
	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, $conf=array())
	isDisabled ($table, $row)
Public Attributes
	$align = Array ('center', 'right', 'left')
	$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 4048 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 3690 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 5528 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 3833 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 5539 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 3862 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 5398 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 1475 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 5474 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 5613 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 3247 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 6475 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 6452 of file class.tslib_content.php.

Documentation TYPO3 par Ameos

tslib_cObj Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation