Inheritance diagram for TYPO3\CMS\Core\Utility\GeneralUtility:

Static Public Member Functions
static	_GP ($var)

static	_GPmerged ($parameter)

static	_GET ($var=NULL)

static	_POST ($var=NULL)

static	_GETset ($inputGet, $key='')

static	removeXSS ($string)

static	gif_compress ($theFile, $type)

static	png_to_gif_by_imagemagick ($theFile)

static	read_png_gif ($theFile, $output_png=FALSE)

static	fixed_lgd_cs ($string, $chars, $appendString='...')

static	cmpIP ($baseIP, $list)

static	cmpIPv4 ($baseIP, $list)

static	cmpIPv6 ($baseIP, $list)

static	IPv6Hex2Bin ($hex)

static	IPv6Bin2Hex ($bin)

static	normalizeIPv6 ($address)

static	compressIPv6 ($address)

static	validIP ($ip)

static	validIPv4 ($ip)

static	validIPv6 ($ip)

static	cmpFQDN ($baseHost, $list)

static	isOnCurrentHost ($url)

static	inList ($list, $item)

static	rmFromList ($element, $list)

static	expandList ($list)

static	int_from_ver ($verNumberStr)

static	compat_version ($verNumberStr)

static	md5int ($str)

static	shortMD5 ($input, $len=10)

static	hmac ($input, $additionalSecret='')

static	uniqueList ($in_list, $secondParameter=NULL)

static	split_fileref ($fileNameWithPath)

static	dirname ($path)

static	modifyHTMLColor ($color, $R, $G, $B)

static	modifyHTMLColorAll ($color, $all)

static	isFirstPartOfStr ($str, $partStr)

static	formatSize ($sizeInBytes, $labels='')

static	convertMicrotime ($microtime)

static	splitCalc ($string, $operators)

static	htmlspecialchars_decode ($value)

static	deHSCentities ($str)

static	slashJS ($string, $extended=FALSE, $char='\'')

static	rawUrlEncodeJS ($str)

static	rawUrlEncodeFP ($str)

static	validEmail ($email)

static	isBrokenEmailEnvironment ()

static	normalizeMailAddress ($address)

static	formatForTextarea ($content)

static	strtoupper ($str)

static	strtolower ($str)

static	generateRandomBytes ($bytesToReturn)

static	idnaEncode ($value)

static	getRandomHexString ($count)

static	underscoredToUpperCamelCase ($string)

static	underscoredToLowerCamelCase ($string)

static	camelCaseToLowerCaseUnderscored ($string)

static	lcfirst ($string)

static	isValidUrl ($url)

static	inArray (array $in_array, $item)

static	intExplode ($delimiter, $string, $removeEmptyValues=FALSE, $limit=0)

static	revExplode ($delimiter, $string, $count=0)

static	trimExplode ($delim, $string, $removeEmptyValues=FALSE, $limit=0)

static	removeArrayEntryByValue (array $array, $cmpValue)

static	keepItemsInArray (array $array, $keepItems, $getValueFunc=NULL)

static	implodeArrayForUrl ($name, array $theArray, $str='', $skipBlank=FALSE, $rawurlencodeParamName=FALSE)

static	explodeUrl2Array ($string, $multidim=FALSE)

static	compileSelectedGetVarsFromArray ($varList, array $getArray, $GPvarAlt=TRUE)

static	addSlashesOnArray (array &$theArray)

static	stripSlashesOnArray (array &$theArray)

static	slashArray (array $arr, $cmd)

static	remapArrayKeys (&$array, $mappingTable)

static	array_merge_recursive_overrule (array $arr0, array $arr1, $notAddKeys=FALSE, $includeEmptyValues=TRUE, $enableUnsetFeature=TRUE)

static	array_merge (array $arr1, array $arr2)

static	arrayDiffAssocRecursive (array $array1, array $array2)

static	csvValues (array $row, $delim=',', $quote='"')

static	removeDotsFromTS (array $ts)

static	naturalKeySortRecursive (&$array)

static	get_tag_attributes ($tag)

static	split_tag_attributes ($tag)

static	implodeAttributes (array $arr, $xhtmlSafe=FALSE, $dontOmitBlankAttribs=FALSE)

static	wrapJS ($string, $linebreak=TRUE)

static	xml2tree ($string, $depth=999)

static	array2xml_cs (array $array, $docTag='phparray', array $options=array(), $charset='')

static	array2xml (array $array, $NSprefix='', $level=0, $docTag='phparray', $spaceInd=0, array $options=array(), array $stackData=array())

static	xml2array ($string, $NSprefix='', $reportDocTag=FALSE)

static	xmlRecompileFromStructValArray (array $vals)

static	xmlGetHeaderAttribs ($xmlData)

static	minifyJavaScript ($script, &$error='')

static	getUrl ($url, $includeHeader=0, $requestHeaders=FALSE, &$report=NULL)

static	writeFile ($file, $content, $changePermissions=FALSE)

static	fixPermissions ($path, $recursive=FALSE)

static	writeFileToTypo3tempDir ($filepath, $content)

static	mkdir ($newFolder)

static	mkdir_deep ($directory, $deepDirectory='')

static	rmdir ($path, $removeNonEmpty=FALSE)

static	flushDirectory ($directory, $keepOriginalDirectory=FALSE, $flushOpcodeCache=FALSE)

static	get_dirs ($path)

static	getFilesInDir ($path, $extensionList='', $prependPath=FALSE, $order='', $excludePattern='')

static	getAllFilesAndFoldersInPath (array $fileArr, $path, $extList='', $regDirs=FALSE, $recursivityLevels=99, $excludePattern='')

static	removePrefixPathFromList (array $fileArr, $prefixToRemove)

static	fixWindowsFilePath ($theFile)

static	resolveBackPath ($pathStr)

static	locationHeaderUrl ($path)

static	getMaxUploadFileSize ($localLimit=0)

static	getBytesFromSizeMeasurement ($measurement)

static	getMaximumPathLength ()

static	createVersionNumberedFilename ($file, $forceQueryString=FALSE)

static	getThisUrl ()

static	linkThisScript (array $getParams=array())

static	linkThisUrl ($url, array $getParams=array())

static	getIndpEnv ($getEnvName)

static	isAllowedHostHeaderValue ($hostHeaderValue)

static	milliseconds ()

static	clientInfo ($useragent='')

static	getHostname ($requestHost=TRUE)

static	getFileAbsFileName ($filename, $onlyRelative=TRUE, $relToTYPO3_mainDir=FALSE)

static	validPathStr ($theFile)

static	isAbsPath ($path)

static	isAllowedAbsPath ($path)

static	verifyFilenameAgainstDenyPattern ($filename)

static	copyDirectory ($source, $destination)

static	sanitizeLocalUrl ($url='')

static	upload_copy_move ($source, $destination)

static	upload_to_tempfile ($uploadedFileName)

static	unlink_tempfile ($uploadedTempFileName)

static	tempnam ($filePrefix, $fileSuffix='')

static	stdAuthCode ($uid_or_record, $fields='', $codeLength=8)

static	hideIfNotTranslated ($l18n_cfg_fieldValue)

static	hideIfDefaultLanguage ($localizationConfiguration)

static	llXmlAutoFileName ($fileRef, $language, $sameLocation=FALSE)

static	loadTCA ($table)

static	resolveSheetDefInDS ($dataStructArray, $sheet='sDEF')

static	resolveAllSheetsInDS (array $dataStructArray)

static	callUserFunction ($funcName, &$params, &$ref, $checkPrefix='', $errorMode=0)

static	getUserObj ($classRef, $checkPrefix='', $silent=FALSE)

static	makeInstance ($className)

static	setSingletonInstance ($className, \TYPO3\CMS\Core\SingletonInterface $instance)

static	removeSingletonInstance ($className, \TYPO3\CMS\Core\SingletonInterface $instance)

static	resetSingletonInstances (array $newSingletonInstances)

static	getSingletonInstances ()

static	addInstance ($className, $instance)

static	purgeInstances ()

static	makeInstanceService ($serviceType, $serviceSubType='', $excludeServiceKeys=array())

static	requireOnce ($requireFile)

static	requireFile ($requireFile)

static	plainMailEncoded ($email, $subject, $message, $headers='', $encoding='quoted-printable', $charset='', $dontEncodeHeader=FALSE)

static	quoted_printable ($string, $maxlen=76)

static	encodeHeader ($line, $enc='quoted-printable', $charset='utf-8')

static	substUrlsInPlainText ($message, $urlmode='76', $index_script_url='')

static	makeRedirectUrl ($inUrl, $l=0, $index_script_url='')

static	freetypeDpiComp ($font_size)

static	initSysLog ()

static	devLog ($msg, $extKey, $severity=0, $dataVar=FALSE)

static	deprecationLog ($msg)

static	getDeprecationLogFileName ()

static	logDeprecatedFunction ()

static	arrayToLogString (array $arr, $valueList=array(), $valueLength=20)

static	imageMagickCommand ($command, $parameters, $path='')

static	unQuoteFilenames ($parameters, $unQuote=FALSE)

static	quoteJSvalue ($value)

static	cleanOutputBuffers ()

static	flushOutputBuffers ()

static	presetApplicationContext (\TYPO3\CMS\Core\Core\ApplicationContext $applicationContext)

static	getApplicationContext ()

static	isRunningOnCgiServerApi ()

Public Attributes
const	SYSLOG_SEVERITY_INFO = 0

const	SYSLOG_SEVERITY_NOTICE = 1

const	SYSLOG_SEVERITY_WARNING = 2

const	SYSLOG_SEVERITY_ERROR = 3

const	SYSLOG_SEVERITY_FATAL = 4

const	ENV_TRUSTED_HOSTS_PATTERN_ALLOW_ALL = '.*'

const	ENV_TRUSTED_HOSTS_PATTERN_SERVER_NAME = 'SERVER_NAME'

Static Protected Member Functions
static	generateRandomBytesOpenSsl ($bytesToGenerate)

static	generateRandomBytesMcrypt ($bytesToGenerate)

static	generateRandomBytesUrandom ($bytesToGenerate)

static	generateRandomBytesFallback ($bytesToReturn)

static	xml2arrayProcess ($string, $NSprefix='', $reportDocTag=FALSE)

static	getRedirectUrlFromHttpHeaders ($content)

static	stripHttpHeaders ($content)

static	createDirectoryPath ($fullDirectoryPath)

static	isInternalRequestType ()

static	instantiateClass ($className, $arguments)

static	getClassName ($className)

static	getImplementationForClass ($className)

static	classHasImplementation ($className)

static	checkInstanceClassName ($className, $instance)

Static Protected Attributes
static	$allowHostHeaderValue = FALSE

static	$singletonInstances = array()

static	$nonSingletonInstances = array()

static	$finalClassNameCache = array()

static	$applicationContext = NULL

static	$idnaStringCache = array()

static	$idnaConverter = NULL

static	$supportedCgiServerApis

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! The legendary "t3lib_div" class - Miscellaneous functions for general purpose. Most of the functions do not relate specifically to TYPO3 However a section of functions requires certain TYPO3 features available See comments in the source. You are encouraged to use this library in your own scripts!

USE: The class is intended to be used without creating an instance of it. So: Don't instantiate - call functions with "\TYPO3\CMS\Core\Utility\GeneralUtility::" prefixed the function name. So use ::[method-name] to refer to the functions, eg. '::milliseconds()'

Author: Kasper Skårhøj kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 31 of file GeneralUtility.php.

Member Function Documentation

◆ _GET()

static TYPO3\CMS\Core\Utility\GeneralUtility::_GET ( $var = NULL )

static

Returns the global $_GET array (or value from) normalized to contain un-escaped values. ALWAYS use this API function to acquire the GET variables!

Parameters

string $var Optional pointer to value in GET array (basically name of GET var)

Returns: mixed If $var is set it returns the value of $_GET[$var]. If $var is NULL (default), returns $_GET itself. In any case slashes are stipped from the output!

See also: _POST(), _GP(), _GETset()

Definition at line 166 of file GeneralUtility.php.

◆ _GETset()

static TYPO3\CMS\Core\Utility\GeneralUtility::_GETset	(	$inputGet,
		$key = `''`
	)

static

Writes input value to $_GET.

Parameters

mixed	$inputGet
string	$key

Returns: void

Definition at line 207 of file GeneralUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

◆ _GP()

static TYPO3\CMS\Core\Utility\GeneralUtility::_GP ( $var )

static

Returns the 'GLOBAL' value of incoming data from POST or GET, with priority to POST (that is equalent to 'GP' order) Strips slashes from all output, both strings and arrays. To enhancement security in your scripts, please consider using ::_GET or ::_POST if you already know by which method your data is arriving to the scripts!

Parameters

string $var GET/POST var to return

Returns: mixed POST var named $var and if not set, the GET var of the same name.

Definition at line 128 of file GeneralUtility.php.

◆ _GPmerged()

static TYPO3\CMS\Core\Utility\GeneralUtility::_GPmerged ( $parameter )

static

Returns the global arrays $_GET and $_POST merged with $_POST taking precedence.

Parameters

string $parameter Key (variable name) from GET or POST vars

Returns: array Returns the GET vars merged recursively onto the POST vars.

