Inheritance diagram for TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer:

Public Member Functions
	__construct (TypoScriptFrontendController $typoScriptFrontendController=null, ContainerInterface $container=null)

	setRequest (ServerRequestInterface $request)

array	__sleep ()

	__wakeup ()

	start ($data, $table='')

string	getCurrentTable ()

	setParent ($data, $currentRecord)

mixed	getCurrentVal ()

	setCurrentVal ($value)

string	cObjGet ($setup, $addKey='')

list< string >	cObjGetSeparated (?array $setup, string $addKey='')

string	cObjGetSingle (string $name, $conf, $TSkey='__')

	getContentObject ($name)

	render (AbstractContentObject $contentObject, $configuration=[])

mixed	getUserObjectType ()

	setUserObjectType ($userObjectType)

	convertToUserIntObject ()

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

string	getSlidePids ($pidList, $pidConf)

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

	lastChanged ($tstamp)

	setCurrentFile ($fileObject)

File FileReference Folder FileInterface FolderInterface string null	getCurrentFile ()

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

string int bool null	stdWrapValue ($key, array $config, $defaultValue='')

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

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

string	stdWrap_setContentToCurrent ($content='')

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

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

string	stdWrap_data ($_='', $conf=[])

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

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

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

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

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

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

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

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

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

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

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

string	stdWrap_trim ($content='')

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

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

string	stdWrap_required ($content='')

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

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

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

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

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

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

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

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

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

string	stdWrap_intval ($content='')

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

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

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

string	stdWrap_expandList ($content='')

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

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

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

string	stdWrap_formattedDate (string $content, array $conf)

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

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

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

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

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

string	stdWrap_stripHtml ($content='')

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

string	stdWrap_rawUrlEncode ($content='')

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

string	stdWrap_encodeForJavaScriptValue ($content='')

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

string	stdWrap_br ($content='')

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

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

string	stdWrap_keywords ($content='')

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

string	stdWrap_insertData ($content='')

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

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

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

	stdWrap_htmlSanitize (string $content='', array $conf=[])

string null	stdWrap_cacheStore ($content='', $conf=[])

string	stdWrap_debug ($content='')

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

string	stdWrap_debugData ($content='')

int	numRows ($conf)

string	listNum ($content, $listNum, $delimeter=',')

	checkIf ($conf)

string	HTMLparser_TSbridge ($theValue, $conf)

string	dataWrap ($content, $wrap)

string	insertData ($str)

string	prefixComment ($str, $conf, $content)

string	substring ($content, $options)

string	crop ($content, $options)

string	cropHTML (string $content, string $options)

int	calc ($val)

string	splitObj ($value, $conf)

string	numberFormat ($content, $conf)

string	parseFunc ($theValue, ?array $conf, ?string $ref=null)

string	encaps_lineSplit ($theValue, $conf)

ImageResource null	getImgResource ($file, $fileArray)

string null	getFieldVal ($field)

string	getData ($string, $fieldArray=null)

mixed	getGlobal ($keyString, $source=null)

int	getKey ($key, $arr)

string LinkResult	typoLink (string $linkText, array $conf)

	createLink (string $linkText, array $conf)

string	createUrl (array $conf)

string	typoLink_URL ($conf)

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

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

mixed	callUserFunction ($funcName, $conf, $content)

string	keywords ($content)

string	caseshift ($theValue, $case)

string	HTMLcaseshift ($theValue, $case)

string	calcAge ($seconds, $labels=null)

array	mergeTSRef (array $typoScriptArray, string $propertyName)

string	searchWhere ($searchWords, $searchFieldList, $searchTable)

Result	exec_getQuery ($table, $conf)

array	getRecords ($tableName, array $queryConfiguration)

string	getQuery (Connection $connection, string $table, array $conf)

array	checkPidArray ($pageIds)

array	getQueryMarkers (Connection $connection, $conf)

	getTypoScriptFrontendController ()

	getRequest ()

Public Attributes
array	$stdWrapOrder

array	$data = array( )

array	$parameters = array( )

string	$currentValKey = 'currentValue_kidjls9dksoje'

string	$currentRecord = ''

int	$currentRecordNumber = 0

int	$parentRecordNumber = 0

array	$parentRecord = array( )

string int null	$checkPid_badDoktypeList

LinkResultInterface	$lastTypoLinkResult = null

bool	$doConvertToUserIntObject = false

const	OBJECTTYPE_USER_INT = 1

const	OBJECTTYPE_USER = 2

Protected Member Functions
	createExceptionHandler (array $configuration)

	determineExceptionHandlerClassName (array $configuration)

	mergeExceptionHandlerConfiguration (array $configuration)

string	replacement ($content, array $configuration)

string	replacementSingle ($content, array $configuration)

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

string	parseFuncInternal ($theValue, $conf)

string	http_makelinks (string $data, array $conf)

string	mailto_makelinks (string $data, array $conf)

Area null	getCropAreaFromFileReference (FileReference $fileReference, array $fileArray)

Area null	getCropAreaFromFromTypoScriptSettings (FileInterface $file, array $fileArray)

	createCropAreaFromJsonString (string $cropSettings, string $cropVariant)

string int	getFileDataKey ($key)

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

	getValueFromRecursiveData (array $keys, mixed $startValue)

array	getQueryConstraints (Connection $connection, string $table, array $conf)

string TYPO3 CMS Core Database Query Expression CompositeExpression null	getLanguageRestriction (ExpressionBuilder $expressionBuilder, string $table, array $conf, Context $context)

