Public Member Functions
	__construct (TypoScriptFrontendController $typoScriptFrontendController=null)

	__sleep ()

	__wakeup ()

	setContentObjectClassMap (array $contentObjectClassMap)

	registerContentObjectClass ($className, $contentObjectName)

	start ($data, $table='')

	getCurrentTable ()

	setParent ($data, $currentRecord)

	getCurrentVal ()

	setCurrentVal ($value)

	cObjGet ($setup, $addKey='')

	getContentObject ($name)

	FLOWPLAYER ($conf)

	TEXT ($conf)

	CLEARGIF ($conf)

	COBJ_ARRAY ($conf, $ext='')

	USER ($conf, $ext='')

	getUserObjectType ()

	setUserObjectType ($userObjectType)

	convertToUserIntObject ()

	FILE ($conf)

	FILES ($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)

	TEMPLATE ($conf)

	MULTIMEDIA ($conf)

	MEDIA ($conf)

	SWFOBJECT ($conf)

	QTOBJECT ($conf)

	SVG ($conf)

	readFlexformIntoConf ($flexData, &$conf, $recursive=false)

	getSlidePids ($pidList, $pidConf)

	cImage ($file, $conf)

	getBorderAttr ($borderAttr)

	getImageTagTemplate ($layoutKey, $conf)

	getImageSourceCollection ($layoutKey, $conf, $file)

	imageLinkWrap ($string, $imageFile, $conf)

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

	lastChanged ($tstamp)

	linkWrap ($content, $wrap)

	getAltParam ($conf, $longDesc=true)

	cleanFormName ($name)

	getATagParams ($conf, $addGlobal=1)

	extLinkATagParams ($URL, $TYPE)

	getSubpart ($content, $marker)

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

	substituteSubpartArray ($content, array $subpartsContent)

	substituteMarker ($content, $marker, $markContent)

	substituteMarkerArrayCached ($content, array $markContentArray=null, array $subpartContentArray=null, array $wrappedSubpartContentArray=null)

	substituteMarkerArray ($content, array $markContentArray, $wrap='', $uppercase=false, $deleteUnused=false)

	substituteMarkerInObject (&$tree, array $markContentArray)

	substituteMarkerAndSubpartArrayRecursive ($content, array $markersAndSubparts, $wrap='', $uppercase=false, $deleteUnused=false)

	fillInMarkerArray (array $markContentArray, array $row, $fieldList='', $nl2br=true, $prefix='FIELD_', $HSC=false)

	setCurrentFile ($fileObject)

	getCurrentFile ()

	stdWrap ($content='', $conf=[])

	stdWrapValue ($key, array $config, $defaultValue='')

	stdWrap_cacheRead ($content='', $conf=[])

	stdWrap_addPageCacheTags ($content='', $conf=[])

	stdWrap_setContentToCurrent ($content='')

	stdWrap_setCurrent ($content='', $conf=[])

	stdWrap_lang ($content='', $conf=[])

	stdWrap_data ($content='', $conf=[])

	stdWrap_field ($content='', $conf=[])

	stdWrap_current ($content='', $conf=[])

	stdWrap_cObject ($content='', $conf=[])

	stdWrap_numRows ($content='', $conf=[])

	stdWrap_filelist ($content='', $conf=[])

	stdWrap_preUserFunc ($content='', $conf=[])

	stdWrap_override ($content='', $conf=[])

	stdWrap_preIfEmptyListNum ($content='', $conf=[])

	stdWrap_ifNull ($content='', $conf=[])

	stdWrap_ifEmpty ($content='', $conf=[])

	stdWrap_ifBlank ($content='', $conf=[])

	stdWrap_listNum ($content='', $conf=[])

	stdWrap_trim ($content='')

	stdWrap_strPad ($content='', $conf=[])

	stdWrap_stdWrap ($content='', $conf=[])

	stdWrap_required ($content='')

	stdWrap_if ($content='', $conf=[])

	stdWrap_fieldRequired ($content='', $conf=[])

	stdWrap_csConv ($content='', $conf=[])

	stdWrap_parseFunc ($content='', $conf=[])

	stdWrap_HTMLparser ($content='', $conf=[])

	stdWrap_split ($content='', $conf=[])

	stdWrap_replacement ($content='', $conf=[])

	stdWrap_prioriCalc ($content='', $conf=[])

	stdWrap_char ($content='', $conf=[])

	stdWrap_intval ($content='')

	stdWrap_hash ($content='', array $conf=[])

	stdWrap_round ($content='', $conf=[])

	stdWrap_numberFormat ($content='', $conf=[])

	stdWrap_expandList ($content='')

	stdWrap_date ($content='', $conf=[])

	stdWrap_strftime ($content='', $conf=[])

	stdWrap_strtotime ($content='', $conf=[])

	stdWrap_age ($content='', $conf=[])

	stdWrap_case ($content='', $conf=[])

	stdWrap_bytes ($content='', $conf=[])

	stdWrap_substring ($content='', $conf=[])

	stdWrap_removeBadHTML ($content='')

	stdWrap_cropHTML ($content='', $conf=[])

	stdWrap_stripHtml ($content='')

	stdWrap_crop ($content='', $conf=[])

	stdWrap_rawUrlEncode ($content='')

	stdWrap_htmlSpecialChars ($content='', $conf=[])

	stdWrap_encodeForJavaScriptValue ($content='')

	stdWrap_doubleBrTag ($content='', $conf=[])

	stdWrap_br ($content='')

	stdWrap_brTag ($content='', $conf=[])

	stdWrap_encapsLines ($content='', $conf=[])

	stdWrap_keywords ($content='')

	stdWrap_innerWrap ($content='', $conf=[])

	stdWrap_innerWrap2 ($content='', $conf=[])

	stdWrap_fontTag ($content='', $conf=[])

	stdWrap_addParams ($content='', $conf=[])

	stdWrap_textStyle ($content='', $conf=[])

	stdWrap_tableStyle ($content='', $conf=[])

	stdWrap_filelink ($content='', $conf=[])

	stdWrap_preCObject ($content='', $conf=[])

	stdWrap_postCObject ($content='', $conf=[])

	stdWrap_wrapAlign ($content='', $conf=[])

	stdWrap_typolink ($content='', $conf=[])

	stdWrap_TCAselectItem ($content='', $conf=[])

	stdWrap_spaceBefore ($content='', $conf=[])

	stdWrap_spaceAfter ($content='', $conf=[])

	stdWrap_space ($content='', $conf=[])

	stdWrap_wrap ($content='', $conf=[])

	stdWrap_noTrimWrap ($content='', $conf=[])

	stdWrap_wrap2 ($content='', $conf=[])

	stdWrap_dataWrap ($content='', $conf=[])

	stdWrap_prepend ($content='', $conf=[])

	stdWrap_append ($content='', $conf=[])

	stdWrap_wrap3 ($content='', $conf=[])

	stdWrap_orderedStdWrap ($content='', $conf=[])

	stdWrap_outerWrap ($content='', $conf=[])

	stdWrap_insertData ($content='')

	stdWrap_offsetWrap ($content='', $conf=[])

	stdWrap_postUserFunc ($content='', $conf=[])

	stdWrap_postUserFuncInt ($content='', $conf=[])

	stdWrap_prefixComment ($content='', $conf=[])

	stdWrap_editIcons ($content='', $conf=[])

	stdWrap_editPanel ($content='', $conf=[])

	stdWrap_debug ($content='')

	stdWrap_debugFunc ($content='', $conf=[])

	stdWrap_debugData ($content='')

	numRows ($conf)

	listNum ($content, $listNum, $char)

	checkIf ($conf)

	filelist ($data)

	clean_directory ($theDir)

	HTMLparser_TSbridge ($theValue, $conf)

	dataWrap ($content, $wrap)

	insertData ($str)

	prefixComment ($str, $conf, $content)

	substring ($content, $options)

	crop ($content, $options)

	cropHTML ($content, $options)

	removeBadHTML ($text)

	textStyle ($theValue, $conf)

	tableStyle ($theValue, $conf)

	addParams ($content, $conf)

	calc ($val)

	calcIntExplode ($delim, $string)

	splitObj ($value, $conf)

	numberFormat ($content, $conf)

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

	_parseFunc ($theValue, $conf)

	encaps_lineSplit ($theValue, $conf)

	http_makelinks ($data, $conf)

	mailto_makelinks ($data, $conf)

	getFieldVal ($field)

	getData ($string, $fieldArray=null)

	rootLineValue ($key, $field, $slideBack=false, $altRootLine='')

	getGlobal ($keyString, $source=null)

	getKey ($key, $arr)

	TCAlookup ($inputValue, $conf)

	typoLink_URL ($conf)

	getTypoLink ($label, $params, $urlParameters=[], $target='')

	getUrlToCurrentLocation ($addQueryString=true)

	getTypoLink_URL ($params, $urlParameters=[], $target='')

	typolinkWrap ($conf)

	currentPageUrl ($urlParameters=[], $id=0)

	getClosestMPvalueForPage ($pageId, $raw=false)

	getMailTo ($mailAddress, $linktxt)

	getQueryArguments ($conf, $overruleQueryArguments=[], $forceOverruleArguments=false)

	wrap ($content, $wrap, $char='\|')

	noTrimWrap ($content, $wrap, $char='\|')

	wrapSpace ($content, $wrap, array $conf=null)

	callUserFunction ($funcName, $conf, $content)

	processParams ($params)

	keywords ($content)

	caseshift ($theValue, $case)

	HTMLcaseshift ($theValue, $case)

	calcAge ($seconds, $labels)

	URLqMark ($url, $params)

	clearTSProperties ($TSArr, $propList)

	mergeTSRef ($confArr, $prop)

	gifBuilderTextBox ($gifbuilderConf, $conf, $text)

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

	includeLibs (array $config)

	DBgetDelete ($table, $uid, $doExec=false)

	DBgetUpdate ($table, $uid, $dataArr, $fieldList, $doExec=false)

	DBgetInsert ($table, $pid, $dataArr, $fieldList, $doExec=false)

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

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

	enableFields ($table, $show_hidden=false, array $ignore_array=[])

	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)

	getRecords ($tableName, array $queryConfiguration)

	getQuery ($table, $conf, $returnQueryArray=false)

	getWhere ($table, $conf, $returnQueryArray=false)

	checkPidArray ($listArr)

	checkPid ($uid)

	getQueryMarkers ($table, $conf)

	editPanel ($content, $conf, $currentRecord='', $dataArr=[])

	editIcons ($content, $params, array $conf=[], $currentRecord='', $dataArr=[], $addUrlParamStr='')

	isDisabled ($table, $row)