Definition at line 149 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getModuleContent(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\gpMergedWillMergeArraysFromGetAndPost(), and TYPO3\CMS\Extbase\Mvc\Web\RequestBuilder\loadDefaultValues().

◆ _POST()

static TYPO3\CMS\Core\Utility\GeneralUtility::_POST ( $var = NULL )

static

Returns the global $_POST array (or value from) normalized to contain un-escaped values. ALWAYS use this API function to acquire the $_POST variables!

Parameters

string $var Optional pointer to value in POST array (basically name of POST var)

Returns: mixed If $var is set it returns the value of $_POST[$var]. If $var is NULL (default), returns $_POST itself. In any case slashes are stipped from the output!

See also: _GET(), _GP()

Definition at line 187 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Perm\Controller\PermissionAjaxController\__construct(), TYPO3\CMS\Frontend\ContentObject\SearchResultContentObject\__construct(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildBackendUri(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\canRetrieveGlobalInputsThroughPost(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\changePassword(), TYPO3\CMS\Recordlist\RecordList\clearCache(), TYPO3\CMS\Backend\Toolbar\ShortcutToolbarItem\createAjaxShortcut(), TYPO3\CMS\Backend\Toolbar\ShortcutToolbarItem\deleteAjaxShortcut(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\executeTasks(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateModuleController\getButtons(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\getLoginFormData(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getLoginFormData(), TYPO3\CMS\Install\Controller\AbstractController\getPostValues(), TYPO3\CMS\Version\Hook\PreviewHook\getPreviewConfiguration(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\locDataCheck(), TYPO3\CMS\Openid\Wizard\main(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateConstantEditorModuleFunctionController\main(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\main(), TYPO3\CMS\Lowlevel\View\ConfigurationView\main(), TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateObjectBrowserModuleFunctionController\main(), TYPO3\CMS\Filelist\Controller\FileListController\menuConfig(), TYPO3\CMS\Core\Database\QueryGenerator\procesData(), TYPO3\CMS\Openid\OpenidService\processLoginData(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\processTemplateRowBeforeSaving(), TYPO3\CMS\Frontend\ContentObject\FormContentObject\render(), TYPO3\CMS\Core\ExtDirect\ExtDirectRouter\route(), TYPO3\CMS\T3editor\Hook\TypoScriptTemplateInfoHook\save(), TYPO3\CMS\Backend\Toolbar\ShortcutToolbarItem\setAjaxShortcut(), TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\setPersonalDictionaryPath(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showForgot(), TYPO3\CMS\Setup\Controller\SetupModuleController\storeIncomingData(), TYPO3\CMS\Version\Controller\VersionModuleController\versioningMgm(), and TYPO3\CMS\SysAction\ActionTask\viewNewBackendUser().

◆ addInstance()

static TYPO3\CMS\Core\Utility\GeneralUtility::addInstance	(	$className,
		$instance
	)

static

Sets the instance of a non-singleton class to be returned by makeInstance.

If this function is called multiple times for the same $className, makeInstance will return the instances in the order in which they have been added (FIFO).

Warning: This is a helper method for unit tests. Do not call this directly in production code!

See also: makeInstance

Exceptions

Definition at line 4651 of file GeneralUtility.php.

◆ addSlashesOnArray()

static TYPO3\CMS\Core\Utility\GeneralUtility::addSlashesOnArray ( array & $theArray )

static

AddSlash array This function traverses a multidimensional array and adds slashes to the values. NOTE that the input array is and argument by reference.!! Twin-function to stripSlashesOnArray

Parameters

array $theArray Multidimensional input array, (REFERENCE!)

Returns: array

Definition at line 1703 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\addSlashesOnArrayAddsSlashesRecursive(), and TYPO3\CMS\Core\Core\SystemEnvironmentBuilder\handleMagicQuotesGpc().

◆ array2xml()

static TYPO3\CMS\Core\Utility\GeneralUtility::array2xml	(	array	$array,
			$NSprefix = `''`,
			$level = `0`,
			$docTag = `'phparray'`,
			$spaceInd = `0`,
		array	$options = `array()`,
		array	$stackData = `array()`
	)

static

Deprecated to call directly (unless you are aware of using XML prologues)! Use "array2xml_cs" instead (which adds an XML-prologue)

Converts a PHP array into an XML string. The XML output is optimized for readability since associative keys are used as tag names. This also means that only alphanumeric characters are allowed in the tag names AND only keys NOT starting with numbers (so watch your usage of keys!). However there are options you can set to avoid this problem. Numeric keys are stored with the default tag name "numIndex" but can be overridden to other formats) The function handles input values from the PHP array in a binary-safe way; All characters below 32 (except 9,10,13) will trigger the content to be converted to a base64-string The PHP variable type of the data IS preserved as long as the types are strings, arrays, integers and booleans. Strings are the default type unless the "type" attribute is set. The output XML has been tested with the PHP XML-parser and parses OK under all tested circumstances with 4.x versions. However, with PHP5 there seems to be the need to add an XML prologue a la <?xml version="1.0" encoding="[charset]" standalone="yes" ?> - otherwise UTF-8 is assumed! Unfortunately, many times the output from this function is used without adding that prologue meaning that non-ASCII characters will break the parsing!! This suchs of course! Effectively it means that the prologue should always be prepended setting the right characterset, alternatively the system should always run as utf-8! However using MSIE to read the XML output didn't always go well: One reason could be that the character encoding is not observed in the PHP data. The other reason may be if the tag-names are invalid in the eyes of MSIE. Also using the namespace feature will make MSIE break parsing. There might be more reasons...

Parameters

array	$array	The input PHP array with any kind of data; text, binary, integers. Not objects though.
string	$NSprefix	tag-prefix, eg. a namespace prefix like "T3:"
integer	$level	Current recursion level. Don't change, stay at zero!
string	$docTag	Alternative document tag. Default is "phparray".
integer	$spaceInd	If greater than zero, then the number of spaces corresponding to this number is used for indenting, if less than zero - no indentation, if zero - a single TAB is used
array	$options	Options for the compilation. Key "useNindex" => 0/1 (boolean: whether to use "n0, n1, n2" for num. indexes); Key "useIndexTagForNum" => "[tag for numerical indexes]"; Key "useIndexTagForAssoc" => "[tag for associative indexes"; Key "parentTagMap" => array('parentTag' => 'thisLevelTag')
array	$stackData	Stack data. Don't touch.

Returns: string An XML string made from the input content in the array.

See also: xml2array()

Definition at line 2115 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Install\SystemEnvironment\Check\checkLibXmlBug(), TYPO3\CMS\Core\Tests\Unit\Resource\ResourceStorageTest\convertConfigurationArrayToFlexformXml(), TYPO3\CMS\Impexp\ImportExport\createXML(), TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\flexArray2Xml(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\xml2ArrayConvertsEmptyArraysToElementWithoutContent().

◆ array2xml_cs()

static TYPO3\CMS\Core\Utility\GeneralUtility::array2xml_cs	(	array	$array,
			$docTag = `'phparray'`,
		array	$options = `array()`,
			$charset = `''`
	)

static

Turns PHP array into XML. See array2xml()

Parameters

array	$array	The input PHP array with any kind of data; text, binary, integers. Not objects though.
string	$docTag	Alternative document tag. Default is "phparray".
array	$options	Options for the compilation. See array2xml() for description.
string	$charset	Forced charset to prologue

Returns: string An XML string made from the input content in the array.

See also: xml2array(),array2xml()

Definition at line 2086 of file GeneralUtility.php.

◆ array_merge()

static TYPO3\CMS\Core\Utility\GeneralUtility::array_merge	(	array	$arr1,
		array	$arr2
	)

static

An array_merge function where the keys are NOT renumbered as they happen to be with the real php-array_merge function. It is "binary safe" in the sense that integer keys are overridden as well.

Parameters

array	$arr1	First array
array	$arr2	Second array

Returns: array Merged result.

Definition at line 1798 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\_ACTION_FLEX_FORMdata(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\arrayMergeKeepsIndexesAfterMerge(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\buildMail(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\fetchGroupData(), TYPO3\CMS\Core\Utility\GeneralUtility\getAllFilesAndFoldersInPath(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLinkTypes(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstanceService(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord_processFieldValue(), and TYPO3\CMS\Backend\Form\Element\SuggestElement\processAjaxRequest().

◆ array_merge_recursive_overrule()

static TYPO3\CMS\Core\Utility\GeneralUtility::array_merge_recursive_overrule	(	array	$arr0,
		array	$arr1,
			$notAddKeys = `FALSE`,
			$includeEmptyValues = `TRUE`,
			$enableUnsetFeature = `TRUE`
	)

static

Merges two arrays recursively and "binary safe" (integer keys are overridden as well), overruling similar values in the first array ($arr0) with the values of the second array ($arr1) In case of identical keys, ie. keeping the values of the second.

Parameters

array	$arr0	First array
array	$arr1	Second array, overruling the first array
boolean	$notAddKeys	If set, keys that are NOT found in $arr0 (first array) will not be set. Thus only existing value can/will be overruled from second array.
boolean	$includeEmptyValues	If set, values from $arr1 will overrule if they are empty or zero. Default: TRUE
boolean	$enableUnsetFeature	If set, special values "__UNSET" can be used in the second array in order to unset array keys in the resulting array.

Returns: array Resulting array where $arr1 values has overruled $arr0 values

Deprecated:: [!!!] Since 6.2, use ArrayUtility::mergeRecursiveWithOverrule - WARNING: The new method changed its signature and does not return the first parameter anymore, but it is more performant.

Definition at line 1784 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\arrayMergeRecursiveOverruleDoesConsiderUnsetValues().

◆ arrayDiffAssocRecursive()

static TYPO3\CMS\Core\Utility\GeneralUtility::arrayDiffAssocRecursive	(	array	$array1,
		array	$array2
	)

static

Filters keys off from first array that also exist in second array. Comparison is done by keys. This method is a recursive version of php array_diff_assoc()

Parameters

array	$array1	Source array
array	$array2	Reduce source array by this array

Returns: array Source array reduced by keys also present in second array

Definition at line 1810 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\arrayDiffAssocRecursiveHandlesMixedArrays(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\arrayDiffAssocRecursiveHandlesMultiDimensionalArrays(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\arrayDiffAssocRecursiveHandlesOneDimensionalArrays(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildBackendUri(), TYPO3\CMS\Version\Hook\DataHandlerHook\processCmdmap_deleteAction(), and TYPO3\CMS\Core\DataHandling\DataHandler\unsetElementsToBeDeleted().

◆ arrayToLogString()

static TYPO3\CMS\Core\Utility\GeneralUtility::arrayToLogString	(	array	$arr,
			$valueList = `array()`,
			$valueLength = `20`
	)

static

Converts a one dimensional array to a one line string which can be used for logging or debugging output Example: "loginType: FE; refInfo: Array; HTTP_HOST: www.example.org; REMOTE_ADDR: 192.168.1.5; REMOTE_HOST:; security_level:; showHiddenRecords: 0;"

Parameters

array	$arr	Data array which should be outputted
mixed	$valueList	List of keys which should be listed in the output string. Pass a comma list or an array. An empty list outputs the whole array.
integer	$valueLength	Long string values are shortened to this length. Default: 20

Returns: string Output string with key names and their value as string

Definition at line 5271 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\checkAuthentication(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\fetchGroupData(), TYPO3\CMS\Lowlevel\SyslogCommand\main(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\processLoginData(), TYPO3\CMS\Backend\ModuleSettings\processStoreControl(), and TYPO3\CMS\Frontend\Controller\DataSubmissionController\start().

◆ callUserFunction()

static TYPO3\CMS\Core\Utility\GeneralUtility::callUserFunction	(		$funcName,
		&	$params,
		&	$ref,
			$checkPrefix = `''`,
			$errorMode = `0`
	)

static

Calls a user-defined function/method in class Such a function/method should look like this: "function proc(&$params, &$ref) {...}"

Parameters

string	$funcName	Function/Method reference or Closure, '[file-reference":"]["&"]class/function["->"method-name]'. You can prefix this reference with "[file-reference]:" and ::getFileAbsFileName() will then be used to resolve the filename and subsequently include it by "require_once()" which means you don't have to worry about including the class file either! Example: "EXT:realurl/class.tx_realurl.php:&tx_realurl->encodeSpURL". Finally; you can prefix the class name with "&" if you want to reuse a former instance of the same object call ("singleton").
mixed	$params	Parameters to be pass along (typically an array) (REFERENCE!)
mixed	$ref	Reference to be passed along (typically "$this" - being a reference to the calling object) (REFERENCE!)
string	$checkPrefix	Not used anymore since 6.0
integer	$errorMode	Error mode (when class/function could not be found): 0 - call debug(), 1 - do nothing, 2 - raise an exception (allows to call a user function that may return FALSE)

Returns: mixed Content from method/function call or FALSE if the class/method/function was not found

See also: getUserObj()

Definition at line 4276 of file GeneralUtility.php.

References $GLOBALS, and debug().

◆ camelCaseToLowerCaseUnderscored()

static TYPO3\CMS\Core\Utility\GeneralUtility::camelCaseToLowerCaseUnderscored ( $string )

static

Returns a given CamelCasedString as an lowercase string with underscores. Example: Converts BlogExample to blog_example, and minimalValue to minimal_value

Parameters

string $string String to be converted to lowercase underscore

Returns: string lowercase_and_underscored_string

Definition at line 1362 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Command\__construct(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\addExtJSModule(), TYPO3\CMS\Core\Core\ClassLoader\buildClassLoadingInformationForClassByNamingConvention(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\camelCaseToLowerCaseUnderscored(), TYPO3\CMS\Extbase\Utility\LocalizationUtility\initializeLocalization(), TYPO3\CMS\Extbase\Utility\ExtensionUtility\registerModule(), TYPO3\CMS\Extbase\Utility\ExtensionUtility\registerPlugin(), and TYPO3\CMS\Fluid\ViewHelpers\Uri\ResourceViewHelper\render().

◆ checkInstanceClassName()

static TYPO3\CMS\Core\Utility\GeneralUtility::checkInstanceClassName	(	$className,
		$instance
	)

staticprotected

Checks that $className is non-empty and that $instance is an instance of $className.

Exceptions

Definition at line 4671 of file GeneralUtility.php.

◆ classHasImplementation()

static TYPO3\CMS\Core\Utility\GeneralUtility::classHasImplementation ( $className )

staticprotected

Checks if a class has a configured implementation

Parameters

string $className

Returns: boolean

Definition at line 4538 of file GeneralUtility.php.

References $GLOBALS.

◆ cleanOutputBuffers()

static TYPO3\CMS\Core\Utility\GeneralUtility::cleanOutputBuffers ( )

static

Ends and cleans all output buffers

Returns: void

Definition at line 5359 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Openid\OpenidReturn\main().

◆ clientInfo()

static TYPO3\CMS\Core\Utility\GeneralUtility::clientInfo ( $useragent = '' )

static

Client Browser Information

Parameters

string $useragent Alternative User Agent string (if empty, ::getIndpEnv('HTTP_USER_AGENT') is used)

Returns: array Parsed information about the HTTP_USER_AGENT in categories BROWSER, VERSION, SYSTEM

Definition at line 3720 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Form\FormEngine\__construct(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\__construct(), TYPO3\CMS\Rtehtmlarea\SelectImage\getAllowedItems(), TYPO3\CMS\Core\Core\SystemEnvironmentBuilder\initializeGlobalVariables(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\start().

◆ cmpFQDN()

static TYPO3\CMS\Core\Utility\GeneralUtility::cmpFQDN	(	$baseHost,
		$list
	)

static

Match fully qualified domain name with list of strings with wildcard

Parameters

string	$baseHost	A hostname or an IPv4/IPv6-address (will by reverse-resolved; typically REMOTE_ADDR)
string	$list	A comma-list of domain names to match with. -wildcard allowed but cannot be part of a string, so it must match the full host name (eg. myhost..com => correct, myhost.*domain.com => wrong)

Returns: boolean TRUE if a domain name mask from $list matches $baseIP

Definition at line 641 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\cmpFqdnReturnsFalse(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\cmpFqdnReturnsTrue(), and TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcher\evaluateConditionCommon().

◆ cmpIP()

static TYPO3\CMS\Core\Utility\GeneralUtility::cmpIP	(	$baseIP,
		$list
	)

static

Match IP number with list of numbers with wildcard Dispatcher method for switching into specialised IPv4 and IPv6 methods.

Parameters

string	$baseIP	Is the current remote IP address for instance, typ. REMOTE_ADDR
string	$list	Is a comma-list of IP-addresses to match with. -wildcard allowed instead of number, plus leaving out parts in the IP number is accepted as wildcard (eg. 192.168..* equals 192.168). If list is "*" no check is done and the function returns TRUE immediately. An empty list always returns FALSE.

Returns: boolean TRUE if an IP-mask from $list matches $baseIP

Definition at line 389 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\beLoginLinkIPList(), TYPO3\CMS\Backend\FrontendBackendUserAuthentication\checkBackendAccessSettingsFromInitPhp(), TYPO3\CMS\Core\Core\Bootstrap\checkBackendIpOrDie(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\checkLockToIP(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\checkPageUnavailableHandler(), TYPO3\CMS\Core\Core\Bootstrap\configureExceptionHandling(), TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcher\evaluateConditionCommon(), TYPO3\CMS\Core\Database\DatabaseConnection\explain(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConfigurationComplete().

◆ cmpIPv4()

static TYPO3\CMS\Core\Utility\GeneralUtility::cmpIPv4	(	$baseIP,
		$list
	)

static

Match IPv4 number with list of numbers with wildcard

Parameters

string	$baseIP	Is the current remote IP address for instance, typ. REMOTE_ADDR
string	$list	Is a comma-list of IP-addresses to match with. -wildcard allowed instead of number, plus leaving out parts in the IP number is accepted as wildcard (eg. 192.168..* equals 192.168), could also contain IPv6 addresses

Returns: boolean TRUE if an IP-mask from $list matches $baseIP

Definition at line 410 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\cmpIPv4ReturnsFalseForNotMatchingAddress(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\cmpIPv4ReturnsTrueForMatchingAddress().

◆ cmpIPv6()

static TYPO3\CMS\Core\Utility\GeneralUtility::cmpIPv6	(	$baseIP,
		$list
	)

static

Match IPv6 address with a list of IPv6 prefixes

Parameters

string	$baseIP	Is the current remote IP address for instance
string	$list	Is a comma-list of IPv6 prefixes, could also contain IPv4 addresses

Returns: boolean TRUE If an baseIP matches any prefix

Definition at line 456 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\cmpIPv6ReturnsFalseForNotMatchingAddress(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\cmpIPv6ReturnsTrueForMatchingAddress().

◆ compat_version()

static TYPO3\CMS\Core\Utility\GeneralUtility::compat_version ( $verNumberStr )

static

Returns TRUE if the current TYPO3 version (or compatibility version) is compatible to the input version Notice that this function compares branches, not versions (4.0.1 would be > 4.0.0 although they use the same compat_version)

Parameters

string $verNumberStr Minimum branch number required (format x.y / e.g. "4.0" NOT "4.0.0"!)

Returns: boolean Returns TRUE if this setup is compatible with the provided version number

Todo:: Still needs a function to convert versions to branches

Definition at line 791 of file GeneralUtility.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\VersionNumberUtility\convertVersionNumberToInteger().

Referenced by TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcher\evaluateConditionCommon(), and TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\getConfigArray().

◆ compileSelectedGetVarsFromArray()

static TYPO3\CMS\Core\Utility\GeneralUtility::compileSelectedGetVarsFromArray	(		$varList,
		array	$getArray,
			$GPvarAlt = `TRUE`
	)

static

Returns an array with selected keys from incoming data. (Better read source code if you want to find out...)

Parameters

string	$varList	List of variable/key names
array	$getArray	Array from where to get values based on the keys in $varList
boolean	$GPvarAlt	If set, then ::_GP() is used to fetch the value if not found (isset) in the $getArray

Returns: array Output array with selected variables.

Definition at line 1681 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\compileSelectedGetVarsFromArrayFiltersIncomingData(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\compileSelectedGetVarsFromArrayUsesGetPostDataFallback(), TYPO3\CMS\Backend\Controller\EditDocumentController\compileStoreDat(), and TYPO3\CMS\Backend\Template\DocumentTemplate\makeShortcutUrl().

◆ compressIPv6()

static TYPO3\CMS\Core\Utility\GeneralUtility::compressIPv6 ( $address )

static

Compress an IPv6 address to the shortest notation

Parameters

string $address Given IPv6 address

Returns: string Compressed address

See also: normalizeIPv6()

Definition at line 594 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\compressIPv6CorrectlyCompressesAdresses(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\compressIPv6CorrectlyCompressesAdressWithSomeAddressOnRightSide().

◆ convertMicrotime()

static TYPO3\CMS\Core\Utility\GeneralUtility::convertMicrotime ( $microtime )

static

Returns microtime input to milliseconds

Parameters

string $microtime Microtime

Returns: integer Microtime input string converted to an integer (milliseconds)

Definition at line 1002 of file GeneralUtility.php.

◆ copyDirectory()

static TYPO3\CMS\Core\Utility\GeneralUtility::copyDirectory	(	$source,
		$destination
	)

static

Low level utility function to copy directories and content recursive

Parameters

string	$source	Path to source directory, relative to document root or absolute
string	$destination	Path to destination directory, relative to document root or absolute

Definition at line 3925 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService\copyDependencies(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\copyDirectoryCopiesFilesAndDirectoriesWithAbsolutePaths(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\copyDirectoryCopiesFilesAndDirectoriesWithRelativePaths(), TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\copyExtensionFolderToTempFolder(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importInitialFiles(), and TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\removeExtensionAndRestoreFromBackup().

◆ createDirectoryPath()

static TYPO3\CMS\Core\Utility\GeneralUtility::createDirectoryPath ( $fullDirectoryPath )

staticprotected

Creates directories for the specified paths if they do not exist. This functions sets proper permission mask but does not set proper user and group.

Parameters

string $fullDirectoryPath

Returns: string Path to the the first created directory in the hierarchy

See also: ::mkdir_deep

Exceptions

Definition at line 2900 of file GeneralUtility.php.

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

◆ createVersionNumberedFilename()

static TYPO3\CMS\Core\Utility\GeneralUtility::createVersionNumberedFilename	(	$file,
		$forceQueryString = `FALSE`
	)

static

Function for static version numbers on files, based on the filemtime

This will make the filename automatically change when a file is changed, and by that re-cached by the browser. If the file does not exist physically the original file passed to the function is returned without the timestamp.

Behaviour is influenced by the setting TYPO3_CONF_VARS[TYPO3_MODE][versionNumberInFilename] = TRUE (BE) / "embed" (FE) : modify filename = FALSE (BE) / "querystring" (FE) : add timestamp as parameter

Parameters

string	$file	Relative path to file including all potential query parameters (not htmlspecialchared yet)
boolean	$forceQueryString	If settings would suggest to embed in filename, this parameter allows us to force the versioning to occur in the query string. This is needed for scriptaculous.js which cannot have a different filename in order to load its modules (?load=...)

Returns: string Relative path with version filename including the timestamp

Definition at line 3253 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\T3editor\T3editor\__construct(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase\getRteInitJsCode(), TYPO3\CMS\Backend\Controller\PageLayoutController\main(), TYPO3\CMS\Core\Page\PageRenderer\processJsFile(), TYPO3\CMS\Frontend\ContentObject\FormContentObject\render(), TYPO3\CMS\Core\Page\PageRenderer\renderAdditionalJavaScriptLibraries(), TYPO3\CMS\Core\Page\PageRenderer\renderCssFiles(), TYPO3\CMS\Core\Page\PageRenderer\renderCssLibraries(), and TYPO3\CMS\Core\Page\PageRenderer\renderJavaScriptFiles().

◆ csvValues()

static TYPO3\CMS\Core\Utility\GeneralUtility::csvValues	(	array	$row,
			$delim = `','`,
			$quote = `'"'`
	)

static

Takes a row and returns a CSV string of the values with $delim (default is ,) and $quote (default is ") as separator chars.

Parameters

array	$row	Input array of values
string	$delim	Delimited, default is comma
string	$quote	Quote-character to wrap around the values.

Returns: string A single line of CSV

Definition at line 1832 of file GeneralUtility.php.

◆ deHSCentities()

static TYPO3\CMS\Core\Utility\GeneralUtility::deHSCentities ( $str )

static

Re-converts HTML entities if they have been converted by htmlspecialchars() Note: Use htmlspecialchars($str, ENT_COMPAT, 'UTF-8', FALSE) to avoid double encoding. This makes the call to this method obsolete.

Parameters

string $str String which contains eg. "&" which should stay "&". Or "Ӓ" to "Ӓ". Or "" to "

Returns: string Converted result.

Definition at line 1051 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\deHSCentitiesReturnsDecodedString().

◆ deprecationLog()

static TYPO3\CMS\Core\Utility\GeneralUtility::deprecationLog ( $msg )

static

Writes a message to the deprecation log.

Parameters

string $msg Message (in English).

Returns: void

Definition at line 5183 of file GeneralUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\DebugUtility\debug(), and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath().

Referenced by FE_loadDBGroup\__construct(), TYPO3\CMS\Extbase\Persistence\Generic\Qom\Statement\__construct(), TYPO3\CMS\Core\Database\RelationHandler\__set(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\addTCAcolumns(), TYPO3\CMS\Core\DataHandling\DataHandler\clear_cacheCmd(), TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper\createDocInstance(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\deprecationLogFixesPermissionsOnLogFile(), TYPO3\CMS\Backend\Form\FormEngine\getSingleField_typeFlex_sheetMenu(), TYPO3\CMS\Core\Database\DatabaseConnection\handleDeprecatedConnectArguments(), TYPO3\CMS\Backend\Controller\ClickMenuController\init(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\insertModuleFunction(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\logDeprecatedTyposcript(), TYPO3\CMS\Fluid\ViewHelpers\Be\ContainerViewHelper\render(), TYPO3\CMS\Backend\Form\FormEngine\renderWizards(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\workspaceAllowAutoCreation().

◆ devLog()

static TYPO3\CMS\Core\Utility\GeneralUtility::devLog	(	$msg,
		$extKey,
		$severity = `0`,
		$dataVar = `FALSE`
	)

static

Logs message to the development log. This should be implemented around the source code, both frontend and backend, logging everything from the flow through an application, messages, results from comparisons to fatal errors. The result is meant to make sense to developers during development or debugging of a site. The idea is that this function is only a wrapper for external extensions which can set a hook which will be allowed to handle the logging of the information to any format they might wish and with any kind of filter they would like. If you want to implement the devLog in your applications, simply add lines like: if (TYPO3_DLOG) ::devLog('[write message in english here]', 'extension key');

Parameters

string	$msg	Message (in english).
string	$extKey	Extension key (from which extension you are calling the log)
integer	$severity	Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message
mixed	$dataVar	Additional data you want to pass to the logger.

Returns: void

Definition at line 5167 of file GeneralUtility.php.

References $GLOBALS.

◆ dirname()

static TYPO3\CMS\Core\Utility\GeneralUtility::dirname ( $path )

static

Returns the directory part of a path without trailing slash If there is no dir-part, then an empty string is returned. Behaviour:

'/dir1/dir2/script.php' => '/dir1/dir2' '/dir1/' => '/dir1' 'dir1/script.php' => 'dir1' 'd/script.php' => 'd' '/script.php' => '' '' => ''

Parameters

string $path Directory name / path

Returns: string Processed input value. See function description.

Definition at line 914 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\dirnameWithDataProvider(), TYPO3\CMS\Workspaces\Controller\PreviewController\generateJavascript(), TYPO3\CMS\Backend\Controller\BackendController\generateJavascript(), TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv(), TYPO3\CMS\Core\Utility\GeneralUtility\gif_compress(), TYPO3\CMS\Backend\Form\FrontendFormEngine\initializeTemplateContainer(), and TYPO3\CMS\Frontend\Page\PageGenerator\renderContent().

◆ encodeHeader()

static TYPO3\CMS\Core\Utility\GeneralUtility::encodeHeader	(	$line,
		$enc = `'quoted-printable'`,
		$charset = `'utf-8'`
	)

static

Encode header lines Email headers must be ASCII, therefore they will be encoded to quoted_printable (default) or base64.

Parameters

string	$line	Content to encode
string	$enc	Encoding type: "base64" or "quoted-printable". Default value is "quoted-printable".
string	$charset	Charset used for encoding

Returns: string The encoded string

Definition at line 4924 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\encodeHeaderEncodesQuestionmarksInQuotedPrintableMailHeader(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\encodeHeaderEncodesWhitespacesInQuotedPrintableMailHeader().

◆ expandList()

static TYPO3\CMS\Core\Utility\GeneralUtility::expandList ( $list )

static

Expand a comma-separated list of integers with ranges (eg 1,3-5,7 becomes 1,3,4,5,7). Ranges are limited to 1000 values per range.

Parameters

string $list Comma-separated list of integers with ranges (string)

Returns: string New comma-separated list of items

Definition at line 750 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\expandListExpandsForTwoThousandElementsExpandsOnlyToThousandElementsMaximum(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\expandListExpandsIntegerRanges(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_expandList().

◆ explodeUrl2Array()

static TYPO3\CMS\Core\Utility\GeneralUtility::explodeUrl2Array	(	$string,
		$multidim = `FALSE`
	)

static

Explodes a string with GETvars (eg. "&id=1&type=2&ext[mykey]=3") into an array

Parameters

string	$string	GETvars string
boolean	$multidim	If set, the string will be parsed into a multidimensional array if square brackets are used in variable names (using PHP function parse_str())

Returns: array Array of values. All values AND keys are rawurldecoded() as they properly should be. But this means that any implosion of the array again must rawurlencode it!

See also: implodeArrayForUrl()

Definition at line 1656 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildBackendUri(), TYPO3\CMS\Backend\Toolbar\ShortcutToolbarItem\createAjaxShortcut(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\explodeUrl2ArrayTransformsParameterStringToFlatArray(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\explodeUrl2ArrayTransformsParameterStringToNestedArray(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getPreserveGetVars(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getUrlToCurrentLocation(), TYPO3\CMS\Backend\Controller\File\RenameFileController\init(), TYPO3\CMS\Backend\Toolbar\ShortcutToolbarItem\initShortcuts(), TYPO3\CMS\Core\TypoScript\TemplateService\linkData(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\removeInaccessiblePages(), and TYPO3\CMS\Backend\Controller\ContentElement\NewContentElementController\removeInvalidElements().

◆ fixed_lgd_cs()

static TYPO3\CMS\Core\Utility\GeneralUtility::fixed_lgd_cs	(	$string,
		$chars,
		$appendString = `'...'`
	)

static

Truncates a string with appended/prepended "..." and takes current character set into consideration.

Parameters

string	$string	String to truncate
integer	$chars	Must be an integer with an absolute value of at least 4. if negative the string is cropped from the right end.
string	$appendString	Appendix to the truncated string

Returns: string Cropped string

Definition at line 368 of file GeneralUtility.php.

References $GLOBALS.

◆ fixPermissions()

static TYPO3\CMS\Core\Utility\GeneralUtility::fixPermissions	(	$path,
		$recursive = `FALSE`
	)

static

Sets the file system mode and group ownership of a file or a folder.

Parameters

string	$path	Path of file or folder, must not be escaped. Path can be absolute or relative
boolean	$recursive	If set, also fixes permissions of files and folders in the folder (if $path is a folder)

Returns: mixed TRUE on success, FALSE on error, always TRUE on Windows OS

Definition at line 2733 of file GeneralUtility.php.

References $GLOBALS, and $result.

Referenced by TYPO3\CMS\Core\Locking\Locker\acquire(), TYPO3\CMS\Core\Locking\Locker\acquireExclusiveLock(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\addFile(), TYPO3\CMS\Core\Http\Observer\Download\closeFile(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\combineExec(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\copyFileWithinStorage(), TYPO3\CMS\Core\Tests\Unit\Resource\Driver\LocalDriverTest\copyFolderWithinStorageCopiesFileInSingleSubFolderToNewFolderName(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\createFile(), TYPO3\CMS\Install\Service\EnableFileService\createInstallToolEnableFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsCorrectlySetsPermissionsRecursive(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsDoesNotSetPermissionsToNotAllowedPath(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsDefaultPermissionsToDirectory(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsDefaultPermissionsToFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsGroup(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsToDirectory(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsToDirectoryWithTrailingSlash(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsToFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsToHiddenDirectory(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsToHiddenFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsWithRelativeFileReference(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\imageMagickExec(), TYPO3\CMS\Backend\Utility\IconUtility\imagemake(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\ImageWrite(), TYPO3\CMS\Backend\View\ThumbnailView\main(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\moveFolderWithinStorage(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\replaceFile(), TYPO3\CMS\Core\Cache\Backend\FileBackend\set(), TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend\set(), TYPO3\CMS\Core\Package\PackageManager\sortAndSavePackageStates(), and TYPO3\CMS\Core\Mail\MboxTransport\stop().

◆ fixWindowsFilePath()

static TYPO3\CMS\Core\Utility\GeneralUtility::fixWindowsFilePath ( $theFile )

static

Fixes a path for windows-backslashes and reduces double-slashes to single slashes

Parameters

string $theFile File path to process

Returns: string

Definition at line 3125 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\applyFiltersToValues(), TYPO3\CMS\Install\Configuration\Image\AbstractImagePreset\cleanUpPath(), TYPO3\CMS\Fluid\View\TemplateView\expandPatterns(), TYPO3\CMS\Core\Tests\Unit\Resource\Driver\LocalDriverTest\filesCanBeCopiedToATemporaryPath(), TYPO3\CMS\Fluid\View\StandaloneView\getLayoutPathAndFilename(), TYPO3\CMS\Fluid\Tests\Unit\View\StandaloneViewTest\getLayoutSourceReturnsContentOfDefaultLayoutFileIfNoLayoutExistsForTheSpecifiedFormat(), TYPO3\CMS\Fluid\Tests\Unit\View\StandaloneViewTest\getLayoutSourceReturnsContentOfLayoutFileForTheDefaultFormat(), TYPO3\CMS\Fluid\Tests\Unit\View\StandaloneViewTest\getLayoutSourceReturnsContentOfLayoutFileForTheSpecifiedFormat(), TYPO3\CMS\Fluid\View\StandaloneView\getPartialPathAndFilename(), TYPO3\CMS\Core\Utility\PathUtility\getRelativePath(), TYPO3\CMS\Core\Utility\CommandUtility\imageMagickCommand(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\moveFolderWithinStorage(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\removeDirectory(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\renameFile(), TYPO3\CMS\Sv\Report\ServicesListReport\renderExecutablesSearchPathList(), TYPO3\CMS\Fluid\Tests\Unit\View\StandaloneViewTest\renderLoadsSpecifiedTemplateFileAndPassesSourceToTemplateParser(), TYPO3\CMS\Core\Tests\Unit\Cache\Backend\FileBackendTest\setCacheDirectoryAllowsRelativeDottedPathWithoutTrailingSlash(), TYPO3\CMS\Core\Tests\Unit\Cache\Backend\FileBackendTest\setCacheDirectoryAllowsRelativeDottedPathWithTrailingSlash(), TYPO3\CMS\Core\Tests\Unit\Cache\Backend\FileBackendTest\setCacheDirectoryAllowsRelativePathWithoutTrailingSlash(), TYPO3\CMS\Core\Tests\Unit\Cache\Backend\FileBackendTest\setCacheDirectoryAllowsRelativePathWithTrailingSlash(), and TYPO3\CMS\Form\Request\storeFiles().

◆ flushDirectory()

static TYPO3\CMS\Core\Utility\GeneralUtility::flushDirectory	(	$directory,
		$keepOriginalDirectory = `FALSE`,
		$flushOpcodeCache = `FALSE`
	)

static

Flushes a directory by first moving to a temporary resource, and then triggering the remove process. This way directories can be flushed faster to prevent race conditions on concurrent processes accessing the same directory.

Parameters

string	$directory	The directory to be renamed and flushed
bool	$keepOriginalDirectory	Whether to only empty the directory and not remove it
bool	$flushOpcodeCache	Also flush the opcode cache right after renaming the directory.

Returns: boolean Whether the action was successful

Definition at line 2969 of file GeneralUtility.php.

References $result, and TYPO3\CMS\Core\Utility\OpcodeCacheUtility\clearAllActive().

Referenced by TYPO3\CMS\Install\Service\ClearCacheService\clearAll(), and TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend\flush().

◆ flushOutputBuffers()

static TYPO3\CMS\Core\Utility\GeneralUtility::flushOutputBuffers ( )

static

Ends and flushes all output buffers

Returns: void

Definition at line 5371 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\jumpUrl().

◆ formatForTextarea()

static TYPO3\CMS\Core\Utility\GeneralUtility::formatForTextarea ( $content )

static

Formats a string for output between <textarea>-tags All content outputted in a textarea form should be passed through this function Not only is the content htmlspecialchar'ed on output but there is also a single newline added in the top. The newline is necessary because browsers will ignore the first newline after <textarea> if that is the first character. Therefore better set it!

Parameters

string $content Input string to be formatted.

Returns: string Formatted for <textarea>-tags

Definition at line 1166 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Rte\AbstractRte\drawRTE(), TYPO3\CMS\Rtehtmlarea\Controller\FrontendRteController\drawRTE(), TYPO3\CMS\Core\Database\QueryView\getQueryResultCode(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase\isAvailable(), TYPO3\CMS\Backend\Controller\File\EditFileController\main(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\processTemplateRowBeforeSaving(), and TYPO3\CMS\Frontend\ContentObject\FormContentObject\render().

◆ formatSize()

static TYPO3\CMS\Core\Utility\GeneralUtility::formatSize	(	$sizeInBytes,
		$labels = `''`
	)

static

Formats the input integer $sizeInBytes as bytes/kilobytes/megabytes (-/K/M)

Parameters

integer	$sizeInBytes	Number of bytes to format.
string	$labels	Labels for bytes, kilo, mega and giga separated by vertical bar (\|) and possibly encapsulated in "". Eg: " \| K\| M\| G" (which is the default value)

Returns: string Formatted representation of the byte number, for output.

Definition at line 967 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\applyFiltersToValues(), TYPO3\CMS\IndexedSearch\Controller\SearchController\compileSingleResultRow(), TYPO3\CMS\Impexp\ImportExport\displayContentOverview(), TYPO3\CMS\Impexp\ImportExport\export_addFile(), TYPO3\CMS\Impexp\ImportExport\export_addRecord(), TYPO3\CMS\Impexp\ImportExport\export_addSysFile(), TYPO3\CMS\Impexp\Controller\ImportExportController\exportData(), TYPO3\CMS\Filelist\FileList\formatFileList(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\formatSizeTranslatesBytesToHigherOrderRepresentation(), TYPO3\CMS\Backend\Form\FormEngine\formatValue(), TYPO3\CMS\Reports\Report\Status\ConfigurationStatus\getDeprecationLogStatus(), TYPO3\CMS\Frontend\View\AdminPanelView\getInfoModule(), TYPO3\CMS\IndexedSearch\Controller\ModuleController\getPhashExternalDocs(), TYPO3\CMS\IndexedSearch\Controller\ModuleController\getPhashT3pages(), TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\getSenderEmailName(), TYPO3\CMS\Reports\Report\Status\SystemStatus\getStatus(), TYPO3\CMS\Rtehtmlarea\User\main_user(), TYPO3\CMS\Backend\Form\FormEngine\previewFieldValue(), TYPO3\CMS\Backend\Clipboard\Clipboard\printContentFromTab(), TYPO3\CMS\IndexedSearch\Controller\IndexedPagesController\printPhashRow(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\procesResources(), TYPO3\CMS\Core\Log\Processor\MemoryUsageProcessor\processLogRecord(), TYPO3\CMS\Core\Log\Processor\MemoryPeakUsageProcessor\processLogRecord(), TYPO3\CMS\Install\ViewHelpers\File\SizeViewHelper\render(), TYPO3\CMS\Core\Resource\Hook\FileInfoHook\renderFileInformationContent(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\resourceListForCopy(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_bytes(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\TBE_dragNDrop().

◆ freetypeDpiComp()

static TYPO3\CMS\Core\Utility\GeneralUtility::freetypeDpiComp ( $font_size )

static

Function to compensate for FreeType2 96 dpi

Parameters

integer $font_size Fontsize for freetype function call

Returns: integer Compensated fontsize based on $GLOBALS['TYPO3_CONF_VARS']['GFX']['TTFdpi']

Definition at line 5038 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\View\ThumbnailView\fontGif(), TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\getSenderEmailName(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\ImageTTFBBoxWrapper(), and TYPO3\CMS\Core\Imaging\GraphicalFunctions\ImageTTFTextWrapper().

◆ generateRandomBytes()

static TYPO3\CMS\Core\Utility\GeneralUtility::generateRandomBytes ( $bytesToReturn )

static

Returns a string of highly randomized bytes (over the full 8-bit range).

Note: Returned values are not guaranteed to be crypto-safe, most likely they are not, depending on the used retrieval method.

Parameters

integer $bytesToReturn Number of characters (bytes) to return

Returns: string Random Bytes

See also: http://bugs.php.net/bug.php?id=52523; http://www.php-security.org/2010/05/09/mops-submission-04-generating-unpredictable-session-ids-and-hashes/index.html

Definition at line 1207 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Saltedpasswords\Tests\Unit\Salt\SaltFactoryTest\base64EncodeReturnsProperLength(), TYPO3\CMS\Saltedpasswords\Tests\Unit\Salt\PhpassSaltTest\createdSaltedHashOfProperStructureForCustomSaltWithoutSetting(), TYPO3\CMS\Saltedpasswords\Tests\Unit\Salt\BlowfishSaltTest\createdSaltedHashOfProperStructureForCustomSaltWithoutSetting(), TYPO3\CMS\Saltedpasswords\Tests\Unit\Salt\Md5SaltTest\createdSaltedHashOfProperStructureForCustomSaltWithoutSetting(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\generateAndSendHash(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\generateRandomBytesReturnsDifferentBytesDuringDifferentCalls(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\generateRandomBytesReturnsExpectedAmountOfBytes(), TYPO3\CMS\Saltedpasswords\Salt\Md5Salt\getGeneratedSalt(), and TYPO3\CMS\Saltedpasswords\Salt\PhpassSalt\getGeneratedSalt().

◆ generateRandomBytesFallback()

static TYPO3\CMS\Core\Utility\GeneralUtility::generateRandomBytesFallback ( $bytesToReturn )

staticprotected

Generate pseudo random bytes as last resort

Parameters

$bytesToReturn

Returns: string

Definition at line 1290 of file GeneralUtility.php.

References $GLOBALS.

◆ generateRandomBytesMcrypt()

static TYPO3\CMS\Core\Utility\GeneralUtility::generateRandomBytesMcrypt ( $bytesToGenerate )

staticprotected

Generate random bytes using mcrypt if available

Parameters

$bytesToGenerate

Returns: string

Definition at line 1258 of file GeneralUtility.php.

◆ generateRandomBytesOpenSsl()

static TYPO3\CMS\Core\Utility\GeneralUtility::generateRandomBytesOpenSsl ( $bytesToGenerate )

staticprotected

Generate random bytes using openssl if available

Parameters

string $bytesToGenerate

Returns: string

Definition at line 1244 of file GeneralUtility.php.

◆ generateRandomBytesUrandom()

static TYPO3\CMS\Core\Utility\GeneralUtility::generateRandomBytesUrandom ( $bytesToGenerate )

staticprotected

Read random bytes from /dev/urandom if it is accessible

Parameters

$bytesToGenerate

Returns: string

Definition at line 1271 of file GeneralUtility.php.

◆ get_dirs()

static TYPO3\CMS\Core\Utility\GeneralUtility::get_dirs ( $path )

static

Returns an array with the names of folders in a specific path Will return 'error' (string) if there were an error with reading directory content.

Parameters

string $path Path to list directories from

Returns: array Returns an array with the directory entries as values. If no path, the return value is nothing.

Definition at line 2994 of file GeneralUtility.php.

Referenced by TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\crawler_execute_type2(), TYPO3\CMS\Documentation\Domain\Repository\DocumentRepository\findAll(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\getDirsReturnsArrayOfDirectoriesFromGivenDirectory(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\getDirsReturnsStringErrorOnPathFailure(), TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\getExtensionFromInExtensionRepository(), and TYPO3\CMS\Backend\Sprite\SpriteGenerator\getFolder().

◆ get_tag_attributes()

static TYPO3\CMS\Core\Utility\GeneralUtility::get_tag_attributes ( $tag )

static

Returns an array with all attributes of the input HTML tag as key/value pairs. Attributes are only lowercase a-z $tag is either a whole tag (eg '<TAG option="" attrib="VALUE">') or the parameter list (ex ' OPTION ATTRIB=VALUE>') If an attribute is empty, then the value for the key is empty. You can check if it existed with isset()

Parameters

string $tag HTML-tag string (or attributes only)

Returns: array Array with the attribute values.

Definition at line 1891 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\_parseFunc(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\addParams(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\encaps_lineSplit(), TYPO3\CMS\Rtehtmlarea\BrowseLinks\initCurrentUrl(), TYPO3\CMS\Recordlist\Browser\ElementBrowser\initCurrentUrl(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_openAtagHrefInJSwindow(), TYPO3\CMS\Rtehtmlarea\Controller\AccessibilityLinkController\removeAccessibilityIcon(), and TYPO3\CMS\IndexedSearch\Indexer\splitHTMLContent().

◆ getAllFilesAndFoldersInPath()

static TYPO3\CMS\Core\Utility\GeneralUtility::getAllFilesAndFoldersInPath	(	array	$fileArr,
			$path,
			$extList = `''`,
			$regDirs = `FALSE`,
			$recursivityLevels = `99`,
			$excludePattern = `''`
	)

static

Recursively gather all files and folders of a path.

Parameters

array	$fileArr	Empty input array (will have files added to it)
string	$path	The path to read recursively from (absolute) (include trailing slash!)
string	$extList	Comma list of file extensions: Only files with extensions in this list (if applicable) will be selected.
boolean	$regDirs	If set, directories are also included in output.
integer	$recursivityLevels	The number of levels to dig down...
string	$excludePattern	regex pattern of files/directories to exclude

Returns: array An array with the found files/directories.

Definition at line 3084 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\crawler_execute_type2(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createZipFileFromExtension(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\includeDirectory(), and TYPO3\CMS\Lowlevel\LostFilesCommand\main().

◆ getApplicationContext()

static TYPO3\CMS\Core\Utility\GeneralUtility::getApplicationContext ( )

static

Get the ApplicationContext

Returns

Definition at line 5415 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Toolbar\ClearCacheToolbarItem\__construct(), TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcher\evaluateConditionCommon(), TYPO3\CMS\Install\Configuration\Context\DevelopmentPreset\getPriority(), TYPO3\CMS\Install\Configuration\Context\ProductionPreset\getPriority(), and TYPO3\CMS\Core\Tests\Unit\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcherTest\setUp().

◆ getBytesFromSizeMeasurement()

static TYPO3\CMS\Core\Utility\GeneralUtility::getBytesFromSizeMeasurement ( $measurement )

static

Gets the bytes value from a measurement string like "100k".

Parameters

string $measurement The measurement (e.g. "100k")

Returns: integer The bytes value (e.g. 102400)

Definition at line 3215 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\getBytesFromSizeMeasurementCalculatesCorrectByteValue(), and TYPO3\CMS\Reports\Report\Status\SystemStatus\getStatus().

◆ getClassName()

static TYPO3\CMS\Core\Utility\GeneralUtility::getClassName ( $className )

staticprotected

Returns the class name for a new instance, taking into account registered implementations for this class

Parameters

string $className Base class name to evaluate

Returns: string Final class name to instantiate with "new [classname]

Definition at line 4513 of file GeneralUtility.php.

◆ getDeprecationLogFileName()

static TYPO3\CMS\Core\Utility\GeneralUtility::getDeprecationLogFileName ( )

static

Gets the absolute path to the deprecation log file.

Returns: string Absolute path to the deprecation log file

Definition at line 5224 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\deprecationLogFixesPermissionsOnLogFile(), TYPO3\CMS\Reports\Report\Status\ConfigurationStatus\executeAdminCommand(), TYPO3\CMS\Reports\Report\Status\ConfigurationStatus\getDeprecationLogFileLink(), and TYPO3\CMS\Reports\Report\Status\ConfigurationStatus\getDeprecationLogStatus().

◆ getFileAbsFileName()

static TYPO3\CMS\Core\Utility\GeneralUtility::getFileAbsFileName	(	$filename,
		$onlyRelative = `TRUE`,
		$relToTYPO3_mainDir = `FALSE`
	)

static

Returns the absolute filename of a relative reference, resolves the "EXT:" prefix (way of referring to files inside extensions) and checks that the file is inside the PATH_site of the TYPO3 installation and implies a check with ::validPathStr().

Parameters

string	$filename	The input filename/filepath to evaluate
boolean	$onlyRelative	If $onlyRelative is set (which it is by default), then only return values relative to the current PATH_site is accepted.
boolean	$relToTYPO3_mainDir	If $relToTYPO3_mainDir is set, then relative paths are relative to PATH_typo3 constant - otherwise (default) they are relative to PATH_site

Returns: string Returns the absolute filename of $filename if valid, otherwise blank string.

Definition at line 3832 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath(), and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded().

Referenced by TYPO3\CMS\Frontend\ContentObject\FluidTemplateContentObject\applyStandardWrapToFluidPaths(), TYPO3\CMS\Core\Tests\Functional\DataHandling\AbstractDataHandlerActionTestCase\assertAssertionDataSet(), TYPO3\CMS\Rtehtmlarea\Extension\MicroDataSchema\buildJavascriptConfiguration(), TYPO3\CMS\Impexp\ImportExport\checkOrCreateDir(), TYPO3\CMS\Scheduler\Task\RecyclerGarbageCollectionTask\cleanupRecycledFiles(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_fixRTEmagicImages(), TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\crawler_execute_type2(), TYPO3\CMS\Extensionmanager\Utility\UpdateScriptUtility\determineUpdateClassName(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\execute(), TYPO3\CMS\Impexp\ImportExport\export_addFile(), TYPO3\CMS\Impexp\ImportExport\export_addFilesFromRelations(), TYPO3\CMS\Core\TypoScript\ExtendedTemplateService\ext_getTSCE_config_image(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\extractIncludes(), TYPO3\CMS\IndexedSearch\Indexer\extractLinks(), TYPO3\CMS\Documentation\Service\DocumentationService\fetchDocument(), TYPO3\CMS\Core\Database\SoftReferenceIndex\fileadminReferences(), TYPO3\CMS\Core\Database\SoftReferenceIndex\findRef_images(), TYPO3\CMS\Core\Database\SoftReferenceIndex\findRef_TStemplate(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getAbsolutePath(), TYPO3\CMS\Rtehtmlarea\RteHtmlAreaBase\getContentCssFileName(), TYPO3\CMS\Extensionmanager\Utility\ConfigurationUtility\getDefaultConfigurationRawString(), TYPO3\CMS\Backend\Utility\BackendUtility\getFlexFormDS(), TYPO3\CMS\Backend\Template\DocumentTemplate\getHtmlTemplate(), TYPO3\CMS\Extensionmanager\ViewHelpers\ImageViewHelper\getImageUri(), TYPO3\CMS\Documentation\Service\DocumentationService\getLocalExtensions(), TYPO3\CMS\Documentation\Service\DocumentationService\getOfficialDocuments(), TYPO3\CMS\Core\Localization\Parser\LocallangXmlParser\getParsedData(), TYPO3\CMS\Core\Localization\Parser\AbstractXmlParser\getParsedData(), TYPO3\CMS\Backend\Utility\BackendUtility\getRegisteredFlexForms(), TYPO3\CMS\Core\Page\PageRenderer\getTemplateForPart(), TYPO3\CMS\Dbal\Database\DatabaseConnection\handler_init(), TYPO3\CMS\Core\Tests\Functional\DataHandling\AbstractDataHandlerActionTestCase\importScenarioDataSet(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\includeDirectory(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\includeFile(), TYPO3\CMS\IndexedSearch\Indexer\indexRegularDocument(), TYPO3\CMS\Backend\Controller\Wizard\ColorpickerController\init(), TYPO3\CMS\Core\Charset\CharsetConverter\initCaseFolding(), TYPO3\CMS\Core\Charset\CharsetConverter\initCharset(), TYPO3\CMS\Core\Core\CliBootstrap\initializeCliKeyOrDie(), TYPO3\CMS\Install\Controller\Action\AbstractAction\initializeHandle(), TYPO3\CMS\Core\Charset\CharsetConverter\initToASCII(), TYPO3\CMS\Core\Charset\CharsetConverter\initUnicodeData(), TYPO3\CMS\Core\Localization\Parser\LocallangArrayParser\isWithinWebRoot(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\jumpUrl(), TYPO3\CMS\Core\Page\PageRenderer\loadRequireJs(), TYPO3\CMS\Core\Localization\LocalizationFactory\localizationOverride(), TYPO3\CMS\Lowlevel\DoubleFilesCommand\main_autoFix(), TYPO3\CMS\Lowlevel\RteImagesCommand\main_autoFix(), TYPO3\CMS\Lowlevel\LostFilesCommand\main_autoFix(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\make_seeAlso(), TYPO3\CMS\Backend\Controller\LoginController\makeLoginBoxImage(), TYPO3\CMS\IndexedSearch\Controller\SearchController\makeRating(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\pageErrorHandler(), TYPO3\CMS\Backend\Form\FormEngine\previewFieldValue(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\printImage(), TYPO3\CMS\Impexp\ImportExport\processSoftReferences_saveFile(), TYPO3\CMS\Impexp\ImportExport\processSoftReferences_saveFile_createRelFile(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\processTemplateRowBeforeSaving(), TYPO3\CMS\Fluid\ViewHelpers\Uri\ResourceViewHelper\render(), TYPO3\CMS\CssStyledContent\Controller\CssStyledContentController\render_uploads(), TYPO3\CMS\Backend\Form\FormEngine\renderWizards(), TYPO3\CMS\Fluid\View\TemplateView\resolveFileNamePath(), TYPO3\CMS\Workspaces\Service\AdditionalResourceService\resolvePath(), TYPO3\CMS\Core\Resource\ResourceFactory\retrieveFileOrFolderObject(), TYPO3\CMS\Core\Localization\LanguageStore\setConfiguration(), TYPO3\CMS\Frontend\ContentObject\FluidTemplateContentObject\setLayoutRootPath(), TYPO3\CMS\Core\Log\Writer\FileWriter\setLogFile(), TYPO3\CMS\Frontend\ContentObject\FluidTemplateContentObject\setPartialRootPath(), TYPO3\CMS\Core\Database\SoftReferenceIndex\setTypoLinkPartsElement(), TYPO3\CMS\Documentation\Service\DocumentationService\unzipDocumentPackage(), TYPO3\CMS\Lang\Utility\Connection\Ter\unzipTranslationFile(), TYPO3\CMS\Lang\Utility\Connection\Ter\updateTranslation(), and TYPO3\CMS\Impexp\ImportExport\writeFileVerify().

◆ getFilesInDir()

static TYPO3\CMS\Core\Utility\GeneralUtility::getFilesInDir	(	$path,
		$extensionList = `''`,
		$prependPath = `FALSE`,
		$order = `''`,
		$excludePattern = `''`
	)

static

Finds all files in a given path and returns them as an array. Each array key is a md5 hash of the full path to the file. This is done because 'some' extensions like the import/export extension depend on this.

Parameters

string	$path	The path to retrieve the files from.
string	$extensionList	A comma-separated list of file extensions. Only files of the specified types will be retrieved. When left blank, files of any type will be retrieved.
boolean	$prependPath	If TRUE, the full path to the file is returned. If FALSE only the file name is returned.
string	$order	The sorting order. The default sorting order is alphabetical. Setting $order to 'mtime' will sort the files by modification time.
string	$excludePattern	A regular expression pattern of file names to exclude. For example: 'clear.gif' or '(clear.gif\|.htaccess)'. The pattern will be wrapped with: '/^' and '$/'.

Returns: array|string Array of the files found, or an error message in case the path could not be opened.

Definition at line 3023 of file GeneralUtility.php.

◆ getHostname()

static TYPO3\CMS\Core\Utility\GeneralUtility::getHostname ( $requestHost = TRUE )

static

Get the fully-qualified domain name of the host.

Parameters

boolean $requestHost Use request host (when not in CLI mode).

Returns: string The fully-qualified host name.

Definition at line 3784 of file GeneralUtility.php.

References $host.

◆ getImplementationForClass()

static TYPO3\CMS\Core\Utility\GeneralUtility::getImplementationForClass ( $className )

staticprotected

Returns the configured implementation of the class

Parameters

string $className

Returns: string

Definition at line 4528 of file GeneralUtility.php.

References $GLOBALS.

◆ getIndpEnv()

static TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv ( $getEnvName )

static

Abstraction method which returns System Environment Variables regardless of server OS, CGI/MODULE version etc. Basically this is SERVER variables for most of them. This should be used instead of getEnv() and $_SERVER/ENV_VARS to get reliable values for all situations.

Parameters

string $getEnvName Name of the "environment variable"/"server variable" you wish to use. Valid values are SCRIPT_NAME, SCRIPT_FILENAME, REQUEST_URI, PATH_INFO, REMOTE_ADDR, REMOTE_HOST, HTTP_REFERER, HTTP_HOST, HTTP_USER_AGENT, HTTP_ACCEPT_LANGUAGE, QUERY_STRING, TYPO3_DOCUMENT_ROOT, TYPO3_HOST_ONLY, TYPO3_HOST_ONLY, TYPO3_REQUEST_HOST, TYPO3_REQUEST_URL, TYPO3_REQUEST_SCRIPT, TYPO3_REQUEST_DIR, TYPO3_SITE_URL, _ARRAY

Returns: string Value based on the input key, independent of server/os environment.

Exceptions

Definition at line 3368 of file GeneralUtility.php.

References $GLOBALS, $host, TYPO3\CMS\Core\Utility\GeneralUtility\dirname(), if, TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix(), and TYPO3\CMS\Core\Utility\GeneralUtility\strtolower().

◆ getMaximumPathLength()

static TYPO3\CMS\Core\Utility\GeneralUtility::getMaximumPathLength ( )

static

Retrieves the maximum path length that is valid in the current environment.

Returns: integer The maximum available path length

Definition at line 3232 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend\setCache().

◆ getMaxUploadFileSize()

static TYPO3\CMS\Core\Utility\GeneralUtility::getMaxUploadFileSize ( $localLimit = 0 )

static

Returns the maximum upload size for a file that is allowed. Measured in KB. This might be handy to find out the real upload limit that is possible for this TYPO3 installation. The first parameter can be used to set something that overrides the maxFileSize, usually for the TCA values.

Parameters

integer $localLimit the number of Kilobytes (!) that should be used as

Returns: integer The maximum size of uploads that are allowed (measured in kilobytes)

Definition at line 3193 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\assureFileUploadPermissions(), and TYPO3\CMS\Filelist\Controller\FileListController\menuConfig().

◆ getRandomHexString()

static TYPO3\CMS\Core\Utility\GeneralUtility::getRandomHexString ( $count )

static

Returns a hex representation of a random byte string.

Parameters

integer $count Number of hex characters to return

Returns: string Random Bytes

Definition at line 1326 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\createSessionId(), TYPO3\CMS\Install\Service\SilentConfigurationUpgradeService\generateEncryptionKeyIfNeeded(), TYPO3\CMS\Core\Database\PreparedStatement\generateParameterWrapToken(), and TYPO3\CMS\Openid\OpenidService\getUser().

◆ getRedirectUrlFromHttpHeaders()

static TYPO3\CMS\Core\Utility\GeneralUtility::getRedirectUrlFromHttpHeaders ( $content )

staticprotected

Parses HTTP headers and returns the content of the "Location" header or the empty string if no such header found.

Parameters

string $content

Returns: string

Definition at line 2667 of file GeneralUtility.php.

References $result.

◆ getSingletonInstances()

static TYPO3\CMS\Core\Utility\GeneralUtility::getSingletonInstances ( )

static

Get all currently registered singletons

Warning: This is NOT a public API method and must not be used in own extensions! This method is usually only used in tests in setUp() to fetch the list of currently registered singletons, if this list is manipulated with setSingletonInstance() in tests.

Definition at line 4632 of file GeneralUtility.php.

◆ getThisUrl()

static TYPO3\CMS\Core\Utility\GeneralUtility::getThisUrl ( )

static

Returns the HOST+DIR-PATH of the current script (The URL, but without 'http://' and without script-filename)

Returns: string

Definition at line 3308 of file GeneralUtility.php.

◆ getUrl()

static TYPO3\CMS\Core\Utility\GeneralUtility::getUrl	(		$url,
			$includeHeader = `0`,
			$requestHeaders = `FALSE`,
		&	$report = `NULL`
	)

static

Reads the file or url $url and returns the content If you are having trouble with proxys when reading URLs you can configure your way out of that with settings like $GLOBALS['TYPO3_CONF_VARS']['SYS']['curlUse'] etc.

Parameters

string	$url	File/URL to read
integer	$includeHeader	Whether the HTTP header should be fetched or not. 0=disable, 1=fetch header+content, 2=fetch header only
array	$requestHeaders	HTTP headers to be used in the request
array	$report	Error code/message and, if $includeHeader is 1, response meta data (HTTP status and content type)

Returns: mixed The content from the resource given as input. FALSE if an error has occurred.

Definition at line 2461 of file GeneralUtility.php.

References $GLOBALS.

◆ getUserObj()

static TYPO3\CMS\Core\Utility\GeneralUtility::getUserObj	(	$classRef,
		$checkPrefix = `''`,
		$silent = `FALSE`
	)

static

Creates and returns reference to a user defined object. This function can return an object reference if you like. Just prefix the function call with "&": "$objRef = &\TYPO3\CMS\Core\Utility\GeneralUtility::getUserObj('EXT:myext/class.tx_myext_myclass.php:&tx_myext_myclass');". This will work ONLY if you prefix the class name with "&" as well. See description of function arguments.

: Deprecate the whole method in several steps: 1. Deprecated singleton pattern, 2. Deprecate file prefix/ require file, 3. Deprecate usage without valid class name. The last step should be to deprecate the method itslef.

Parameters

string	$classRef	Class reference, '[file-reference":"]["&"]class-name'. You can prefix the class name with "[file-reference]:" and ::getFileAbsFileName() will then be used to resolve the filename and subsequently include it by "require_once()" which means you don't have to worry about including the class file either! Example: "EXT:realurl/class.tx_realurl.php:&tx_realurl". Finally; for the class name you can prefix it with "&" and you will reuse the previous instance of the object identified by the full reference string (meaning; if you ask for the same $classRef later in another place in the code you will get a reference to the first created one!).
string	$checkPrefix	Not used anymore since 6.0
boolean	$silent	Not used anymore since 6.0

Returns: object The instance of the class asked for. Instance is created with ::makeInstance

See also: callUserFunction()

Definition at line 4378 of file GeneralUtility.php.

References $GLOBALS.

◆ gif_compress()

static TYPO3\CMS\Core\Utility\GeneralUtility::gif_compress	(	$theFile,
		$type
	)

static

Compressing a GIF file if not already LZW compressed. This function is a workaround for the fact that ImageMagick and/or GD does not compress GIF-files to their minimun size (that is RLE or no compression used)

The function takes a file-reference, $theFile, and saves it again through GD or ImageMagick in order to compress the file GIF: If $type is not set, the compression is done with ImageMagick (provided that $GLOBALS['TYPO3_CONF_VARS']['GFX']['im_path_lzw'] is pointing to the path of a lzw-enabled version of 'convert') else with GD (should be RLE-enabled!) If $type is set to either 'IM' or 'GD' the compression is done with ImageMagick and GD respectively PNG: No changes.

$theFile is expected to be a valid GIF-file! The function returns a code for the operation.

Parameters

string	$theFile	Filepath
string	$type	See description of function

Returns: string Returns "GD" if GD was used, otherwise "IM" if ImageMagick was used. If nothing done at all, it returns empty string.

Definition at line 276 of file GeneralUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\dirname(), TYPO3\CMS\Core\Utility\CommandUtility\exec(), and TYPO3\CMS\Core\Utility\GeneralUtility\strtolower().

Referenced by TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\getSenderEmailName(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\imageMagickConvert(), TYPO3\CMS\Backend\Utility\IconUtility\makeIcon(), and TYPO3\CMS\Core\Imaging\GraphicalFunctions\output().

◆ hideIfDefaultLanguage()

static TYPO3\CMS\Core\Utility\GeneralUtility::hideIfDefaultLanguage ( $localizationConfiguration )

static

Returns true if the "l18n_cfg" field value is not set to hide pages in the default language

Parameters

integer $localizationConfiguration

Returns: boolean

Definition at line 4119 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\filterMenuPages(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\isSubMenu(), TYPO3\CMS\Frontend\Controller\TranslationStatusController\renderL10nTable(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\settingLanguage(), and TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\start().

◆ hideIfNotTranslated()

static TYPO3\CMS\Core\Utility\GeneralUtility::hideIfNotTranslated ( $l18n_cfg_fieldValue )

static

Responds on input localization setting value whether the page it comes from should be hidden if no translation exists or not.

Parameters

integer $l18n_cfg_fieldValue Value from "l18n_cfg" field of a page record

Returns: boolean TRUE if the page should be hidden

Definition at line 4104 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\filterMenuPages(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\isSubMenu(), TYPO3\CMS\Frontend\Controller\TranslationStatusController\renderL10nTable(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\settingLanguage(), and TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\start().

◆ hmac()

static TYPO3\CMS\Core\Utility\GeneralUtility::hmac	(	$input,
		$additionalSecret = `''`
	)

static

Returns a proper HMAC on a given input string and secret TYPO3 encryption key.

Parameters

string	$input	Input string to create HMAC from
string	$additionalSecret	additionalSecret to prevent hmac beeing used in a different context

Returns: string resulting (hexadecimal) HMAC currently with a length of 40 (HMAC-SHA-1)

Definition at line 828 of file GeneralUtility.php.

References $GLOBALS.

◆ htmlspecialchars_decode()

static TYPO3\CMS\Core\Utility\GeneralUtility::htmlspecialchars_decode ( $value )

static

Inverse version of htmlspecialchars()

Deprecated:: since 6.2 replaced by php native htmlspecialchars_decode()

Parameters

string $value Value where >, <, " and & should be converted to regular chars.

Returns: string Converted result.

Definition at line 1037 of file GeneralUtility.php.

◆ idnaEncode()

static TYPO3\CMS\Core\Utility\GeneralUtility::idnaEncode ( $value )

static

Returns an ASCII string (punicode) representation of $value

Parameters

string $value

Returns: string An ASCII encoded (punicode) string

Definition at line 1307 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_input_Eval(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\TCAlookup().

◆ imageMagickCommand()

static TYPO3\CMS\Core\Utility\GeneralUtility::imageMagickCommand	(	$command,
		$parameters,
		$path = `''`
	)

static

Compile the command for running ImageMagick/GraphicsMagick.

Parameters

string	$command	Command to be run: identify, convert or combine/composite
string	$parameters	The parameters string
string	$path	Override the default path (e.g. used by the install tool)

Returns: string Compiled command that deals with IM6 & GraphicsMagick

Definition at line 5293 of file GeneralUtility.php.

References $parameters.

Referenced by TYPO3\CMS\Core\Imaging\GraphicalFunctions\combineExec(), TYPO3\CMS\Core\Resource\Processing\LocalPreviewHelper\generatePreviewFromFile(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\imageMagickExec(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\imageMagickIdentify(), and TYPO3\CMS\Backend\View\ThumbnailView\main().

◆ implodeArrayForUrl()

static TYPO3\CMS\Core\Utility\GeneralUtility::implodeArrayForUrl	(		$name,
		array	$theArray,
			$str = `''`,
			$skipBlank = `FALSE`,
			$rawurlencodeParamName = `FALSE`
	)

static

Implodes a multidim-array into GET-parameters (eg. &param[key][key2]=value2&param[key][key3]=value3)

Parameters

string	$name	Name prefix for entries. Set to blank if you wish none.
array	$theArray	The (multidimensional) array to implode
string	$str	(keep blank)
boolean	$skipBlank	If set, parameters which were blank strings would be removed.
boolean	$rawurlencodeParamName	If set, the param name itself (for example "param[key][key2]") would be rawurlencoded as well.

Returns: string Imploded result, fx. &param[key][key2]=value2&param[key][key3]=value3

See also: explodeUrl2Array()

Definition at line 1634 of file GeneralUtility.php.

◆ implodeAttributes()

static TYPO3\CMS\Core\Utility\GeneralUtility::implodeAttributes	(	array	$arr,
			$xhtmlSafe = `FALSE`,
			$dontOmitBlankAttribs = `FALSE`
	)

static

Implodes attributes in the array $arr for an attribute list in eg. and HTML tag (with quotes)

Parameters

array	$arr	Array with attribute key/value pairs, eg. "bgcolor"=>"red", "border"=>0
boolean	$xhtmlSafe	If set the resulting attribute list will have a) all attributes in lowercase (and duplicates weeded out, first entry taking precedence) and b) all values htmlspecialchar()'ed. It is recommended to use this switch!
boolean	$dontOmitBlankAttribs	If TRUE, don't check if values are blank. Default is to omit attributes with blank values.

Returns: string Imploded attributes, eg. 'bgcolor="red" border="0"'

Definition at line 1961 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\addParams(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\encaps_lineSplit(), TYPO3\CMS\Rtehtmlarea\BrowseLinks\getBodyTagAdditions(), TYPO3\CMS\Rtehtmlarea\Controller\CustomAttributeController\render_clickenlarge(), TYPO3\CMS\CssStyledContent\Controller\CssStyledContentController\render_table(), TYPO3\CMS\CssStyledContent\Controller\CssStyledContentController\render_uploads(), TYPO3\CMS\Frontend\Page\PageGenerator\renderContent(), TYPO3\CMS\Rtehtmlarea\Controller\ImageRenderingController\renderImageAttributes(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\setATagParts(), TYPO3\CMS\Core\Html\RteHtmlParser\transformStyledATags(), TYPO3\CMS\Core\Html\RteHtmlParser\TS_AtagToAbs(), TYPO3\CMS\Core\Html\RteHtmlParser\TS_images_rte(), TYPO3\CMS\Core\Html\RteHtmlParser\TS_links_db(), and TYPO3\CMS\Core\Html\RteHtmlParser\TS_reglinks().

◆ inArray()

static TYPO3\CMS\Core\Utility\GeneralUtility::inArray	(	array	$in_array,
			$item
	)

static

Check if an string item exists in an array. Please note that the order of function parameters is reverse compared to the PHP function in_array()!!!

Parameters

array	$in_array	One-dimensional array of items
string	$item	Item to check for

Returns: boolean TRUE if $item is in the one-dimensional array $in_array

Definition at line 1451 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Utility\BackendUtility\blindGroupNames(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\filterMenuPages(), TYPO3\CMS\Frontend\ContentObject\Menu\JavaScriptMenuContentObject\generate_level(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\inArrayChecksStringExistenceWithinArray().

◆ initSysLog()

static TYPO3\CMS\Core\Utility\GeneralUtility::initSysLog ( )

static

Initialize the system log.

Returns: void

See also: sysLog()

Definition at line 5052 of file GeneralUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\forceIntegerInRange(), TYPO3\CMS\Core\Utility\MailUtility\getSystemFrom(), and TYPO3\CMS\Core\Utility\GeneralUtility\strtoupper().

◆ inList()

static TYPO3\CMS\Core\Utility\GeneralUtility::inList	(	$list,
		$item
	)

static

Check for item in list Check if an item exists in a comma-separated list of items.

Parameters

string	$list	Comma-separated list of items (string)
string	$item	Item to check for

Returns: boolean TRUE if $item is in $list

Definition at line 719 of file GeneralUtility.php.

◆ instantiateClass()

static TYPO3\CMS\Core\Utility\GeneralUtility::instantiateClass	(	$className,
		$arguments
	)

staticprotected

Speed optimized alternative to ReflectionClass::newInstanceArgs()

Parameters

string	$className	Name of the class to instantiate
array	$arguments	Arguments passed to self::makeInstance() thus the first one with index 0 holds the requested class name

Returns: mixed

Definition at line 4465 of file GeneralUtility.php.

◆ int_from_ver()

static TYPO3\CMS\Core\Utility\GeneralUtility::int_from_ver ( $verNumberStr )

static

Returns an integer from a three part version number, eg '4.12.3' -> 4012003

Parameters

string $verNumberStr Version number on format x.x.x

Returns: integer Integer version of version number (where each part can count to 999)

Deprecated:: Use VersionNumberUtility::convertVersionNumberToInteger instead, will be removed after 6.2

Definition at line 778 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\VersionNumberUtility\convertVersionNumberToInteger().

◆ intExplode()

static TYPO3\CMS\Core\Utility\GeneralUtility::intExplode	(	$delimiter,
		$string,
		$removeEmptyValues = `FALSE`,
		$limit = `0`
	)

static

Explodes a $string delimited by $delim and casts each item in the array to (int). Corresponds to ::trimExplode(), but with conversion to integers for all values.

Parameters

string	$delimiter	Delimiter string to explode with
string	$string	The string to explode
boolean	$removeEmptyValues	If set, all empty values (='') will NOT be set in output
integer	$limit	If positive, the result will contain a maximum of limit elements,

Returns: array Exploded values, all converted to integers

Definition at line 1470 of file GeneralUtility.php.

References $result.

◆ IPv6Bin2Hex()

static TYPO3\CMS\Core\Utility\GeneralUtility::IPv6Bin2Hex ( $bin )

static

Transform an IPv6 address from binary to hex-representation

Parameters

string $bin IPv6 address in hex-presentation

Returns: string Binary representation (16 characters, 128 characters)

See also: IPv6Hex2Bin()

Definition at line 520 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\IPv6Bin2HexCorrectlyConvertsAddresses().

◆ IPv6Hex2Bin()

static TYPO3\CMS\Core\Utility\GeneralUtility::IPv6Hex2Bin ( $hex )

static

Transform a regular IPv6 address from hex-representation into binary

Parameters

string $hex IPv6 address in hex-presentation

Returns: string Binary representation (16 characters, 128 characters)

See also: IPv6Bin2Hex()

Definition at line 509 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\IPv6Hex2BinCorrectlyConvertsAddresses().

◆ isAbsPath()

static TYPO3\CMS\Core\Utility\GeneralUtility::isAbsPath ( $path )

static

Checks if the $path is absolute or relative (detecting either '/' or 'x:/' as first part of string) and returns TRUE if so.

Parameters

string $path File path to evaluate

Returns: boolean

Definition at line 3885 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\clean_directory(), TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\crawler_execute_type2(), TYPO3\CMS\Backend\Template\DocumentTemplate\getHtmlTemplate(), TYPO3\CMS\Backend\Toolbar\ShortcutToolbarItem\getShortcutIcon(), TYPO3\CMS\IndexedSearch\Indexer\indexRegularDocument(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\loadNewTcaColumnsConfigFiles(), and TYPO3\CMS\Core\Imaging\GraphicalFunctions\prependAbsolutePath().

◆ isAllowedAbsPath()

static TYPO3\CMS\Core\Utility\GeneralUtility::isAllowedAbsPath ( $path )

static

Returns TRUE if the path is absolute, without backpath '..' and within the PATH_site OR within the lockRootPath

Parameters

string $path File path to evaluate

Returns: boolean

Definition at line 3895 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Locking\Locker\__destruct(), TYPO3\CMS\Frontend\Controller\DataSubmissionController\__destruct(), TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\crawler_execute_type2(), TYPO3\CMS\IndexedSearch\Indexer\extractLinks(), TYPO3\CMS\Backend\Template\DocumentTemplate\getHtmlTemplate(), TYPO3\CMS\Core\Utility\PathUtility\getRelativePath(), TYPO3\CMS\Extensionmanager\Utility\InstallUtility\importInitialFiles(), TYPO3\CMS\IndexedSearch\Indexer\indexRegularDocument(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\jumpUrl(), and TYPO3\CMS\Core\Locking\Locker\release().

◆ isAllowedHostHeaderValue()

static TYPO3\CMS\Core\Utility\GeneralUtility::isAllowedHostHeaderValue ( $hostHeaderValue )

static

Checks if the provided host header value matches the trusted hosts pattern. If the pattern is not defined (which only can happen early in the bootstrap), deny any value.

Parameters

string $hostHeaderValue HTTP_HOST header value as sent during the request (may include port)

Returns: bool

Definition at line 3658 of file GeneralUtility.php.

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

◆ isBrokenEmailEnvironment()

static TYPO3\CMS\Core\Utility\GeneralUtility::isBrokenEmailEnvironment ( )

static

Checks if current e-mail sending method does not accept recipient/sender name in a call to PHP mail() function. Windows version of mail() and mini_sendmail program are known not to process such input correctly and they cause SMTP errors. This function will return TRUE if current mail sending method has problem with recipient name in recipient/sender argument for mail().

TODO: 4.3 should have additional configuration variable, which is combined by || with the rest in this function.

Returns: boolean TRUE if mail() does not accept recipient name

Definition at line 1140 of file GeneralUtility.php.

◆ isFirstPartOfStr()

static TYPO3\CMS\Core\Utility\GeneralUtility::isFirstPartOfStr	(	$str,
		$partStr
	)

static

Returns TRUE if the first part of $str matches the string $partStr

Parameters

string	$str	Full string to check
string	$partStr	Reference string which must be found as the "first part" of the full string

Returns: boolean TRUE if $partStr was found to be equal to the first part of $str

Definition at line 956 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Locking\Locker\__destruct(), TYPO3\CMS\Frontend\Controller\DataSubmissionController\__destruct(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\_parseFunc(), TYPO3\CMS\SysAction\ActionTask\action_getUserMainDir(), TYPO3\CMS\Backend\View\BackendLayoutView\addColPosListLayoutItems(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\addFile(), TYPO3\CMS\Core\DataHandling\DataHandler\applyFiltersToValues(), TYPO3\CMS\Extensionmanager\Domain\Repository\ConfigurationItemRepository\buildConfigurationArray(), TYPO3\CMS\Core\Resource\ResourceCompressor\checkBaseDirectory(), TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\checkDeniedSuburls(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\checkIncludeLines(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\checkPathAgainstMounts(), TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\checkUrl(), TYPO3\CMS\Core\DataHandling\DataHandler\clear_cacheCmd(), TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler\collectTcaSpriteIcons(), TYPO3\CMS\Dbal\Database\SqlParser\compileWhereClause(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_fixRTEmagicImages(), TYPO3\CMS\Core\Database\ReferenceIndex\createEntryData_fileRels(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\createGlossaryIndex(), TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\createTempSubDir(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\determineBaseUrl(), TYPO3\CMS\Impexp\ImportExport\export_addFile(), TYPO3\CMS\Documentation\Service\DocumentationService\fetchNearestDocument(), TYPO3\CMS\Linkvalidator\Linktype\FileLinktype\fetchType(), TYPO3\CMS\Linkvalidator\Linktype\LinkHandler\fetchType(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\filelist(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\findFirstWebFolder(), TYPO3\CMS\Core\Database\SoftReferenceIndex\findRef_images(), TYPO3\CMS\Core\Database\SoftReferenceIndex\findRef_TStemplate(), TYPO3\CMS\Impexp\ImportExport\fixFileIDsInRelations(), TYPO3\CMS\Core\TypoScript\TemplateService\getFileName(), TYPO3\CMS\Core\Resource\ResourceFactory\getFolderObjectFromCombinedIdentifier(), TYPO3\CMS\Backend\Template\DocumentTemplate\getHtmlTemplate(), TYPO3\CMS\Extensionmanager\Utility\ListUtility\getInstallTypeForPackage(), TYPO3\CMS\Documentation\Domain\Repository\DocumentRepository\getMetadata(), TYPO3\CMS\Backend\Utility\BackendUtility\getPathType_web_nonweb(), TYPO3\CMS\Core\Utility\MailUtility\getSystemFromAddress(), TYPO3\CMS\Recordlist\Browser\ElementBrowser\initCurrentUrl(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\is_webpath(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConfigurationComplete(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\isFirstPartOfStrReturnsFalseForNotMatchingFirstPart(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\isFirstPartOfStrReturnsTrueForMatchingFirstPart(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\isInCurrentDomain(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\isInLocalDomain(), TYPO3\CMS\Backend\Form\FormEngine\isNewRecord(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\isRelativeUrl(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\isValidExtensionPath(), TYPO3\CMS\Core\Configuration\ConfigurationManager\isValidLocalConfigurationPath(), TYPO3\CMS\Recordlist\Browser\ElementBrowser\isWebFolder(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\isWithin(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\jumpUrl(), TYPO3\CMS\Lowlevel\DoubleFilesCommand\main(), TYPO3\CMS\Lowlevel\RteImagesCommand\main(), TYPO3\CMS\Lowlevel\LostFilesCommand\main(), TYPO3\CMS\Lowlevel\RteImagesCommand\main_autoFix(), TYPO3\CMS\Saltedpasswords\Tests\Unit\Evaluation\EvaluatorTest\md5HashIsUpdatedToTemporarySaltedString(), TYPO3\CMS\Install\Service\SilentConfigurationUpgradeService\migrateOldInstallWizardDoneSettingsToNewClassNames(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord_processFieldValue(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\pageErrorHandler(), TYPO3\CMS\Recordlist\Browser\ElementBrowser\parseCurUrl(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\parseSub(), TYPO3\CMS\Impexp\ImportExport\processSoftReferences_saveFile(), TYPO3\CMS\Impexp\ImportExport\processSoftReferences_saveFile_createRelFile(), TYPO3\CMS\Backend\Utility\BackendUtility\referenceCount(), TYPO3\CMS\Core\Locking\Locker\release(), TYPO3\CMS\Rtehtmlarea\Controller\AccessibilityLinkController\removeAccessibilityIcon(), TYPO3\CMS\Rtehtmlarea\Controller\CustomAttributeController\render_clickenlarge(), TYPO3\CMS\Cshmanual\Controller\HelpModuleController\render_TOC(), TYPO3\CMS\CssStyledContent\Controller\CssStyledContentController\render_uploads(), TYPO3\CMS\Backend\Form\FormEngine\renderWizards(), TYPO3\CMS\Core\Resource\ResourceFactory\retrieveFileOrFolderObject(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\set_no_cache(), TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend\setCacheDirectory(), TYPO3\CMS\Core\Database\SoftReferenceIndex\setTypoLinkPartsElement(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\TCAlookup(), TYPO3\CMS\Core\Html\RteHtmlParser\TS_links_rte(), TYPO3\CMS\Impexp\ImportExport\unlinkTempFiles(), and TYPO3\CMS\Impexp\ImportExport\verifyFolderAccess().

◆ isInternalRequestType()

static TYPO3\CMS\Core\Utility\GeneralUtility::isInternalRequestType ( )

staticprotected

Allows internal requests to the install tool and from the command line. We accept this risk to have the install tool always available. Also CLI needs to be allowed as unfortunately AbstractUserAuthentication::getAuthInfoArray() accesses HTTP_HOST without reason on CLI

Returns: bool

Definition at line 3701 of file GeneralUtility.php.

◆ isOnCurrentHost()

static TYPO3\CMS\Core\Utility\GeneralUtility::isOnCurrentHost ( $url )

static

Checks if a given URL matches the host that currently handles this HTTP request. Scheme, hostname and (optional) port of the given URL are compared.

Parameters

string $url URL to compare with the TYPO3 request host

Returns: boolean Whether the URL matches the TYPO3 request host

Definition at line 707 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\isOnCurrentHostReturnsTrueWithCurrentHost().

◆ isRunningOnCgiServerApi()

static TYPO3\CMS\Core\Utility\GeneralUtility::isRunningOnCgiServerApi ( )

static

Check if the current request is running on a CGI server API

Returns: bool

Definition at line 5423 of file GeneralUtility.php.

◆ isValidUrl()

static TYPO3\CMS\Core\Utility\GeneralUtility::isValidUrl ( $url )

static

Checks if a given string is a Uniform Resource Locator (URL).

On seriously malformed URLs, parse_url may return FALSE and emit an E_WARNING.

filter_var() requires a scheme to be present.

http://www.faqs.org/rfcs/rfc2396.html Scheme names consist of a sequence of characters beginning with a lower case letter and followed by any combination of lower case letters, digits, plus ("+"), period ("."), or hyphen ("-"). For resiliency, programs interpreting URI should treat upper case letters as equivalent to lower case in scheme names (e.g., allow "HTTP" as well as "http"). scheme = alpha *( alpha | digit | "+" | "-" | "." )

Convert the domain part to punicode if it does not look like a regular domain name. Only the domain part because RFC3986 specifies the the rest of the url may not contain special characters: http://tools.ietf.org/html/rfc3986#appendix-A

Parameters

string $url The URL to be validated

Returns: boolean Whether the given URL is valid

Definition at line 1401 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\HttpUtility\buildUrl().

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\determineBaseUrl(), TYPO3\CMS\Core\Resource\ResourceStorage\getPublicUrl(), TYPO3\CMS\Core\Tests\Unit\Resource\Driver\LocalDriverTest\getPublicUrlReturnsValidUrlContainingSpecialCharacters(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\isInLocalDomain(), TYPO3\CMS\Frontend\ContentObject\MediaContentObject\render(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validURLReturnsFalseForInvalidRessoure(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validURLReturnsTrueForValidResource().

◆ keepItemsInArray()

static TYPO3\CMS\Core\Utility\GeneralUtility::keepItemsInArray	(	array	$array,
			$keepItems,
			$getValueFunc = `NULL`
	)

static

Filters an array to reduce its elements to match the condition. The values in $keepItems can be optionally evaluated by a custom callback function.

Example (arguments used to call this function): $array = array( array('aa' => array('first', 'second'), array('bb' => array('third', 'fourth'), array('cc' => array('fifth', 'sixth'), ); $keepItems = array('third'); $getValueFunc = create_function('$value', 'return $value[0];');

Returns: array( array('bb' => array('third', 'fourth'), )

Parameters

array	$array	The initial array to be filtered/reduced
mixed	$keepItems	The items which are allowed/kept in the array - accepts array or csv string
string	$getValueFunc	(optional) Callback function used to get the value to keep

Returns: array The filtered/reduced array with the kept items

Definition at line 1599 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Form\Element\InlineElement\getPossibleRecords(), TYPO3\CMS\Backend\Form\FormEngine\getSelectItems(), TYPO3\CMS\Backend\Form\FormEngine\getSingleField_typeSelect_multiple(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\keepItemsInArrayCanUseCallbackOnSearchArray(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\keepItemsInArrayCanUseClosure(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\keepItemsInArrayWorksWithOneArgument(), and TYPO3\CMS\Backend\Form\FlexFormsHelper\modifySingleFlexFormSheet().

◆ lcfirst()

static TYPO3\CMS\Core\Utility\GeneralUtility::lcfirst ( $string )

static

Converts the first char of a string to lowercase if it is a latin character (A-Z). Example: Converts "Hello World" to "hello World"

Parameters

string $string The string to be used to lowercase the first character

Returns: string The string with the first character as lowercase

Definition at line 1373 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\lcFirst().

◆ linkThisScript()

static TYPO3\CMS\Core\Utility\GeneralUtility::linkThisScript ( array $getParams = array() )

static

Returns the link-url to the current script. In $getParams you can set associative keys corresponding to the GET-vars you wish to add to the URL. If you set them empty, they will remove existing GET-vars from the current URL. REMEMBER to always use htmlspecialchars() for content in href-properties to get ampersands converted to entities (XHTML requirement and XSS precaution)

Parameters

array $getParams Array of GET parameters to include

Returns: string

Definition at line 3325 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\TypoScript\ConfigurationForm\ext_getForm(), TYPO3\CMS\Backend\Controller\NewRecordController\getButtons(), TYPO3\CMS\Backend\Controller\Wizard\RteController\init(), TYPO3\CMS\Filelist\FileList\listURL(), TYPO3\CMS\ExtraPageCmOptions\ExtraPageContextMenuOptions\main(), TYPO3\CMS\Backend\Controller\ContentElement\MoveElementController\main(), TYPO3\CMS\Backend\Controller\PageTreeNavigationController\main(), TYPO3\CMS\Backend\Clipboard\Clipboard\printClipboard(), TYPO3\CMS\Backend\Template\DocumentTemplate\redirectUrls(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateModuleController\renderList(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\TBE_dragNDrop().

◆ linkThisUrl()

static TYPO3\CMS\Core\Utility\GeneralUtility::linkThisUrl	(		$url,
		array	$getParams = `array()`
	)

static

Takes a full URL, $url, possibly with a querystring and overlays the $getParams arrays values onto the quirystring, packs it all together and returns the URL again. So basically it adds the parameters in $getParams to an existing URL, $url

Parameters

string	$url	URL string
array	$getParams	Array of key/value pairs for get parameters to add/overrule with. Can be multidimensional.

Returns: string Output URL with added getParams.

Definition at line 3347 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Backend\Controller\File\FileUploadController\main(), TYPO3\CMS\Backend\Controller\File\RenameFileController\main(), and TYPO3\CMS\Backend\Controller\File\CreateFolderController\main().

◆ llXmlAutoFileName()

static TYPO3\CMS\Core\Utility\GeneralUtility::llXmlAutoFileName	(	$fileRef,
		$language,
		$sameLocation = `FALSE`
	)

static

Returns auto-filename for locallang localizations

Parameters

string	$fileRef	Absolute file reference to locallang file
string	$language	Language key
bool	$sameLocation	If TRUE, then locallang localization file name will be returned with same directory as $fileRef

Returns: string Returns the filename reference for the language unless error occurred in which case it will be NULL

Definition at line 4146 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Localization\Parser\LocallangXmlParser\getParsedData(), and TYPO3\CMS\Core\Localization\Parser\AbstractXmlParser\getParsedData().

◆ loadTCA()

static TYPO3\CMS\Core\Utility\GeneralUtility::loadTCA ( $table )

static

Loads the $GLOBALS['TCA'] (Table Configuration Array) for the $table

Requirements: 1) must be configured table (the ctrl-section configured), 2) columns must not be an array (which it is always if whole table loaded), and 3) there is a value for dynamicConfigFile (filename in typo3conf)

Parameters

string $table Table name for which to load the full TCA array part into $GLOBALS['TCA']

Returns: void

Deprecated:: since 6.1, will be removed two versions later

Definition at line 4198 of file GeneralUtility.php.

◆ locationHeaderUrl()

static TYPO3\CMS\Core\Utility\GeneralUtility::locationHeaderUrl ( $path )

static

Prefixes a URL used with 'header-location' with 'http://...' depending on whether it has it already.

If already having a scheme, nothing is prepended
If having REQUEST_URI slash '/', then prefixing 'http://[host]' (relative to host)
Otherwise prefixed with TYPO3_REQUEST_DIR (relative to current dir / TYPO3_REQUEST_DIR)

Parameters

string $path URL / path to prepend full URL addressing to.

Returns: string

Exceptions

Definition at line 3169 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\generateAndSendHash(), TYPO3\CMS\Frontend\View\AdminPanelView\getAdminPanelHeaderData(), TYPO3\CMS\Openid\OpenidService\getReturnURL(), TYPO3\CMS\Core\ExtDirect\ExtDirectApi\getRoutingUrl(), TYPO3\CMS\Core\Utility\HttpUtility\redirect(), and TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ logDeprecatedFunction()

static TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedFunction ( )

static

Logs a call to a deprecated function. The log message will be taken from the annotation.

Returns: void

Definition at line 5234 of file GeneralUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\DebugUtility\debugTrail(), and TYPO3\CMS\Core\Utility\PathUtility\stripPathSitePrefix().

◆ makeInstance()

static TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance ( $className )

static

Creates an instance of a class taking into account the class-extensions API of TYPO3. USE THIS method instead of the PHP "new" keyword. Eg. "$obj = new myclass;" should be "$obj = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance("myclass")" instead!

You can also pass arguments for a constructor: ::makeInstance('myClass', $arg1, $arg2, ..., $argN)

Exceptions

Definition at line 4424 of file GeneralUtility.php.

◆ makeInstanceService()

static TYPO3\CMS\Core\Utility\GeneralUtility::makeInstanceService	(	$serviceType,
		$serviceSubType = `''`,
		$excludeServiceKeys = `array()`
	)

static

Find the best service and check if it works. Returns object of the service class.

Parameters

string	$serviceType	Type of service (service key).
string	$serviceSubType	Sub type like file extensions or similar. Defined by the service.
mixed	$excludeServiceKeys	List of service keys which should be excluded in the search for a service. Array or comma list.

Returns: object The service object or an array with error info's.

Definition at line 4705 of file GeneralUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\array_merge(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\deactivateService(), die, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\findService(), and TYPO3\CMS\Core\Utility\DebugUtility\viewArray().

Referenced by TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\checkAuthentication(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\fetchGroupData(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\processLoginData().

◆ makeRedirectUrl()

static TYPO3\CMS\Core\Utility\GeneralUtility::makeRedirectUrl	(	$inUrl,
		$l = `0`,
		$index_script_url = `''`
	)

static

Sub-function for substUrlsInPlainText() above.

Parameters

string	$inUrl	Input URL
integer	$l	URL string length limit
string	$index_script_url	URL of "index script" - the prefix of the "?RDCT=..." parameter. If not supplied it will default to ::getIndpEnv('TYPO3_REQUEST_DIR').'index.php'

Returns: string Processed URL

Definition at line 5014 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Utility\GeneralUtility\substUrlsInPlainText().

◆ md5int()

static TYPO3\CMS\Core\Utility\GeneralUtility::md5int ( $str )

static

Makes a positive integer hash out of the first 7 chars from the md5 hash of the input

Parameters

string $str String to md5-hash

Returns: integer Returns 28bit integer-hash

Definition at line 806 of file GeneralUtility.php.

Referenced by TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\crawler_init(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\generateExpandCollapseParameter(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getBrowsableTree(), TYPO3\CMS\Core\TypoScript\TemplateService\getCurrentPageData(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getFolderTree(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getShortHashNumberForStorage(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\hashLockClause_getHashInt(), and TYPO3\CMS\Filelist\FileList\linkWrapDir().

◆ milliseconds()

static TYPO3\CMS\Core\Utility\GeneralUtility::milliseconds ( )

static

Gets the unixtime as milliseconds.

Returns: integer The unixtime as milliseconds

Definition at line 3710 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\combineImages(), TYPO3\CMS\IndexedSearch\Controller\SearchFormController\doSearch(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_DELETEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_INSERTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_SELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_TRUNCATEquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\exec_UPDATEquery(), TYPO3\CMS\Lowlevel\CleanerCommand\genTree(), TYPO3\CMS\Lowlevel\CleanerCommand\genTree_traverse(), TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\getSenderEmailName(), TYPO3\CMS\IndexedSearch\Indexer\indexRegularDocument(), TYPO3\CMS\IndexedSearch\Indexer\indexTypo3PageContent(), TYPO3\CMS\Core\Core\SystemEnvironmentBuilder\initializeGlobalTimeTrackingVariables(), TYPO3\CMS\Lowlevel\OrphanRecordsCommand\main(), TYPO3\CMS\Dbal\Database\DatabaseConnection\precompileSELECTquery(), TYPO3\CMS\Dbal\Database\DatabaseConnection\prepare_SELECTquery(), TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\scaleImages(), and TYPO3\CMS\IndexedSearch\Controller\SearchController\searchAction().

◆ minifyJavaScript()

static TYPO3\CMS\Core\Utility\GeneralUtility::minifyJavaScript	(		$script,
		&	$error = `''`
	)

static

Minifies JavaScript

Parameters

string	$script	Script to minify
string	$error	Error message (if any)

Returns: string Minified script or source string if error happened

Definition at line 2425 of file GeneralUtility.php.

References $GLOBALS, and $parameters.

Referenced by TYPO3\CMS\Frontend\View\AdminPanelView\display(), TYPO3\CMS\Core\Page\PageRenderer\doCompressJavaScript(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\minifyJavaScriptCallsRegisteredHookWithInputString(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\minifyJavaScriptReturnsErrorStringOfHookException(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\minifyJavaScriptReturnsInputStringIfNoHookIsRegistered(), and TYPO3\CMS\Frontend\Page\PageGenerator\renderContent().

◆ mkdir()

static TYPO3\CMS\Core\Utility\GeneralUtility::mkdir ( $newFolder )

static

Wrapper function for mkdir. Sets folder permissions according to $GLOBALS['TYPO3_CONF_VARS']['BE']['folderCreateMask'] and group ownership according to $GLOBALS['TYPO3_CONF_VARS']['BE']['createGroup']

Parameters

string $newFolder Absolute path to folder, see PHP mkdir() function. Removes trailing slash internally.

Returns: boolean TRUE if went well!

Definition at line 2854 of file GeneralUtility.php.

References $GLOBALS, and $result.

◆ mkdir_deep()

static TYPO3\CMS\Core\Utility\GeneralUtility::mkdir_deep	(	$directory,
		$deepDirectory = `''`
	)

static

Creates a directory - including parent directories if necessary and sets permissions on newly created directories.

Parameters

string	$directory	Target directory to create. Must a have trailing slash
string	$deepDirectory	Directory to create. This second parameter

Returns: void

Exceptions

Definition at line 2872 of file GeneralUtility.php.

◆ modifyHTMLColor()

static TYPO3\CMS\Core\Utility\GeneralUtility::modifyHTMLColor	(	$color,
		$R,
		$G,
		$B
	)

static

Modifies a HTML Hex color by adding/subtracting $R,$G and $B integers

Parameters

string	$color	A hexadecimal color code, #xxxxxx
integer	$R	Offset value 0-255
integer	$G	Offset value 0-255
integer	$B	Offset value 0-255

Returns: string A hexadecimal color code, #xxxxxx, modified according to input vars

See also: modifyHTMLColorAll()

Definition at line 929 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Core\Database\QueryGenerator\printCodeArray().

◆ modifyHTMLColorAll()

static TYPO3\CMS\Core\Utility\GeneralUtility::modifyHTMLColorAll	(	$color,
		$all
	)

static

Modifies a HTML Hex color by adding/subtracting $all integer from all R/G/B channels

Parameters

string	$color	A hexadecimal color code, #xxxxxx
integer	$all	Offset value 0-255 for all three channels.

Returns: string A hexadecimal color code, #xxxxxx, modified according to input vars

See also: modifyHTMLColor()

Definition at line 945 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Form\FormEngine\__construct(), and TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\syntaxHighlight_print().

◆ naturalKeySortRecursive()

static TYPO3\CMS\Core\Utility\GeneralUtility::naturalKeySortRecursive ( & $array )

static

Sorts an array by key recursive - uses natural sort order (aAbB-zZ)

Parameters

array $array array to be sorted recursively, passed by reference

Returns: boolean TRUE if param is an array

Definition at line 1867 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Lowlevel\View\ConfigurationView\main(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\naturalKeySortRecursiveReturnsFalseIfInputIsNotAnArray(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\naturalKeySortRecursiveSortsMultiDimensionalArrayByNaturalOrder(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\naturalKeySortRecursiveSortsOneDimensionalArrayByNaturalOrder().

◆ normalizeIPv6()

static TYPO3\CMS\Core\Utility\GeneralUtility::normalizeIPv6 ( $address )

static

Normalize an IPv6 address to full length

Parameters

string $address Given IPv6 address

Returns: string Normalized address

See also: compressIPv6()

Definition at line 531 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\normalizeIPv6CorrectlyNormalizesAddresses().

◆ normalizeMailAddress()

static TYPO3\CMS\Core\Utility\GeneralUtility::normalizeMailAddress ( $address )

static

Changes from/to arguments for mail() function to work in any environment.

Parameters

string $address Address to adjust

Returns: string Adjusted address

Definition at line 1150 of file GeneralUtility.php.

◆ plainMailEncoded()

static TYPO3\CMS\Core\Utility\GeneralUtility::plainMailEncoded	(	$email,
		$subject,
		$message,
		$headers = `''`,
		$encoding = `'quoted-printable'`,
		$charset = `''`,
		$dontEncodeHeader = `FALSE`
	)

static

Simple substitute for the PHP function mail() which allows you to specify encoding and character set The fifth parameter ($encoding) will allow you to specify 'base64' encryption for the output (set $encoding=base64) Further the output has the charset set to UTF-8 by default.

Parameters

string	$email	Email address to send to. (see PHP function mail())
string	$subject	Subject line, non-encoded. (see PHP function mail())
string	$message	Message content, non-encoded. (see PHP function mail())
string	$headers	Headers, separated by LF
string	$encoding	Encoding type: "base64", "quoted-printable", "8bit". Default value is "quoted-printable".
string	$charset	Charset used in encoding-headers (only if $encoding is set to a valid value which produces such a header)
boolean	$dontEncodeHeader	If set, the header content will not be encoded

Returns: boolean TRUE if mail was accepted for delivery, FALSE otherwise

Deprecated:: since 6.1, will be removed two versions later - Use instead

Definition at line 4805 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\plainMailEncoded().

◆ png_to_gif_by_imagemagick()

static TYPO3\CMS\Core\Utility\GeneralUtility::png_to_gif_by_imagemagick ( $theFile )

static

Converts a png file to gif. This converts a png file to gif IF the FLAG $GLOBALS['TYPO3_CONF_VARS']['FE']['png_to_gif'] is set TRUE.

Parameters

string $theFile The filename with path

Returns: string New filename

Definition at line 316 of file GeneralUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\CommandUtility\exec(), and TYPO3\CMS\Core\Utility\GeneralUtility\strtolower().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cImage(), TYPO3\CMS\Frontend\ContentObject\Menu\ImageMenuContentObject\generate(), TYPO3\CMS\Frontend\ContentObject\Menu\TextMenuContentObject\getBeforeAfter(), and TYPO3\CMS\Frontend\ContentObject\Menu\GraphicalMenuContentObject\makeGifs().

◆ presetApplicationContext()

static TYPO3\CMS\Core\Utility\GeneralUtility::presetApplicationContext ( \TYPO3\CMS\Core\Core\ApplicationContext $applicationContext )

static

Set the ApplicationContext

This function is used by the Bootstrap to hand over the application context. It must not be used anywhere else, because the context shall never be changed on runtime!

Parameters

\TYPO3\CMS\Core\Core\ApplicationContext $applicationContext

Exceptions

Definition at line 5402 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\$applicationContext.

Referenced by TYPO3\CMS\Core\Core\Bootstrap\baseSetup().

◆ purgeInstances()

static TYPO3\CMS\Core\Utility\GeneralUtility::purgeInstances ( )

static

Purge all instances returned by makeInstance.

This function is most useful when called from tearDown in a test case to drop any instances that have been created by the tests.

Warning: This is a helper method for unit tests. Do not call this directly in production code!

See also: makeInstance

Returns: void

Definition at line 4691 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\makeInstanceCalledTwoTimesForSingletonClassWithPurgeInstancesInbetweenReturnsDifferentInstances(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\purgeInstancesDropsAddedInstance(), TYPO3\CMS\Core\Tests\Unit\Resource\FileReferenceTest\setUp(), TYPO3\CMS\Extbase\Tests\Unit\Core\BootstrapTest\tearDown(), and TYPO3\CMS\Fluid\Tests\Unit\View\StandaloneViewTest\tearDown().

◆ quoted_printable()

static TYPO3\CMS\Core\Utility\GeneralUtility::quoted_printable	(	$string,
		$maxlen = `76`
	)

static

Implementation of quoted-printable encode. See RFC 1521, section 5.1 Quoted-Printable Content-Transfer-Encoding

Parameters

string	$string	Content to encode
integer	$maxlen	Length of the lines, default is 76

Returns: string The QP encoded string

Definition at line 4866 of file GeneralUtility.php.

◆ quoteJSvalue()

static TYPO3\CMS\Core\Utility\GeneralUtility::quoteJSvalue ( $value )

static

Quotes a string for usage as JS parameter.

Parameters

string $value the string to encode, may be empty

Returns: string the encoded value already quoted (with single quotes),

Definition at line 5339 of file GeneralUtility.php.

◆ rawUrlEncodeFP()

static TYPO3\CMS\Core\Utility\GeneralUtility::rawUrlEncodeFP ( $str )

static

rawurlencode which preserves "/" chars Useful when file paths should keep the "/" chars, but have all other special chars encoded.

Parameters

string $str Input string

Returns: string Output string

Definition at line 1088 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\cImage(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rawUrlEncodeFpPreservesSlashes(), and TYPO3\CMS\Recordlist\Browser\ElementBrowser\TBE_dragNDrop().

◆ rawUrlEncodeJS()

static TYPO3\CMS\Core\Utility\GeneralUtility::rawUrlEncodeJS ( $str )

static

Version of rawurlencode() where all spaces (%20) are re-converted to space-characters. Useful when passing text to JavaScript where you simply url-encode it to get around problems with syntax-errors, linebreaks etc.

Parameters

string $str String to raw-url-encode with spaces preserved

Returns: string Rawurlencoded result of input string, but with all %20 (space chars) converted to real spaces.

Definition at line 1077 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rawUrlEncodeJsPreservesWhitespaces().

◆ read_png_gif()

static TYPO3\CMS\Core\Utility\GeneralUtility::read_png_gif	(	$theFile,
		$output_png = `FALSE`
	)

static

Returns filename of the png/gif version of the input file (which can be png or gif). If input file type does not match the wanted output type a conversion is made and temp-filename returned.

Parameters

string	$theFile	Filepath of image file
boolean	$output_png	If set, then input file is converted to PNG, otherwise to GIF

Returns: string If the new image file exists, its filepath is returned

Definition at line 338 of file GeneralUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\CommandUtility\exec(), and TYPO3\CMS\Core\Utility\GeneralUtility\strtolower().

Referenced by TYPO3\CMS\Backend\Utility\IconUtility\imagecreatefrom().

◆ remapArrayKeys()

static TYPO3\CMS\Core\Utility\GeneralUtility::remapArrayKeys	(	&	$array,
			$mappingTable
	)

static

Rename Array keys with a given mapping table

Parameters

array	$array	Array by reference which should be remapped
array	$mappingTable	Array with remap information, array/$oldKey => $newKey)

Definition at line 1759 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\remapArrayKeysExchangesKeysWithGivenMapping(), and TYPO3\CMS\Frontend\ContentObject\QuicktimeObjectContentObject\render().

◆ removeArrayEntryByValue()

static TYPO3\CMS\Core\Utility\GeneralUtility::removeArrayEntryByValue	(	array	$array,
			$cmpValue
	)

static

Removes the value $cmpValue from the $array if found there. Returns the modified array

Parameters

array	$array	Array containing the values
string	$cmpValue	Value to search for and if found remove array entry where found.

Returns: array Output array with entries removed if search string is found

Definition at line 1565 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\applyFiltersToValues(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\checkRemoveArrayEntryByValueRemovesEntriesFromMultiDimensionalArray(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\checkRemoveArrayEntryByValueRemovesEntriesFromOneDimensionalArray(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\checkRemoveArrayEntryByValueRemovesEntryWithEmptyString(), TYPO3\CMS\Version\Controller\VersionModuleController\pageSubContent(), and TYPO3\CMS\Backend\User\ExtDirect\BackendUserSettingsDataProvider\removeFromList().

◆ removeDotsFromTS()

static TYPO3\CMS\Core\Utility\GeneralUtility::removeDotsFromTS ( array $ts )

static

Removes dots "." from end of a key identifier of TypoScript styled array. array('key.' => array('property.' => 'value')) –> array('key' => array('property' => 'value'))

Parameters

array $ts TypoScript configuration array

Returns: array TypoScript configuration array without dots at the end of all keys

Definition at line 1848 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Authentication\BackendUserAuthentication\backendSetUC(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\getConfigArray(), TYPO3\CMS\Backend\Form\FlexFormsHelper\modifyFlexFormDS(), TYPO3\CMS\Backend\Form\FormEngine\overrideFieldConf(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\removeDotsFromTypoScriptOverridesSubArray(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\removeDotsFromTypoScriptOverridesWithScalar(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\removeDotsFromTypoScriptSucceedsWithDottedArray().

◆ removePrefixPathFromList()

static TYPO3\CMS\Core\Utility\GeneralUtility::removePrefixPathFromList	(	array	$fileArr,
			$prefixToRemove
	)

static

Removes the absolute part of all files/folders in fileArr

Parameters

array	$fileArr	The file array to remove the prefix from
string	$prefixToRemove	The prefix path to remove (if found as first part of string!)

Returns: array The input $fileArr processed.

Definition at line 3107 of file GeneralUtility.php.

Referenced by TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\crawler_execute_type2(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createZipFileFromExtension(), and TYPO3\CMS\Lowlevel\LostFilesCommand\main().

◆ removeSingletonInstance()

static TYPO3\CMS\Core\Utility\GeneralUtility::removeSingletonInstance	(		$className,
		\TYPO3\CMS\Core\SingletonInterface	$instance
	)

static

Removes the instance of a singleton class to be returned by makeInstance.

Warning: This is NOT a public API method and must not be used in own extensions! This methods exists mostly for unit tests to inject a mock of a singleton class. If you use this, make sure to always combine this with getSingletonInstances() and resetSingletonInstances() in setUp() and tearDown() of the test class.

See also: makeInstance

Exceptions

Definition at line 4588 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Cache\Cache\flagCachingFrameworkForReinitialization().

◆ removeXSS()

static TYPO3\CMS\Core\Utility\GeneralUtility::removeXSS ( $string )

static

Wrapper for the RemoveXSS function. Removes potential XSS code from an input string.

Using an external class by Travis Puderbaugh kalla.nosp@m.har@.nosp@m.quick.nosp@m.wire.nosp@m.d.com

Parameters

string $string Input string

Returns: string Input string with potential XSS code removed

Definition at line 247 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Form\Filter\RemoveXssFilter\filter(), TYPO3\CMS\Filelist\FileList\getButtonsAndOtherMarkers(), TYPO3\CMS\Frontend\ContentObject\FormContentObject\render(), TYPO3\CMS\Backend\Search\LiveSearch\LiveSearch\setQueryString(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\validateRedirectUrl().

◆ requireFile()

static TYPO3\CMS\Core\Utility\GeneralUtility::requireFile ( $requireFile )

static

Requires a class for TYPO3 Useful to require classes from inside other classes (not global scope). A limited set of global variables are available (see function)

Parameters

string $requireFile, Path of the file to be included

Returns: void

Definition at line 4784 of file GeneralUtility.php.

References $TYPO3_CONF_VARS.

◆ requireOnce()

static TYPO3\CMS\Core\Utility\GeneralUtility::requireOnce ( $requireFile )

static

Require a class for TYPO3 Useful to require classes from inside other classes (not global scope). A limited set of global variables are available (see function)

Parameters

string $requireFile, Path of the file to be included

Returns: void

Definition at line 4770 of file GeneralUtility.php.

References $TYPO3_CONF_VARS.

◆ resetSingletonInstances()

static TYPO3\CMS\Core\Utility\GeneralUtility::resetSingletonInstances ( array $newSingletonInstances )

static

Set a group of singleton instances. Similar to setSingletonInstance(), but multiple instances can be set.

Warning: This is NOT a public API method and must not be used in own extensions! This method is usually only used in tests to restore the list of singletons in tearDown(), that was backed up with getSingletonInstances() in setUp() and manipulated in tests with setSingletonInstance()

Definition at line 4613 of file GeneralUtility.php.

◆ resolveAllSheetsInDS()

static TYPO3\CMS\Core\Utility\GeneralUtility::resolveAllSheetsInDS ( array $dataStructArray )

static

Resolves ALL sheet definitions in dataStructArray If no sheet is found, then the default "sDEF" will be created with the dataStructure inside.

Parameters

array $dataStructArray Input data structure, possibly with a sheet-definition and references to external data source files.

Returns: array Output data structure with all sheets resolved as arrays.

Definition at line 4248 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Utility\BackendUtility\getRegisteredFlexForms(), TYPO3\CMS\Backend\Form\FlexFormsHelper\modifyFlexFormDS(), and TYPO3\CMS\Backend\Form\Element\SuggestElement\processAjaxRequest().

◆ resolveBackPath()

static TYPO3\CMS\Core\Utility\GeneralUtility::resolveBackPath ( $pathStr )

static

Resolves "../" sections in the input path string. For example "fileadmin/directory/../other_directory/" will be resolved to "fileadmin/other_directory/"

Parameters

string $pathStr File path in which "/../" is resolved

Returns: string

Definition at line 3136 of file GeneralUtility.php.

◆ resolveSheetDefInDS()

static TYPO3\CMS\Core\Utility\GeneralUtility::resolveSheetDefInDS	(	$dataStructArray,
		$sheet = `'sDEF'`
	)

static

Looks for a sheet-definition in the input data structure array. If found it will return the data structure for the sheet given as $sheet (if found). If the sheet definition is in an external file that file is parsed and the data structure inside of that is returned.

Parameters

array	$dataStructArray	Input data structure, possibly with a sheet-definition and references to external data source files.
string	$sheet	The sheet to return, preferably.

Returns: array An array with two num. keys: key0: The data structure is returned in this key (array) UNLESS an error occurred in which case an error string is returned (string). key1: The used sheet key value!

Definition at line 4211 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_flex_procInData(), TYPO3\CMS\Backend\Form\DataPreprocessor\renderRecord_flexProc_procInData(), and TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\traverseFlexFormXMLData().

◆ revExplode()

static TYPO3\CMS\Core\Utility\GeneralUtility::revExplode	(	$delimiter,
		$string,
		$count = `0`
	)

static

Reverse explode which explodes the string counting from behind.

Note: The delimiter has to given in the reverse order as it is occurring within the string.

GeneralUtility::revExplode('[]', '[my][words][here]', 2) ==> array('[my][words', 'here]')

Parameters

string	$delimiter	Delimiter string to explode with
string	$string	The string to explode
integer	$count	Number of array entries

Returns: array Exploded values

Definition at line 1506 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\encaps_lineSplit(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\evaluateExpandCollapseParameter(), TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\filterInlineChildren(), TYPO3\CMS\IndexedSearch\Domain\Repository\IndexSearchRepository\freeIndexUidWhere(), TYPO3\CMS\IndexedSearch\Controller\SearchFormController\freeIndexUidWhere(), TYPO3\CMS\Version\Hook\DataHandlerHook\getEmailsForStageChangeNotification(), TYPO3\CMS\Backend\Form\FormEngine\getRTypeNum(), TYPO3\CMS\Backend\Form\FormEngine\getSingleField_typeFlex_sheetMenu(), TYPO3\CMS\Backend\Controller\Wizard\EditController\main(), TYPO3\CMS\Backend\Form\Element\InlineElement\renderForeignRecordHeader(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\revExplodeCorrectlyExplodesStringForGivenPartsCount(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\revExplodeRespectsLimitThreeWhenExploding(), and TYPO3\CMS\Core\Core\Bootstrap\transferDeprecatedCurlSettings().

◆ rmdir()

static TYPO3\CMS\Core\Utility\GeneralUtility::rmdir	(	$path,
		$removeNonEmpty = `FALSE`
	)

static

Wrapper function for rmdir, allowing recursive deletion of folders and files

Parameters

string	$path	Absolute path to folder, see PHP rmdir() function. Removes trailing slash internally.
boolean	$removeNonEmpty	Allow deletion of non-empty directories

Returns: boolean TRUE if went well!

Definition at line 2926 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Locking\LockerTest\constructorCreatesLockDirectoryIfNotExisting(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\deleteFolder(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\moveFolderWithinStorage(), TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\removeBackupFolder(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\removeDirectory(), TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\removeExtensionAndRestoreFromBackup(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmdirDoesNotRemoveDirectoryWithFilesAndReturnsFalseIfRecursiveDeletionIsOff(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmdirRemovesDeadLinkToDirectory(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmdirRemovesDeadLinkToFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmdirRemovesDirectoriesRecursiveAndReturnsTrue(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmdirRemovesDirectory(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmdirRemovesDirectoryWithTrailingSlash(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmdirRemovesFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmdirRemovesLinkToDirectory(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmdirReturnFalseIfNoFileWasRemoved(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmdirReturnTrueIfFileWasRemoved(), TYPO3\CMS\Install\Tests\Unit\FolderStructure\DirectoryNodeTest\tearDown(), TYPO3\CMS\Install\Tests\Unit\FolderStructure\LinkNodeTest\tearDown(), TYPO3\CMS\Install\Tests\Unit\FolderStructure\FileNodeTest\tearDown(), TYPO3\CMS\Install\Tests\Unit\FolderStructure\RootNodeTest\tearDown(), TYPO3\CMS\Install\Tests\Unit\FolderStructure\AbstractNodeTest\tearDown(), TYPO3\CMS\Extensionmanager\Tests\Unit\Utility\FileHandlingUtilityTest\tearDown(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\tearDown(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\tearDown(), TYPO3\CMS\Core\Tests\Unit\Resource\Driver\LocalDriverTest\tearDown(), TYPO3\CMS\Extensionmanager\Tests\Unit\Utility\InstallUtilityTest\tearDown(), and TYPO3\CMS\Lang\Utility\Connection\Ter\updateTranslation().

◆ rmFromList()

static TYPO3\CMS\Core\Utility\GeneralUtility::rmFromList	(	$element,
		$list
	)

static

Removes an item from a comma-separated list of items.

If $element contains a comma, the behaviour of this method is undefined. Empty elements in the list are preserved.

Parameters

string	$element	Element to remove
string	$list	Comma-separated list of items (string)

Returns: string New comma-separated list of items

Definition at line 733 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Setup\Controller\SetupModuleController\getFieldsFromShowItem(), TYPO3\CMS\Rtehtmlarea\ContentParser\keepSpanTagsWithId(), TYPO3\CMS\Rtehtmlarea\Extension\Language\main(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\rmFromListRemovesElementsFromCommaSeparatedList().

◆ sanitizeLocalUrl()

static TYPO3\CMS\Core\Utility\GeneralUtility::sanitizeLocalUrl ( $url = '' )

static

Checks if a given string is a valid frame URL to be loaded in the backend.

Parameters

string $url potential URL to check

Returns: string either $url if $url is considered to be harmless, or an

Definition at line 3955 of file GeneralUtility.php.

◆ setSingletonInstance()

static TYPO3\CMS\Core\Utility\GeneralUtility::setSingletonInstance	(		$className,
		\TYPO3\CMS\Core\SingletonInterface	$instance
	)

static

Sets the instance of a singleton class to be returned by makeInstance.

If this function is called multiple times for the same $className, makeInstance will return the last set instance.

Warning: This is NOT a public API method and must not be used in own extensions! This methods exists mostly for unit tests to inject a mock of a singleton class. If you use this, make sure to always combine this with getSingletonInstances() and resetSingletonInstances() in setUp() and tearDown() of the test class.

See also: makeInstance

Parameters

string	$className
\TYPO3\CMS\Core\SingletonInterface	$instance

Returns: void

Definition at line 4567 of file GeneralUtility.php.

◆ shortMD5()

static TYPO3\CMS\Core\Utility\GeneralUtility::shortMD5	(	$input,
		$len = `10`
	)

static

Returns the first 10 positions of the MD5-hash (changed from 6 to 10 recently)

Parameters

string	$input	Input string to be md5-hashed
integer	$len	The string-length of the output

Returns: string Substring of the resulting md5-hash, being $len chars long (from beginning)

Definition at line 817 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\Imaging\GifBuilder\checkFile(), TYPO3\CMS\IndexedSearch\Indexer\createLocalPathFromT3vars(), TYPO3\CMS\IndexedSearch\Tests\Unit\IndexerTest\extractHyperLinksReturnsCorrectFileUsingT3Vars(), TYPO3\CMS\Core\Localization\Parser\LocallangArrayParser\generateCacheFileName(), TYPO3\CMS\Workspaces\Controller\PreviewController\generateJavascript(), TYPO3\CMS\Backend\Controller\BackendController\generateJavascript(), TYPO3\CMS\Backend\Template\DocumentTemplate\getDragDropCode(), TYPO3\CMS\Backend\Template\DocumentTemplate\getDynTabMenuId(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\imageMagickConvert(), TYPO3\CMS\Backend\Controller\ClickMenuController\init(), TYPO3\CMS\Backend\Utility\IconUtility\makeIcon(), TYPO3\CMS\Core\Cache\Backend\ApcBackend\setCache(), TYPO3\CMS\Core\Tests\Unit\Cache\Backend\ApcBackendTest\setRemovesTagsFromPreviousSet(), TYPO3\CMS\Backend\Template\DocumentTemplate\wrapClickMenuOnIcon(), TYPO3\CMS\Frontend\ContentObject\Menu\JavaScriptMenuContentObject\writeMenu(), and TYPO3\CMS\Frontend\ContentObject\Menu\ImageMenuContentObject\writeMenu().

◆ slashArray()

static TYPO3\CMS\Core\Utility\GeneralUtility::slashArray	(	array	$arr,
			$cmd
	)

static

Either slashes ($cmd=add) or strips ($cmd=strip) array $arr depending on $cmd

Parameters

array	$arr	Multidimensional input array
string	$cmd	"add" or "strip", depending on usage you wish.

Returns: array

Definition at line 1743 of file GeneralUtility.php.

◆ slashJS()

static TYPO3\CMS\Core\Utility\GeneralUtility::slashJS	(	$string,
		$extended = `FALSE`,
		$char = `'\''`
	)

static

This function is used to escape any ' -characters when transferring text to JavaScript!

Parameters

string	$string	String to escape
boolean	$extended	If set, also backslashes are escaped.
string	$char	The character to escape, default is ' (single-quote)

Returns: string Processed input string

Definition at line 1063 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\slashJsEscapesSingleQuotesAndSlashes().

◆ split_fileref()

static TYPO3\CMS\Core\Utility\GeneralUtility::split_fileref ( $fileNameWithPath )

static

Splits a reference to a file in 5 parts

Parameters

string $fileNameWithPath File name with path to be analysed (must exist if open_basedir is set)

Returns: array Contains keys [path], [file], [filebody], [fileext], [realFileext]

Definition at line 876 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\applyFiltersToValues(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\filelink(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\filelist(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\fileResource(), TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\findRecycler(), TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\func_unzip(), TYPO3\CMS\Backend\Template\DocumentTemplate\getFileheader(), TYPO3\CMS\Core\TypoScript\TemplateService\getFileName(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\getTotalFileInfo(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\getUniqueName(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\IMreduceColors(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\procesResources(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\processTemplateRowBeforeSaving(), TYPO3\CMS\Frontend\ContentObject\MultimediaContentObject\render(), TYPO3\CMS\Frontend\ContentObject\MediaContentObject\render(), TYPO3\CMS\T3editor\T3editor\setModeByFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\splitFileRefReturnsFileTypeForFilesWithoutPathSite(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\splitFileRefReturnsFileTypeNotForFolders(), and TYPO3\CMS\Impexp\ImportExport\writeFileVerify().

◆ split_tag_attributes()

static TYPO3\CMS\Core\Utility\GeneralUtility::split_tag_attributes ( $tag )

static

Returns an array with the 'components' from an attribute list from an HTML tag. The result is normally analyzed by get_tag_attributes Removes tag-name if found

Parameters

string $tag HTML-tag string (or attributes only)

Returns: array Array with the attribute values.

Definition at line 1926 of file GeneralUtility.php.

◆ splitCalc()

static TYPO3\CMS\Core\Utility\GeneralUtility::splitCalc	(	$string,
		$operators
	)

static

This splits a string by the chars in $operators (typical /+-*) and returns an array with them in

Parameters

string $string Input string, eg "123 + 456 / 789 - 4 @param string $operators Operators to split by, typically "/+-*

Returns: array Array with operators and operands separated.

See also: ::calc(), ::calcOffset()

Definition at line 1015 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\calc(), TYPO3\CMS\Frontend\Imaging\GifBuilder\calculateValue(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\splitCalcCorrectlySplitsExpression().

◆ stdAuthCode()

static TYPO3\CMS\Core\Utility\GeneralUtility::stdAuthCode	(	$uid_or_record,
		$fields = `''`,
		$codeLength = `8`
	)

static

Standard authentication code (used in Direct Mail, checkJumpUrl and setfixed links computations)

Parameters

mixed	$uid_or_record	Uid (integer) or record (array)
string	$fields	List of fields from the record if that is given.
integer	$codeLength	Length of returned authentication code.

Returns: string MD5 hash of 8 chars.

Definition at line 4078 of file GeneralUtility.php.

References $GLOBALS.

◆ stripHttpHeaders()

static TYPO3\CMS\Core\Utility\GeneralUtility::stripHttpHeaders ( $content )

staticprotected

Strips HTTP headers from the content.

Parameters

string $content

Returns: string

Definition at line 2691 of file GeneralUtility.php.

◆ stripSlashesOnArray()

static TYPO3\CMS\Core\Utility\GeneralUtility::stripSlashesOnArray ( array & $theArray )

static

StripSlash array This function traverses a multidimensional array and strips slashes to the values. NOTE that the input array is and argument by reference.!! Twin-function to addSlashesOnArray

Parameters

array $theArray Multidimensional input array, (REFERENCE!)

Returns: array

Definition at line 1724 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\getPlaceholderTitleForTableLabel(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\stripSlashesOnArrayStripsSlashesRecursive().

◆ strtolower()

static TYPO3\CMS\Core\Utility\GeneralUtility::strtolower ( $str )

static

Converts string to lowercase The function converts all Latin characters (A-Z, but no accents, etc) to lowercase. It is safe for all supported character sets (incl. utf-8). Unlike strtolower() it does not honour the locale.

Parameters

string $str Input string

Returns: string Lowercase String

Definition at line 1192 of file GeneralUtility.php.

◆ strtoupper()

static TYPO3\CMS\Core\Utility\GeneralUtility::strtoupper ( $str )

static

Converts string to uppercase The function converts all Latin characters (a-z, but no accents, etc) to uppercase. It is safe for all supported character sets (incl. utf-8). Unlike strtoupper() it does not honour the locale.

Parameters

string $str Input string

Returns: string Uppercase String

Definition at line 1179 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Felogin\Controller\FrontendLoginController\getUserFieldMarkers(), TYPO3\CMS\Core\Utility\GeneralUtility\initSysLog(), TYPO3\CMS\IndexedSearch\Controller\SearchFormController\makeSearchForm(), TYPO3\CMS\IndexedSearch\Controller\SearchFormController\printResultRow(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\strtoupperConvertsOnlyLatinCharacters().

◆ substUrlsInPlainText()

static TYPO3\CMS\Core\Utility\GeneralUtility::substUrlsInPlainText	(	$message,
		$urlmode = `'76'`,
		$index_script_url = `''`
	)

static

Takes a clear-text message body for a plain text email, finds all 'http://' links and if they are longer than 76 chars they are converted to a shorter URL with a hash parameter. The real parameter is stored in the database and the hash-parameter/URL will be redirected to the real parameter when the link is clicked. This function is about preserving long links in messages.

Parameters

string	$message	Message content
string	$urlmode	URL mode; "76" or "all
string	$index_script_url	URL of index script (see makeRedirectUrl())

Returns: string Processed message content

See also: makeRedirectUrl()

Definition at line 4978 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\plainMailEncoded(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\substUrlsInPlainText().

◆ tempnam()

static TYPO3\CMS\Core\Utility\GeneralUtility::tempnam	(	$filePrefix,
		$fileSuffix = `''`
	)

static

Create temporary filename (Create file with unique file name) This function should be used for getting temporary file names - will make your applications safe for open_basedir = on REMEMBER to delete the temporary files after use! This is done by ::unlink_tempfile()

Parameters

string	$filePrefix	Prefix for temporary file
string	$fileSuffix	Suffix for temporary file, for example a special file extension

Returns: string result from PHP function tempnam() with PATH_site . 'typo3temp/' set for temp path.

See also: unlink_tempfile(), upload_to_tempfile()

Definition at line 4056 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Dbal\Tests\Unit\Database\DatabaseConnectionTest\createFakeExtension(), TYPO3\CMS\Impexp\Controller\ImportExportController\exportData(), TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateGraphic(), TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateHighDensityGraphic(), TYPO3\CMS\Core\Utility\DiffUtility\getDiff(), TYPO3\CMS\Core\Resource\Processing\LocalPreviewHelper\getTemporaryFilePath(), TYPO3\CMS\Impexp\ImportExport\import_addFileNameToBeCopied(), TYPO3\CMS\IndexedSearch\Indexer\indexExternalUrl(), TYPO3\CMS\Impexp\Tests\Functional\Import\AbstractImportTestCase\isCaseSensitiveFilesystem(), TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main(), TYPO3\CMS\IndexedSearch\FileContentParser\readFileContent(), TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\spellCheckHandler(), TYPO3\CMS\Core\Service\AbstractService\tempFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\tempnamReturnsAbsolutePathInsideDocumentRoot(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\tempnamReturnsPathStartingWithGivenPrefix(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\tempnamReturnsPathWithoutBackslashes(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\tidyHTML(), and TYPO3\CMS\Impexp\ImportExport\writeTemporaryFileFromData().

◆ trimExplode()

static TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode	(	$delim,
		$string,
		$removeEmptyValues = `FALSE`,
		$limit = `0`
	)

static

Explodes a string and trims all values for whitespace in the end. If $onlyNonEmptyValues is set, then all blank ('') values are removed.

Parameters

string	$delim	Delimiter string to explode with
string	$string	The string to explode
bool	$removeEmptyValues	If set, all empty values will be removed in output
int	$limit	If limit is set and positive, the returned array will contain a maximum of limit elements with the last element containing the rest of string. If the limit parameter is negative, all components except the last -limit are returned.

Returns: array Exploded values

Definition at line 1536 of file GeneralUtility.php.

References $result.

◆ underscoredToLowerCamelCase()

static TYPO3\CMS\Core\Utility\GeneralUtility::underscoredToLowerCamelCase ( $string )

static

Returns a given string with underscores as lowerCamelCase. Example: Converts minimal_value to minimalValue

Parameters

string $string String to be converted to camel case

Returns: string lowerCamelCasedWord

Definition at line 1349 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory\buildDataMap(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\underscoredToLowerCamelCase().

◆ underscoredToUpperCamelCase()

static TYPO3\CMS\Core\Utility\GeneralUtility::underscoredToUpperCamelCase ( $string )

static

Returns a given string with underscores as UpperCamelCase. Example: Converts blog_example to BlogExample

Parameters

string $string String to be converted to camel case

Returns: string UpperCamelCasedWord

Definition at line 1337 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Package\PackageFactory\__construct(), TYPO3\CMS\Extbase\Scheduler\TaskExecutor\execute(), TYPO3\CMS\Core\Page\PageRenderer\loadRequireJs(), TYPO3\CMS\Extbase\Utility\ExtensionUtility\registerModule(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\underscoredToUpperCamelCase().

◆ uniqueList()

static TYPO3\CMS\Core\Utility\GeneralUtility::uniqueList	(	$in_list,
		$secondParameter = `NULL`
	)

static

Takes comma-separated lists and arrays and removes all duplicates If a value in the list is trim(empty), the value is ignored.

Parameters

string	$in_list	Accept multiple parameters which can be comma-separated lists of values and arrays.
mixed	$secondParameter	Dummy field, which if set will show a warning!

Returns: string Returns the list without any duplicates of values, space around values are trimmed

Definition at line 860 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\checkFileExtensionPermission(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\fetchGroupData(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\filelist(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\init(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\uniqueListUnifiesCommaSeparatedList(), and TYPO3\CMS\Core\Authentication\BackendUserAuthentication\workspaceInit().

◆ unlink_tempfile()

static TYPO3\CMS\Core\Utility\GeneralUtility::unlink_tempfile ( $uploadedTempFileName )

static

Deletes (unlink) a temporary filename in 'PATH_site."typo3temp/"' given as input. The function will check that the file exists, is in PATH_site."typo3temp/" and does not contain back-spaces ("../") so it should be pretty safe. Use this after upload_to_tempfile() or tempnam() from this class!

Parameters

string $uploadedTempFileName Filepath for a file in PATH_site."typo3temp/". Must be absolute.

Returns: boolean Returns TRUE if the file was unlink()'ed

See also: upload_to_tempfile(), tempnam()

Definition at line 4031 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateGraphic(), TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateHighDensityGraphic(), TYPO3\CMS\Backend\Tests\Unit\Utility\IconUtilityTest\imagemakeFixesPermissionsOnNewFiles(), TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\main(), TYPO3\CMS\Form\Request\removeFiles(), TYPO3\CMS\Rtehtmlarea\Controller\SpellCheckingController\spellCheckHandler(), TYPO3\CMS\Core\Tests\Unit\Configuration\ConfigurationManagerTest\tearDown(), TYPO3\CMS\Core\Tests\Unit\Utility\ExtensionManagementUtilityTest\tearDown(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\unlink_tempfileRemovesHiddenFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\unlink_tempfileRemovesValidFileInTypo3temp(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\unlink_tempfileReturnsNullIfFileDoesNotExist(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\unlink_tempfileReturnsNullIfFileIsNowWithinTypo3temp(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\unlink_tempfileReturnsTrueIfFileWasRemoved(), TYPO3\CMS\Core\Service\AbstractService\unlinkTempFiles(), and TYPO3\CMS\Impexp\ImportExport\unlinkTempFiles().

◆ unQuoteFilenames()

static TYPO3\CMS\Core\Utility\GeneralUtility::unQuoteFilenames	(	$parameters,
		$unQuote = `FALSE`
	)

static

Explode a string (normally a list of filenames) with whitespaces by considering quotes in that string. This is mostly needed by the imageMagickCommand function above.

Parameters

string	$parameters	The whole parameters string
boolean	$unQuote	If set, the elements of the resulting array are unquoted.

Returns: array Exploded parameters

Definition at line 5304 of file GeneralUtility.php.

References $parameters.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\explodeAndUnquoteImageMagickCommands(), TYPO3\CMS\Core\Database\SoftReferenceIndex\getTypoLinkParts(), TYPO3\CMS\Core\Utility\CommandUtility\imageMagickCommand(), TYPO3\CMS\Recordlist\Browser\ElementBrowser\initCurrentUrl(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\TCAlookup(), and TYPO3\CMS\Core\Html\RteHtmlParser\TS_links_rte().

◆ upload_copy_move()

static TYPO3\CMS\Core\Utility\GeneralUtility::upload_copy_move	(	$source,
		$destination
	)

static

Moves $source file to $destination if uploaded, otherwise try to make a copy

Parameters

string	$source	Source file, absolute path
string	$destination	Destination file, absolute path

Returns: boolean Returns TRUE if the file was moved. Dennis Petersen fesso.nosp@m.r@so.nosp@m.ftwar.nosp@m.e.dk

See also: upload_to_tempfile()

Definition at line 3990 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\applyFiltersToValues(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_fixRTEmagicImages(), TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateGraphic(), TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateHighDensityGraphic(), TYPO3\CMS\Lowlevel\DoubleFilesCommand\main_autoFix(), TYPO3\CMS\Lowlevel\RteImagesCommand\main_autoFix(), and TYPO3\CMS\Install\Updates\TtContentUploadsUpdateWizard\migrateRecord().

◆ upload_to_tempfile()

static TYPO3\CMS\Core\Utility\GeneralUtility::upload_to_tempfile ( $uploadedFileName )

static

Will move an uploaded file (normally in "/tmp/xxxxx") to a temporary filename in PATH_site."typo3temp/" from where TYPO3 can use it. Use this function to move uploaded files to where you can work on them. REMEMBER to use ::unlink_tempfile() afterwards - otherwise temp-files will build up! They are NOT automatically deleted in PATH_site."typo3temp/"!

Parameters

string $uploadedFileName The temporary uploaded filename, eg. $_FILES['[upload field name here]']['tmp_name']

Returns: string If a new file was successfully created, return its filename, otherwise blank string.

See also: unlink_tempfile(), upload_copy_move()

Definition at line 4014 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractAction(), and TYPO3\CMS\Form\Request\storeFiles().

◆ validEmail()

static TYPO3\CMS\Core\Utility\GeneralUtility::validEmail ( $email )

static

Checking syntax of input email address

http://tools.ietf.org/html/rfc3696 International characters are allowed in email. So the whole address needs to be converted to punicode before passing it to filter_var(). We convert the user- and domain part separately to increase the chance of hitting an entry in self::$idnaStringCache.

Also the @ sign may appear multiple times in an address. If not used as a boundary marker between the user- and domain part, it must be escaped with a backslash: @. This mean we can not just explode on the @ sign and expect to get just two parts. So we pop off the domain and then glue the rest together again.

Parameters

string $email Input string to evaluate

Returns: boolean Returns TRUE if the $email address (input string) is valid

Definition at line 1110 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\executeAction(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLinkTypes(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getReceipientsOfStage(), TYPO3\CMS\Workspaces\ExtDirect\ActionHandler\getRecipientList(), TYPO3\CMS\Core\Utility\MailUtility\getSystemFromAddress(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\link(), TYPO3\CMS\Frontend\Controller\DataSubmissionController\start(), TYPO3\CMS\Linkvalidator\Task\ValidatorTaskAdditionalFieldProvider\validateAdditionalFields(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validEmailReturnsFalseForInvalidMailAddress(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validEmailReturnsTrueForValidMailAddress(), and TYPO3\CMS\SysAction\ActionTask\viewNewBackendUser().

◆ validIP()

static TYPO3\CMS\Core\Utility\GeneralUtility::validIP ( $ip )

static

Validate a given IP address.

Possible format are IPv4 and IPv6.

Parameters

string $ip IP address to be tested

Returns: boolean TRUE if $ip is either of IPv4 or IPv6 format.

Definition at line 606 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validIpReturnsFalseForInvalidIp(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validIpReturnsTrueForValidIp().

◆ validIPv4()

static TYPO3\CMS\Core\Utility\GeneralUtility::validIPv4 ( $ip )

static

Validate a given IP address to the IPv4 address format.

Example for possible format: 10.0.45.99

Parameters

string $ip IP address to be tested

Returns: boolean TRUE if $ip is of IPv4 format.

Definition at line 618 of file GeneralUtility.php.

◆ validIPv6()

static TYPO3\CMS\Core\Utility\GeneralUtility::validIPv6 ( $ip )

static

Validate a given IP address to the IPv6 address format.

Example for possible format: 43FB::BB3F:A0A0:0 | ::1

Parameters

string $ip IP address to be tested

Returns: boolean TRUE if $ip is of IPv6 format.

Definition at line 630 of file GeneralUtility.php.

◆ validPathStr()

static TYPO3\CMS\Core\Utility\GeneralUtility::validPathStr ( $theFile )

static

Checks for malicious file paths.

Returns TRUE if no '//', '..', '\' or control characters are found in the $theFile. This should make sure that the path is not pointing 'backwards' and further doesn't contain double/back slashes. So it's compatible with the UNIX style path strings valid for TYPO3 internally.

Parameters

string $theFile File path to evaluate

Returns: boolean TRUE, $theFile is allowed path string, FALSE otherwise

See also: http://php.net/manual/en/security.filesystem.nullbytes.php

Todo:: Possible improvement: Should it rawurldecode the string first to check if any of these characters is encoded?

Definition at line 3874 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Utility\File\BasicFileUtility\checkPathAgainstMounts(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\clean_directory(), TYPO3\CMS\Core\Html\RteHtmlParser\evalWriteFile(), TYPO3\CMS\Core\Utility\File\ExtendedFileUtility\findRecycler(), TYPO3\CMS\Core\Charset\CharsetConverter\initCharset(), TYPO3\CMS\Core\Charset\CharsetConverter\initUnicodeData(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\is_directory(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\isPathValid(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validPathStrDetectsInvalidCharacters(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validPathStrWorksWithUnicodeFileNames().

◆ verifyFilenameAgainstDenyPattern()

static TYPO3\CMS\Core\Utility\GeneralUtility::verifyFilenameAgainstDenyPattern ( $filename )

static

Verifies the input filename against the 'fileDenyPattern'. Returns TRUE if OK.

Filenames are not allowed to contain control characters. Therefore we allways filter on [[:cntrl:]].

Parameters

string $filename File path to evaluate

Returns: boolean

Definition at line 3911 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\checkFileExtensionPermission(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\checkIfAllowed(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\extractIncludes(), TYPO3\CMS\Reports\Report\Status\SecurityStatus\getHtaccessUploadStatus(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\includeFile(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\jumpUrl(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\verifyFilenameAgainstDenyPatternDetectsNotAllowedFiles().

◆ wrapJS()

static TYPO3\CMS\Core\Utility\GeneralUtility::wrapJS	(	$string,
		$linebreak = `TRUE`
	)

static

Wraps JavaScript code XHTML ready with <script>-tags Automatic re-indenting of the JS code is done by using the first line as indent reference. This is nice for indenting JS code with PHP code on the same level.

Parameters

string	$string	JavaScript code
boolean	$linebreak	Wrap script element in line breaks? Default is TRUE.

Returns: string The wrapped JS code, ready to put into a XHTML page

Definition at line 1989 of file GeneralUtility.php.

Referenced by TYPO3\CMS\T3editor\T3editor\__construct(), TYPO3\CMS\Core\TypoScript\ConfigurationForm\ext_getForm(), TYPO3\CMS\T3editor\T3editor\getModeSpecificJavascriptCode(), TYPO3\CMS\Core\Page\PageRenderer\renderJqueryScriptTag(), and TYPO3\CMS\Core\Page\PageRenderer\renderMainJavaScriptLibraries().

◆ writeFile()

static TYPO3\CMS\Core\Utility\GeneralUtility::writeFile	(	$file,
		$content,
		$changePermissions = `FALSE`
	)

static

Writes $content to the file $file

Parameters

string	$file	Filepath to write to
string	$content	Content to write
boolean	$changePermissions	If TRUE, permissions are forced to be set

Returns: boolean TRUE if the file was successfully opened and written to.

Definition at line 2707 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\__construct(), TYPO3\CMS\Lowlevel\AdminCommand\cli_main(), TYPO3\CMS\Dbal\Tests\Unit\Database\DatabaseConnectionTest\createFakeExtension(), TYPO3\CMS\Core\Log\Writer\FileWriter\createHtaccessFile(), TYPO3\CMS\Core\Log\Writer\FileWriter\createLogFile(), TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile(), TYPO3\CMS\Install\Service\SessionService\ensureSessionSavePathExists(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\extractIncludes(), TYPO3\CMS\Documentation\Service\DocumentationService\fetchDocument(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchFile(), TYPO3\CMS\Backend\Sprite\AbstractSpriteHandler\generate(), TYPO3\CMS\Backend\Sprite\SpriteGenerator\generateCSS(), TYPO3\CMS\Core\Utility\DiffUtility\getDiff(), TYPO3\CMS\Documentation\Service\DocumentationService\getOfficialDocuments(), TYPO3\CMS\Core\DataHandling\DataHandler\getPlaceholderTitleForTableLabel(), TYPO3\CMS\Impexp\ImportExport\import_addFileNameToBeCopied(), TYPO3\CMS\IndexedSearch\Indexer\indexExternalUrl(), TYPO3\CMS\Frontend\Page\PageGenerator\inline2TempFile(), TYPO3\CMS\Lowlevel\View\ConfigurationView\main(), TYPO3\CMS\Impexp\ImportExport\processSoftReferences_saveFile_createRelFile(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\processTemplateRowBeforeSaving(), TYPO3\CMS\Core\Resource\ResourceCompressor\retrieveExternalFile(), TYPO3\CMS\Documentation\Service\DocumentationService\unzipDocumentPackage(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unzipExtensionFromFile(), TYPO3\CMS\Lang\Utility\Connection\Ter\unzipTranslationFile(), TYPO3\CMS\Lang\Utility\Connection\Ter\updateTranslation(), TYPO3\CMS\Install\Service\SessionService\write(), TYPO3\CMS\Core\Configuration\ConfigurationManager\writeAdditionalConfiguration(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\writeEmConfToFile(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\writeExtensionFiles(), TYPO3\CMS\Core\Resource\ResourceCompressor\writeFileAndCompressed(), TYPO3\CMS\Impexp\ImportExport\writeFileVerify(), TYPO3\CMS\Core\Configuration\ConfigurationManager\writeLocalConfiguration(), and TYPO3\CMS\Impexp\ImportExport\writeTemporaryFileFromData().

◆ writeFileToTypo3tempDir()

static TYPO3\CMS\Core\Utility\GeneralUtility::writeFileToTypo3tempDir	(	$filepath,
		$content
	)

static

Writes $content to a filename in the typo3temp/ folder (and possibly one or two subfolders...) Accepts an additional subdirectory in the file path!

Parameters

string	$filepath	Absolute file path to write to inside "typo3temp/". First part of this string must match PATH_site."typo3temp/
string	$content	Content string to write

Returns: string Returns NULL on success, otherwise an error string telling about the problem.

Definition at line 2796 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\copyDirectoryCopiesFilesAndDirectoriesWithAbsolutePaths(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\copyDirectoryCopiesFilesAndDirectoriesWithRelativePaths(), TYPO3\CMS\Extensionmanager\Utility\UpdateScriptUtility\determineUpdateClassName(), TYPO3\CMS\Extensionmanager\Controller\ActionController\downloadExtensionDataAction(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsCorrectlySetsPermissionsRecursive(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsDefaultPermissionsToFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsGroup(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsToFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsToHiddenFile(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsWithRelativeFileReference(), TYPO3\CMS\Core\Localization\Parser\LocallangArrayParser\generateCacheFile(), TYPO3\CMS\Backend\Controller\BackendController\getLocalLangFileName(), TYPO3\CMS\Core\Charset\CharsetConverter\initCaseFolding(), TYPO3\CMS\Core\Charset\CharsetConverter\initCharset(), TYPO3\CMS\Core\Charset\CharsetConverter\initToASCII(), TYPO3\CMS\Core\Charset\CharsetConverter\initUnicodeData(), TYPO3\CMS\Core\Tests\Unit\Resource\ResourceFactoryTest\retrieveFileOrFolderObjectReturnsFileIfPathIsGiven(), and TYPO3\CMS\Version\Hook\DataHandlerHook\versionizePages().

◆ xml2array()

static TYPO3\CMS\Core\Utility\GeneralUtility::xml2array	(	$string,
		$NSprefix = `''`,
		$reportDocTag = `FALSE`
	)

static

Converts an XML string to a PHP array. This is the reverse function of array2xml() This is a wrapper for xml2arrayProcess that adds a two-level cache

Parameters

string	$string	XML content to convert into an array
string	$NSprefix	The tag-prefix resolve, eg. a namespace like "T3:"
boolean	$reportDocTag	If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array

Returns: mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.

See also: array2xml(),xml2arrayProcess()

Definition at line 2232 of file GeneralUtility.php.

References TYPO3\CMS\Frontend\Page\PageRepository\getHash(), and TYPO3\CMS\Frontend\Page\PageRepository\storeHash().

Referenced by TYPO3\CMS\Install\Updates\MediaFlexformUpdate\checkForUpdate(), TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_flex(), TYPO3\CMS\Extbase\Service\FlexFormService\convertFlexFormContentToArray(), TYPO3\CMS\Core\Resource\ResourceFactory\convertFlexFormDataToConfigurationArray(), TYPO3\CMS\Backend\Utility\BackendUtility\getFlexFormDS(), TYPO3\CMS\Backend\Utility\BackendUtility\getRegisteredFlexForms(), TYPO3\CMS\Core\Database\ReferenceIndex\getRelations(), TYPO3\CMS\Core\DataHandling\DataHandler\insertNewCopyVersion(), TYPO3\CMS\Impexp\ImportExport\loadFile(), TYPO3\CMS\Backend\Controller\Wizard\AddController\main(), TYPO3\CMS\Install\Updates\FileIdentifierHashUpdate\performUpdate(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\readFlexformIntoConf(), TYPO3\CMS\Core\DataHandling\DataHandler\remapListedDBRecords(), TYPO3\CMS\Impexp\ImportExport\remapListedDBRecords_flexFormCallBack(), TYPO3\CMS\Frontend\ContentObject\MediaContentObject\render(), TYPO3\CMS\Backend\Form\DataPreprocessor\renderRecord_flexProc(), TYPO3\CMS\Impexp\ImportExport\setFlexFormRelations(), TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\traverseFlexFormXMLData(), TYPO3\CMS\Core\DataHandling\DataHandler\updateFlexFormData(), and TYPO3\CMS\Core\DataHandling\DataHandler\versionizeRecord().

◆ xml2arrayProcess()

static TYPO3\CMS\Core\Utility\GeneralUtility::xml2arrayProcess	(	$string,
		$NSprefix = `''`,
		$reportDocTag = `FALSE`
	)

staticprotected

Converts an XML string to a PHP array. This is the reverse function of array2xml()

Parameters

string	$string	XML content to convert into an array
string	$NSprefix	The tag-prefix resolve, eg. a namespace like "T3:"
boolean	$reportDocTag	If set, the document tag will be set in the key "_DOCUMENT_TAG" of the output array

Returns: mixed If the parsing had errors, a string with the error message is returned. Otherwise an array with the content.

See also: array2xml()

Definition at line 2261 of file GeneralUtility.php.

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

◆ xml2tree()

static TYPO3\CMS\Core\Utility\GeneralUtility::xml2tree	(	$string,
		$depth = `999`
	)

static

Parses XML input into a PHP array with associative keys

Parameters

string	$string	XML data input
integer	$depth	Number of element levels to resolve the XML into an array. Any further structure will be set as XML.

Returns: mixed The array with the parsed structure unless the XML parser returns with an error in which case the error message string is returned.

Author: bisqwit at iki dot fi dot not dot for dot ads dot invalid / http://dk.php.net/xml_parse_into_struct + kaspe.nosp@m.rYYY.nosp@m.Y@typ.nosp@m.o3.c.nosp@m.om

Definition at line 2017 of file GeneralUtility.php.

Referenced by TYPO3\CMS\IndexedSearch\FileContentParser\readFileContent().

◆ xmlGetHeaderAttribs()

static TYPO3\CMS\Core\Utility\GeneralUtility::xmlGetHeaderAttribs ( $xmlData )

static

Extracts the attributes (typically encoding and version) of an XML prologue (header).

Parameters

string $xmlData XML data

Returns: array Attributes of the xml prologue (header)

Definition at line 2411 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\traverseFlexFormXMLData().

◆ xmlRecompileFromStructValArray()

static TYPO3\CMS\Core\Utility\GeneralUtility::xmlRecompileFromStructValArray ( array $vals )

static

This implodes an array of XML parts (made with xml_parse_into_struct()) into XML again.

Parameters

array $vals An array of XML parts, see xml2tree

Returns: string Re-compiled XML data.

Definition at line 2368 of file GeneralUtility.php.

Member Data Documentation

◆ $allowHostHeaderValue

TYPO3\CMS\Core\Utility\GeneralUtility::$allowHostHeaderValue = FALSE

staticprotected

Definition at line 49 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\Fixtures\GeneralUtilityFixture\setAllowHostHeaderValue().

◆ $applicationContext

TYPO3\CMS\Core\Utility\GeneralUtility::$applicationContext = NULL

staticprotected

Definition at line 78 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Utility\GeneralUtility\presetApplicationContext(), and TYPO3\CMS\Core\Tests\Unit\Configuration\TypoScript\ConditionMatching\Fixtures\GeneralUtilityFixture\setApplicationContext().

◆ $finalClassNameCache

TYPO3\CMS\Core\Utility\GeneralUtility::$finalClassNameCache = array()

staticprotected

Definition at line 71 of file GeneralUtility.php.

◆ $idnaConverter

TYPO3\CMS\Core\Utility\GeneralUtility::$idnaConverter = NULL

staticprotected

Definition at line 92 of file GeneralUtility.php.

◆ $idnaStringCache

TYPO3\CMS\Core\Utility\GeneralUtility::$idnaStringCache = array()

staticprotected

Definition at line 85 of file GeneralUtility.php.

◆ $nonSingletonInstances

TYPO3\CMS\Core\Utility\GeneralUtility::$nonSingletonInstances = array()

staticprotected

Definition at line 64 of file GeneralUtility.php.

◆ $singletonInstances

TYPO3\CMS\Core\Utility\GeneralUtility::$singletonInstances = array()

staticprotected

Definition at line 57 of file GeneralUtility.php.

◆ $supportedCgiServerApis

TYPO3\CMS\Core\Utility\GeneralUtility::$supportedCgiServerApis

staticprotected

Initial value:

= array(
        'fpm-fcgi',
        'cgi',
        'isapi',
        'cgi-fcgi',
        'srv', 
    )

Definition at line 99 of file GeneralUtility.php.

◆ ENV_TRUSTED_HOSTS_PATTERN_ALLOW_ALL

const TYPO3\CMS\Core\Utility\GeneralUtility::ENV_TRUSTED_HOSTS_PATTERN_ALLOW_ALL = '.*'

Definition at line 40 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\getIndpEnvForHostAllowsAllHostnameValuesIfHostPatternIsSetToAllowAll(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\setUp().

◆ ENV_TRUSTED_HOSTS_PATTERN_SERVER_NAME

const TYPO3\CMS\Core\Utility\GeneralUtility::ENV_TRUSTED_HOSTS_PATTERN_SERVER_NAME = 'SERVER_NAME'

Definition at line 41 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\isAllowedHostHeaderValueWorksCorrectlyWithWithServerNamePattern().

◆ SYSLOG_SEVERITY_ERROR

const TYPO3\CMS\Core\Utility\GeneralUtility::SYSLOG_SEVERITY_ERROR = 3

Definition at line 37 of file GeneralUtility.php.

◆ SYSLOG_SEVERITY_FATAL

const TYPO3\CMS\Core\Utility\GeneralUtility::SYSLOG_SEVERITY_FATAL = 4

Definition at line 38 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\prefixLocalAnchorsWithScript(), TYPO3\CMS\Core\Database\DatabaseConnection\sql_pconnect(), TYPO3\CMS\Core\Database\DatabaseConnection\sql_select_db(), TYPO3\CMS\Dbal\Database\DatabaseConnection\sql_select_db(), and TYPO3\CMS\Core\Error\AbstractExceptionHandler\writeLogEntries().

◆ SYSLOG_SEVERITY_INFO

const TYPO3\CMS\Core\Utility\GeneralUtility::SYSLOG_SEVERITY_INFO = 0

Definition at line 34 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\acquirePageGenerationLock(), and TYPO3\CMS\Extbase\Validation\ValidatorResolver\createValidator().

◆ SYSLOG_SEVERITY_NOTICE

const TYPO3\CMS\Core\Utility\GeneralUtility::SYSLOG_SEVERITY_NOTICE = 1

Definition at line 35 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\set_no_cache(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\syslogFixesPermissionsOnFileIfUsingFileLogging(), and TYPO3\CMS\Openid\OpenidService\writeLog().

◆ SYSLOG_SEVERITY_WARNING

const TYPO3\CMS\Core\Utility\GeneralUtility::SYSLOG_SEVERITY_WARNING = 2

Definition at line 36 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\__construct(), TYPO3\CMS\Core\Locking\Locker\acquire(), TYPO3\CMS\Core\Locking\Locker\acquireExclusiveLock(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\checkIncludeLines(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\createUserSession(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\executeValueModifier(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\extractIncludes(), TYPO3\CMS\Core\Locking\Locker\isLocked(), TYPO3\CMS\Core\Cache\Backend\MemcachedBackend\set(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\set_no_cache(), and TYPO3\CMS\Felogin\Controller\FrontendLoginController\validateRedirectUrl().

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ _GET()

◆ _GETset()

◆ _GP()

◆ _GPmerged()

◆ _POST()

◆ addInstance()

◆ addSlashesOnArray()

◆ array2xml()

◆ array2xml_cs()

◆ array_merge()

◆ array_merge_recursive_overrule()

◆ arrayDiffAssocRecursive()

◆ arrayToLogString()

◆ callUserFunction()

◆ camelCaseToLowerCaseUnderscored()

◆ checkInstanceClassName()

◆ classHasImplementation()

◆ cleanOutputBuffers()

◆ clientInfo()

◆ cmpFQDN()

◆ cmpIP()

◆ cmpIPv4()

◆ cmpIPv6()

◆ compat_version()

◆ compileSelectedGetVarsFromArray()

◆ compressIPv6()

◆ convertMicrotime()

◆ copyDirectory()

◆ createDirectoryPath()

◆ createVersionNumberedFilename()

◆ csvValues()

◆ deHSCentities()

◆ deprecationLog()

◆ devLog()

◆ dirname()

◆ encodeHeader()

◆ expandList()

◆ explodeUrl2Array()

◆ fixed_lgd_cs()

◆ fixPermissions()

◆ fixWindowsFilePath()

◆ flushDirectory()

◆ flushOutputBuffers()

◆ formatForTextarea()

◆ formatSize()

◆ freetypeDpiComp()

◆ generateRandomBytes()

◆ generateRandomBytesFallback()

◆ generateRandomBytesMcrypt()

◆ generateRandomBytesOpenSsl()

◆ generateRandomBytesUrandom()

◆ get_dirs()

◆ get_tag_attributes()

◆ getAllFilesAndFoldersInPath()

◆ getApplicationContext()

◆ getBytesFromSizeMeasurement()

◆ getClassName()

◆ getDeprecationLogFileName()

◆ getFileAbsFileName()

◆ getFilesInDir()

◆ getHostname()

◆ getImplementationForClass()

◆ getIndpEnv()

◆ getMaximumPathLength()

◆ getMaxUploadFileSize()

◆ getRandomHexString()

◆ getRedirectUrlFromHttpHeaders()

◆ getSingletonInstances()

◆ getThisUrl()

◆ getUrl()

◆ getUserObj()

◆ gif_compress()

◆ hideIfDefaultLanguage()

◆ hideIfNotTranslated()