string	sanitizeSelectPart (Connection $connection, string $selectPart, string $table)

	getResourceFactory ()

	getPageRepository ()

string	getEnvironmentVariable ($key)

string bool	getFromCache (array $configuration)

int null	calculateCacheLifetime (array $configuration)

array	calculateCacheTags (array $configuration)

string	calculateCacheKey (array $configuration)

TimeTracker	getTimeTracker ()

	getContentLengthOfCurrentTag (string $theValue, int $pointer, string $currentTag)

	shallDebug ()

Protected Attributes
ContainerInterface null	$container

string	$table = ''

File FileReference Folder FolderInterface FileInterface string null	$currentFile

int bool	$userObjectType = false

array	$stopRendering = array( )

int	$stdWrapRecursionLevel = 0

TypoScriptFrontendController null	$typoScriptFrontendController

Private Attributes
ServerRequestInterface	$request = null

Detailed Description

This class contains all main TypoScript features, is the backbone of TypoScript rendering, include stdWrap and TypoScript content objects, usually 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.

Definition at line 101 of file ContentObjectRenderer.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::__construct	(	TypoScriptFrontendController	$typoScriptFrontendController = `null`,
		ContainerInterface	$container = `null`
	)

Definition at line 367 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$container, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$typoScriptFrontendController.

Member Function Documentation

◆ __sleep()

array 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 385 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 404 of file ContentObjectRenderer.php.

References $GLOBALS, and TYPO3\CMS\Webhooks\Message\$identifier.

◆ calc()

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

Performs basic mathematical evaluation of the input string. Does NOT take parenthesis and operator precedence into account! (for that, see \TYPO3\CMS\Core\Utility\MathUtility::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: ‪\TYPO3\CMS\Core\Utility\MathUtility::calculateWithPriorityToAdditionAndSubtraction()

Definition at line 2711 of file ContentObjectRenderer.php.

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

◆ calcAge()

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::calcAge	(	$seconds,
		$labels = `null`
	)

Returns the 'age' of the tstamp $seconds

Parameters

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

Returns: ‪string The formatted string

Definition at line 4528 of file ContentObjectRenderer.php.

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

◆ calculateCacheKey()

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

protected

Applies stdWrap to the cache key

Returns: ‪string

Definition at line 5334 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\render(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_cacheStore().

◆ calculateCacheLifetime()

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

protected

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

Returns: ‪int|null

Definition at line 5303 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\render(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_cacheStore().

◆ calculateCacheTags()

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

protected

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

Returns: ‪array

Definition at line 5322 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\render(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_cacheStore().

◆ callUserFunction()

mixed 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
mixed	$content	‪The content payload to pass the function

Returns: ‪mixed The return content from the function call. Should probably be a string.

Definition at line 4398 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkFactory\create(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\parseFuncInternal(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_postUserFunc(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_preUserFunc().

◆ caseshift()

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

◆ checkIf()

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

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

Parameters

array $conf ‪TypoScript properties defining what to compare

Definition at line 2443 of file ContentObjectRenderer.php.

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

◆ checkPidArray()

array TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::checkPidArray ( $pageIds )

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

int[] $pageIds ‪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

Definition at line 5150 of file ContentObjectRenderer.php.

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

◆ cObjGet()

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

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

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

◆ cObjGetSeparated()

list<string> TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::cObjGetSeparated	(	?array	$setup,
		string	$addKey = `''`
	)

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

Returns: ‪list<string>

Definition at line 528 of file ContentObjectRenderer.php.

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

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

◆ cObjGetSingle()

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::cObjGetSingle	(	string	$name,
			$conf,
			$TSkey = `'__'`
	)

Renders a content object

Parameters

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

Returns: ‪string cObject output

Exceptions

Definition at line 554 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getContentObject(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTimeTracker(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mergeTSRef(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\render().

◆ convertToUserIntObject()

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

Requests the current USER object to be converted to USER_INT.

Definition at line 741 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTimeTracker(), and TYPO3\CMS\Core\TimeTracker\TimeTracker\setTSlogMessage().

◆ createCropAreaFromJsonString()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::createCropAreaFromJsonString	(	string	$cropSettings,
		string	$cropVariant
	)

protected

Takes a JSON string and creates CropVariantCollection and fetches the corresponding CropArea for that.

Definition at line 3717 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection\create().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getCropAreaFromFileReference(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getCropAreaFromFromTypoScriptSettings().

◆ createExceptionHandler()

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

protected

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

Exceptions

ContentRenderingException

Definition at line 661 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\determineExceptionHandlerClassName(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mergeExceptionHandlerConfiguration().

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

◆ createLink()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::createLink	(	string	$linkText,
		array	$conf
	)

Similar to ->typoLink(), however it does not evaluate the .wrap and .ATagBeforeWrap functionality.

For this reason, it also does not consider the LinkResult functionality, and "returnLast" logic, as the whole LinkResult object is available.

It is recommended to use this method when working with PHP and wanting to create a typolink, but be aware that you need to escape the Link yourself as PHP developer depending on the needs.

Parameters

string	$linkText	‪the text to be wrapped in a link
array	$conf	‪the typolink configuration

Exceptions

UnableToLinkException

See also: ‪typoLink(); ‪createUrl()

Definition at line 4298 of file ContentObjectRenderer.php.

◆ createUrl()

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

This method creates a typoLink() and just returns the information of the "href" attribute of the link (most of the time, this is the URL).

Parameters

array $conf ‪the typolink configuration.

Returns: ‪string The URL

See also: ‪typoLink(); ‪createLink()

Definition at line 4321 of file ContentObjectRenderer.php.

◆ crop()

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

See also: ‪stdWrap()

Definition at line 2661 of file ContentObjectRenderer.php.

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

◆ cropHTML()

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::cropHTML	(	string	$content,
		string	$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.

See also: ‪stdWrap()

Returns: ‪string The processed input value.

Definition at line 2689 of file ContentObjectRenderer.php.

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

◆ dataWrap()

string 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 2561 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().

◆ determineExceptionHandlerClassName()

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

protected

Determine exception handler class name from global and content object configuration

Definition at line 678 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Core\Environment\getContext(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getRequest().

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

◆ encaps_lineSplit()

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

Lets you split the content by LF and process 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.

Definition at line 3307 of file ContentObjectRenderer.php.

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

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

◆ exec_getQuery()

Result 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: ‪Result

See also: ‪getQuery()

Definition at line 4672 of file ContentObjectRenderer.php.

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

◆ getContentLengthOfCurrentTag()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getContentLengthOfCurrentTag	(	string	$theValue,
		int	$pointer,
		string	$currentTag
	)

protected

Get content length of the current tag that could also contain nested tag contents

Helper method of parseFuncInternal().

Definition at line 5363 of file ContentObjectRenderer.php.

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

◆ getContentObject()

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

Returns a new content object of type $name.

Parameters

string $name

Exceptions

ContentRenderingException

Definition at line 584 of file ContentObjectRenderer.php.

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

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

◆ getCropAreaFromFileReference()

Area null TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getCropAreaFromFileReference	(	FileReference	$fileReference,
		array	$fileArray
	)

protected

Returns an ImageManipulation\Area object for the given cropVariant (or 'default') or null if the crop settings or crop area is empty.

The cropArea from file reference is used, if not set in TypoScript.

Example TypoScript settings: file.crop = OR file.crop = 50,50,100,100 OR file.crop.data = file:current:crop

Parameters

FileReference	$fileReference
array	$fileArray	‪TypoScript properties for the imgResource type

Returns: ‪Area|null

Definition at line 3660 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\createCropAreaFromJsonString(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getCropAreaFromFromTypoScriptSettings(), and TYPO3\CMS\Core\Resource\FileReference\getProperty().

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

◆ getCropAreaFromFromTypoScriptSettings()

Area null TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getCropAreaFromFromTypoScriptSettings	(	FileInterface	$file,
		array	$fileArray
	)

protected

Returns an ImageManipulation\Area object for the given cropVariant (or 'default') or null if the crop settings or crop area is empty.

Returns: ‪Area|null

Definition at line 3679 of file ContentObjectRenderer.php.

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

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getCropAreaFromFileReference(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getImgResource().

◆ getCurrentFile()

File FileReference Folder FileInterface FolderInterface string null TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getCurrentFile ( )

Gets the current file object during iterations over files.

Returns: ‪File|FileReference|Folder|FileInterface|FolderInterface|string|null The current file object.

Definition at line 1020 of file ContentObjectRenderer.php.

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

◆ getCurrentTable()

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

Returns the current table

Returns: ‪string

Definition at line 455 of file ContentObjectRenderer.php.

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

Referenced by TYPO3\CMS\Frontend\DataProcessing\FilesProcessor\process(), and TYPO3\CMS\Frontend\DataProcessing\FlexFormProcessor\processFileReferences().

◆ getCurrentVal()

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

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

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

◆ getData()

string 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 split by "//" is shown
array \| null	$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 is used.

Returns: ‪string The value fetched

See also: ‪getFieldVal()

Definition at line 3759 of file ContentObjectRenderer.php.

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

◆ getEnvironmentVariable()

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

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

◆ getFieldVal()

string null 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|null

Definition at line 3733 of file ContentObjectRenderer.php.

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

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

◆ getFileDataKey()

string int TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getFileDataKey ( $key )

protected

Gets file information. This is a helper function for the getData() method above, which resolves e.g. page.10.data = file:current:title or page.10.data = file:17:title

Parameters

string $key ‪A colon-separated key, e.g. 17:name or current:sha1, with the first part being a sys_file uid or the keyword "current" and the second part being the key of information to get from file (e.g. "title", "size", "description", etc.)

Returns: ‪string|int The value as retrieved from the file object.

Definition at line 4065 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

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

◆ getFromCache()

string bool TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getFromCache ( array $configuration )

protected

Fetches content from cache

Parameters

array $configuration ‪Array

Returns: ‪string|bool FALSE on cache miss

Exceptions

Definition at line 5279 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\render(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_cacheRead().

◆ getGlobal()

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

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

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

◆ getImgResource()

ImageResource null TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getImgResource	(	$file,
		$fileArray
	)

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

Structure of the returned info array: 0 => width 1 => height 2 => file extension 3 => file name origFile => original file name origFile_mtime => original file mtime – only available if processed via FAL: – originalFile => original file object processedFile => processed file object fileCacheHash => checksum of processed file

Parameters

string \| File \| FileReference	$file	‪A "imgResource" TypoScript data type. Either a TypoScript file resource, a file or a file reference object or the string GIFBUILDER. See description above.
array	$fileArray	‪TypoScript properties for the imgResource type

Returns: ‪ImageResource|null

See also: ‪cImage(); ‪\TYPO3\CMS\Frontend\Imaging\GifBuilder

Definition at line 3542 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Core\Resource\ProcessedFile\CONTEXT_IMAGECROPSCALEMASK, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getCropAreaFromFileReference(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getCropAreaFromFromTypoScriptSettings(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getResourceFactory(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrapValue().

Referenced by TYPO3\CMS\Frontend\Imaging\GifBuilder\getResource().

◆ getKey()

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

See also: ‪getData()

Definition at line 4214 of file ContentObjectRenderer.php.

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

◆ getLanguageRestriction()

string TYPO3 CMS Core Database Query Expression CompositeExpression null TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getLanguageRestriction	(	ExpressionBuilder	$expressionBuilder,
		string	$table,
		array	$conf,
		Context	$context
	)

protected

Adds parts to the WHERE clause that are related to language. This only works on TCA tables which have the [ctrl][languageField] field set or if they have select.languageField = my_language_field set explicitly.

It is also possible to disable the language restriction for a query by using select.languageField = 0, if select.languageField is not explicitly set, the TCA default values are taken.

If the table is "localizeable" (= any of the criteria above is met), then the DB query is restricted:

If the current language aspect has overlays enabled, then the only records with language "0" or "-1" are fetched (the overlays are taken care of later-on). if the current language has overlays but also records without localization-parent (free mode) available, then these are fetched as well. This can explicitly set via select.includeRecordsWithoutDefaultTranslation = 1 which overrules the overlayType within the language aspect.

If the language aspect has NO overlays enabled, it behaves as in "free mode" (= only fetch the records for the current language.

Returns: ‪string|\TYPO3\CMS\Core\Database\Query\Expression\CompositeExpression|null

Exceptions

Definition at line 5050 of file ContentObjectRenderer.php.

References $GLOBALS, TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\and(), TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\eq(), TYPO3\CMS\Core\Context\Context\getAspect(), TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\in(), and TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\or().

◆ getPageRepository()

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

protected

Definition at line 5252 of file ContentObjectRenderer.php.

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

◆ getQuery()

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getQuery	(	Connection	$connection,
		string	$table,
		array	$conf
	)

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

Returns: ‪string A SELECT query

Exceptions

Definition at line 4727 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Database\Connection\createQueryBuilder().

◆ getQueryConstraints()

array TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getQueryConstraints	(	Connection	$connection,
		string	$table,
		array	$conf
	)

protected

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

Parameters

string	$table	‪The table name
array	$conf	‪The TypoScript configuration properties

Returns: ‪array Associative array containing the prepared data for WHERE, ORDER BY and GROUP BY fragments

Exceptions

Definition at line 4917 of file ContentObjectRenderer.php.

References $GLOBALS, and TYPO3\CMS\Core\Database\Connection\createQueryBuilder().

◆ getQueryMarkers()

array TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getQueryMarkers	(	Connection	$connection,
			$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

array $conf ‪Select part of CONTENT definition

Returns: ‪array List of values to replace markers with

See also: ‪getQuery()

Definition at line 5182 of file ContentObjectRenderer.php.

◆ getRecords()

array 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

Exceptions

Definition at line 4689 of file ContentObjectRenderer.php.

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

◆ getRequest()

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

Todo:

‪: This getRequest() is still a bit messy. Underling code depends on both, a ContentObjectRenderer instance and a request, but the API currently only passes one or the other. For instance Extbase and Fluid only pass the Request, DataProcessors only a ContentObjectRenderer. This is why getRequest() is currently public here. A potential refactoring could:

‪Create interfaces to pass both where needed (or pass a combined context object)
‪Deprecate access to getRequest() here afterwards A circular dependency that the instance of ContentObjectRenderer holds a request with the instance of itself as attribute must be avoided. This is currently achieved by adding a new request with $this->request->withAttribute('currentContentObject', $cObj) in code that needs it, but this new request is NOT passed back into the ContentObjectRenderer instance.

This method might be deprecated with TYPO3 v13.

Definition at line 5430 of file ContentObjectRenderer.php.

References $GLOBALS.

◆ getResourceFactory()

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

protected

Definition at line 5247 of file ContentObjectRenderer.php.

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

◆ getSlidePids()

string 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

Definition at line 808 of file ContentObjectRenderer.php.

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

◆ getTimeTracker()

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

protected

Returns: ‪TimeTracker

Definition at line 5343 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cObjGetSingle(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\convertToUserIntObject().

◆ getTypoScriptFrontendController()

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

this is set to public so extensions such as EXT:solr can use the method in tests.

Definition at line 5351 of file ContentObjectRenderer.php.

References $GLOBALS.

◆ getUserObjectType()

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

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

◆ getValueFromRecursiveData()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getValueFromRecursiveData	(	array	$keys,
		mixed	$startValue
	)

protected

This method recursively checks for values in methods, arrays, objects, but does not fall back to $GLOBALS object instead of getGlobal().

see getGlobal()

Definition at line 4173 of file ContentObjectRenderer.php.

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

◆ HTMLcaseshift()

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

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

◆ HTMLparser_TSbridge()

string 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 \TYPO3\CMS\Core\Html\HtmlParser class.

Parameters

string	$theValue	‪The value to parse by the class \TYPO3\CMS\Core\Html\HtmlParser
array	$conf	‪TypoScript properties for the parser. See link.

Returns: ‪string Return value.

See also: ‪stdWrap(); ‪\TYPO3\CMS\Core\Html\HtmlParser::HTMLparserConfig(); ‪\TYPO3\CMS\Core\Html\HtmlParser::HTMLcleaner()

Definition at line 2545 of file ContentObjectRenderer.php.

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

◆ http_makelinks()

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

protected

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.

Helper method of parseFuncInternal().

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.

Definition at line 3428 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$data, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\typoLink().

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

◆ imageLinkWrap()

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

This method should be used within TYPO3 Core only

Definition at line 845 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$parameters, TYPO3\CMS\Webhooks\Message\$url, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cObjGetSingle(), TYPO3\CMS\Core\Resource\ProcessedFile\CONTEXT_IMAGECROPSCALEMASK, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getRequest(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrapValue(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\typoLink().

◆ insertData()

string 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. If the content inside the curly braces starts with a hash sign {#...} it is a field name that must be quoted by Doctrine DBAL and is skipped here for later processing.

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

◆ keywords()

string 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 4438 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)

See also: ‪TypoScriptFrontendController::setSysLastChanged()

Definition at line 990 of file ContentObjectRenderer.php.

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

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentContentObject\render(), and TYPO3\CMS\Frontend\ContentObject\RecordsContentObject\render().

◆ listNum()

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::listNum	(	$content,
		$listNum,
		$delimeter = `','`
	)

Explode a string by the $delimeter value and return the value of index $listNum

Parameters

string	$content	‪String to explode
string	$listNum	‪Index-number \| 'last' \| 'rand' \| arithmetic expression. 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	$delimeter	‪Either a string used to explode the content string or an integer value (as string) which will then be changed into a character, eg. "10" for a linebreak char.

Returns: ‪string

Definition at line 2418 of file ContentObjectRenderer.php.

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\listNum(), TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\listNumWithListNumRandReturnsString(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_listNum(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_preIfEmptyListNum().

◆ mailto_makelinks()

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::mailto_makelinks	(	string	$data,
		array	$conf
	)

protected

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.

Helper method of parseFuncInternal().

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.

Definition at line 3489 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$data, and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\typoLink().

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

◆ mergeExceptionHandlerConfiguration()

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

protected

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

Definition at line 702 of file ContentObjectRenderer.php.

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

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

◆ mergeTSRef()

array TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::mergeTSRef	(	array	$typoScriptArray,
		string	$propertyName
	)

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

In short: This parses the "=<" operator for a couple of special properties like "parseFunc" and "tt_content.*".

Note the "=<" operator is not a general TypoScript language construct, but applied here for a couple of special objects only.

Parameters

array	$typoScriptArray	‪The TypoScript array: ['someProperty' => 'somePropertyValue', 'someProperty.' => [ 'someSubProperty' => 'someSubValue', ... ]
string	$propertyName	‪The property name: If this value in $typoScriptArray[$prop] is a reference (eg. "< lib.contentElement"), then the reference will be retrieved and inserted at that position and overlaid with given local properties if any.

Returns: ‪array The modified TypoScript array with resolved "=<" reference operator

Todo:: ‪: It would be better if this method would get the setup object tree to resolve a ReferenceChildNode only once per node. This would however mean the object tree is moved around in the entire rendering chain, which is quite hard to achieve.

Definition at line 4575 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cObjGetSingle(), TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\mergeTSRefResolvesRecursive(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\parseFunc().

◆ noTrimWrap()

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

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

◆ numberFormat()

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

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

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

◆ numRows()

int 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 The number of rows found by the select

See also: ‪stdWrap()

Definition at line 2402 of file ContentObjectRenderer.php.

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

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

◆ parseFunc()

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::parseFunc	(		$theValue,
		?array	$conf,
		?string	$ref = `null`
	)

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 split 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 ->parseFuncInternal()

Parameters

string	$theValue	‪The value to process.
	non-empty-array<string,mixed>\|null	‪$conf TypoScript configuration for parseFunc
non-empty-string \| null	$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

Definition at line 2962 of file ContentObjectRenderer.php.

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

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

◆ parseFuncInternal()

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

protected

Helper function for parseFunc()

Parameters

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

Returns: ‪string The processed value

Definition at line 3094 of file ContentObjectRenderer.php.

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

◆ prefixComment()

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

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

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

◆ 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

Definition at line 762 of file ContentObjectRenderer.php.

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

◆ render()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::render	(	AbstractContentObject	$contentObject,
			$configuration = `[]`
	)

Renders a content object by taking exception and cache handling into consideration

Parameters

AbstractContentObject	$contentObject	‪Content object instance
array	$configuration	‪Array of TypoScript properties

Exceptions

ContentRenderingException

Definition at line 607 of file ContentObjectRenderer.php.

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

◆ replacement()

string 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 2819 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()

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

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

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

◆ rootLineValue()

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

protected

Returns a value from the current rootline.

Parameters

int	$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.

See also: ‪getData()

Definition at line 4130 of file ContentObjectRenderer.php.

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

◆ round()

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

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

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

◆ sanitizeSelectPart()

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::sanitizeSelectPart	(	Connection	$connection,
		string	$selectPart,
		string	$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.

Returns: ‪string Sanitized select part

See also: ‪getQuery

Definition at line 5110 of file ContentObjectRenderer.php.

References $GLOBALS, and TYPO3\CMS\Core\Database\Connection\quoteIdentifier().

◆ searchWhere()

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::searchWhere	(	$searchWords,
		$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	$searchWords	‪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 4624 of file ContentObjectRenderer.php.

◆ setCurrentFile()

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

Sets the current file object during iterations over files.

Parameters

Definition at line 1010 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

See also: ‪getCurrentVal()

Definition at line 500 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.

Definition at line 468 of file ContentObjectRenderer.php.

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

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentContentObject\render(), and TYPO3\CMS\Frontend\ContentObject\RecordsContentObject\render().

◆ setRequest()

TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::setRequest ( ServerRequestInterface $request )

Definition at line 373 of file ContentObjectRenderer.php.

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\mergeTSRefResolvesRecursive(), TYPO3\CMS\Frontend\ContentObject\ContentContentObject\render(), TYPO3\CMS\Frontend\ContentObject\RecordsContentObject\render(), TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_formattedDate(), TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_prefixComment(), and TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrapDoesOnlyCallIfEmptyIfTheTrimmedContentIsEmptyOrZero().

◆ setUserObjectType()

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

Sets the user object type

Parameters

mixed $userObjectType

Definition at line 733 of file ContentObjectRenderer.php.

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

◆ shallDebug()

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

protected

Definition at line 5404 of file ContentObjectRenderer.php.

References $GLOBALS.

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

◆ splitObj()

string 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

See also: ‪stdWrap(); ‪\TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject::processItemStates()

Definition at line 2753 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$currentValKey, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cObjGet(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrapValue(), 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.

Definition at line 436 of file ContentObjectRenderer.php.

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

Referenced by TYPO3\CMS\Frontend\Imaging\GifBuilder\checkTextObj(), TYPO3\CMS\Frontend\Imaging\GifBuilder\getResource(), TYPO3\CMS\Frontend\ContentObject\ContentContentObject\render(), and TYPO3\CMS\Frontend\ContentObject\RecordsContentObject\render().

◆ stdWrap()

string null 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.

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|null The processed input value

Definition at line 1039 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\$stdWrapRecursionLevel, TYPO3\CMS\Core\Utility\GeneralUtility\inList(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrapValue().

◆ stdWrap_addPageCacheTags()

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

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

◆ stdWrap_age()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_age().

◆ stdWrap_append()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_append().

◆ stdWrap_br()

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

Returns: ‪string The processed input value

Definition at line 1946 of file ContentObjectRenderer.php.

◆ stdWrap_brTag()

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

◆ stdWrap_bytes()

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

◆ stdWrap_cacheRead()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_cacheRead().

◆ stdWrap_cacheStore()

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

Store content into cache

Parameters

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

Returns: ‪string|null The processed input value

Definition at line 2321 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calculateCacheKey(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calculateCacheLifetime(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calculateCacheTags(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getTypoScriptFrontendController().

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\beforeStdWrapContentStoredInCacheEventIsCalled(), and TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_cacheStore().

◆ stdWrap_case()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_case().

◆ stdWrap_char()

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

char Returns a one-character string containing the character specified by ascii code.

Reliable results only for character codes in the integer range 0 - 127.

See also: ‪https://php.net/manual/en/function.chr.php

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

◆ stdWrap_cObject()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_cObject().

◆ stdWrap_crop()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_crop().

◆ stdWrap_cropHTML()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_cropHTML().

◆ stdWrap_csConv()

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

stdWrap csConv: Converts the input to UTF-8

The character set of the input must be specified. Returns the input if matters go wrong, for example if an invalid character set is given.

Parameters

string	$content	‪The string to convert.
array	$conf	‪stdWrap properties for csConv.

Returns: ‪string The processed input.

Definition at line 1538 of file ContentObjectRenderer.php.

References $output.

◆ stdWrap_current()

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

current Gets content that has been previously 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 1281 of file ContentObjectRenderer.php.

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

◆ stdWrap_data()

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

Gets content from different sources based on getText functions.

Parameters

string	$_	‪Unused
array	$conf	‪stdWrap properties for data.

Returns: ‪string The processed input value

Definition at line 1254 of file ContentObjectRenderer.php.

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_data().

◆ stdWrap_dataWrap()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_dataWrap().

◆ stdWrap_date()

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

References $GLOBALS.

◆ stdWrap_debug()

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

◆ stdWrap_debugData()

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

References debug().

◆ stdWrap_debugFunc()

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

References debug().

◆ stdWrap_doubleBrTag()

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

◆ stdWrap_encapsLines()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_encapsLines().

◆ stdWrap_encodeForJavaScriptValue()

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

encodeForJavaScriptValue Escapes content to be used inside JavaScript strings. Single quotes are added around the value.

Parameters

string $content ‪Input value undergoing processing in this function

Returns: ‪string The processed input value

Definition at line 1920 of file ContentObjectRenderer.php.

◆ stdWrap_expandList()

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

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

◆ stdWrap_field()

string null 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|null The processed input value

Definition at line 1267 of file ContentObjectRenderer.php.

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_field().

◆ stdWrap_fieldRequired()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_fieldRequired().

◆ stdWrap_formattedDate()

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::stdWrap_formattedDate	(	string	$content,
		array	$conf
	)

php-intl dateformatted Will return a timestamp based on configuration given according to PHP-intl DateFormatter->format() see https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax

Parameters

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

Returns: ‪string The processed input value

Definition at line 1772 of file ContentObjectRenderer.php.

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_formattedDate().

◆ stdWrap_hash()

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

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

◆ stdWrap_HTMLparser()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_HTMLparser().

◆ stdWrap_htmlSanitize()

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

Definition at line 2298 of file ContentObjectRenderer.php.

References TYPO3\CMS\Core\Utility\DebugUtility\debugTrail(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\shallDebug().

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

◆ stdWrap_htmlSpecialChars()

string 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 htmlSpecialChars.

Returns: ‪string The processed input value

Definition at line 1903 of file ContentObjectRenderer.php.

◆ stdWrap_if()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_if().

◆ stdWrap_ifBlank()

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

◆ stdWrap_ifEmpty()

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

◆ stdWrap_ifNull()

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

◆ stdWrap_innerWrap()

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

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

◆ stdWrap_innerWrap2()

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

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

◆ stdWrap_insertData()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_insertData().

◆ stdWrap_intval()

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

◆ stdWrap_keywords()

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

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

◆ stdWrap_lang()

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

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

◆ stdWrap_listNum()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_listNum().

◆ stdWrap_noTrimWrap()

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

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

◆ stdWrap_numberFormat()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_numberFormat().

◆ stdWrap_numRows()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_numRows().

◆ stdWrap_orderedStdWrap()

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

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

◆ stdWrap_outerWrap()

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

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

◆ stdWrap_override()

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

◆ stdWrap_parseFunc()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_parseFunc().

◆ stdWrap_postCObject()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_postCObject().

◆ stdWrap_postUserFunc()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_postUserFunc().

◆ stdWrap_postUserFuncInt()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_postUserFuncInt().

◆ stdWrap_preCObject()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_preCObject().

◆ stdWrap_prefixComment()

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

References TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getRequest(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\prefixComment().

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_prefixComment().

◆ stdWrap_preIfEmptyListNum()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_preIfEmptyListNum().

◆ stdWrap_prepend()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_prepend().

◆ stdWrap_preUserFunc()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_preUserFunc().

◆ stdWrap_prioriCalc()

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

References TYPO3\CMS\Core\Utility\MathUtility\calculateWithParentheses().

◆ stdWrap_rawUrlEncode()

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

◆ stdWrap_replacement()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_replacement().

◆ stdWrap_required()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_required().

◆ stdWrap_round()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_round().

◆ stdWrap_setContentToCurrent()

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

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

◆ stdWrap_setCurrent()

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

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

◆ stdWrap_split()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_split().

◆ stdWrap_stdWrap()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_stdWrap().

◆ stdWrap_strftime()

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

References $GLOBALS, and $output.

◆ stdWrap_stripHtml()

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

stripHtml Completely removes HTML tags from content

Parameters

string $content ‪Input value undergoing processing in this function.

Returns: ‪string The processed input value

Definition at line 1864 of file ContentObjectRenderer.php.

◆ stdWrap_strPad()

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

References TYPO3\CMS\Core\Utility\StringUtility\multibyteStringPad(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrapValue().

◆ stdWrap_strtotime()

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

References $GLOBALS.

◆ stdWrap_substring()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_substring().

◆ stdWrap_trim()

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

◆ stdWrap_typolink()

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

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

Referenced by TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\stdWrap_typolink().

◆ stdWrap_wrap()

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

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

◆ stdWrap_wrap2()

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

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

◆ stdWrap_wrap3()

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

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

◆ stdWrap_wrapAlign()

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

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

◆ stdWrapValue()

string int bool null 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 \| int \| bool \| null	$defaultValue	‪Optional default value.

Returns: ‪string|int|bool|null Value of the config variable

Definition at line 1139 of file ContentObjectRenderer.php.

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

◆ substring()

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

See also: ‪stdWrap()

Definition at line 2643 of file ContentObjectRenderer.php.

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

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

◆ typoLink()

string LinkResult TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::typoLink	(	string	$linkText,
		array	$conf
	)

Implements the "typolink" property of stdWrap (and others) Basically the input string, $linkText, is (typically) wrapped in a -tag linking to some page, email address, file or URL based on a parameter defined by the configuration array $conf. This function is best used from internal functions as is. There are some API functions defined after this function which is more suited for general usage in external applications.

Generally the concept "typolink" should be used in your own applications as an API for making links to pages with parameters and more. The reason for this is that you will then automatically make links compatible with all the centralized functions for URL simulation and manipulation of parameters into hashes and more.

For many more details on the parameters and how they are interpreted, please see the link to TSref below.

Parameters

string	$linkText	‪The string (text) to link
array	$conf	‪TypoScript configuration (see link below)

Returns: ‪string|LinkResult A link-wrapped string.

See also: ‪stdWrap()

Definition at line 4252 of file ContentObjectRenderer.php.

References TYPO3\CMS\Frontend\Typolink\UnableToLinkException\getLinkText().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\http_makelinks(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\imageLinkWrap(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mailto_makelinks(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_typolink().

◆ typoLink_URL()

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

◆ wrap()

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

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

Parameters

string	$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 4359 of file ContentObjectRenderer.php.

Member Data Documentation

◆ $checkPid_badDoktypeList

string int null TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$checkPid_badDoktypeList

this property might change and is not part of TYPO3 Core API anymore since TYPO3 v13.0. Use at your own risk

Definition at line 317 of file ContentObjectRenderer.php.

◆ $container

ContainerInterface null TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$container

protected

Definition at line 108 of file ContentObjectRenderer.php.

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

◆ $currentFile

File FileReference Folder FolderInterface FileInterface string null TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$currentFile

protected

Current file objects (during iterations over files)

Definition at line 323 of file ContentObjectRenderer.php.

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

◆ $currentRecord

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

Definition at line 294 of file ContentObjectRenderer.php.

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

◆ $currentRecordNumber

int TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$currentRecordNumber = 0

Incremented in RecordsContentObject and ContentContentObject before each record rendering.

Definition at line 300 of file ContentObjectRenderer.php.

◆ $currentValKey

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$currentValKey = 'currentValue_kidjls9dksoje'

Definition at line 287 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getCurrentVal(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\parseFuncInternal(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\setCurrentVal(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\splitObj(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_setContentToCurrent(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_setCurrent().

◆ $data

array TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$data = array( )

Loaded with the current data-record.

If the instance of this class is used to render records from the database those records are found in this array. The function stdWrap has TypoScript properties that fetch field-data from this array.

See also: ‪start()

Definition at line 273 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\http_makelinks(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\mailto_makelinks(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\parseFuncInternal(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\setParent(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\start().

◆ $doConvertToUserIntObject

bool TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$doConvertToUserIntObject = false

Set to TRUE by doConvertToUserIntObject() if USER object wants to become USER_INT

Definition at line 328 of file ContentObjectRenderer.php.

◆ $lastTypoLinkResult

LinkResultInterface TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$lastTypoLinkResult = null

Definition at line 319 of file ContentObjectRenderer.php.

◆ $parameters

array TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$parameters = array( )

Used by the parseFunc function and is loaded with tag-parameters when parsing tags.

Definition at line 283 of file ContentObjectRenderer.php.

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

◆ $parentRecord

array TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$parentRecord = array( )

If the ContentObjectRender was started from ContentContentObject, RecordsContentObject or SearchResultContentObject this array has two keys, 'data' and 'currentRecord' which indicates the record and data for the parent cObj.

Definition at line 312 of file ContentObjectRenderer.php.

◆ $parentRecordNumber

int TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$parentRecordNumber = 0

Incremented in RecordsContentObject and ContentContentObject before each record rendering.

Definition at line 306 of file ContentObjectRenderer.php.

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

◆ $request

ServerRequestInterface TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$request = null

private

Request pointer, if injected. Use getRequest() instead of reading this property directly.

Definition at line 352 of file ContentObjectRenderer.php.

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

◆ $stdWrapOrder

array TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$stdWrapOrder

Definition at line 116 of file ContentObjectRenderer.php.

◆ $stdWrapRecursionLevel

int TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$stdWrapRecursionLevel = 0

protected

Definition at line 343 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_fieldRequired(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_if(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_required().

◆ $stopRendering

array TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$stopRendering = array( )

protected

Definition at line 339 of file ContentObjectRenderer.php.

◆ $table

string TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$table = ''

protected

Definition at line 277 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getCurrentTable(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\start().

◆ $typoScriptFrontendController

TypoScriptFrontendController null TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::$typoScriptFrontendController

protected

Definition at line 347 of file ContentObjectRenderer.php.

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

◆ $userObjectType

int bool 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 335 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 365 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Extbase\Core\Bootstrap\handleFrontendRequest(), TYPO3\CMS\Form\Domain\Runtime\FormRuntime\isRenderedCached(), TYPO3\CMS\Frontend\ContentObject\UserContentObject\render(), and TYPO3\CMS\Extbase\ContentObject\ExtbasePluginContentObject\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 359 of file ContentObjectRenderer.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\UserInternalContentObject\render(), and TYPO3\CMS\Extbase\ContentObject\ExtbasePluginContentObject\render().

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __sleep()

◆ __wakeup()

◆ calc()

◆ calcAge()

◆ calculateCacheKey()

◆ calculateCacheLifetime()

◆ calculateCacheTags()

◆ callUserFunction()

◆ caseshift()

◆ checkIf()

◆ checkPidArray()

◆ cObjGet()

◆ cObjGetSeparated()

◆ cObjGetSingle()

◆ convertToUserIntObject()

◆ createCropAreaFromJsonString()

◆ createExceptionHandler()

◆ createLink()

◆ createUrl()

◆ crop()

◆ cropHTML()

◆ dataWrap()

◆ determineExceptionHandlerClassName()

◆ encaps_lineSplit()

◆ exec_getQuery()

◆ getContentLengthOfCurrentTag()

◆ getContentObject()

◆ getCropAreaFromFileReference()

◆ getCropAreaFromFromTypoScriptSettings()

◆ getCurrentFile()

◆ getCurrentTable()

◆ getCurrentVal()

◆ getData()

◆ getEnvironmentVariable()

◆ getFieldVal()

◆ getFileDataKey()

◆ getFromCache()

◆ getGlobal()

◆ getImgResource()

◆ getKey()

◆ getLanguageRestriction()

◆ getPageRepository()

◆ getQuery()

◆ getQueryConstraints()

◆ getQueryMarkers()

◆ getRecords()

◆ getRequest()

◆ getResourceFactory()

◆ getSlidePids()

◆ getTimeTracker()

◆ getTypoScriptFrontendController()

◆ getUserObjectType()

◆ getValueFromRecursiveData()

◆ HTMLcaseshift()

◆ HTMLparser_TSbridge()

◆ http_makelinks()

◆ imageLinkWrap()

◆ insertData()

◆ keywords()

◆ lastChanged()

◆ listNum()

◆ mailto_makelinks()

◆ mergeExceptionHandlerConfiguration()

◆ mergeTSRef()

◆ noTrimWrap()

◆ numberFormat()

◆ numRows()

◆ parseFunc()

◆ parseFuncInternal()

◆ prefixComment()

◆ readFlexformIntoConf()