Public Attributes
	$align

	$stdWrapOrder

	$image_compression

	$image_effects

	$data = []

	$oldData = []

	$alternativeData = ''

	$parameters = []

	$currentValKey = 'currentValue_kidjls9dksoje'

	$currentRecord = ''

	$currentRecordTotal = 0

	$currentRecordNumber = 0

	$parentRecordNumber = 0

	$parentRecord = []

	$INT_include = 0

	$checkPid_cache = []

	$checkPid_badDoktypeList = '255'

	$lastTypoLinkUrl = ''

	$lastTypoLinkTarget = ''

	$lastTypoLinkLD = []

	$substMarkerCache = []

	$recordRegister = []

	$cObjHookObjectsArr = []

	$doConvertToUserIntObject = false

const	OBJECTTYPE_USER_INT = 1

const	OBJECTTYPE_USER = 2

Protected Member Functions
	getGetImgResourceHookObjects ()

	createExceptionHandler ($configuration=[])

	determineExceptionHandlerClassName ($configuration)

	mergeExceptionHandlerConfiguration ($configuration)

	FLUIDTEMPLATE (array $conf)

	replacement ($content, array $configuration)

	replacementSingle ($content, array $configuration)

	round ($content, array $conf=[])

	resolveMixedLinkParameter ($linkText, $mixedLinkParameter, &$configuration=[])

	detectLinkTypeFromLinkParameter ($linkParameter)

	forceAbsoluteUrl ($url, array $configuration)

	isClassAvailable ($className, array $config=null)

	sanitizeSelectPart ($selectPart, $table)

	getResourceFactory ()

	getEnvironmentVariable ($key)

	calculateCacheLifetime (array $configuration)

	calculateCacheTags (array $configuration)

	calculateCacheKey (array $configuration)

	getFrontendBackendUser ()

	getDatabaseConnection ()

	getTimeTracker ()

	getTypoScriptFrontendController ()

Protected Attributes
	$contentObjectClassMap = []

	$table = ''

	$cObjHookObjectsRegistry = []

	$stdWrapHookObjects = []

	$getImgResourceHookObjects

	$currentFile = null

	$userObjectType = false

	$stopRendering = []

	$stdWrapRecursionLevel = 0

	$typoScriptFrontendController

	$templateService

Detailed Description

This class contains all main TypoScript features. This includes the rendering of TypoScript content objects (cObjects). Is the backbone of TypoScript Template rendering.

There are lots of functions you can use from your include-scripts. The class is normally instantiated and referred to as "cObj". When you call your own PHP-code typically through a USER or USER_INT cObject then it is this class that instantiates the object and calls the main method. Before it does so it will set (if you are using classes) a reference to itself in the internal variable "cObj" of the object. Thus you can access all functions and data from this class by $this->cObj->... from within you classes written to be USER or USER_INT content objects.

Definition at line 62 of file ContentObjectRenderer.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::__construct ( TypoScriptFrontendController $typoScriptFrontendController = null )

Parameters

TypoScriptFrontendController $typoScriptFrontendController

Definition at line 583 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$typoScriptFrontendController, and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

◆ __sleep()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::__sleep ( )

Prevent several objects from being serialized. If currentFile is set, it is either a File or a FileReference object. As the object itself can't be serialized, we have store a hash and restore the object in __wakeup()

Returns: array

Definition at line 597 of file ContentObjectRenderer.php.

◆ __wakeup()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::__wakeup ( )

Restore currentFile from hash. If currentFile references a File, the identifier equals file identifier. If it references a FileReference the identifier equals the uid of the reference.

Definition at line 616 of file ContentObjectRenderer.php.

References $GLOBALS, and TYPO3\CMS\Core\Resource\ResourceFactory\getInstance().

◆ _parseFunc()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::_parseFunc	(	$theValue,
		$conf
	)

Helper function for parseFunc()

Parameters

string	$theValue	The value to process.
array	$conf	TypoScript configuration for parseFunc

Returns: string The processed value private

See also: parseFunc()

Definition at line 5248 of file ContentObjectRenderer.php.

References $a, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentValKey, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$data, $params, TYPO3\CMS\Core\Utility\StringUtility\beginsWith(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\callUserFunction(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\checkIf(), TYPO3\CMS\Core\Utility\StringUtility\endsWith(), TYPO3\CMS\Core\Utility\GeneralUtility\get_tag_attributes(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\http_makelinks(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mailto_makelinks(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\parseFunc().

◆ addParams()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::addParams	(	$content,
		$conf
	)

Implements the TypoScript function "addParams"

Parameters

string	$content	The string with the HTML tag.
array	$conf	The TypoScript configuration properties

Returns: string The modified string

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

Definition at line 4660 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Core\Resource\ProcessedFile\CONTEXT_IMAGEPREVIEW, TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Core\Utility\GeneralUtility\get_tag_attributes(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getAltParam(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getATagParams(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getBorderAttr(), TYPO3\CMS\Core\Resource\ResourceFactory\getInstance(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeAttributes(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\siteRelPath(), TYPO3\CMS\Core\Utility\GeneralUtility\split_fileref(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_addParams().

◆ calc()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::calc ( $val )

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

Parameters

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

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

See also: ::calculateWithPriorityToAdditionAndSubtraction()

Definition at line 4873 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\splitCalc().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calcIntExplode(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\checkIf(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQuery(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\listNum().

◆ calcAge()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::calcAge	(	$seconds,
		$labels
	)

Returns the 'age' of the tstamp $seconds

Parameters

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

Returns: string The formatted string

Definition at line 7447 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Utility\MailUtility\getSystemFrom(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\round().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_age().

◆ calcIntExplode()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::calcIntExplode	(	$delim,
		$string
	)

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

Parameters

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

Returns: array And array with evaluated values.

See also: calc(), ::makeGifs()

Definition at line 4912 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calc().

◆ calculateCacheKey()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::calculateCacheKey ( array $configuration )

protected

Applies stdWrap to the cache key

Parameters

array $configuration

Returns: string

Definition at line 8960 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getEnvironmentVariable(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_editPanel().

◆ calculateCacheLifetime()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::calculateCacheLifetime ( array $configuration )

protected

Calculates the lifetime of a cache entry based on the given configuration

Parameters

array $configuration

Returns: int|null

Definition at line 8921 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_editPanel().

◆ calculateCacheTags()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::calculateCacheTags ( array $configuration )

protected

Calculates the tags for a cache entry bases on the given configuration

Parameters

array $configuration

Returns: array

Definition at line 8945 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_editPanel().

◆ callUserFunction()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$funcName	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	$conf	The TypoScript configuration to pass the function
string	$content	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 7306 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTimeTracker(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\isClassAvailable(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\_parseFunc(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_postUserFunc(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_preUserFunc().

◆ CASEFUNC()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::CASEFUNC ( $conf )

Rendering the cObject, CASE

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('CASE', $conf) instead

Definition at line 1321 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ caseshift()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::caseshift	(	$theValue,
		$case
	)

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

Parameters

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

Returns: string

See also: HTMLcaseshift()

Definition at line 7382 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\underscoredToLowerCamelCase(), and TYPO3\CMS\Core\Utility\GeneralUtility\underscoredToUpperCamelCase().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\HTMLcaseshift().

◆ checkIf()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 $conf TypoScript properties defining what to compare

Returns: bool

See also: stdWrap(), _parseFunc()

Definition at line 4016 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calc(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

Referenced by TYPO3\CMS\Frontend\DataProcessing\DatabaseQueryProcessor\__construct(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\_parseFunc(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getImageSourceCollection(), TYPO3\CMS\Frontend\DataProcessing\SplitProcessor\process(), TYPO3\CMS\Frontend\DataProcessing\CommaSeparatedValueProcessor\process(), TYPO3\CMS\Frontend\DataProcessing\GalleryProcessor\process(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_if().

◆ checkPid()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::checkPid ( $uid )

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

Parameters

int $uid Page UID to test

Returns: bool TRUE if OK private

See also: getWhere(), checkPidArray()

Definition at line 8709 of file ContentObjectRenderer.php.

References $uid, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\enableFields(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection().

◆ checkPidArray()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 $listArr 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 8682 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\enableFields(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTimeTracker().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getSlidePids(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getWhere().

◆ cImage()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	File TypoScript resource
array	$conf	TypoScript configuration properties

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

See also: IMAGE()

Definition at line 1561 of file ContentObjectRenderer.php.

◆ clean_directory()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 $theDir Absolute path to directory

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

See also: filelist()

Definition at line 4183 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\isAbsPath(), and TYPO3\CMS\Core\Utility\GeneralUtility\validPathStr().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\filelist().

◆ cleanFormName()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::cleanFormName ( $name )

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

Parameters

string $name Input string

Returns: string the cleaned string

See also: FORM()

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8, the method is moved to FormContentObject

Definition at line 1986 of file ContentObjectRenderer.php.

◆ CLEARGIF()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::CLEARGIF ( $conf )

Rendering the cObject, CLEARGIF

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('CLEARGIF', $conf) instead

Definition at line 1076 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ clearTSProperties()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::clearTSProperties	(	$TSArr,
		$propList
	)

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

Parameters

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

Returns: array The TypoScript array

See also: gifBuilderTextBox()

Definition at line 7560 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\gifBuilderTextBox().

◆ COBJ_ARRAY()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::COBJ_ARRAY	(	$conf,
		$ext = `''`
	)

Rendering the cObject, COBJ_ARRAY / COA and COBJ_ARRAY_INT

Parameters

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

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('COA', $conf) or $cObj->cObjGetSingle('COA_INT', $conf) instead

Definition at line 1090 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ cObjGet()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 794 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTimeTracker(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render(), and TYPO3\CMS\Core\TypoScript\TemplateService\sortedKeyList().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\splitObj().

◆ COLUMNS()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::COLUMNS ( $conf )

Rendering the cObject, COLUMNS

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('COLUMNS', $conf) instead

Definition at line 1295 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ CONTENT()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::CONTENT ( $conf )

Rendering the cObject, CONTENT

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('CONTENT', $conf) instead

Definition at line 1230 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ convertToUserIntObject()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::convertToUserIntObject ( )

Requests the current USER object to be converted to USER_INT.

Returns: void

Definition at line 1147 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTimeTracker().

◆ createExceptionHandler()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::createExceptionHandler ( $configuration = [] )

protected

Creates the content object exception handler from local content object configuration or, from global configuration if not explicitly disabled in local configuration

Parameters

array $configuration

Returns: NULL|ExceptionHandlerInterface

Exceptions

ContentRenderingException

Definition at line 980 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\determineExceptionHandlerClassName(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mergeExceptionHandlerConfiguration().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject().

◆ crop()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::crop	(	$content,
		$options
	)

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

Parameters

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

Returns: string The processed input value. private

See also: stdWrap()

Definition at line 4310 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_crop().

◆ cropHTML()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::cropHTML	(	$content,
		$options
	)

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

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

Parameters

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

Returns: string The processed input value. private

See also: stdWrap()

Definition at line 4351 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_cropHTML().

◆ CTABLE()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::CTABLE ( $conf )

Rendering the cObject, CTABLE

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('CTABLE', $conf) instead

Definition at line 1269 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ currentPageUrl()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::currentPageUrl	(	$urlParameters = `[]`,
		$id = `0`
	)

Returns the current page URL

Parameters

array \| string	$urlParameters	As an array key/value pairs represent URL parameters to set. Values NOT URL-encoded yet, keys should be URL-encoded if needed. As a string the parameter is expected to be URL-encoded already.
int	$id	An alternative ID to the current id ($GLOBALS['TSFE']->id)

Returns: string The URL

See also: getTypoLink_URL()

Definition at line 7020 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoLink_URL(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ dataWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::dataWrap	(	$content,
		$wrap
	)

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

Parameters

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

Returns: string Output string wrapped in the wrapping value.

See also: insertData(), stdWrap()

Definition at line 4221 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\insertData(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_dataWrap().

◆ DBgetDelete()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::DBgetDelete	(	$table,
		$uid,
		$doExec = `false`
	)

Returns an UPDATE/DELETE sql query which will "delete" the record. If the $GLOBALS['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	$table	The table name, should be in $GLOBALS['TCA']
int	$uid	The UID of the record from $table which we are going to delete
bool	$doExec	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 7740 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, $uid, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection().

◆ DBgetInsert()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::DBgetInsert	(	$table,
		$pid,
		$dataArr,
		$fieldList,
		$doExec = `false`
	)

Returns an INSERT sql query which automatically added "system-fields" according to $GLOBALS['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 $GLOBALS['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	$table	The table name, should be in $GLOBALS['TCA']
int	$pid	The PID value for the record to insert
array	$dataArr	The data array where key/value pairs are fieldnames/values for the record to insert
string	$fieldList	Comma list of fieldnames which are allowed to be inserted. Only values from the data record for fields in this list will be inserted!!
bool	$doExec	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 7819 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ DBgetUpdate()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::DBgetUpdate	(	$table,
		$uid,
		$dataArr,
		$fieldList,
		$doExec = `false`
	)

Returns an UPDATE sql query. If a "tstamp" field is configured for the $table tablename in $GLOBALS['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	$table	The table name, should be in $GLOBALS['TCA']
int	$uid	The UID of the record from $table which we are going to update
array	$dataArr	The data array where key/value pairs are fieldnames/values for the record to update.
string	$fieldList	Comma list of fieldnames which are allowed to be updated. Only values from the data record for fields in this list will be updated!!
bool	$doExec	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 7779 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, $uid, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ DBmayFEUserEdit()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::DBmayFEUserEdit	(	$table,
		$row,
		$feUserRow,
		$allowedGroups = `''`,
		$feEditSelf = `0`
	)

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

Parameters

string	$table	The table name, found in $GLOBALS['TCA']
array	$row	The record data array for the record in question
array	$feUserRow	The array of the fe_user which is evaluated, typ. $GLOBALS['TSFE']->fe_user->user
string	$allowedGroups	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.
bool \| int	$feEditSelf	TRUE, if the fe_user may edit his own fe_user record.

Returns: bool

See also: user_feAdmin

Definition at line 7879 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ DBmayFEUserEditSelect()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$table	The table name
array	$feUserRow	The array of the fe_user which is evaluated, typ. $GLOBALS['TSFE']->fe_user->user
string	$allowedGroups	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.
bool \| int	$feEditSelf	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 7931 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ detectLinkTypeFromLinkParameter()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::detectLinkTypeFromLinkParameter ( $linkParameter )

protected

part of the typolink construction functionality, called by typoLink()

tries to get the type of the link from the link parameter could be

"mailto" an email address
"url" external URL
"file" a local file (checked AFTER getPublicUrl() is called)
"page" a page (integer or alias)

Parameters

string $linkParameter could be "fileadmin/myfile.jpg" or "info@typo3.org" or "13" or "http://www.typo3.org"

Returns: string the keyword

See also: typoLink()

Definition at line 6346 of file ContentObjectRenderer.php.

◆ determineExceptionHandlerClassName()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::determineExceptionHandlerClassName ( $configuration )

protected

Determine exception handler class name from global and content object configuration

Parameters

array $configuration

Returns: string|NULL

Definition at line 1000 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\getApplicationContext(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\createExceptionHandler().

◆ editIcons()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::editIcons	(		$content,
			$params,
		array	$conf = `[]`,
			$currentRecord = `''`,
			$dataArr = `[]`,
			$addUrlParamStr = `''`
	)

Adds an edit icon to the content string. The edit icon links to FormEngine 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	$content	The content to which the edit icons should be appended
string	$params	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 FormEngine
array	$conf	TypoScript properties for configuring the edit icons.
string	$currentRecord	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	$dataArr	Alternative data array to use. Default is $this->data
string	$addUrlParamStr	Additional URL parameters for the link pointing to FormEngine

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 8838 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentRecord, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$data, $params, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getFrontendBackendUser(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_editIcons().

◆ editPanel()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::editPanel	(	$content,
		$conf,
		$currentRecord = `''`,
		$dataArr = `[]`
	)

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	$content	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	$conf	TypoScript configuration properties for the editPanel
string	$currentRecord	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	$dataArr	Alternative data array to use. Default is $this->data

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

Definition at line 8811 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentRecord, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$data, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getFrontendBackendUser(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_editPanel().

◆ enableFields()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::enableFields	(		$table,
			$show_hidden = `false`,
		array	$ignore_array = `[]`
	)

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 ::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	$table	The table for which to get the where clause
bool	$show_hidden	If set, then you want NOT to filter out hidden records. Otherwise hidden record are filtered based on the current preview settings.
array	$ignore_array	Array you can pass where keys can be "disabled", "starttime", "endtime", "fe_group" (keys from "enablefields" in TCA) and if set they will make sure that part of the clause is not added. Thus disables the specific part of the clause. For previewing etc.

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

Definition at line 7988 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$parameters, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\checkPid(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\checkPidArray(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getWhere().

◆ encaps_lineSplit()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::encaps_lineSplit	(	$theValue,
		$conf
	)

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

Parameters

string	$theValue	The input value
array	$conf	TypoScript options

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

Definition at line 5476 of file ContentObjectRenderer.php.

References $params, TYPO3\CMS\Core\Utility\GeneralUtility\get_tag_attributes(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeAttributes(), TYPO3\CMS\Core\Utility\GeneralUtility\revExplode(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_encapsLines().

◆ exec_getQuery()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$table	The table name
array	$conf	The TypoScript configuration properties

Returns: mixed A SQL result pointer

See also: getQuery()

Definition at line 8286 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQuery().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getRecords(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\numRows().

◆ exec_mm_query()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::exec_mm_query	(	$select,
		$local_table,
		$mm_table,
		$foreign_table,
		$whereClause = `''`,
		$groupBy = `''`,
		$orderBy = `''`,
		$limit = `''`
	)

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

Parameters

string	$select	List of fields to select
string	$local_table	The local table
string	$mm_table	The join-table; The "uid_local" field of this table will be matched with $local_table's "uid" field.
string	$foreign_table	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	$whereClause	Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
string	$groupBy	Optional GROUP BY field(s), if none, supply blank string.
string	$orderBy	Optional ORDER BY field(s), if none, supply blank string.
string	$limit	Optional LIMIT value ([begin,]max), if none, supply blank string.

Returns: bool| SQL result pointer

See also: mm_query_uidList()

Definition at line 8200 of file ContentObjectRenderer.php.

◆ exec_mm_query_uidList()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::exec_mm_query_uidList	(	$select,
		$local_table_uidlist,
		$mm_table,
		$foreign_table = `''`,
		$whereClause = `''`,
		$groupBy = `''`,
		$orderBy = `''`,
		$limit = `''`
	)

Executes a SELECT query for joining two tables according to the MM-relation standards used for tables configured in $GLOBALS['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	$select	List of fields to select
string	$local_table_uidlist	List of UID integers, eg. "1,2,3,456 @param string $mm_table The join-table; The "uid_local" field of this table will be matched with the list of UID numbers from $local_table_uidlist @param string $foreign_table 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	$whereClause	Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
string	$groupBy	Optional GROUP BY field(s), if none, supply blank string.
string	$orderBy	Optional ORDER BY field(s), if none, supply blank string.
string	$limit	Optional LIMIT value ([begin,]max), if none, supply blank string.

Returns: bool| SQL result pointer

See also: mm_query()

Definition at line 8229 of file ContentObjectRenderer.php.

◆ extLinkATagParams()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::extLinkATagParams	(	$URL,
		$TYPE
	)

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

Parameters

string	$URL	URL of the website
string	$TYPE

Returns: string The additional tag properties

Definition at line 2043 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\http_makelinks().

◆ FILE()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::FILE ( $conf )

Rendering the cObject, FILE

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('FILE', $conf) instead

Definition at line 1163 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ filelist()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 $data 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 4091 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$data, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\clean_directory(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), TYPO3\CMS\Core\Utility\GeneralUtility\split_fileref(), and TYPO3\CMS\Core\Utility\GeneralUtility\uniqueList().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_filelist().

◆ fileResource()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$fName	The filename, being a TypoScript resource data type
string	$addParams	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 1885 of file ContentObjectRenderer.php.

◆ FILES()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::FILES ( $conf )

Rendering the cObject, FILES

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('FILES', $conf) instead

Definition at line 1176 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ fillInMarkerArray()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::fillInMarkerArray	(	array	$markContentArray,
		array	$row,
			$fieldList = `''`,
			$nl2br = `true`,
			$prefix = `'FIELD_'`,
			$HSC = `false`
	)

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

Parameters

array	$markContentArray	Array with key/values being marker-strings/substitution values.
array	$row	An array with keys found in the $fieldList (typically a record) which values should be moved to the $markContentArray
string	$fieldList	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)
bool	$nl2br	If set, all values added to $markContentArray will be nl2br()'ed
string	$prefix	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 "###
bool	$HSC	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 2334 of file ContentObjectRenderer.php.

◆ FLOWPLAYER()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::FLOWPLAYER ( $conf )

Rendering the cObject, FLOWPLAYER

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('FLOWPLAYER', $conf) instead

Definition at line 1050 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ FLUIDTEMPLATE()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::FLUIDTEMPLATE ( array $conf )

protected

Rendering the cObject, FLUIDTEMPLATE

Parameters

array $conf Array of TypoScript properties

Returns: string the HTML output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('FLUIDTEMPLATE', $conf) instead

Definition at line 1396 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ forceAbsoluteUrl()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::forceAbsoluteUrl	(		$url,
		array	$configuration
	)

protected

Forces a given URL to be absolute.

Parameters

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

Returns: string The absolute URL

Definition at line 6877 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getEnvironmentVariable(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter().

◆ FORM()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::FORM	(	$conf,
		$formData = `''`
	)

Rendering the cObject, FORM

Parameters

array	$conf	Array of TypoScript properties
array \| string	$formData	Alternative formdata overriding whatever comes from TypoScript

Returns: string Output

Exceptions

ContentRenderingException

Definition at line 1356 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ getAltParam()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getAltParam	(	$conf,
		$longDesc = `true`
	)

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

Parameters

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

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

See also: IMGTEXT(), FILE(), FORM(), cImage(), filelink()

Definition at line 1950 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\addParams(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cImage().

◆ getATagParams()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getATagParams	(	$conf,
		$addGlobal = `1`
	)

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

Parameters

array	$conf	TypoScript configuration properties
bool \| int	$addGlobal	If set, will add the global config.ATagParams to the link

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

See also: IMGTEXT(), filelink(), makelinks(), typolink()

Definition at line 2004 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\addParams(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\http_makelinks(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mailto_makelinks().

◆ getBorderAttr()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getBorderAttr ( $borderAttr )

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

Parameters

string $borderAttr The border attribute

Returns: string The border attribute

Definition at line 1621 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\addParams(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cImage().

◆ getClosestMPvalueForPage()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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

int	$pageId	page id
bool	$raw	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 7078 of file ContentObjectRenderer.php.

References $GLOBALS, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter().

◆ getContentObject()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getContentObject ( $name )

Returns a new content object of type $name. This content object needs to be registered as content object in $this->contentObjectClassMap

Parameters

string $name

Returns: NULL|AbstractContentObject

Exceptions

ContentRenderingException

Definition at line 897 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calculateCacheKey(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calculateCacheLifetime(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calculateCacheTags(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\createExceptionHandler(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Frontend\ContentObject\AbstractContentObject\render(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ getCurrentFile()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getCurrentFile ( )

Gets the current file object during iterations over files.

Returns: File The current file object.

Definition at line 2372 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData().

◆ getCurrentTable()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getCurrentTable ( )

Returns the current table

Returns: string

Definition at line 710 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table.

◆ getCurrentVal()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 768 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentValKey.

◆ getData()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getData	(	$string,
		$fieldArray = `null`
	)

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	$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)
NULL \| array	$fieldArray	Alternative field array; If you set this to an array this variable will be used to look up values for the "field" key. Otherwise the current page record in $GLOBALS['TSFE']->page is used.

Returns: string The value fetched

See also: getFieldVal()

Definition at line 5899 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentValKey, $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$parentRecordNumber, TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getCurrentFile(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getEnvironmentVariable(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getGlobal(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getKey(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\rootLineValue(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Utility\DebugUtility\viewArray().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\insertData(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_data().

◆ getDatabaseConnection()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getDatabaseConnection ( )

protected

Returns the database connection

Returns

Definition at line 8983 of file ContentObjectRenderer.php.

References $GLOBALS.

◆ getEnvironmentVariable()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getEnvironmentVariable ( $key )

protected

Wrapper function for GeneralUtility::getIndpEnv()

See also: GeneralUtility::getIndpEnv

Parameters

string $key Name of the "environment variable"/"server variable" you wish to get.

Returns: string

Definition at line 8889 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calculateCacheKey(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\forceAbsoluteUrl(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQueryArguments().

◆ getFieldVal()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 $field 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 5876 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_field().

◆ getFrontendBackendUser()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getFrontendBackendUser ( )

protected

Returns the current BE user.

Returns

Definition at line 8973 of file ContentObjectRenderer.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\editIcons(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\editPanel().

◆ getGetImgResourceHookObjects()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getGetImgResourceHookObjects ( )

protected

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

Returns: array The 'getImgResource' hook objects (if any)

Definition at line 721 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$getImgResourceHookObjects, $GLOBALS, and TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mailto_makelinks().

◆ getGlobal()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getGlobal	(	$keyString,
		$source = `null`
	)

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

Parameters

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

Returns: mixed Whatever value. If none, then blank string.

See also: getData()

Definition at line 6178 of file ContentObjectRenderer.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData().

◆ getImageSourceCollection()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getImageSourceCollection	(	$layoutKey,
		$conf,
		$file
	)

Render alternate sources for the image tag. If no source collection is given an empty string is returned.

Parameters

string	$layoutKey	rendering key
array	$conf	TypoScript configuration properties
string	$file

Exceptions

Definition at line 1662 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\checkIf(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\substituteMarkerArray().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cImage().

◆ getImageTagTemplate()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getImageTagTemplate	(	$layoutKey,
		$conf
	)

Returns the html-template for rendering the image-Tag if no template is defined via typoscript the default tag template is returned

Parameters

string	$layoutKey	rendering key
array	$conf	TypoScript configuration properties

Returns: string

Definition at line 1643 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cImage().

◆ getKey()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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

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

Returns: int The processed integer key value. private

See also: getData()

Definition at line 6211 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData().

◆ getMailTo()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getMailTo	(	$mailAddress,
		$linktxt
	)

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

Parameters

string	$mailAddress	Email address
string	$linktxt	Link text, default will be the email address.

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

Definition at line 7135 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\Http\UrlProcessorInterface\CONTEXT_MAIL, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mailto_makelinks().

◆ getQuery()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$table	See ->exec_getQuery()
array	$conf	See ->exec_getQuery()
bool	$returnQueryArray	If set, the function will return the query not as a string but array with the various parts. RECOMMENDED!

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

See also: CONTENT(), numRows()

Definition at line 8352 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\exec_getQuery().

◆ getQueryArguments()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getQueryArguments	(	$conf,
		$overruleQueryArguments = `[]`,
		$forceOverruleArguments = `false`
	)

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

Parameters

string	$conf	Configuration
array	$overruleQueryArguments	Multidimensional key/value pairs that overrule incoming query arguments
bool	$forceOverruleArguments	If set, key/value pairs not in the query but the overrule array will be set

Returns: string The URL query part (starting with a &)

Definition at line 7180 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Core\Utility\GeneralUtility\_POST(), TYPO3\CMS\Core\Utility\ArrayUtility\arrayDiffAssocRecursive(), TYPO3\CMS\Core\Utility\GeneralUtility\explodeUrl2Array(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getEnvironmentVariable(), TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl(), and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter().

◆ getQueryMarkers()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getQueryMarkers	(	$table,
		$conf
	)

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

Parameters

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

Returns: array List of values to replace markers with private

See also: getQuery()

Definition at line 8729 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQuery().

◆ getRecords()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getRecords	(		$tableName,
		array	$queryConfiguration
	)

Executes a SELECT query for records from $table and with conditions based on the configuration in the $conf array and overlays with translation and version if available

Parameters

string	$tableName	the name of the TCA database table
array	$queryConfiguration	The TypoScript configuration properties, see .select in TypoScript reference

Returns: array The records

Definition at line 8300 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\exec_getQuery(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTimeTracker(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\DataProcessing\DatabaseQueryProcessor\__construct().

◆ getResourceFactory()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getResourceFactory ( )

protected

Get instance of FAL resource factory

Returns: ResourceFactory

Definition at line 8877 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Resource\ResourceFactory\getInstance().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mailto_makelinks(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\resolveMixedLinkParameter().

◆ getSlidePids()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getSlidePids	(	$pidList,
		$pidConf
	)

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

Parameters

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

Returns: string A list of PIDs private

Definition at line 1526 of file ContentObjectRenderer.php.

References $uid, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\checkPidArray(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

◆ getSubpart()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 Wrapper for ::getSubpart which behaves identical

Parameters

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

Returns: string The subpart found, if found.

Definition at line 2078 of file ContentObjectRenderer.php.

◆ getTimeTracker()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getTimeTracker ( )

protected

Returns

Definition at line 8991 of file ContentObjectRenderer.php.

References $GLOBALS.

◆ getTypoLink()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getTypoLink	(	$label,
		$params,
		$urlParameters = `[]`,
		$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	$label	Text string being wrapped by the link.
string	$params	Link parameter; eg. "123" for page id, "kasperYYYY@typo3.com" for email address, "http://...." for URL, "fileadmin/blabla.txt" for file.
array \| string	$urlParameters	As an array key/value pairs represent URL parameters to set. Values NOT URL-encoded yet, keys should be URL-encoded if needed. As a string the parameter is expected to be URL-encoded already.
string	$target	Specific target set, if any. (Default is using the current)

Returns: string The wrapped $label-text string

See also: getTypoLink_URL()

Definition at line 6940 of file ContentObjectRenderer.php.

References $params, and TYPO3\CMS\Core\Utility\GeneralUtility\implodeArrayForUrl().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoLink_URL().

◆ getTypoLink_URL()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getTypoLink_URL	(	$params,
		$urlParameters = `[]`,
		$target = `''`
	)

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

Parameters

string	$params	Link parameter; eg. "123" for page id, "kasperYYYY@typo3.com" for email address, "http://...." for URL, "fileadmin/blabla.txt" for file.
array \| string	$urlParameters	As an array key/value pairs represent URL parameters to set. Values NOT URL-encoded yet, keys should be URL-encoded if needed. As a string the parameter is expected to be URL-encoded already.
string	$target	Specific target set, if any. (Default is using the current)

Returns: string The URL

See also: getTypoLink()

Definition at line 6993 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$lastTypoLinkUrl, $params, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoLink().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\currentPageUrl(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter().

◆ getTypoScriptFrontendController()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getTypoScriptFrontendController ( )

protected

Returns

Definition at line 8999 of file ContentObjectRenderer.php.

References $GLOBALS.

◆ getUrlToCurrentLocation()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getUrlToCurrentLocation ( $addQueryString = true )

Returns the canonical URL to the current "location", which include the current page ID and type and optionally the query string

Parameters

bool $addQueryString Whether additional GET arguments in the query string should be included or not

Returns: string

Definition at line 6967 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\_GET(), TYPO3\CMS\Core\Utility\GeneralUtility\explodeUrl2Array(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\typoLink_URL().

◆ getUserObjectType()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getUserObjectType ( )

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

Returns: mixed One of OBJECTTYPE_ class constants or FALSE

Definition at line 1126 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$userObjectType.

◆ getWhere()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getWhere	(	$table,
		$conf,
		$returnQueryArray = `false`
	)

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

Parameters

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

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

See also: getQuery()

Definition at line 8506 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\checkPidArray(), TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\enableFields(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), if, TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Core\Versioning\VersionState\MOVE_PLACEHOLDER, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQuery().

◆ gifBuilderTextBox()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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.

Parameters

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

Returns: array The modified $gifbuilderConf array

Definition at line 7603 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\clearTSProperties(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\linebreaks(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\round().

◆ HMENU()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::HMENU ( $conf )

Rendering the cObject, HMENU

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('HMENU', $conf) instead

Definition at line 1256 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ HRULER()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::HRULER ( $conf )

Rendering the cObject, HRULER

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('HRULER', $conf) instead

Definition at line 1308 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ HTMLcaseshift()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::HTMLcaseshift	(	$theValue,
		$case
	)

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

Parameters

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

Returns: string

See also: caseshift()

Definition at line 7419 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\caseshift().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_case(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\textStyle().

◆ HTMLparser_TSbridge()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::HTMLparser_TSbridge	(	$theValue,
		$conf
	)

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

Parameters

string	$theValue	The value to parse by the class
array	$conf	TypoScript properties for the parser. See link.

Returns: string Return value.

See also: stdWrap(), ::HTMLparserConfig(), ::HTMLcleaner()

Definition at line 4206 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_HTMLparser().

◆ http_makelinks()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::http_makelinks	(	$data,
		$conf
	)

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

Parameters

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

Returns: string The processed input string, being returned.

See also: _parseFunc()

Definition at line 5583 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$data, TYPO3\CMS\Frontend\Http\UrlProcessorInterface\CONTEXT_COMMON, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\extLinkATagParams(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getATagParams(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\_parseFunc().

◆ IMAGE()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::IMAGE ( $conf )

Rendering the cObject, IMAGE

Parameters

array $conf Array of TypoScript properties

Returns: string Output

See also: cImage()

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('IMAGE', $conf) instead

Definition at line 1190 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ imageLinkWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::imageLinkWrap	(	$string,
		$imageFile,
		$conf
	)

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

Parameters

string	$string	String to wrap, probably an tag
string \| File \| FileReference	$imageFile	The original image file
array	$conf	TypoScript properties for the "imageLinkWrap" function

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

See also: cImage()

Definition at line 1768 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$parameters, $params, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Resource\ResourceFactory\getInstance(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\hmac(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cImage().

◆ IMG_RESOURCE()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::IMG_RESOURCE ( $conf )

Rendering the cObject, IMG_RESOURCE

Parameters

array $conf Array of TypoScript properties

Returns: string Output

See also: getImgResource()

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('IMG_RESOURCE', $conf) instead

Definition at line 1204 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ IMGTEXT()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::IMGTEXT ( $conf )

Rendering the cObject, IMGTEXT

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('IMGTEXT', $conf) instead

Definition at line 1217 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ includeLibs()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::includeLibs ( array $config )

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

Parameters

array $config TypoScript configuration

Returns: bool Whether a configuration for including libs was found and processed

Definition at line 7680 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\isClassAvailable().

◆ insertData()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 $str Input value

Returns: string Processed input value

See also: getData(), stdWrap(), dataWrap()

Definition at line 4234 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\dataWrap(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\prefixComment(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_insertData().

◆ isClassAvailable()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::isClassAvailable	(		$className,
		array	$config = `null`
	)

protected

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

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

Parameters

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

Returns: bool Whether the class is available todo 93.

Definition at line 7710 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\includeLibs().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\callUserFunction().

◆ isDisabled()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$table	The table name
array	$row	The data record

Returns: bool private

See also: editPanelPreviewBorder()

Definition at line 8862 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

◆ keywords()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::keywords ( $content )

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

Parameters

string $content String of keywords

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

Definition at line 7365 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_keywords().

◆ lastChanged()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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

int $tstamp Unix timestamp (number of seconds since 1970)

Returns: void

See also: TypoScriptFrontendController::setSysLastChanged()

Definition at line 1912 of file ContentObjectRenderer.php.

◆ linebreaks()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$string	The string to break
int	$chars	Max number of characters per line.
int	$maxLines	Max number of lines in all.

Returns: array array with lines. private

See also: gifBuilderTextBox()

Definition at line 7654 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\gifBuilderTextBox().

◆ linkWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$content	Input string
string	$wrap	A string where the first two parts separated by "\|" (vertical line) will be wrapped around the input string

Returns: string Wrapped output string

See also: wrap(), cImage(), FILE()

Definition at line 1930 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cImage().

◆ listNum()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::listNum	(	$content,
		$listNum,
		$char
	)

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

Parameters

string	$content	String to explode
string	$listNum	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	$char	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 3992 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calc(), and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_listNum(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_preIfEmptyListNum().

◆ LOAD_REGISTER()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$conf	Array of TypoScript properties
string	$name	If "RESTORE_REGISTER" then the cObject rendered is "RESTORE_REGISTER", otherwise "LOAD_REGISTER"

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

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('LOAD_REGISTER', $conf) and $cObj->cObjGetSingle('RESTORE_REGISTER', $conf) instead

Definition at line 1336 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ mailto_makelinks()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$data	The string in which to search for "mailto:
array	$conf	Configuration for makeLinks, see link

Returns: string The processed input string, being returned.

See also: _parseFunc()

Definition at line 5659 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$data, $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Resource\ProcessedFile\CONTEXT_IMAGECROPSCALEMASK, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getATagParams(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getGetImgResourceHookObjects(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getMailTo(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getResourceFactory(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\_parseFunc().

◆ MEDIA()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::MEDIA ( $conf )

Rendering the cObject, MEDIA

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('MEDIA', $conf) instead

Definition at line 1422 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ mergeExceptionHandlerConfiguration()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::mergeExceptionHandlerConfiguration ( $configuration )

protected

Merges global exception handler configuration with the one from the content object and returns the merged exception handler configuration

Parameters

array $configuration

Returns: array

Definition at line 1030 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\createExceptionHandler().

◆ mergeTSRef()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$confArr	The TypoScript array
string	$prop	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

Definition at line 7579 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\parseFunc().

◆ MULTIMEDIA()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::MULTIMEDIA ( $conf )

Rendering the cObject, MULTIMEDIA

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('MULTIMEDIA', $conf) instead

Definition at line 1409 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ noTrimWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::noTrimWrap	(	$content,
		$wrap,
		$char = `'\|'`
	)

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	$content	The content to wrap, eg. "HELLO WORLD @param string $wrap The wrap value, eg. " \| \|
string	$char	The char used to split the wrapping value, default is "\|"

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

See also: wrap()

Definition at line 7252 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_noTrimWrap().

◆ numberFormat()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::numberFormat	(	$content,
		$conf
	)

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

Parameters

float	$content	Value to process
array	$conf	TypoScript Configuration for numberFormat

Returns: string The formatted number

Definition at line 5116 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_numberFormat().

◆ numRows()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::numRows ( $conf )

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

Parameters

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

Returns: int|bool The number of rows found by the select (FALSE on error) private

See also: stdWrap()

Definition at line 3968 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\exec_getQuery(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getDatabaseConnection(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTimeTracker().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_numRows().

◆ OTABLE()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::OTABLE ( $conf )

Rendering the cObject, OTABLE

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('OTABLE', $conf) instead

Definition at line 1282 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ parseFunc()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 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	$theValue	The value to process.
array	$conf	TypoScript configuration for parseFunc
string	$ref	Reference to get configuration from. Eg. "< lib.parseFunc" which means that the configuration of the object path "lib.parseFunc" will be retrieved and MERGED with what is in $conf!

Returns: string The processed value

See also: _parseFunc()

Definition at line 5143 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\_parseFunc(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mergeTSRef(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_parseFunc().

◆ prefixComment()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$str	Input value
array	$conf	TypoScript Configuration (not used at this point.)
string	$content	The content to wrap the comment around.

Returns: string Processed input value

See also: stdWrap()

Definition at line 4265 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\insertData().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_prefixComment().

◆ processParams()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 $params Text which the parameters

Returns: array array with the parameters as key/value pairs

Definition at line 7345 of file ContentObjectRenderer.php.

References $params, and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ QTOBJECT()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::QTOBJECT ( $conf )

Rendering the cObject, QTOBJECT

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('QTOBJECT', $conf) instead

Definition at line 1448 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ readFlexformIntoConf()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::readFlexformIntoConf	(		$flexData,
		&	$conf,
			$recursive = `false`
	)

Converts a given config in Flexform to a conf-array

Parameters

string \| array	$flexData	Flexform data
array	$conf	Array to write the data into, by reference
bool	$recursive	Is set if called recursive. Don't call function with this parameter, it's used inside the function only

Returns: void

Definition at line 1480 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\xml2array().

◆ RECORDS()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::RECORDS ( $conf )

Rendering the cObject, RECORDS

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('RECORDS', $conf) instead

Definition at line 1243 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ registerContentObjectClass()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::registerContentObjectClass	(	$className,
		$contentObjectName
	)

Register a single content object name to class name

This method is private API, please use configuration $GLOBALS['TYPO3_CONF_VARS']['FE']['ContentObjects'] to add new content objects

Definition at line 659 of file ContentObjectRenderer.php.

◆ removeBadHTML()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::removeBadHTML ( $text )

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 $text Input string to be cleaned.

Returns: string Return string

Definition at line 4493 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_removeBadHTML().

◆ replacement()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::replacement	(		$content,
		array	$configuration
	)

protected

Processes ordered replacements on content data.

Parameters

string	$content	The content to be processed
array	$configuration	The TypoScript configuration for stdWrap.replacement

Returns: string The processed content data

Definition at line 4997 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\replacementSingle().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_replacement().

◆ replacementSingle()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::replacementSingle	(		$content,
		array	$configuration
	)

protected

Processes a single search/replace on content data.

Parameters

string	$content	The content to be processed
array	$configuration	The TypoScript of the search/replace action to be processed

Returns: string The processed content data

Definition at line 5017 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\replacement().

◆ resolveMixedLinkParameter()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::resolveMixedLinkParameter	(		$linkText,
			$mixedLinkParameter,
		&	$configuration = `[]`
	)

protected

called from the typoLink() function

does the magic to split the full "typolink" string like "15,13 _blank myclass &more=1" into separate parts

Parameters

string	$linkText	The string (text) to link
string	$mixedLinkParameter	destination data like "15,13 _blank myclass &more=1" used to create the link
array	$configuration	TypoScript configuration

Returns: array | string

See also: typoLink()

Definition at line 6277 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\StringUtility\beginsWith(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getResourceFactory(), TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter().

◆ rootLineValue()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::rootLineValue	(	$key,
		$field,
		$slideBack = `false`,
		$altRootLine = `''`
	)

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

Parameters

string	$key	Which level in the root line
string	$field	The field in the rootline record to return (a field from the pages table)
bool	$slideBack	If set, then we will traverse through the rootline from outer level towards the root level until the value found is TRUE
mixed	$altRootLine	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 6153 of file ContentObjectRenderer.php.

References $a, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData().

◆ round()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::round	(		$content,
		array	$conf = `[]`
	)

protected

Implements the "round" property of stdWrap This is a Wrapper function for PHP's rounding functions (round,ceil,floor), defaults to round()

Parameters

string	$content	Value to process
array	$conf	TypoScript configuration for round

Returns: string The formatted number

Definition at line 5088 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calcAge(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\gifBuilderTextBox(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_round().

◆ sanitizeSelectPart()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::sanitizeSelectPart	(	$selectPart,
		$table
	)

protected

Helper function for getQuery, sanitizing the select part

This functions checks if the necessary fields are part of the select and adds them if necessary.

Parameters

string	$selectPart	Select part
string	$table	Table to select from

Returns: string Sanitized select part private

See also: getQuery

Definition at line 8648 of file ContentObjectRenderer.php.

References $GLOBALS, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQuery().

◆ SEARCHRESULT()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::SEARCHRESULT ( $conf )

Rendering the cObject, SEARCHRESULT

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('SEARCHRESULT', $conf) instead

Definition at line 1369 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ searchWhere()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$sw	The search words. These will be separated by space and comma.
string	$searchFieldList	The fields to search in
string	$searchTable	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 8252 of file ContentObjectRenderer.php.

◆ setContentObjectClassMap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::setContentObjectClassMap ( array $contentObjectClassMap )

Allow injecting content object class map.

This method is private API, please use configuration $GLOBALS['TYPO3_CONF_VARS']['FE']['ContentObjects'] to add new content objects

Definition at line 644 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$contentObjectClassMap.

◆ setCurrentFile()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::setCurrentFile ( $fileObject )

Sets the current file object during iterations over files.

Parameters

File $fileObject The file object.

Definition at line 2362 of file ContentObjectRenderer.php.

◆ setCurrentVal()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::setCurrentVal ( $value )

Sets the "current" value.

Parameters

mixed $value The variable that you want to set as "current

Returns: void

See also: getCurrentVal()

Definition at line 780 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentValKey.

◆ setParent()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::setParent	(	$data,
		$currentRecord
	)

Sets the internal variable parentRecord with information about current record. If the ContentObjectRender 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 747 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentRecord, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$data.

◆ setUserObjectType()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::setUserObjectType ( $userObjectType )

Sets the user object type

Parameters

mixed $userObjectType

Returns: void

Definition at line 1137 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$userObjectType.

◆ splitObj()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$value	The string value to explode by $conf[token] and process each part
array	$conf	TypoScript properties for "split

Returns: string Compiled result private

See also: stdWrap(), ::procesItemStates()

Definition at line 4932 of file ContentObjectRenderer.php.

References $a, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentValKey, $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cObjGet(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_split().

◆ start()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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 673 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$data, $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, and TYPO3\CMS\Core\Utility\GeneralUtility\getUserObj().

◆ stdWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$content	Input value undergoing processing in this function. Possibly substituted by other values fetched from another source.
array	$conf	TypoScript "stdWrap properties".

Returns: string The processed input value

Definition at line 2393 of file ContentObjectRenderer.php.

◆ stdWrap_addPageCacheTags()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_addPageCacheTags	(	$content = `''`,
		$conf = `[]`
	)

Add tags to page cache (comma-separated list)

Parameters

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

Returns: string The processed input value

Definition at line 2540 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ stdWrap_addParams()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_addParams	(	$content = `''`,
		$conf = `[]`
	)

addParams Adds tag attributes to any content that is a tag

Parameters

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

Returns: string The processed input value

Definition at line 3425 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\addParams().

◆ stdWrap_age()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_age	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3169 of file ContentObjectRenderer.php.

References $GLOBALS, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calcAge().

◆ stdWrap_append()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_append	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3681 of file ContentObjectRenderer.php.

◆ stdWrap_br()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_br ( $content = '' )

br Searches for single line breaks and replaces them with a
/
tag according to the doctype

Parameters

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

Returns: string The processed input value

Definition at line 3330 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

◆ stdWrap_brTag()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_brTag	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3343 of file ContentObjectRenderer.php.

◆ stdWrap_bytes()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_bytes	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3196 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\formatSize().

◆ stdWrap_cacheRead()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_cacheRead	(	$content = `''`,
		$conf = `[]`
	)

Check if content was cached before (depending on the given cache key)

Parameters

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

Returns: string The processed input value

Definition at line 2524 of file ContentObjectRenderer.php.

◆ stdWrap_case()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_case	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3183 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\HTMLcaseshift().

◆ stdWrap_char()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_char	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3033 of file ContentObjectRenderer.php.

◆ stdWrap_cObject()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_cObject	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2648 of file ContentObjectRenderer.php.

◆ stdWrap_crop()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_crop	(	$content = `''`,
		$conf = `[]`
	)

crop Crops content to a given size without caring about HTML tags

Parameters

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

Returns: string The processed input value

Definition at line 3259 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\crop().

◆ stdWrap_cropHTML()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_cropHTML	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3234 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cropHTML().

◆ stdWrap_csConv()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_csConv	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2944 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

◆ stdWrap_current()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_current	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2634 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentValKey.

◆ stdWrap_data()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_data	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2604 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData().

◆ stdWrap_dataWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_dataWrap	(	$content = `''`,
		$conf = `[]`
	)

dataWrap Sixth of a set of different wraps which will be applied in a certain order before or after other functions that modify the content Can fetch additional content the same way data does (i.e. {field:whatever}) and apply it to the wrap before that is applied to the content

Parameters

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

Returns: string The processed input value

Definition at line 3655 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\dataWrap().

◆ stdWrap_date()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_date	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3115 of file ContentObjectRenderer.php.

References $GLOBALS.

◆ stdWrap_debug()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_debug ( $content = '' )

debug Will output the content as readable HTML code

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 3924 of file ContentObjectRenderer.php.

◆ stdWrap_debugData()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_debugData ( $content = '' )

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

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 3950 of file ContentObjectRenderer.php.

References debug().

◆ stdWrap_debugFunc()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_debugFunc	(	$content = `''`,
		$conf = `[]`
	)

debugFunc Will output the content in a debug table

Parameters

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

Returns: string The processed input value

Definition at line 3937 of file ContentObjectRenderer.php.

References debug().

◆ stdWrap_doubleBrTag()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_doubleBrTag	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3316 of file ContentObjectRenderer.php.

◆ stdWrap_editIcons()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_editIcons	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3837 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\editIcons(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

◆ stdWrap_editPanel()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_editPanel	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3856 of file ContentObjectRenderer.php.

References $GLOBALS, $params, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calculateCacheKey(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calculateCacheLifetime(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calculateCacheTags(), TYPO3\CMS\Core\Utility\GeneralUtility\callUserFunction(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\editPanel(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ stdWrap_encapsLines()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_encapsLines	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3357 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\encaps_lineSplit().

◆ stdWrap_encodeForJavaScriptValue()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_encodeForJavaScriptValue ( $content = '' )

encodeForJavaScriptValue Escapes content to be used inside JavaScript strings. No quotes are added around the value as this can easily be done in TypoScript

Parameters

string $content Input value undergoing processing in this function

Returns: string The processed input value

Definition at line 3303 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\quoteJSvalue().

◆ stdWrap_expandList()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_expandList ( $content = '' )

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

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 3101 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\expandList().

◆ stdWrap_field()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_field	(	$content = `''`,
		$conf = `[]`
	)

field Gets content from a DB field

Parameters

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

Returns: string The processed input value

Definition at line 2620 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getFieldVal().

◆ stdWrap_fieldRequired()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_fieldRequired	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2927 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$stdWrapRecursionLevel.

◆ stdWrap_filelink()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_filelink	(	$content = `''`,
		$conf = `[]`
	)

filelink Used to make lists of links to files See wrap

Parameters

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

Returns: string The processed input value

Definition at line 3467 of file ContentObjectRenderer.php.

◆ stdWrap_filelist()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_filelist	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2675 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\filelist().

◆ stdWrap_fontTag()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_fontTag	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3412 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

◆ stdWrap_hash()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_hash	(		$content = `''`,
		array	$conf = `[]`
	)

Will return a hashed value of the current content

Parameters

string	$content	Input value undergoing processing in this function.
array	$conf	stdWrap properties for hash.

Returns: string The processed input value for a list of supported hash algorithms

Definition at line 3058 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

◆ stdWrap_HTMLparser()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_HTMLparser	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2972 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\HTMLparser_TSbridge().

◆ stdWrap_htmlSpecialChars()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_htmlSpecialChars	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3285 of file ContentObjectRenderer.php.

◆ stdWrap_if()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_if	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2909 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$stdWrapRecursionLevel, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\checkIf().

◆ stdWrap_ifBlank()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_ifBlank	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2780 of file ContentObjectRenderer.php.

◆ stdWrap_ifEmpty()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_ifEmpty	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2763 of file ContentObjectRenderer.php.

◆ stdWrap_ifNull()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_ifNull	(	$content = `''`,
		$conf = `[]`
	)

ifNull Will set content to a replacement value in case the value of content is NULL

Parameters

string \| NULL	$content	Input value undergoing processing in this function.
array	$conf	stdWrap properties for ifNull.

Returns: string The processed input value

Definition at line 2749 of file ContentObjectRenderer.php.

◆ stdWrap_innerWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_innerWrap	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3383 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

◆ stdWrap_innerWrap2()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_innerWrap2	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3397 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

◆ stdWrap_insertData()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_insertData ( $content = '' )

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

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 3737 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\insertData().

◆ stdWrap_intval()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_intval ( $content = '' )

intval Will return an integer value of the current content

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 3045 of file ContentObjectRenderer.php.

◆ stdWrap_keywords()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_keywords ( $content = '' )

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

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 3369 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\keywords().

◆ stdWrap_lang()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_lang	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2587 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

◆ stdWrap_listNum()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_listNum	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2798 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\listNum().

◆ stdWrap_noTrimWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_noTrimWrap	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3616 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\noTrimWrap(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

◆ stdWrap_numberFormat()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_numberFormat	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3089 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\numberFormat().

◆ stdWrap_numRows()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_numRows	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2662 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\numRows().

◆ stdWrap_offsetWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_offsetWrap	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Deprecated:: since CMS 7, will be removed with CMS 8 without replacement

Definition at line 3752 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

◆ stdWrap_orderedStdWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_orderedStdWrap	(	$content = `''`,
		$conf = `[]`
	)

orderedStdWrap Calls stdWrap for each entry in the provided array

Parameters

string	$content	Input value undergoing processing in this function.
array	$conf	stdWrap properties for orderedStdWrap.

Returns: string The processed input value

Definition at line 3708 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\TypoScript\TemplateService\sortedKeyList(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

◆ stdWrap_outerWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_outerWrap	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3725 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

◆ stdWrap_override()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_override	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2719 of file ContentObjectRenderer.php.

◆ stdWrap_parseFunc()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_parseFunc	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2958 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\parseFunc().

◆ stdWrap_postCObject()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_postCObject	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3493 of file ContentObjectRenderer.php.

◆ stdWrap_postUserFunc()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_postUserFunc	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3785 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\callUserFunction().

◆ stdWrap_postUserFuncInt()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_postUserFuncInt	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3799 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

◆ stdWrap_preCObject()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_preCObject	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3480 of file ContentObjectRenderer.php.

◆ stdWrap_prefixComment()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_prefixComment	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3821 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\prefixComment().

◆ stdWrap_preIfEmptyListNum()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_preIfEmptyListNum	(	$content = `''`,
		$conf = `[]`
	)

preIfEmptyListNum Gets a value off a CSV list before the following ifEmpty check Makes sure that the result of ifEmpty will be TRUE in case the CSV does not contain a value at the position given by preIfEmptyListNum

Parameters

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

Returns: string The processed input value

Definition at line 2736 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\listNum().

◆ stdWrap_prepend()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_prepend	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3668 of file ContentObjectRenderer.php.

◆ stdWrap_preUserFunc()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_preUserFunc	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2688 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\callUserFunction().

◆ stdWrap_prioriCalc()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_prioriCalc	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3016 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\MathUtility\calculateWithParentheses().

◆ stdWrap_rawUrlEncode()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_rawUrlEncode ( $content = '' )

rawUrlEncode Encodes content to be used within URLs

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 3271 of file ContentObjectRenderer.php.

◆ stdWrap_removeBadHTML()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_removeBadHTML ( $content = '' )

removeBadHTML Removes HTML tags based on stdWrap properties

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 3221 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\removeBadHTML().

◆ stdWrap_replacement()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_replacement	(	$content = `''`,
		$conf = `[]`
	)

replacement Will execute replacements on the content (optionally with preg-regex)

Parameters

string	$content	Input value undergoing processing in this function.
array	$conf	stdWrap properties for replacement.

Returns: string The processed input value

Definition at line 3002 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\replacement().

◆ stdWrap_required()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_required ( $content = '' )

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

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 2891 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$stdWrapRecursionLevel.

◆ stdWrap_round()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_round	(	$content = `''`,
		$conf = `[]`
	)

stdWrap_round will return a rounded number with ceil(), floor() or round(), defaults to round() Only the english number format is supported . (dot) as decimal point

Parameters

string	$content	Input value undergoing processing in this function.
array	$conf	stdWrap properties for round.

Returns: string The processed input value

Definition at line 3076 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\round().

◆ stdWrap_setContentToCurrent()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_setContentToCurrent ( $content = '' )

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

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 2559 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentValKey.

◆ stdWrap_setCurrent()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_setCurrent	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2573 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentValKey.

◆ stdWrap_space()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_space	(	$content = `''`,
		$conf = `[]`
	)

space Will add space before or after the current content By default this is done with a clear.gif but it can be done with CSS margins by setting the property space.useDiv to TRUE See wrap

Parameters

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

Returns: string The processed input value

Definition at line 3585 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrapSpace().

◆ stdWrap_spaceAfter()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_spaceAfter	(	$content = `''`,
		$conf = `[]`
	)

spaceAfter Will add space after the current content By default this is done with a clear.gif but it can be done with CSS margins by setting the property space.useDiv to TRUE

Parameters

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

Returns: string The processed input value

Definition at line 3570 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrapSpace().

◆ stdWrap_spaceBefore()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_spaceBefore	(	$content = `''`,
		$conf = `[]`
	)

spaceBefore Will add space before the current content By default this is done with a clear.gif but it can be done with CSS margins by setting the property space.useDiv to TRUE

Parameters

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

Returns: string The processed input value

Definition at line 3556 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrapSpace().

◆ stdWrap_split()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_split	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2989 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\splitObj().

◆ stdWrap_stdWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_stdWrap	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 2860 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

◆ stdWrap_strftime()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_strftime	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3132 of file ContentObjectRenderer.php.

References $GLOBALS, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

◆ stdWrap_stripHtml()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_stripHtml ( $content = '' )

stripHtml Copmletely removes HTML tags from content

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 3246 of file ContentObjectRenderer.php.

◆ stdWrap_strPad()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_strPad	(	$content = `''`,
		$conf = `[]`
	)

strPad Will return a string padded left/right/on both sides, based on configuration given as stdWrap properties

Parameters

string	$content	Input value undergoing processing in this function.
array	$conf	stdWrap properties for strPad.

Returns: string The processed input value

Definition at line 2823 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

◆ stdWrap_strtotime()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_strtotime	(	$content = `''`,
		$conf = `[]`
	)

strtotime Will return a timestamp based on configuration given according to PHP strtotime

Parameters

string	$content	Input value undergoing processing in this function.
array	$conf	stdWrap properties for strtotime.

Returns: string The processed input value

Definition at line 3153 of file ContentObjectRenderer.php.

References $GLOBALS.

◆ stdWrap_substring()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_substring	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3209 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\substring().

◆ stdWrap_tableStyle()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_tableStyle	(	$content = `''`,
		$conf = `[]`
	)

tableStyle Wraps content with table tags See wrap

Parameters

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

Returns: string The processed input value

Definition at line 3453 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\tableStyle().

◆ stdWrap_TCAselectItem()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_TCAselectItem	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3539 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\TCAlookup().

◆ stdWrap_textStyle()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_textStyle	(	$content = `''`,
		$conf = `[]`
	)

textStyle Wraps content in font tags See wrap

Parameters

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

Returns: string The processed input value

Definition at line 3439 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\textStyle().

◆ stdWrap_trim()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_trim ( $content = '' )

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

Parameters

string $content Input value undergoing processing in this function.

Returns: string The processed input value

Definition at line 2810 of file ContentObjectRenderer.php.

◆ stdWrap_typolink()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_typolink	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3526 of file ContentObjectRenderer.php.

◆ stdWrap_wrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_wrap	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3602 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

◆ stdWrap_wrap2()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_wrap2	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3641 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

◆ stdWrap_wrap3()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_wrap3	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3695 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

◆ stdWrap_wrapAlign()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_wrapAlign	(	$content = `''`,
		$conf = `[]`
	)

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

Parameters

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

Returns: string The processed input value

Definition at line 3507 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

◆ stdWrapValue()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrapValue	(		$key,
		array	$config,
			$defaultValue = `''`
	)

Gets a configuration value by passing them through stdWrap first and taking a default value if stdWrap doesn't yield a result.

Parameters

string	$key	The config variable key (from TS array).
array	$config	The TypoScript array.
string	$defaultValue	Optional default value.

Returns: string Value of the config variable

Definition at line 2484 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap().

Referenced by TYPO3\CMS\Frontend\DataProcessing\DatabaseQueryProcessor\__construct(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cImage(), TYPO3\CMS\Frontend\DataProcessing\SplitProcessor\process(), TYPO3\CMS\Frontend\DataProcessing\CommaSeparatedValueProcessor\process(), and TYPO3\CMS\Frontend\DataProcessing\GalleryProcessor\process().

◆ substituteMarker()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::substituteMarker	(	$content,
		$marker,
		$markContent
	)

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

Parameters

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

Returns: string The processed HTML content string.

See also: substituteSubpart()

Definition at line 2122 of file ContentObjectRenderer.php.

◆ substituteMarkerAndSubpartArrayRecursive()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::substituteMarkerAndSubpartArrayRecursive	(		$content,
		array	$markersAndSubparts,
			$wrap = `''`,
			$uppercase = `false`,
			$deleteUnused = `false`
	)

Replaces all markers and subparts in a template with the content provided in the structured array.

Parameters

string	$content
array	$markersAndSubparts
string	$wrap
bool	$uppercase
bool	$deleteUnused

Returns: string

Definition at line 2317 of file ContentObjectRenderer.php.

◆ substituteMarkerArray()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::substituteMarkerArray	(		$content,
		array	$markContentArray,
			$wrap = `''`,
			$uppercase = `false`,
			$deleteUnused = `false`
	)

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

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

Parameters

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

Returns: string The processed output stream

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

Definition at line 2282 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cImage(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getImageSourceCollection().

◆ substituteMarkerArrayCached()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::substituteMarkerArrayCached	(		$content,
		array	$markContentArray = `null`,
		array	$subpartContentArray = `null`,
		array	$wrappedSubpartContentArray = `null`
	)

Multi substitution function with caching.

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

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

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

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

$wrappedSubpartContentArray is an array of arrays with 0/1 keys where the subparts pointed to by the main key is wrapped with the 0/1 value alternating.

Parameters

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

◆ substituteMarkerInObject()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::substituteMarkerInObject	(	&	$tree,
		array	$markContentArray
	)

Substitute marker array in an array of values

Parameters

mixed	$tree	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	$markContentArray	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 2295 of file ContentObjectRenderer.php.

◆ substituteSubpart()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::substituteSubpart	(	$content,
		$marker,
		$subpartContent,
		$recursive = `1`
	)

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

Parameters

string	$content	The content stream, typically HTML template content.
string	$marker	The marker string, typically on the form "###[the marker string]###
mixed	$subpartContent	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.
bool \| int	$recursive	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.

Definition at line 2095 of file ContentObjectRenderer.php.

◆ substituteSubpartArray()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::substituteSubpartArray	(		$content,
		array	$subpartsContent
	)

Substitues multiple subparts at once

Parameters

string	$content	The content stream, typically HTML template content.
array	$subpartsContent	The array of key/value pairs being subpart/content values used in the substitution. For each element in this array the function will substitute a subpart in the content stream with the content.

Returns: string The processed HTML content string.

Definition at line 2107 of file ContentObjectRenderer.php.

◆ substring()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::substring	(	$content,
		$options
	)

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

Parameters

string	$content	The string to perform the operation on
string	$options	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 4290 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Core\Utility\GeneralUtility\intExplode().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_substring().

◆ SVG()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::SVG ( $conf )

Rendering the cObject, SVG

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('SVG', $conf) instead

Definition at line 1461 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ SWFOBJECT()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::SWFOBJECT ( $conf )

Rendering the cObject, SWFOBJECT

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('SWFOBJECT', $conf) instead

Definition at line 1435 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ tableStyle()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::tableStyle	(	$theValue,
		$conf
	)

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

with properties which is wrapped around the input value.

Parameters

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

Returns: string The processed output value private

See also: stdWrap()

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 4616 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$align, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_tableStyle().

◆ TCAlookup()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::TCAlookup	(	$inputValue,
		$conf
	)

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

Parameters

mixed	$inputValue	Comma-separated list of values to look up
array	$conf	TS-configuration array, see TSref for details

Returns: string String of translated values, separated by $delimiter. If no matches were found, the input value is simply returned.

Todo:: It would be nice it this function basically looked up any type of value, db-relations etc.

Definition at line 6234 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$table, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_TCAselectItem().

◆ TEMPLATE()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::TEMPLATE ( $conf )

Rendering the cObject, TEMPLATE

Parameters

array $conf Array of TypoScript properties

Returns: string Output

See also: substituteMarkerArrayCached()

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('TEMPLATE', $conf) instead

Definition at line 1383 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ TEXT()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::TEXT ( $conf )

Rendering the cObject, TEXT

Parameters

array $conf Array of TypoScript properties

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('TEXT', $conf) instead

Definition at line 1063 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ textStyle()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$theValue	The input value
array	$conf	TypoScript properties for the "TypoScript function" '->textStyle'

Returns: string The processed output value private

See also: stdWrap()

Deprecated:: since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 4534 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$align, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\HTMLcaseshift(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\wrap().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_textStyle().

◆ typoLink_URL()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::typoLink_URL ( $conf )

Based on the input "TypoLink" TypoScript configuration this will return the generated URL

Parameters

array $conf TypoScript properties for "typolink

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

See also: typoLink()

Definition at line 6921 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$lastTypoLinkUrl.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getUrlToCurrentLocation().

◆ typolinkWrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::typolinkWrap ( $conf )

Generates a typolink and returns the two link tags - start and stop - in an array

Parameters

array $conf "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 7006 of file ContentObjectRenderer.php.

◆ URLqMark()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::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	$url	Input URL
string	$params	URL parameters

Returns: string

Definition at line 7543 of file ContentObjectRenderer.php.

References $params.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter().

◆ USER()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::USER	(	$conf,
		$ext = `''`
	)

Rendering the cObject, USER and USER_INT

Parameters

array	$conf	Array of TypoScript properties
string	$ext	If "INT" then the cObject is a "USER_INT" (non-cached), otherwise just "USER" (cached)

Returns: string Output

Deprecated:: since TYPO3 CMS 7, will be removed with TYPO3 CMS 8, use $cObj->cObjGetSingle('USER', $conf) or $cObj->cObjGetSingle('USER_INT', $conf) instead

Definition at line 1108 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Core\Utility\GeneralUtility\logDeprecatedFunction(), and TYPO3Fluid\Fluid\Core\ViewHelper\Traits\render().

◆ wrap()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::wrap	(	$content,
		$wrap,
		$char = `'\|'`
	)

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

Parameters

string	$content	The content to wrap
string	$wrap	The wrap value, eg. "<strong> \| </strong> @param string $char The char used to split the wrapping value, default is "\|

Returns: string Wrapped input string

See also: noTrimWrap()

Definition at line 7233 of file ContentObjectRenderer.php.

◆ wrapSpace()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::wrapSpace	(		$content,
			$wrap,
		array	$conf = `null`
	)

Adds space above/below the input HTML string. It is done by adding a clear-gif and
tag before and/or after the content.

Parameters

string	$content	The content to add space above/below to.
string	$wrap	A value like "10 \| 20" where the first part denotes the space BEFORE and the second part denotes the space AFTER (in pixels)
array	$conf	Configuration from TypoScript

Returns: string Wrapped string

Definition at line 7271 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_space(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_spaceAfter(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_spaceBefore().

Member Data Documentation

◆ $align

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$align

Initial value:

= [
        'center',
        'right',
        'left'
    ]

Definition at line 67 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\tableStyle(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\textStyle().

◆ $alternativeData

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$alternativeData = ''

Definition at line 402 of file ContentObjectRenderer.php.

◆ $checkPid_badDoktypeList

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$checkPid_badDoktypeList = '255'

Definition at line 469 of file ContentObjectRenderer.php.

◆ $checkPid_cache

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$checkPid_cache = []

Definition at line 464 of file ContentObjectRenderer.php.

◆ $cObjHookObjectsArr

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$cObjHookObjectsArr = []

Definition at line 514 of file ContentObjectRenderer.php.

◆ $cObjHookObjectsRegistry

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$cObjHookObjectsRegistry = []

protected

Definition at line 509 of file ContentObjectRenderer.php.

◆ $contentObjectClassMap

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$contentObjectClassMap = []

protected

Definition at line 257 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\setContentObjectClassMap().

◆ $currentFile

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$currentFile = null

protected

Definition at line 533 of file ContentObjectRenderer.php.

◆ $currentRecord

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$currentRecord = ''

Definition at line 422 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\editIcons(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\editPanel(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\setParent().

◆ $currentRecordNumber

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$currentRecordNumber = 0

Definition at line 436 of file ContentObjectRenderer.php.

◆ $currentRecordTotal

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$currentRecordTotal = 0

Definition at line 429 of file ContentObjectRenderer.php.

◆ $currentValKey

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$currentValKey = 'currentValue_kidjls9dksoje'

Definition at line 414 of file ContentObjectRenderer.php.

◆ $data

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$data = []

Definition at line 383 of file ContentObjectRenderer.php.

◆ $doConvertToUserIntObject

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$doConvertToUserIntObject = false

Set to TRUE by doConvertToUserIntObject() if USER object wants to become USER_INT

Definition at line 538 of file ContentObjectRenderer.php.

◆ $getImgResourceHookObjects

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$getImgResourceHookObjects

protected

Definition at line 528 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getGetImgResourceHookObjects().

◆ $image_compression

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$image_compression

Initial value:

= [
        10 => [
            'params' => ''

Definition at line 265 of file ContentObjectRenderer.php.

◆ $image_effects

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$image_effects

Initial value:

= [

1 => '-rotate 90'

Definition at line 362 of file ContentObjectRenderer.php.

◆ $INT_include

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$INT_include = 0

Definition at line 457 of file ContentObjectRenderer.php.

◆ $lastTypoLinkLD

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$lastTypoLinkLD = []

Definition at line 488 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter().

◆ $lastTypoLinkTarget

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$lastTypoLinkTarget = ''

Definition at line 483 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter().

◆ $lastTypoLinkUrl

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$lastTypoLinkUrl = ''

Definition at line 476 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\detectLinkTypeFromLinkParameter(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoLink_URL(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\typoLink_URL().

◆ $oldData

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$oldData = []

Definition at line 395 of file ContentObjectRenderer.php.

◆ $parameters

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$parameters = []

Definition at line 409 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\enableFields(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\imageLinkWrap().

◆ $parentRecord

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$parentRecord = []

Definition at line 450 of file ContentObjectRenderer.php.

◆ $parentRecordNumber

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$parentRecordNumber = 0

Definition at line 443 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData().

◆ $recordRegister

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$recordRegister = []

Definition at line 502 of file ContentObjectRenderer.php.

◆ $stdWrapHookObjects

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$stdWrapHookObjects = []

protected

Definition at line 521 of file ContentObjectRenderer.php.

◆ $stdWrapOrder

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$stdWrapOrder

Initial value:

= [

'stdWrapPreProcess' => 'hook'

stdWrap functions in their correct order

See also: stdWrap()

Definition at line 78 of file ContentObjectRenderer.php.

◆ $stdWrapRecursionLevel

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$stdWrapRecursionLevel = 0

protected

Definition at line 555 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_fieldRequired(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_if(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_required().

◆ $stopRendering

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$stopRendering = []

protected

Definition at line 550 of file ContentObjectRenderer.php.

◆ $substMarkerCache

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$substMarkerCache = []

Definition at line 495 of file ContentObjectRenderer.php.

◆ $table

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$table = ''

protected

Definition at line 388 of file ContentObjectRenderer.php.

◆ $templateService

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$templateService

protected

Definition at line 565 of file ContentObjectRenderer.php.

◆ $typoScriptFrontendController

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$typoScriptFrontendController

protected

Definition at line 560 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\__construct().

◆ $userObjectType

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$userObjectType = false

protected

Indicates current object type. Can hold one of OBJECTTYPE_ constants or FALSE. The value is set and reset inside USER() function. Any time outside of USER() it is FALSE.

Definition at line 545 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getUserObjectType(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\setUserObjectType().

◆ OBJECTTYPE_USER

const TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::OBJECTTYPE_USER = 2

Indicates that object type is USER.

See also: ContentObjectRender::$userObjectType

Definition at line 578 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\FrontendRequestHandler\injectExtensionService(), and TYPO3\CMS\Frontend\ContentObject\UserContentObject\render().

◆ OBJECTTYPE_USER_INT

const TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::OBJECTTYPE_USER_INT = 1

Indicates that object type is USER.

See also: ContentObjectRender::$userObjectType

Definition at line 572 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\UserInternalContentObject\render().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __sleep()

◆ __wakeup()

◆ _parseFunc()

◆ addParams()

◆ calc()

◆ calcAge()

◆ calcIntExplode()

◆ calculateCacheKey()

◆ calculateCacheLifetime()

◆ calculateCacheTags()

◆ callUserFunction()

◆ CASEFUNC()

◆ caseshift()

◆ checkIf()

◆ checkPid()

◆ checkPidArray()

◆ cImage()

◆ clean_directory()

◆ cleanFormName()

◆ CLEARGIF()

◆ clearTSProperties()

◆ COBJ_ARRAY()

◆ cObjGet()

◆ COLUMNS()

◆ CONTENT()

◆ convertToUserIntObject()

◆ createExceptionHandler()

◆ crop()

◆ cropHTML()

◆ CTABLE()

◆ currentPageUrl()

◆ dataWrap()

◆ DBgetDelete()

◆ DBgetInsert()

◆ DBgetUpdate()

◆ DBmayFEUserEdit()

◆ DBmayFEUserEditSelect()

◆ detectLinkTypeFromLinkParameter()

◆ determineExceptionHandlerClassName()

◆ editIcons()

◆ editPanel()

◆ enableFields()

◆ encaps_lineSplit()

◆ exec_getQuery()

◆ exec_mm_query()

◆ exec_mm_query_uidList()

◆ extLinkATagParams()

◆ FILE()

◆ filelist()

◆ fileResource()

◆ FILES()

◆ fillInMarkerArray()

◆ FLOWPLAYER()

◆ FLUIDTEMPLATE()

◆ forceAbsoluteUrl()

◆ FORM()

◆ getAltParam()

◆ getATagParams()

◆ getBorderAttr()

◆ getClosestMPvalueForPage()

◆ getContentObject()

◆ getCurrentFile()

◆ getCurrentTable()

◆ getCurrentVal()

◆ getData()

◆ getDatabaseConnection()

◆ getEnvironmentVariable()

◆ getFieldVal()

◆ getFrontendBackendUser()

◆ getGetImgResourceHookObjects()

◆ getGlobal()

◆ getImageSourceCollection()