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	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	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	isFirstPartOfStr ($str, $partStr)

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

static	convertMicrotime ($microtime)

static	splitCalc ($string, $operators)

static	deHSCentities ($str)

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

static	rawUrlEncodeJS ($str)

static	rawUrlEncodeFP ($str)

static	validEmail ($email)

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	intExplode ($delimiter, $string, $removeEmptyValues=false, $limit=0)

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

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

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

static	explodeUrl2Array ($string, $multidim=false)

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

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

static	removeDotsFromTS (array $ts)

static	get_tag_attributes ($tag)

static	split_tag_attributes ($tag)

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

static	wrapJS ($string, $_=null)

static	xml2tree ($string, $depth=999, $parserOptions=[])

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

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

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

static	xmlRecompileFromStructValArray (array $vals)

static	xmlGetHeaderAttribs ($xmlData)

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

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

static	getBytesFromSizeMeasurement ($measurement)

static	getMaximumPathLength ()

static	createVersionNumberedFilename ($file)

static	linkThisScript (array $getParams=[])

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

static	getIndpEnv ($getEnvName)

static	isAllowedHostHeaderValue ($hostHeaderValue)

static	hostHeaderValueMatchesTrustedHostsPattern ($hostHeaderValue)

static	milliseconds ()

static	clientInfo ($useragent='')

static	getHostname ($requestHost=true)

static	getFileAbsFileName ($filename, $_=null, $_2=null)

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	resolveSheetDefInDS ($dataStructArray, $sheet='sDEF')

static	resolveAllSheetsInDS (array $dataStructArray)

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

static	getUserObj ($classRef)

static	makeInstance ($className,... $constructorArguments)

static	setSingletonInstance ($className, SingletonInterface $instance)

static	removeSingletonInstance ($className, SingletonInterface $instance)

static	resetSingletonInstances (array $newSingletonInstances)

static	getSingletonInstances ()

static	addInstance ($className, $instance)

static	purgeInstances ()

static	flushInternalRuntimeCaches ()

static	makeInstanceService ($serviceType, $serviceSubType='', $excludeServiceKeys=[])

static	requireOnce ($requireFile)

static	requireFile ($requireFile)

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

static	freetypeDpiComp ($fontSize)

static	initSysLog ()

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

static	deprecationLog ($msg)

static	logDeprecatedViewHelperAttribute (string $property, RenderingContextInterface $renderingContext, string $additionalMessage='')

static	getDeprecationLogFileName ()

static	logDeprecatedFunction ()

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

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

static	unQuoteFilenames ($parameters, $unQuote=false)

static	quoteJSvalue ($value)

static	flushOutputBuffers ()

static	presetApplicationContext (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	xml2arrayProcess ($string, $NSprefix='', $reportDocTag=false)

static	splitHeaderLines (array $headers)

static	createDirectoryPath ($fullDirectoryPath)

static	isInternalRequestType ()

static	getClassName ($className)

static	getImplementationForClass ($className)

static	classHasImplementation ($className)

static	checkInstanceClassName ($className, $instance)

Static Protected Attributes
static	$allowHostHeaderValue = false

static	$singletonInstances = []

static	$nonSingletonInstances = []

static	$finalClassNameCache = []

static	$applicationContext = null

static	$idnaStringCache = []

static	$idnaConverter = null

static	$supportedCgiServerApis

static	$indpEnvCache = []

Detailed Description

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

Definition at line 39 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! This function was previously used to normalize between magic quotes logic, which was removed from PHP 5.5

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 185 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

Definition at line 219 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) To enhance security in your scripts, please consider using GeneralUtility::_GET or GeneralUtility::_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 142 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 167 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\getModuleContent(), TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcher\getVariableCommon(), 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 203 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Beuser\Controller\PermissionAjaxController\__construct(), TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem\addShortcut(), TYPO3\CMS\Fluid\Core\Widget\WidgetRequestBuilder\build(), 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\Controller\Wizard\ColorpickerController\colorList(), TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\executeTasks(), TYPO3\CMS\Core\Http\ServerRequestFactory\fromGlobals(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateModuleController\getButtons(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getData(), TYPO3\CMS\Setup\Controller\SetupModuleController\getFormProtection(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\getLoginFormData(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getLoginFormData(), TYPO3\CMS\Install\Controller\AbstractController\getPostValues(), TYPO3\CMS\Workspaces\Hook\PreviewHook\getPreviewConfiguration(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQueryArguments(), TYPO3\CMS\Filelist\Controller\FileListController\initializeIndexAction(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateConstantEditorModuleFunctionController\main(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateObjectBrowserModuleFunctionController\main(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateInformationModuleFunctionController\main(), TYPO3\CMS\Impexp\Controller\ImportExportController\main(), TYPO3\CMS\Impexp\Controller\ImportExportController\makeSaveForm(), TYPO3\CMS\Lowlevel\View\ConfigurationView\menuConfig(), TYPO3\CMS\Core\Database\QueryGenerator\procesData(), TYPO3\CMS\Core\Database\QueryView\resultRowDisplay(), TYPO3\CMS\T3editor\Hook\TypoScriptTemplateInfoHook\save(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\showForgot(), TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem\tryAddingTheShortcut(), 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 4131 of file GeneralUtility.php.

◆ array2xml()

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

static

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:"
int	$level	Current recursion level. Don't change, stay at zero!
string	$docTag	Alternative document tag. Default is "phparray".
int	$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 1680 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Install\SystemEnvironment\SetupCheck\checkLibXmlBug(), TYPO3\CMS\Core\Tests\Unit\Resource\ResourceStorageTest\convertConfigurationArrayToFlexformXml(), TYPO3\CMS\Impexp\Export\createXML(), TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\flexArray2Xml(), TYPO3\CMS\Backend\Controller\Wizard\TableController\tableWizard(), 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 = `[]`,
			$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()

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9.

Definition at line 1651 of file GeneralUtility.php.

◆ arrayToLogString()

static TYPO3\CMS\Core\Utility\GeneralUtility::arrayToLogString	(	array	$arr,
			$valueList = `[]`,
			$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.
int	$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 4577 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Lowlevel\Command\ListSysLogCommand\execute(), TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication\fetchGroupData(), TYPO3\CMS\Sv\AuthenticationService\getUser(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\isRefreshTimeBasedCookie(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\processLoginData().

◆ callUserFunction()

static TYPO3\CMS\Core\Utility\GeneralUtility::callUserFunction	(		$funcName,
		&	$params,
		&	$ref,
			$_ = `''`,
			$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". However, using file references has been marked as deprecated and should be avoided, instead use the autoloading mechanism in place directly. 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	$_	Not used anymore since 6.0
int	$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 3786 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 1145 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Cli\Command\__construct(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\camelCaseToLowerCaseUnderscored(), TYPO3\CMS\Backend\Template\Components\Menu\Menu\getDataIdentifier(), TYPO3\CMS\Backend\Utility\BackendUtility\getDropdownMenu(), TYPO3\CMS\Backend\Utility\BackendUtility\getFuncMenu(), TYPO3\CMS\Backend\Controller\BackendController\loadResourcesForRegisteredNavigationComponents(), TYPO3\CMS\Extbase\Utility\ExtensionUtility\registerPlugin(), TYPO3\CMS\Fluid\ViewHelpers\Uri\ResourceViewHelper\renderStatic(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translateFileReference().

◆ 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 4151 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: bool

Definition at line 4017 of file GeneralUtility.php.

References $GLOBALS.

◆ 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 3212 of file GeneralUtility.php.

Referenced by 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: bool TRUE if a domain name mask from $list matches $baseIP

Definition at line 562 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: bool TRUE if an IP-mask from $list matches $baseIP

Definition at line 300 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\Http\RequestHandler\__construct(), 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\Database\DatabaseConnection\debug_check_recordset(), TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcher\evaluateConditionCommon(), TYPO3\CMS\Sv\AuthenticationService\getGroups(), and TYPO3\CMS\Core\Core\Bootstrap\initializeErrorHandling().

◆ 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: bool TRUE if an IP-mask from $list matches $baseIP

Definition at line 322 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: bool TRUE If an baseIP matches any prefix

Definition at line 369 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: bool Returns TRUE if this setup is compatible with the provided version number

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

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 707 of file GeneralUtility.php.

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

◆ 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
bool	$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 1382 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(), TYPO3\CMS\Backend\Template\DocumentTemplate\makeShortcutUrl(), and TYPO3\CMS\Backend\Template\ModuleTemplate\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 511 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: int Microtime input string converted to an integer (milliseconds)

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 906 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 3430 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(), TYPO3\CMS\Impexp\Import\loadFile(), 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 2346 of file GeneralUtility.php.

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

◆ createVersionNumberedFilename()

static TYPO3\CMS\Core\Utility\GeneralUtility::createVersionNumberedFilename ( $file )

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)

Returns: string Relative path with version filename including the timestamp

Definition at line 2725 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController\getRelativePathToStylesheetFile(), TYPO3\CMS\Core\Page\PageRenderer\getStreamlinedFileName(), and TYPO3\CMS\Core\Page\PageRenderer\processJsFile().

◆ 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

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9.

Definition at line 1405 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\CsvUtility\csvValues().

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

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9

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

Definition at line 4460 of file GeneralUtility.php.

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

◆ 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 a line like: ::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)
int	$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.

Definition at line 4444 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 832 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\dirnameWithDataProvider(), and TYPO3\CMS\Core\Utility\GeneralUtility\getIndpEnv().

◆ 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 676 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
bool	$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 1356 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildBackendUri(), TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem\createShortcutAction(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\explodeUrl2ArrayTransformsParameterStringToFlatArray(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\explodeUrl2ArrayTransformsParameterStringToNestedArray(), TYPO3\CMS\Beuser\Controller\BackendUserActionController\generateMenu(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\getPreserveGetVars(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getQueryArguments(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\getUrlToCurrentLocation(), TYPO3\CMS\Backend\Controller\File\RenameFileController\init(), TYPO3\CMS\Backend\Controller\File\ReplaceFileController\init(), TYPO3\CMS\Beuser\ViewHelpers\IssueCommandViewHelper\initializeArguments(), TYPO3\CMS\Backend\Backend\ToolbarItems\ShortcutToolbarItem\initShortcuts(), TYPO3\CMS\Core\TypoScript\TemplateService\linkData(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\prepareMenuItemsForBrowseMenu(), TYPO3\CMS\Backend\Controller\ContentElement\NewContentElementController\removeInvalidElements(), and TYPO3\CMS\Beuser\ViewHelpers\EditRecordViewHelper\renderStatic().

◆ 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
int	$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 279 of file GeneralUtility.php.

◆ 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
bool	$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 2178 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Locking\FileLockStrategy\acquire(), TYPO3\CMS\Core\Locking\SimpleLockStrategy\acquire(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\addFile(), 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\Service\Archive\ZipService\extract(), 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\Resource\OnlineMedia\Helpers\YouTubeHelper\getPreviewImage(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\VimeoHelper\getPreviewImage(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\gifCompress(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\imageMagickExec(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\ImageWrite(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\moveFolderWithinStorage(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\readPngGif(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\replaceFile(), TYPO3\CMS\Core\Mail\MboxTransport\send(), TYPO3\CMS\Core\Cache\Backend\FileBackend\set(), TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend\set(), TYPO3\CMS\Documentation\Service\DocumentationService\unzipDocumentPackage(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\unzipExtensionFromFile(), TYPO3\CMS\Lang\Service\TerService\unzipTranslationFile(), and TYPO3\CMS\Install\Service\SessionService\write().

◆ 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 2594 of file GeneralUtility.php.

◆ 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: bool Whether the action was successful

Definition at line 2421 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\StringUtility\getUniqueId().

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

◆ flushInternalRuntimeCaches()

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

static

Flush internal runtime caches

Used in unit tests only.

Definition at line 4184 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\allGetIndpEnvCallsRelatedToHostNamesCallIsAllowedHostHeaderValue(), TYPO3\CMS\Frontend\Tests\Unit\Configuration\TypoScript\ConditionMatching\ConditionMatcherTest\genericGetVariablesSucceedsWithNamespaceIENV(), TYPO3\CMS\Backend\Tests\Unit\Configuration\TypoScript\ConditionMatching\ConditionMatcherTest\genericGetVariablesSucceedsWithNamespaceIENV(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\tearDown().

◆ flushOutputBuffers()

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

static

Ends and flushes all output buffers

Deprecated:: since TYPO3 CMS 8, will be removed in TYPO3 CMS 9.

Definition at line 4673 of file GeneralUtility.php.

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

◆ formatSize()

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

static

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

Parameters

int	$sizeInBytes	Number of bytes to format.
string	$labels	Binary unit name "iec", decimal unit name "si" or labels for bytes, kilo, mega, giga, and so on separated by vertical bar (\|) and possibly encapsulated in "". Eg: " \| K\| M\| G". Defaults to "iec".
int	$base	The unit base if not using a unit name. Defaults to 1024.

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

Definition at line 858 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\applyFiltersToValues(), TYPO3\CMS\IndexedSearch\Controller\SearchController\compileSingleResultRow(), TYPO3\CMS\Impexp\ImportExport\displayContentOverview(), TYPO3\CMS\Impexp\Export\export_addFile(), TYPO3\CMS\Impexp\Export\export_addRecord(), TYPO3\CMS\Impexp\Export\export_addSysFile(), TYPO3\CMS\Filelist\FileList\formatFileList(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\formatSizeTranslatesBytesToHigherOrderRepresentation(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\formatValue(), TYPO3\CMS\Impexp\Controller\ImportExportController\getButtons(), TYPO3\CMS\Backend\Clipboard\Clipboard\getContentFromTab(), TYPO3\CMS\Reports\Report\Status\ConfigurationStatus\getDeprecationLogStatus(), TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\getEmailSubject(), TYPO3\CMS\Filelist\FileList\getFolderInfo(), TYPO3\CMS\Frontend\View\AdminPanelView\getInfoModule(), TYPO3\CMS\Backend\Controller\ContentElement\ElementInformationController\getPageTitle(), TYPO3\CMS\Filelist\FileFacade\getSize(), TYPO3\CMS\Backend\Form\FieldWizard\OtherLanguageContent\previewFieldValue(), TYPO3\CMS\Core\Log\Processor\MemoryPeakUsageProcessor\processLogRecord(), TYPO3\CMS\Core\Log\Processor\MemoryUsageProcessor\processLogRecord(), TYPO3\CMS\Backend\Form\Element\FileInfoElement\render(), TYPO3\CMS\Recordlist\Browser\FileBrowser\renderFilesInFolder(), TYPO3\CMS\Recordlist\LinkHandler\FileLinkHandler\renderItem(), TYPO3\CMS\Install\ViewHelpers\File\SizeViewHelper\renderStatic(), and TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\stdWrap_bytes().

◆ freetypeDpiComp()

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

static

Function to compensate for DPI resolution.

Parameters

float $fontSize font size for freetype function call

Returns: float compensated font size based on 96 dpi

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9, the functionality is now moved to GraphicalFunctions->compensateFontSizeiBasedOnFreetypeDpi()

Definition at line 4317 of file GeneralUtility.php.

◆ generateRandomBytes()

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

static

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

Parameters

int $bytesToReturn Number of bytes to return

Returns: string Random Bytes

Deprecated:: since TYPO3 CMS 8, this method will be removed in TYPO3 CMS 9. Use ->generateRandomBytes() instead

Definition at line 1077 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. Will return null if provided path is false.

Parameters

string $path Path to list directories from

Returns: array|string|null Returns an array with the directory entries as values. If no path is provided, the return value will be null.

Definition at line 2455 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(), and TYPO3\CMS\Extensionmanager\Utility\DependencyUtility\getExtensionFromInExtensionRepository().

◆ 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 1445 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\Frontend\Plugin\AbstractPlugin\pi_openAtagHrefInJSwindow(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\resolveMixedLinkParameter(), 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.
bool	$regDirs	If set, directories are also included in output.
int	$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 2551 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\addItemsFromFolder(), TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\crawler_execute_type2(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createZipFileFromExtension(), TYPO3\CMS\Lowlevel\Command\RteImagesCommand\findAllRteFilesInDirectory(), TYPO3\CMS\Lowlevel\Command\LostFilesCommand\findLostFiles(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\getAllFilesAndFoldersInPathReturnsArrayWithMd5Keys(), and TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\includeDirectory().

◆ getApplicationContext()

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

static

Get the ApplicationContext

Returns

Definition at line 4720 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\callRenderMethod(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\determineExceptionHandlerClassName(), TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcher\evaluateConditionCommon(), TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\exceptionHandlerIsEnabledByDefaultInProductionContext(), TYPO3\CMS\Backend\Backend\ToolbarItems\SystemInformationToolbarItem\getApplicationContext(), TYPO3\CMS\Install\Configuration\Context\DebugPreset\getPriority(), TYPO3\CMS\Install\Configuration\Context\LivePreset\getPriority(), TYPO3\CMS\Core\Page\PageRenderer\loadJquery(), 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: int The bytes value (e.g. 102400)

Definition at line 2684 of file GeneralUtility.php.

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

◆ 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 3990 of file GeneralUtility.php.

References TYPO3\CMS\Core\Core\ClassLoadingInformation\getClassNameForAlias().

◆ 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 4537 of file GeneralUtility.php.

References $GLOBALS.

Referenced by 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,
		$_ = `null`,
		$_2 = `null`
	)

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
bool	$_	- obsolete, will be removed in TYPO3 CMS 9
bool	$_2	- obsolete, will be removed in TYPO3 CMS 9

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

Definition at line 3325 of file GeneralUtility.php.

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

◆ 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.
bool	$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 2486 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

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

Returns: string The fully-qualified host name.

Definition at line 3277 of file GeneralUtility.php.

◆ 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 4006 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 2830 of file GeneralUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\dirname(), 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: int The maximum available path length

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 2703 of file GeneralUtility.php.

◆ getMaxUploadFileSize()

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

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.

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

Definition at line 2666 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceStorage\assureFileUploadPermissions(), TYPO3\CMS\Filelist\Controller\FileListController\initializeIndexAction(), and TYPO3\CMS\Backend\Form\Container\InlineControlContainer\renderPossibleRecordsSelectorTypeGroupDB().

◆ getRandomHexString()

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

static

Returns a hex representation of a random byte string.

Parameters

int $count Number of hex characters to return

Returns: string Random Bytes

Deprecated:: since TYPO3 CMS 8, this method will be removed in TYPO3 CMS 9. Use ::generateRandomHexString() instead

Definition at line 1108 of file GeneralUtility.php.

◆ 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 4112 of file GeneralUtility.php.

◆ getUserObj()

static TYPO3\CMS\Core\Utility\GeneralUtility::getUserObj ( $classRef )

static

This method should be avoided, as it will be deprecated completely in TYPO3 v9, and will be removed in TYPO3 v10. Instead use makeInstance() directly.

Creates and returns reference to a user defined object. This function can return an object reference if you like.

Parameters

string $classRef Class reference, '[file-reference":"]class-name'. You can prefix the class name with "[file-reference]:" and GeneralUtility::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". However, the file reference part is marked as deprecated as the class loading mechanism via composer or the autoloading part of TYPO3 should be used instead.

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

See also: callUserFunction()

Definition at line 3905 of file GeneralUtility.php.

◆ 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

int $localizationConfiguration

Returns: bool

Definition at line 3653 of file GeneralUtility.php.

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

◆ 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

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

Returns: bool TRUE if the page should be hidden

Definition at line 3641 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\ContentObject\Menu\AbstractMenuContentObject\prepareMenuItemsForLanguageMenu(), TYPO3\CMS\Frontend\Controller\TranslationStatusController\renderL10nTable(), and TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\settingLanguage().

◆ 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 being used in a different context

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

Definition at line 743 of file GeneralUtility.php.

References $GLOBALS.

◆ hostHeaderValueMatchesTrustedHostsPattern()

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

static

Checks if the provided host header value matches the trusted hosts pattern without any preprocessing.

Parameters

string $hostHeaderValue

Returns: bool

Definition at line 3160 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Install\SystemEnvironment\SetupCheck\checkTrustedHostPattern(), and TYPO3\CMS\Install\Controller\StepController\redirectToTool().

◆ 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 1089 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_input_Eval(), TYPO3\CMS\Core\Mail\MailMessage\idnaEncodeAddress(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\idnaEncodeConvertsUnicodeCharsToASCIIString().

◆ 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 ImageMagick & GraphicsMagick

Deprecated:: since TYPO3 CMS 8, will be removed in TYPO3 CMS 9. - use CommandUtility directly

Definition at line 4601 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\CommandUtility\imageMagickCommand().

◆ 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)
bool	$skipBlank	If set, parameters which were blank strings would be removed.
bool	$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 1333 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
bool	$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!
bool	$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 1517 of file GeneralUtility.php.

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

◆ initSysLog()

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

static

Initialize the system log.

See also: sysLog()

Definition at line 4330 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: bool TRUE if $item is in $list

Definition at line 643 of file GeneralUtility.php.

◆ intExplode()

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

static

Explodes a $string delimited by $delimiter 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
bool	$removeEmptyValues	If set, all empty values (='') will NOT be set in output
int	$limit	If positive, the result will contain a maximum of limit elements,

Returns: array Exploded values, all converted to integers

Definition at line 1233 of file GeneralUtility.php.

◆ 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 435 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 423 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: bool

Definition at line 3381 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\clean_directory(), TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\crawler_execute_type2(), TYPO3\CMS\Rsaauth\BackendWarnings\displayWarningMessages_postProcess(), TYPO3\CMS\Backend\Template\DocumentTemplate\getHtmlTemplate(), TYPO3\CMS\IndexedSearch\Indexer\indexRegularDocument(), 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: bool

Definition at line 3395 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\Service\AbstractService\checkInputFile(), 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\Impexp\Import\loadFile(), TYPO3\CMS\Core\Locking\SimpleLockStrategy\release(), and TYPO3\CMS\Core\Service\AbstractService\writeFile().

◆ 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. The result is saved, so the check needs to be executed only once.

Parameters

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

Returns: bool

Definition at line 3129 of file GeneralUtility.php.

References $GLOBALS.

◆ 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: bool TRUE if $partStr was found to be equal to the first part of $str

Definition at line 845 of file GeneralUtility.php.

Referenced by TYPO3\CMS\SysAction\ActionTask\action_getUserMainDir(), 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\IndexedSearch\Hook\CrawlerHook\checkUrl(), TYPO3\CMS\Core\DataHandling\DataHandler\clear_cacheCmd(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_flexFormCallBack(), TYPO3\CMS\Core\Database\ReferenceIndex\createEntryDataForFileRelationsUsingRecord(), TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\createTempSubDir(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\determineBaseUrl(), TYPO3\CMS\Impexp\Export\export_addFile(), TYPO3\CMS\Documentation\Service\DocumentationService\fetchNearestDocument(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\filelist(), TYPO3\CMS\Lowlevel\Command\LostFilesCommand\findLostFiles(), TYPO3\CMS\Core\ExtDirect\ExtDirectApi\findNamespace(), TYPO3\CMS\Core\Database\SoftReferenceIndex\findRef_images(), TYPO3\CMS\Impexp\Export\fixFileIDsInRelations(), TYPO3\CMS\Backend\View\BackendLayoutView\getColumnName(), 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\Cshmanual\Domain\Repository\TableManualRepository\getSections(), TYPO3\CMS\Core\Utility\MailUtility\getSystemFromAddress(), TYPO3\CMS\Core\IO\PharStreamWrapperInterceptor\isAllowed(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\isFirstPartOfStrReturnsFalseForNotMatchingFirstPart(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\isFirstPartOfStrReturnsTrueForMatchingFirstPart(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\isInLocalDomain(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\isRelativeUrl(), TYPO3\CMS\Saltedpasswords\Task\BulkUpdateTask\isSaltedHash(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\isValidExtensionPath(), TYPO3\CMS\Core\Configuration\ConfigurationManager\isValidLocalConfigurationPath(), TYPO3\CMS\Core\Resource\Driver\LocalDriver\isWithin(), TYPO3\CMS\Saltedpasswords\Tests\Unit\Evaluation\EvaluatorTest\md5HashIsUpdatedToTemporarySaltedString(), TYPO3\CMS\Version\Hook\DataHandlerHook\moveRecord_processFieldValue(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\pageErrorHandler(), TYPO3\CMS\Impexp\Import\processSoftReferences_saveFile(), TYPO3\CMS\Impexp\Import\processSoftReferences_saveFile_createRelFile(), TYPO3\CMS\Backend\Utility\BackendUtility\referenceCount(), TYPO3\CMS\Core\Locking\SimpleLockStrategy\release(), TYPO3\CMS\Backend\Form\FieldControl\AddRecord\render(), TYPO3\CMS\Backend\Form\FieldControl\TableWizard\render(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\renderWizards(), TYPO3\CMS\Core\Resource\ResourceFactory\retrieveFileOrFolderObject(), TYPO3\CMS\Core\Html\RteHtmlParser\runHtmlParserIfConfigured(), TYPO3\CMS\Core\Cache\Backend\SimpleFileBackend\setCacheDirectory(), TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate(), TYPO3\CMS\Form\Service\TranslationService\translate(), and TYPO3\CMS\Impexp\Import\unlinkTempFiles().

◆ 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 Additionally, allows requests when no REQUESTTYPE is set, which can happen quite early in the Bootstrap. See Application.php in EXT:backend/Classes/Http/.

Returns: bool

Definition at line 3191 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: bool Whether the URL matches the TYPO3 request host

Definition at line 630 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 4729 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: bool Whether the given URL is valid

Definition at line 1189 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\Backend\Backend\Avatar\Image\getUrl(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\isInLocalDomain(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validURLReturnsFalseForInvalidRessoure(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validURLReturnsTrueForValidResource().

◆ 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

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 1159 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\lcFirst(), and TYPO3\CMS\Core\Utility\GeneralUtility\underscoredToLowerCamelCase().

◆ linkThisScript()

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

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 2785 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\ReturnUrl\addData(), TYPO3\CMS\Backend\History\RecordHistory\displaySettings(), TYPO3\CMS\Core\TypoScript\ConfigurationForm\ext_getForm(), TYPO3\CMS\Backend\Controller\NewRecordController\getButtons(), TYPO3\CMS\InfoPagetsconfig\Controller\InfoPageTyposcriptConfigController\getList(), TYPO3\CMS\Filelist\Controller\FileListController\getModuleHeadline(), TYPO3\CMS\Recordlist\Browser\DatabaseBrowser\getTemporaryTreeMountCancelNotice(), TYPO3\CMS\Recordlist\LinkHandler\PageLinkHandler\getTemporaryTreeMountCancelNotice(), TYPO3\CMS\Backend\Tree\View\ContentMovingPagePositionMap\linkPageTitle(), TYPO3\CMS\Backend\Tree\View\PageMovingPagePositionMap\linkPageTitle(), TYPO3\CMS\Backend\Tree\View\ContentLayoutPagePositionMap\linkToCurrentModule(), TYPO3\CMS\Filelist\FileList\listURL(), TYPO3\CMS\Backend\Controller\PageLayoutController\local_linkThisScript(), TYPO3\CMS\Backend\Controller\ContentElement\MoveElementController\main(), TYPO3\CMS\Backend\Controller\EditDocumentController\openInNewWindowLink(), TYPO3\CMS\Backend\Clipboard\Clipboard\printClipboard(), TYPO3\CMS\Backend\Template\DocumentTemplate\redirectUrls(), TYPO3\CMS\Backend\Template\ModuleTemplate\redirectUrls(), TYPO3\CMS\Backend\Controller\NewRecordController\regularNew(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateModuleController\renderList(), TYPO3\CMS\Beuser\ViewHelpers\SwitchUserViewHelper\renderStatic(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateModuleController\setInPageArray(), TYPO3\CMS\Backend\Tree\View\PagePositionMap\wrapRecordTitle(), and TYPO3\CMS\Backend\Tree\View\AbstractTreeView\wrapStop().

◆ linkThisUrl()

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

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 2808 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getButtons().

◆ 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 3666 of file GeneralUtility.php.

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

◆ 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

Definition at line 2639 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Form\Domain\Finishers\RedirectFinisher\addBaseUriIfNecessary(), TYPO3\CMS\Backend\Controller\File\FileController\finish(), TYPO3\CMS\Felogin\Controller\FrontendLoginController\generateAndSendHash(), TYPO3\CMS\Core\ExtDirect\ExtDirectApi\generateAPI(), TYPO3\CMS\Frontend\View\AdminPanelView\getAdminPanelHeaderData(), TYPO3\CMS\Extbase\Service\ImageService\getImageUri(), TYPO3\CMS\Core\Resource\ResourceStorage\getPublicUrl(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\locationHeaderUrl(), TYPO3\CMS\Backend\Controller\OnlineMediaController\mainAction(), TYPO3\CMS\Backend\Controller\SimpleDataHandlerController\mainAction(), and TYPO3\CMS\Core\Utility\HttpUtility\redirect().

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

Definition at line 4546 of file GeneralUtility.php.

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

◆ logDeprecatedViewHelperAttribute()

static TYPO3\CMS\Core\Utility\GeneralUtility::logDeprecatedViewHelperAttribute	(	string	$property,
		RenderingContextInterface	$renderingContext,
		string	$additionalMessage = `''`
	)

static

Logs the usage of a deprecated fluid ViewHelper argument. The log message will be generated automatically and contains the template path. With the third argument of this method it is possible to append some text to the log message.

example usage: if ($htmlEscape !== null) { GeneralUtility::logDeprecatedViewHelperAttribute( 'htmlEscape', $renderingContext, 'Please wrap the view helper in <f:format.raw> if you want to disable HTML escaping, which is enabled by default now.' ); }

The example above will create this deprecation log message: 15-02-17 23:12: [typo3/sysext/backend/Resources/Private/Templates/ToolbarItems/HelpToolbarItemDropDown.html] The property "htmlEscape" has been deprecated. Please wrap the view helper in <f:format.raw> if you want to disable HTML escaping, which is enabled by default now.

Parameters

string	$property
RenderingContextInterface	$renderingContext
string	$additionalMessage

Definition at line 4517 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Be\PageRendererViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\Be\ContainerViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\CaseViewHelper\renderStatic(), and TYPO3\CMS\Fluid\ViewHelpers\TranslateViewHelper\renderStatic().

◆ makeInstance()

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

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(::class, $arg1, $arg2, ..., $argN)

You may want to use ::get() if you want TYPO3 to take care about injecting dependencies of the class to be created. Therefore create an instance of ObjectManager via GeneralUtility::makeInstance() first and call its get() method to get the instance of a specific class.

Parameters

string	$className	name of the class to instantiate, must not be empty and not start with a backslash
	array<int,mixed>	$constructorArguments Arguments for the constructor

Returns: object the created instance

Exceptions

Definition at line 3945 of file GeneralUtility.php.

◆ makeInstanceService()

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

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|string[] The service object or an array with error infos.

Definition at line 4199 of file GeneralUtility.php.

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

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

◆ makeRedirectUrl()

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

static

Create a shortened "redirect" URL with specified length from an incoming URL

Parameters

string	$inUrl	Input URL
int	$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 4283 of file GeneralUtility.php.

References $GLOBALS.

◆ 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: int Returns 28bit integer-hash

Definition at line 719 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\getId(), TYPO3\CMS\Filelist\Controller\FileListController\getModuleHeadline(), TYPO3\CMS\Backend\Tree\View\FolderTreeView\getShortHashNumberForStorage(), and TYPO3\CMS\Filelist\FileList\linkWrapDir().

◆ milliseconds()

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

static

Gets the unixtime as milliseconds.

Returns: int The unixtime as milliseconds

Definition at line 3201 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\combineImages(), TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\getEmailSubject(), TYPO3\CMS\IndexedSearch\Indexer\indexRegularDocument(), TYPO3\CMS\IndexedSearch\Indexer\indexTypo3PageContent(), TYPO3\CMS\Core\Core\SystemEnvironmentBuilder\initializeGlobalTimeTrackingVariables(), 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 1991 of file GeneralUtility.php.

References $GLOBALS.

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\Core\Tests\Unit\Utility\GeneralUtilityTest\minifyJavaScriptWritesExceptionMessageToDevLog().

◆ mkdir()

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

static

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

Parameters

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

Returns: bool TRUE if went well!

Definition at line 2299 of file GeneralUtility.php.

References $GLOBALS.

◆ 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

Exceptions

Definition at line 2317 of file GeneralUtility.php.

◆ 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 447 of file GeneralUtility.php.

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

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

◆ presetApplicationContext()

static TYPO3\CMS\Core\Utility\GeneralUtility::presetApplicationContext ( 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 4706 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

Definition at line 4171 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(), TYPO3\CMS\Backend\Tests\Unit\Form\FormDataProvider\TcaRadioItemsTest\tearDown(), TYPO3\CMS\Backend\Tests\Unit\Form\FormDataProvider\TcaCheckboxItemsTest\tearDown(), TYPO3\CMS\Core\Tests\Unit\Service\MarkerBasedTemplateServiceTest\tearDown(), TYPO3\CMS\Extbase\Tests\Unit\Persistence\Generic\Storage\Typo3DbQueryParserTest\tearDown(), TYPO3\CMS\Backend\Tests\Unit\Form\FormDataProvider\DatabaseSystemLanguageRowsTest\tearDown(), TYPO3\CMS\Frontend\Tests\Unit\Authentication\FrontendUserAuthenticationTest\tearDown(), TYPO3\CMS\Backend\Tests\Unit\Form\FormDataProvider\TcaSelectItemsTest\tearDown(), TYPO3\CMS\Backend\Tests\Unit\Form\FormDataProvider\TcaFlexPrepareTest\tearDown(), TYPO3\CMS\Frontend\Tests\Unit\ContentObject\Menu\AbstractMenuContentObjectTest\tearDown(), TYPO3\CMS\Backend\Tests\Unit\Form\FormDataProvider\TcaSelectTreeItemsTest\tearDown(), TYPO3\CMS\Felogin\Tests\Unit\Controller\FrontendLoginControllerTest\tearDown(), and TYPO3\CMS\Fluid\Tests\Unit\View\StandaloneViewTest\tearDown().

◆ 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 4652 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

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9, use the PHP methods directly instead

Definition at line 991 of file GeneralUtility.php.

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

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

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9, implement directly via PHP instead

Definition at line 977 of file GeneralUtility.php.

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

◆ 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 1418 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Authentication\BackendUserAuthentication\backendSetUC(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\getConfigArray(), TYPO3\CMS\Fluid\View\TemplatePaths\getContextSpecificViewConfiguration(), TYPO3\CMS\Backend\Form\Utility\FormEngineUtility\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 2575 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Form\FormDataProvider\AbstractItemProvider\addItemsFromFolder(), TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\crawler_execute_type2(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\createZipFileFromExtension(), TYPO3\CMS\Lowlevel\Command\RteImagesCommand\findAllRteFilesInDirectory(), and TYPO3\CMS\Lowlevel\Command\LostFilesCommand\findLostFiles().

◆ removeSingletonInstance()

static TYPO3\CMS\Core\Utility\GeneralUtility::removeSingletonInstance	(		$className,
		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 4067 of file GeneralUtility.php.

◆ 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

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 254 of file GeneralUtility.php.

◆ 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

Deprecated:: since TYPO3 CMS 8, this method will be removed in TYPO3 CMS 9

Definition at line 4267 of file GeneralUtility.php.

◆ 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

Deprecated:: since TYPO3 CMS 8, this method will be removed in TYPO3 CMS 9

Definition at line 4251 of file GeneralUtility.php.

◆ 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 4092 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.

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9. This is now integrated in FlexFormTools->parseDataStructureByIdentifier()

Definition at line 3756 of file GeneralUtility.php.

◆ 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 2606 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Controller\BackendController\addJavascriptFile(), TYPO3\CMS\Core\Resource\ResourceCompressor\compressCssFile(), TYPO3\CMS\Core\Resource\ResourceCompressor\compressJsFile(), TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile(), TYPO3\CMS\Impexp\Export\export_addFile(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\getAbsolutePath(), TYPO3\CMS\Core\Utility\PathUtility\getAbsoluteWebPath(), TYPO3\CMS\Core\Resource\ResourceCompressor\getFilenameFromMainDir(), TYPO3\CMS\Backend\Template\DocumentTemplate\getHtmlTemplate(), TYPO3\CMS\Backend\Domain\Repository\Module\BackendModuleRepository\getLanguageService(), TYPO3\CMS\Backend\Controller\AbstractFormEngineAjaxController\getRelativePathToStylesheetFile(), TYPO3\CMS\Core\Page\PageRenderer\getStreamlinedFileName(), TYPO3\CMS\IndexedSearch\Hook\CrawlerHook\indexExtUrl(), TYPO3\CMS\IndexedSearch\Indexer\isAllowedLocalFile(), TYPO3\CMS\Impexp\Import\processSoftReferences_saveFile_createRelFile(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\resolveBackPathWithDataProvider().

◆ 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!

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9. This is now integrated in FlexFormTools->parseDataStructureByIdentifier()

Definition at line 3716 of file GeneralUtility.php.

◆ 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
int	$count	Number of array entries

Returns: array Exploded values

Definition at line 1270 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\Version\Hook\DataHandlerHook\getEmailsForStageChangeNotification(), TYPO3\CMS\Core\Core\SystemEnvironmentBuilder\getRootPathFromScriptPath(), TYPO3\CMS\Backend\Controller\Wizard\EditController\mainAction(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\revExplodeCorrectlyExplodesStringForGivenPartsCount(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\revExplodeRespectsLimitThreeWhenExploding().

◆ 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.
bool	$removeNonEmpty	Allow deletion of non-empty directories

Returns: bool TRUE if went well!

Definition at line 2373 of file GeneralUtility.php.

◆ 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 658 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Filelist\FileList\linkClipboardHeaderIcon(), 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.

If the given url is empty or considered to be harmless, it is returned as is, else the event is logged and an empty string is returned.

Parameters

string $url potential URL to check

Returns: string $url or empty string

Definition at line 3465 of file GeneralUtility.php.

◆ setSingletonInstance()

static TYPO3\CMS\Core\Utility\GeneralUtility::setSingletonInstance	(		$className,
		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

Definition at line 4046 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
int	$len	The string-length of the output

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

Definition at line 731 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\Lowlevel\Command\WorkspaceVersionRecordsCommand\findInvalidMovePlaceholderRecords(), TYPO3\CMS\Workspaces\Controller\PreviewController\generateJavascript(), TYPO3\CMS\Backend\Controller\BackendController\generateJavascript(), TYPO3\CMS\RteCKEditor\Form\Element\RichTextElement\getCkEditorRequireJsModuleCode(), TYPO3\CMS\Core\Resource\Processing\AbstractTask\getConfigurationChecksum(), TYPO3\CMS\Backend\Clipboard\Clipboard\getContentFromTab(), TYPO3\CMS\Backend\Template\ModuleTemplate\getDynamicTabMenu(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\imageMagickConvert(), TYPO3\CMS\Frontend\Page\PageGenerator\inline2TempFile(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isRecordInClipboard(), TYPO3\CMS\Filelist\FileList\makeClip(), TYPO3\CMS\Filelist\FileList\makeEdit(), TYPO3\CMS\Core\Hooks\BackendUserPasswordCheck\processDatamap_preProcessFieldArray(), TYPO3\CMS\Backend\Form\Container\FlexFormTabsContainer\render(), TYPO3\CMS\Backend\Form\Container\TabsContainer\render(), TYPO3\CMS\Backend\Form\Element\AbstractFormElement\renderWizards(), TYPO3\CMS\Core\Html\RteHtmlParser\runHtmlParserIfConfigured(), TYPO3\CMS\Core\Cache\Backend\ApcuBackend\setCache(), TYPO3\CMS\Core\Cache\Backend\ApcBackend\setCache(), TYPO3\CMS\Core\Tests\Unit\Cache\Backend\ApcuBackendTest\setRemovesTagsFromPreviousSet(), TYPO3\CMS\Core\Tests\Unit\Cache\Backend\ApcBackendTest\setRemovesTagsFromPreviousSet(), TYPO3\CMS\Frontend\ContentObject\Menu\JavaScriptMenuContentObject\writeMenu(), and TYPO3\CMS\Frontend\ContentObject\Menu\ImageMenuContentObject\writeMenu().

◆ 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
bool	$extended	If set, also backslashes are escaped.
string	$char	The character to escape, default is ' (single-quote)

Returns: string Processed input string

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9

Definition at line 960 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 793 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\addParams(), TYPO3\CMS\Core\DataHandling\DataHandler\applyFiltersToValues(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\filelist(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\getUniqueName(), TYPO3\CMS\Core\Imaging\GraphicalFunctions\IMreduceColors(), TYPO3\CMS\Frontend\ContentObject\FileContentObject\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\Import\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 1481 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 921 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().

◆ splitHeaderLines()

static TYPO3\CMS\Core\Utility\GeneralUtility::splitHeaderLines ( array $headers )

staticprotected

Split an array of MIME header strings into an associative array. Multiple headers with the same name have their values merged as an array.

Parameters

array $headers List of headers, eg. ['Foo: Bar', 'Foo: Baz']

Returns: array Key/Value(s) pairs of headers, eg. ['Foo' => ['Bar', 'Baz']]

Definition at line 2119 of file GeneralUtility.php.

◆ 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 (int) or record (array)
string	$fields	List of fields from the record if that is given.
int	$codeLength	Length of returned authentication code.

Returns: string MD5 hash of 8 chars.

Definition at line 3614 of file GeneralUtility.php.

References $fields, and $GLOBALS.

◆ 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

Deprecated:: since TYPO3 CMS v8, this method will be removed in TYPO3 CMS v9, use mb_strtolower() instead

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

Deprecated:: since TYPO3 CMS v8, this method will be removed in TYPO3 CMS v9, use mb_strtoupper() instead

Definition at line 1048 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Utility\GeneralUtility\initSysLog(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\strtoupperConvertsOnlyLatinCharacters().

◆ 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 3588 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\createNewFile(), TYPO3\CMS\Impexp\Controller\ImportExportController\getButtons(), TYPO3\CMS\Core\Tests\Unit\Http\UploadedFileTest\getGetStreamRaisesExceptionAfterMove(), TYPO3\CMS\Core\Tests\Unit\Imaging\IconProvider\SvgIconProviderTest\getIconWithInlineOptionReturnsCleanSvgMarkup(), TYPO3\CMS\Core\Resource\Processing\LocalPreviewHelper\getTemporaryFilePath(), TYPO3\CMS\Impexp\Import\import_addFileNameToBeCopied(), TYPO3\CMS\IndexedSearch\Indexer\indexExternalUrl(), TYPO3\CMS\Impexp\Tests\Functional\AbstractImportExportTestCase\isCaseSensitiveFilesystem(), TYPO3\CMS\Core\Tests\Unit\Http\UploadedFileTest\moveToCannotBeCalledMoreThanOnce(), TYPO3\CMS\Core\Tests\Unit\Http\UploadedFileTest\moveToMovesFileToDesignatedPath(), TYPO3\CMS\IndexedSearch\FileContentParser\readFileContent(), 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(), and TYPO3\CMS\Impexp\Import\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 1300 of file GeneralUtility.php.

◆ 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 1133 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapFactory\buildDataMap(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\caseshift(), TYPO3\CMS\Backend\Controller\BackendController\loadResourcesForRegisteredNavigationComponents(), 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 1121 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\caseshift(), TYPO3\CMS\Core\Page\PageRenderer\computeRequireJsConfig(), TYPO3\CMS\Extbase\Scheduler\TaskExecutor\execute(), 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 776 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Utility\File\BasicFileUtility\__construct(), 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\Filelist\FileList\linkClipboardHeaderIcon(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\setFileExtensionPermissions(), 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: bool Returns TRUE if the file was unlink()'ed

See also: upload_to_tempfile(), tempnam()

Definition at line 3562 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Resource\Processing\LocalCropScaleMaskHelper\__construct(), TYPO3\CMS\Frontend\Tests\Unit\ContentObject\ContentObjectRendererTest\filelinkCreatesCorrectUrlForFileWithUrlEncodedSpecialChars(), TYPO3\CMS\Core\Resource\OnlineMedia\Processing\PreviewProcessing\needsReprocessing(), 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\Import\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
bool	$unQuote	If set, the elements of the resulting array are unquoted.

Returns: array Exploded parameters

Definition at line 4616 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\explodeAndUnquoteImageMagickCommands(), and TYPO3\CMS\Core\Utility\CommandUtility\imageMagickCommand().

◆ 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: bool Returns TRUE if the file was moved.

See also: upload_to_tempfile()

Definition at line 3502 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\applyFiltersToValues(), TYPO3\CMS\Lowlevel\Command\FilesWithMultipleReferencesCommand\copyMultipleReferencedFiles(), TYPO3\CMS\Lowlevel\Command\RteImagesCommand\copyMultipleReferencedRteImages(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_flexFormCallBack(), TYPO3\CMS\Impexp\Export\export_addFile(), TYPO3\CMS\Impexp\Export\export_addSysFile(), and TYPO3\CMS\Core\Http\UploadedFile\moveTo().

◆ 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 3536 of file GeneralUtility.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Extensionmanager\Controller\UploadExtensionFileController\extractAction().

◆ 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: bool Returns TRUE if the $email address (input string) is valid

Definition at line 1015 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValue_input_Eval(), TYPO3\CMS\Install\Controller\Action\Tool\TestSetup\executeAction(), TYPO3\CMS\Linkvalidator\Task\ValidatorTask\getLinkTypes(), TYPO3\CMS\Workspaces\Controller\Remote\ActionHandler\getRecipientList(), TYPO3\CMS\Workspaces\Controller\Remote\ActionHandler\getRecipientsOfStage(), TYPO3\CMS\Core\Utility\MailUtility\getSystemFromAddress(), TYPO3\CMS\Frontend\ContentObject\Menu\AbstractMenuContentObject\link(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\linkUrlMail(), TYPO3\CMS\Core\LinkHandling\LegacyLinkNotationConverter\resolve(), TYPO3\CMS\Reports\Task\SystemStatusUpdateTaskNotificationEmailField\validateAdditionalFields(), 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: bool TRUE if $ip is either of IPv4 or IPv6 format.

Definition at line 524 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: bool TRUE if $ip is of IPv4 format.

Definition at line 537 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: bool TRUE if $ip is of IPv6 format.

Definition at line 550 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: bool TRUE, $theFile is allowed path string, FALSE otherwise

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

Definition at line 3369 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\clean_directory(), TYPO3\CMS\Core\Charset\CharsetConverter\initCharset(), TYPO3\CMS\Core\Charset\CharsetConverter\initUnicodeData(), TYPO3\CMS\Core\Utility\File\BasicFileUtility\is_directory(), TYPO3\CMS\Core\IO\PharStreamWrapperInterceptor\isAllowed(), TYPO3\CMS\Core\Resource\Driver\AbstractHierarchicalFilesystemDriver\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 always filter on [[:cntrl:]].

Parameters

string $filename File path to evaluate

Returns: bool

Definition at line 3415 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\Form\Mvc\Property\TypeConverter\UploadedFileReferenceConverter\importUploadedResource(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\includeFile(), TYPO3\CMS\Backend\Controller\File\CreateFolderController\main(), TYPO3\CMS\Recordlist\View\FolderUtilityRenderer\uploadForm(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\verifyFilenameAgainstDenyPatternAcceptAllowedFiles(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\verifyFilenameAgainstDenyPatternDetectsNotAllowedFiles(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\verifyNulCharacterFilesAgainstPatternWithoutFileDenyPattern().

◆ wrapJS()

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

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
null	$_	unused, will be removed in TYPO3 CMS 9

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

Definition at line 1546 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Backend\Controller\LoginController\checkRedirect(), TYPO3\CMS\Core\Utility\DebugUtility\debug(), TYPO3\CMS\Core\Utility\DebugUtility\debugInPopUpWindow(), TYPO3\CMS\Backend\Template\DocumentTemplate\endPage(), TYPO3\CMS\Core\TypoScript\ConfigurationForm\ext_getForm(), TYPO3\CMS\Backend\Controller\Wizard\ColorpickerController\frameSet(), TYPO3\CMS\Core\Page\PageRenderer\getRequireJsLoader(), TYPO3\CMS\Fluid\ViewHelpers\Be\TableListViewHelper\initializeArguments(), TYPO3\CMS\Backend\Template\DocumentTemplate\insertStylesAndJS(), TYPO3\CMS\Backend\Form\FormResultCompiler\JSbottom(), TYPO3\CMS\Recordlist\Controller\ElementBrowserFramesetController\main(), TYPO3\CMS\Fluid\ViewHelpers\Be\ContainerViewHelper\render(), and TYPO3\CMS\Core\Page\PageRenderer\renderJqueryScriptTag().

◆ 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
bool	$changePermissions	If TRUE, permissions are forced to be set

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

Definition at line 2151 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Resource\ResourceCompressor\__construct(), TYPO3\CMS\Core\Log\Writer\FileWriter\createHtaccessFile(), TYPO3\CMS\Core\Log\Writer\FileWriter\createLogFile(), TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile(), TYPO3\CMS\Install\Tests\Unit\Controller\Action\Ajax\ExtensionCompatibilityTesterTest\deleteProtocolFileDeletesFile(), TYPO3\CMS\Install\Service\SessionService\ensureSessionSavePathExists(), TYPO3\CMS\Backend\Command\LockBackendCommand\execute(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\extractIncludes(), TYPO3\CMS\Documentation\Service\DocumentationService\fetchNearestDocument(), TYPO3\CMS\Impexp\Import\import_addFileNameToBeCopied(), TYPO3\CMS\IndexedSearch\Indexer\indexExternalUrl(), TYPO3\CMS\Core\Core\ClassLoadingInformation\isClassLoadingInformationAvailable(), TYPO3\CMS\Impexp\Import\processSoftReferences_saveFile_createRelFile(), TYPO3\CMS\Install\Controller\Action\Ajax\ExtensionCompatibilityTester\removeCurrentExtensionFromFile(), TYPO3\CMS\Install\Tests\Unit\Controller\Action\Ajax\ExtensionCompatibilityTesterTest\removeCurrentExtensionFromFileRemovesGivenExtension(), TYPO3\CMS\Core\Resource\ResourceCompressor\retrieveExternalFile(), TYPO3\CMS\Core\Package\PackageManager\sortAndSavePackageStates(), 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\Import\writeFileVerify(), TYPO3\CMS\Core\Configuration\ConfigurationManager\writeLocalConfiguration(), and TYPO3\CMS\Impexp\Import\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 2246 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Feedit\FrontendEditAssetLoader\attachAssets(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\copyDirectoryCopiesFilesAndDirectoriesWithAbsolutePaths(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\copyDirectoryCopiesFilesAndDirectoriesWithRelativePaths(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\createNewFile(), TYPO3\CMS\Extensionmanager\Utility\UpdateScriptUtility\determineUpdateClassName(), TYPO3\CMS\Extensionmanager\Controller\ActionController\downloadExtensionDataAction(), TYPO3\CMS\Extensionmanager\Utility\Repository\Helper\fetchFile(), TYPO3\CMS\Documentation\Service\DocumentationService\fetchNearestDocument(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsWithRelativeFileReference(), TYPO3\CMS\Backend\Controller\BackendController\getLocalLangFileName(), TYPO3\CMS\Documentation\Service\DocumentationService\getOfficialDocuments(), 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\Frontend\Page\PageGenerator\inline2TempFile(), TYPO3\CMS\Install\Controller\Action\Ajax\ExtensionCompatibilityTester\logError(), TYPO3\CMS\Core\Tests\Unit\Resource\ResourceFactoryTest\retrieveFileOrFolderObjectReturnsFileIfPathIsGiven(), TYPO3\CMS\Lang\Service\TerService\updateTranslation(), TYPO3\CMS\Version\Hook\DataHandlerHook\version_setStage(), and TYPO3\CMS\Install\Controller\Action\Ajax\ExtensionCompatibilityTester\writeCurrentExtensionToFile().

◆ 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:"
bool	$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 1797 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValueForFlex(), TYPO3\CMS\Extbase\Service\FlexFormService\convertFlexFormContentToArray(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_procBasedOnFieldType(), TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate\enrichFormDefinitionsInformationWithDataFromReferences(), TYPO3\CMS\Form\Hooks\DataStructureIdentifierHook\getDataStructureIdentifierPostProcess(), TYPO3\CMS\Backend\Utility\BackendUtility\getFlexFormDS(), TYPO3\CMS\Core\Database\ReferenceIndex\getRelations(), TYPO3\CMS\Backend\Form\FormDataProvider\TcaFlexPrepare\initializeDataValues(), TYPO3\CMS\Install\Updates\TableFlexFormToTtContentFieldsUpdate\initializeFlexForm(), TYPO3\CMS\Impexp\Import\loadFile(), TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\parseDataStructureByIdentifier(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_initPIflexForm(), TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\readFlexformIntoConf(), TYPO3\CMS\Core\DataHandling\DataHandler\remapListedDBRecords(), TYPO3\CMS\Impexp\Import\remapListedDBRecords_flexFormCallBack(), TYPO3\CMS\Form\Tests\Functional\Hooks\FormFileExtensionUpdateTest\retrieveAllFlexForms(), TYPO3\CMS\Impexp\Import\setFlexFormRelations(), TYPO3\CMS\Backend\Controller\Wizard\TableController\tableWizard(), TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\traverseFlexFormXMLData(), TYPO3\CMS\Core\DataHandling\DataHandler\updateFlexFormData(), TYPO3\CMS\Core\DataHandling\DataHandler\versionizeRecord(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\xml2ArrayDealsProperlyWithWhitespace().

◆ 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:"
bool	$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 1822 of file GeneralUtility.php.

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

◆ xml2tree()

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

static

Parses XML input into a PHP array with associative keys

Parameters

string	$string	XML data input
int	$depth	Number of element levels to resolve the XML into an array. Any further structure will be set as XML.
array	$parserOptions	Options that will be passed to PHP's xml_parser_set_option()

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.

Definition at line 1577 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)

Deprecated:: since TYPO3 v8, will be removed in TYPO3 v9.

Definition at line 1975 of file GeneralUtility.php.

◆ 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 1930 of file GeneralUtility.php.

Member Data Documentation

◆ $allowHostHeaderValue

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

staticprotected

Definition at line 57 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 86 of file GeneralUtility.php.

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

◆ $finalClassNameCache

TYPO3\CMS\Core\Utility\GeneralUtility::$finalClassNameCache = []

staticprotected

Definition at line 79 of file GeneralUtility.php.

◆ $idnaConverter

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

staticprotected

Definition at line 100 of file GeneralUtility.php.

◆ $idnaStringCache

TYPO3\CMS\Core\Utility\GeneralUtility::$idnaStringCache = []

staticprotected

Definition at line 93 of file GeneralUtility.php.

◆ $indpEnvCache

TYPO3\CMS\Core\Utility\GeneralUtility::$indpEnvCache = []

staticprotected

Definition at line 118 of file GeneralUtility.php.

◆ $nonSingletonInstances

TYPO3\CMS\Core\Utility\GeneralUtility::$nonSingletonInstances = []

staticprotected

Definition at line 72 of file GeneralUtility.php.

◆ $singletonInstances

TYPO3\CMS\Core\Utility\GeneralUtility::$singletonInstances = []

staticprotected

Definition at line 65 of file GeneralUtility.php.

◆ $supportedCgiServerApis

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

staticprotected

Initial value:

= [
        'fpm-fcgi',
        'cgi',
        'isapi',
        'cgi-fcgi',
        'srv', 
    ]

Definition at line 107 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 48 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Install\SystemEnvironment\SetupCheck\checkTrustedHostPattern(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\getIndpEnvForHostAllowsAllHostnameValuesIfHostPatternIsSetToAllowAll(), TYPO3\CMS\Reports\Report\Status\SecurityStatus\getTrustedHostsPatternStatus(), 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 49 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 45 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Database\DatabaseConnection\checkConnectionCharset(), TYPO3\CMS\Frontend\Page\PageRepository\checkWorkspaceAccess(), TYPO3\CMS\Core\Database\Connection\connect(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\connectToDB(), TYPO3\CMS\Core\Database\DatabaseConnection\debug_check_recordset(), TYPO3\CMS\Core\Database\ReferenceIndex\destPathFromUploadFolder(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\fetch_the_id(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\getConfigArray(), TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getCookieDomain(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\getPageAndRootline(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\getPageShortcut(), TYPO3\CMS\Core\Session\Backend\RedisSessionBackend\initializeConnection(), TYPO3\CMS\Core\Cache\Backend\RedisBackend\initializeObject(), TYPO3\CMS\Extbase\Scheduler\Task\logException(), TYPO3\CMS\Scheduler\Task\AbstractTask\logException(), TYPO3\CMS\Recordlist\RecordList\AbstractDatabaseRecordList\makeFieldList(), TYPO3\CMS\Core\Cache\Backend\ApcuBackend\set(), TYPO3\CMS\Core\Cache\Backend\ApcBackend\set(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\settingLanguage(), TYPO3\CMS\Workspaces\Service\GridDataService\sortDataArray(), TYPO3\CMS\Core\Database\DatabaseConnection\sql_field_type(), and TYPO3\CMS\Backend\Utility\BackendUtility\titleAltAttrib().

◆ SYSLOG_SEVERITY_FATAL

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

Definition at line 46 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Database\DatabaseConnection\sql_field_type(), TYPO3\CMS\Core\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 42 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Saltedpasswords\SaltedPasswordService\authUser(), and TYPO3\CMS\Extbase\Validation\ValidatorResolver\createValidator().

◆ SYSLOG_SEVERITY_NOTICE

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

Definition at line 43 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\Saltedpasswords\SaltedPasswordService\updatePassword().

◆ SYSLOG_SEVERITY_WARNING

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

Definition at line 44 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\__construct(), TYPO3\CMS\Sv\AuthenticationService\authUser(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\error(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\executeValueModifier(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\extractIncludes(), TYPO3\CMS\Sv\AuthenticationService\getUser(), TYPO3\CMS\Backend\View\PageLayoutView\isDragAndDropAllowed(), TYPO3\CMS\Core\Tests\Unit\Database\DatabaseConnectionTest\noQuoteForFullQuoteArrayDataProvider(), TYPO3\CMS\Backend\Form\FieldWizard\FileThumbnails\render(), TYPO3\CMS\Core\Cache\Backend\MemcachedBackend\set(), TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController\set_no_cache(), TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\typoscriptIncludeError(), 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()

◆ array2xml()

◆ array2xml_cs()

◆ arrayToLogString()

◆ callUserFunction()

◆ camelCaseToLowerCaseUnderscored()

◆ checkInstanceClassName()

◆ classHasImplementation()

◆ clientInfo()

◆ cmpFQDN()

◆ cmpIP()

◆ cmpIPv4()

◆ cmpIPv6()

◆ compat_version()

◆ compileSelectedGetVarsFromArray()

◆ compressIPv6()

◆ convertMicrotime()

◆ copyDirectory()

◆ createDirectoryPath()

◆ createVersionNumberedFilename()

◆ csvValues()

◆ deHSCentities()

◆ deprecationLog()

◆ devLog()

◆ dirname()

◆ expandList()

◆ explodeUrl2Array()

◆ fixed_lgd_cs()

◆ fixPermissions()

◆ fixWindowsFilePath()

◆ flushDirectory()

◆ flushInternalRuntimeCaches()

◆ flushOutputBuffers()

◆ formatSize()

◆ freetypeDpiComp()

◆ generateRandomBytes()

◆ get_dirs()

◆ get_tag_attributes()

◆ getAllFilesAndFoldersInPath()

◆ getApplicationContext()

◆ getBytesFromSizeMeasurement()

◆ getClassName()

◆ getDeprecationLogFileName()

◆ getFileAbsFileName()

◆ getFilesInDir()

◆ getHostname()

◆ getImplementationForClass()

◆ getIndpEnv()

◆ getMaximumPathLength()

◆ getMaxUploadFileSize()

◆ getRandomHexString()

◆ getSingletonInstances()

◆ getUserObj()

◆ hideIfDefaultLanguage()

◆ hideIfNotTranslated()

◆ hmac()

◆ hostHeaderValueMatchesTrustedHostsPattern()

◆ idnaEncode()

◆ imageMagickCommand()

◆ implodeArrayForUrl()

◆ implodeAttributes()

◆ initSysLog()

◆ inList()

◆ intExplode()

◆ IPv6Bin2Hex()

◆ IPv6Hex2Bin()

◆ isAbsPath()

◆ isAllowedAbsPath()

◆ isAllowedHostHeaderValue()