tslib_cObj Class Reference

List of all members.


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)
	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)
	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()
	$conf ['min'] = intval($this->stdWrap($conf['min'],$conf['min.']))
	$valArr = explode($conf['token'],$value)
	$splitCount = count($valArr)
	$splitArr ['wrap'] = $conf['wrap']
	$content = ''
	$value = $this->stdWrap($this->cObjGet($conf[$objName.'.'],$objName.'.'),$conf[$objName.'.'])
return	$content

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 4020 of file class.tslib_content.php.
References $data, $val, a, t3lib_div::get_tag_attributes(), and t3lib_div::inList().

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

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

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 5370 of file class.tslib_content.php.
References $content, $GLOBALS, $parts, 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 1455 of file class.tslib_content.php.
References $conf, $content, $key, $name, cObjGetSingle(), and stdWrap().

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

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

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 6447 of file class.tslib_content.php.
References $GLOBALS, $res, and pages.

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 6424 of file class.tslib_content.php.
References $GLOBALS, $res, $row, and pages.

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 2489 of file class.tslib_content.php.
References $conf, $GLOBALS, getAltParam(), getImgResource(), height, imageLinkWrap(), img, linkWrap(), t3lib_div::png_to_gif_by_imagemagick(), and wrap().

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 600 of file class.tslib_content.php.
References $conf, $w, height, img, 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 5597 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 619 of file class.tslib_content.php.
References $content, $GLOBALS, 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 408 of file class.tslib_content.php.
References $conf, $content, cObjGetSingle(), and t3lib_TStemplate::sortedKeyList().

tslib_cObj::cObjGetSingle ( $ name,

$ conf,

$ TSkey = __'

)

Definition at line 432 of file class.tslib_content.php.
References $conf, $content, $GLOBALS, $key, $name, CASEFUNC(),

tslib_cObj Class Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation