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

Static Public Member Functions
static mixed	_GP ($var)

static array	_GPmerged ($parameter)

static mixed	_GET ($var=null)

static mixed	_POST ($var=null)

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

static bool	cmpIP ($baseIP, $list)

static bool	cmpIPv4 ($baseIP, $list)

static bool	cmpIPv6 ($baseIP, $list)

static string	normalizeIPv6 ($address)

static bool	validIP ($ip)

static bool	validIPv4 ($ip)

static bool	validIPv6 ($ip)

static bool	cmpFQDN ($baseHost, $list)

static bool	isOnCurrentHost ($url)

static bool	inList ($list, $item)

static string	expandList ($list)

static int	md5int ($str)

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

static array< int, splitCalc( $string, $operators){ $res=[];$sign='+';while( $string) { $valueLen=strcspn( $string, $operators);$value=substr( $string, 0, $valueLen);$res[]=[ $sign, trim( $value)];$sign=substr( $string, $valueLen, 1);$string=substr( $string, $valueLen+1);} reset( $res);return $res;} public static bool function validEmail( $email) { if(!is_string( $email)) { return false;} if(trim( $email) !==$email) { return false;} if(!str_contains( $email, '@')) { return false;} $validators=[];foreach( $GLOBALS[ 'TYPO3_CONF_VARS'][ 'MAIL'][ 'validators'] ??[RFCValidation::class] as $className) { $validator=new $className();if( $validator instanceof EmailValidation) { $validators[]=$validator;} } return(new EmailValidator()) ->	isValid ($email, new MultipleValidationWithAnd($validators, MultipleValidationWithAnd::STOP_ON_ERROR))

static string	underscoredToUpperCamelCase ($string)

static string	underscoredToLowerCamelCase ($string)

static string	camelCaseToLowerCaseUnderscored ($string)

static bool	isValidUrl ($url)

static int[]	intExplode ($delimiter, $string, $removeEmptyValues=false, $limit=0)

static list< string >	revExplode ($delimiter, $string, $limit=0)

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

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

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

static mixed	xml2arrayProcess ($string, $NSprefix='', $reportDocTag=false)

static string	xmlRecompileFromStructValArray (array $vals)

static string false	getUrl ($url)

static bool	writeFile ($file, $content, $changePermissions=false)

static mixed	fixPermissions ($path, $recursive=false)

static string null	writeFileToTypo3tempDir ($filepath, $content)

static bool	mkdir ($newFolder)

static	mkdir_deep ($directory)

static bool	rmdir ($path, $removeNonEmpty=false)

static string[] string null	get_dirs ($path)

Public Attributes
static if(empty($labels)) if(isset($defaultFormats[$labels]))	else

if($base !==1000 && $base !==1024)	$labelArr = explode('\|', str_replace('"', '', $labels))

	$localeInfo = localeconv()

	$sizeInBytes = max($sizeInBytes, 0)

	$multiplier = floor(($sizeInBytes ? log($sizeInBytes) : 0) / log($base))

	$sizeInUnits = $sizeInBytes / $base ** $multiplier

if($sizeInUnits >($base *.9))	$multiplier = min($multiplier, count($labelArr) - 1)

	$nl = $spaceInd >= 0 ? LF : ''

	$output = ''

foreach($array as $k=> $v) if(! $level) return	$output

Static Public Attributes
static array< string, function explodeUrl2Array( $string) { $output=[];$p=explode('&', $string);foreach( $p as $v) { if( $v !=='') { $nameAndValue=explode('=', $v, 2);$output[rawurldecode( $nameAndValue[0])]=isset( $nameAndValue[1]) ? rawurldecode( $nameAndValue[1]) :'';} } return $output;} public static array function removeDotsFromTS(array $ts):array { $out=[];foreach( $ts as $key=> $value) { if(is_array( $value)) { $key=rtrim( $key, '.');$out[ $key]=self::removeDotsFromTS( $value);} else { $out[ $key]=$value;} } return $out;} public static array< string, function get_tag_attributes( $tag, bool $decodeEntities=false) { $components=self::split_tag_attributes( $tag);$name='';$valuemode=false;$attributes=[];foreach( $components as $key=> $val) { if( $val !=='=') { if( $valuemode) { if( $name) { $attributes[ $name]=$decodeEntities ? htmlspecialchars_decode( $val) :$val;$name='';} } else { if( $key=strtolower(preg_replace('/[^[:alnum:]_\\:\\-]/', '', $val) ?? '')) { $attributes[ $key]='';$name=$key;} } $valuemode=false;} else { $valuemode=true;} } return $attributes;} public static string[] function split_tag_attributes( $tag) { $tag_tmp=trim(preg_replace('/^<[^[:space:]] */', '', trim( $tag)) ?? '');$tag_tmp=trim(rtrim( $tag_tmp, '>'));$value=[];while( $tag_tmp !=='') { $firstChar=$tag_tmp[0];if( $firstChar==='"' \|\| $firstChar === '\'') { $reg = explode($firstChar, $tag_tmp, 3); $value[] = $reg[1]; $tag_tmp = trim($reg[2] ?? ''); } elseif ($firstChar === '=') { $value[] = '='; $tag_tmp = trim(substr($tag_tmp, 1)); } else { $reg = preg_split('/[[:space:]=]/', $tag_tmp, 2); $value[] = trim($reg[0]); $tag_tmp = trim(substr($tag_tmp, strlen($reg[0]), 1) . ($reg[1] ?? '')); } } reset($value); return $value; } public static string function implodeAttributes(array $arr, $xhtmlSafe = false, $keepBlankAttributes = false) { if ($xhtmlSafe) { $newArr = []; foreach ($arr as $attributeName => $attributeValue) { $attributeName = strtolower($attributeName); if (!isset($newArr[$attributeName])) { $newArr[$attributeName] = htmlspecialchars((string)$attributeValue); } } $arr = $newArr; } $list = []; foreach ($arr as $attributeName => $attributeValue) { if ((string)$attributeValue !== '' \|\| $keepBlankAttributes) { $list[] = $attributeName . '="' . $attributeValue . '"'; } } return implode(' ', $list); } public static string function wrapJS(string $string, array $attributes = []) { if (trim($string)) { $string = ltrim($string, LF); $match = []; if (preg_match('/^(\\t+)/', $string, $match)) { $string = str_replace($match[1], "\t", $string); } return '<script ' . GeneralUtility::implodeAttributes($attributes, true) . '>' . $string . '</script>'; } return ''; } public static mixed function xml2tree($string, $depth = 999, $parserOptions = []) { $parser = xml_parser_create(); $vals = []; $index = []; xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0); xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0); foreach ($parserOptions as $option => $value) { xml_parser_set_option($parser, $option, $value); } xml_parse_into_struct($parser, $string, $vals, $index); if (xml_get_error_code($parser)) { return 'Line ' . xml_get_current_line_number($parser) . ': ' . xml_error_string(xml_get_error_code($parser)); } xml_parser_free($parser); $stack = [[]]; $stacktop = 0; $startPoint = 0; $tagi = []; foreach ($vals as $key => $val) { $type = $val['type']; if ($type === 'open' \|\| $type === 'complete') { $stack[$stacktop++] = $tagi; if ($depth == $stacktop) { $startPoint = $key; } $tagi = ['tag' => $val['tag']]; if (isset($val['attributes'])) { $tagi['attrs'] = $val['attributes']; } if (isset($val['value'])) { $tagi['values'][] = $val['value']; } } if ($type === 'complete' \|\| $type === 'close') { $oldtagi = $tagi; $tagi = $stack[--$stacktop]; $oldtag = $oldtagi['tag']; unset($oldtagi['tag']); if ($depth == $stacktop + 1) { if ($key - $startPoint > 0) { $partArray = array_slice($vals, $startPoint + 1, $key - $startPoint - 1); $oldtagi['XMLvalue'] = self::xmlRecompileFromStructValArray($partArray); } else { $oldtagi['XMLvalue'] = $oldtagi['values'][0]; } } $tagi['ch'][$oldtag][] = $oldtagi; unset($oldtagi); } if ($type === 'cdata') { $tagi['values'][] = $val['value']; } } return $tagi['ch']; } public static string function array2xml(array $array, $NSprefix = '', $level = 0, $docTag = 'phparray', $spaceInd = 0, array $options = [], array $stackData = []) { $binaryChars = "\0" . chr(1) . chr(2) . chr(3) . chr(4) . chr(5) . chr(6) . chr(7) . chr(8) . chr(11) . chr(12) . chr(14) . chr(15) . chr(16) . chr(17) . chr(18) . chr(19) . chr(20) . chr(21) . chr(22) . chr(23) . chr(24) . chr(25) . chr(26) . chr(27) . chr(28) . chr(29) . chr(30) . chr(31); $indentChar = $spaceInd ? ' ' : "\t"; $indentN = $spaceInd >	$spaceInd: 1

Static Protected Member Functions
static string	createDirectoryPath ($fullDirectoryPath)

Static Protected Attributes
static ContainerInterface	$container = null

static array	$singletonInstances = []

static array	$nonSingletonInstances = []

static array	$finalClassNameCache = []

static array	$indpEnvCache = []

Private Member Functions
	__construct ()

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: All methods in this class are meant to be called statically. So use \TYPO3\CMS\Core\Utility\GeneralUtility::[method-name] to refer to the functions, eg. '\TYPO3\CMS\Core\Utility\GeneralUtility::milliseconds()'

Definition at line 50 of file GeneralUtility.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Utility\GeneralUtility::__construct ( )

finalprivate

Definition at line 81 of file GeneralUtility.php.

Member Function Documentation

◆ _GET()

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

static

Returns the global $_GET array (or value from) normalized to contain un-escaped values. 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.

Definition at line 155 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\canRetrieveGlobalInputsThroughGet(), TYPO3\CMS\Core\Http\ServerRequestFactory\fromGlobals(), and TYPO3\CMS\Install\ViewHelpers\Uri\ActionViewHelper\renderStatic().

◆ _GP()

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

static

Returns the 'GLOBAL' value of incoming data from POST or GET, with priority to POST, which is equivalent to 'GP' order In case you already know by which method your data is arriving consider using GeneralUtility::_GET or GeneralUtility::_POST.

Parameters

string $var ‪GET/POST var to return

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

Deprecated:: ‪since TYPO3 v12.3. will be removed in TYPO3 v13.0.

Definition at line 107 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\UnitDeprecated\Utility\GeneralUtilityTest\canRetrieveValueWithGP(), and TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher\determinePageId().

◆ _GPmerged()

static array 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.

Deprecated:: ‪since TYPO3 v12.2. will be removed in TYPO3 v13.0.

Definition at line 134 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\UnitDeprecated\Utility\GeneralUtilityTest\gpMergedWillMergeArraysFromGetAndPost().

◆ _POST()

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

static

Returns the global $_POST array (or value from) normalized to contain un-escaped values.

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.

Deprecated:: ‪since TYPO3 v12.2. will be removed in TYPO3 v13.0.

Definition at line 174 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\UnitDeprecated\Utility\GeneralUtilityTest\canRetrieveGlobalInputsThroughPost().

◆ camelCaseToLowerCaseUnderscored()

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

static

Returns a given CamelCasedString as a 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 767 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\camelCaseToLowerCaseUnderscored(), TYPO3\CMS\Backend\ViewHelpers\Toolbar\AttributesViewHelper\convertClassNameToIdAttribute(), TYPO3\CMS\Extbase\Persistence\Generic\Mapper\DataMapper\convertPropertyNameToColumnName(), TYPO3\CMS\Install\Controller\SettingsController\featuresGetContentAction(), TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters\getControllerExtensionKey(), TYPO3\CMS\Backend\Template\Components\Menu\Menu\getDataIdentifier(), TYPO3\CMS\Lowlevel\Controller\DatabaseIntegrityController\getDropdownMenu(), TYPO3\CMS\Extbase\Utility\LocalizationUtility\getLanguageFilePath(), TYPO3\CMS\Extbase\Utility\ExtensionUtility\registerPlugin(), TYPO3\CMS\Fluid\ViewHelpers\TranslateViewHelper\renderStatic(), and TYPO3\CMS\Fluid\ViewHelpers\Uri\ResourceViewHelper\resolveExtensionKey().

◆ cmpFQDN()

static bool 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 451 of file GeneralUtility.php.

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

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\cmpFqdnReturnsFalse(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\cmpFqdnReturnsTrue().

◆ cmpIP()

static bool 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. CIDR-notation should be used. For IPv4 addresses only, the -wildcard is also 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 223 of file GeneralUtility.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\cmpIPv4(), and TYPO3\CMS\Core\Utility\GeneralUtility\cmpIPv6().

Referenced by TYPO3\CMS\Core\Http\NormalizedParams\determineHttps(), TYPO3\CMS\Core\Http\NormalizedParams\determineIsBehindReverseProxy(), TYPO3\CMS\Core\ExpressionLanguage\FunctionsProvider\DefaultFunctionsProvider\getIpFunction(), TYPO3\CMS\Core\Core\Bootstrap\initializeErrorHandling(), TYPO3\CMS\Frontend\Middleware\BackendUserAuthenticator\isAuthenticated(), TYPO3\CMS\Core\RateLimiter\RateLimiterFactory\isIpExcluded(), TYPO3\CMS\Frontend\Controller\ErrorController\isPageUnavailableHandlerConfigured(), TYPO3\CMS\Frontend\Middleware\MaintenanceMode\process(), and TYPO3\CMS\Backend\Middleware\LockedBackendGuard\validateVisitorsIpAgainstIpMaskList().

◆ cmpIPv4()

static bool 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. CIDR-notation, -wildcard allowed instead of number, plus leaving out parts in the IP number is accepted as wildcard (eg. 192.168.0.0/16 equals 192.168..* equals 192.168), could also contain IPv6 addresses

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

Definition at line 245 of file GeneralUtility.php.

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

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

◆ cmpIPv6()

static bool 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. IPv6 addresses must be specified in CIDR-notation, not with * wildcard, otherwise self::validIPv6() will fail.

Returns: ‪bool TRUE If a baseIP matches any prefix

Definition at line 294 of file GeneralUtility.php.

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

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

◆ createDirectoryPath()

static string 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: ‪\TYPO3\CMS\Core\Utility\GeneralUtility::mkdir_deep

Exceptions

Definition at line 1779 of file GeneralUtility.php.

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

◆ expandList()

static string 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 544 of file GeneralUtility.php.

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

◆ fixed_lgd_cs()

static string TYPO3\CMS\Core\Utility\GeneralUtility::fixed_lgd_cs	(	string	$string,
		int	$chars,
		string	$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 202 of file GeneralUtility.php.

◆ fixPermissions()

static mixed 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 1594 of file GeneralUtility.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\PathUtility\isAbsolutePath(), and TYPO3\CMS\Core\Core\Environment\isWindows().

◆ get_dirs()

static string [] string null 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: ‪string[]|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 1863 of file GeneralUtility.php.

References $dir.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\getDirsReturnsArrayOfDirectoriesFromGivenDirectory(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\getDirsReturnsStringErrorOnPathFailure().

◆ getUrl()

static string false TYPO3\CMS\Core\Utility\GeneralUtility::getUrl ( $url )

static

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

Parameters

string $url ‪File/URL to read

Returns: ‪string|false The content from the resource given as input. FALSE if an error has occurred.

Definition at line 1542 of file GeneralUtility.php.

References TYPO3\CMS\Webhooks\Message\$url.

Referenced by TYPO3\CMS\Install\Service\CoreUpdateService\downloadVersion(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOEmbedHelper\getOEmbedData(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\YouTubeHelper\getPreviewImage(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\VimeoHelper\getPreviewImage(), TYPO3\CMS\Dashboard\Widgets\RssWidget\getRssItems(), TYPO3\CMS\IndexedSearch\Indexer\indexExternalUrl(), TYPO3\CMS\IndexedSearch\FileContentParser\readFileContent(), and TYPO3\CMS\Core\Resource\ResourceCompressor\retrieveExternalFile().

◆ hmac()

static string 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 584 of file GeneralUtility.php.

References $GLOBALS.

◆ implodeArrayForUrl()

static string 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 954 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\implodeArrayForUrlBuildsValidParameterString(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\implodeArrayForUrlCanSkipEmptyParameters(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\implodeArrayForUrlCanUrlEncodeKeyNames().

◆ inList()

static bool 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 532 of file GeneralUtility.php.

◆ intExplode()

static int [] 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 \TYPO3\CMS\Core\Utility\GeneralUtility::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

Deprecated:: ‪will be removed in TYPO3 v13.0 without replacement. If positive, the result will contain a maximum of $limit elements.

Returns: ‪int[] Exploded values, all converted to integers

Definition at line 842 of file GeneralUtility.php.

◆ isOnCurrentHost()

static bool 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 519 of file GeneralUtility.php.

References TYPO3\CMS\Webhooks\Message\$url.

Referenced by TYPO3\CMS\Core\Html\DefaultSanitizerBuilder\__construct(), TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile(), TYPO3\CMS\Frontend\Typolink\LinkFactory\isInternalUrl(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\isOnCurrentHostReturnsTrueWithCurrentHost().

◆ isValid()

static array<int, splitCalc($string, $operators) { $res = []; $sign = '+'; while ($string) { $valueLen = strcspn($string, $operators); $value = substr($string, 0, $valueLen); $res[] = [$sign, trim($value)]; $sign = substr($string, $valueLen, 1); $string = substr($string, $valueLen + 1); } reset($res); return $res; } public static bool function validEmail($email) { if (!is_string($email)) { return false; } if (trim($email) !== $email) { return false; } if (!str_contains($email, '@')) { return false; } $validators = []; foreach ($GLOBALS['TYPO3_CONF_VARS']['MAIL']['validators'] ?? [RFCValidation::class] as $className) { $validator = new $className(); if ($validator instanceof EmailValidation) { $validators[] = $validator; } } return (new EmailValidator())-> TYPO3\CMS\Core\Utility\GeneralUtility::isValid	(		$email,
		new	MultipleValidationWithAnd $validators, MultipleValidationWithAnd::STOP_ON_ERROR
	)

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<int, array<int, string>> Array with operators and operands separated.

See also: ‪\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::calc(); ‪\TYPO3\CMS\Frontend\Imaging\GifBuilder::calcOffset()

◆ isValidUrl()

static bool 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: https://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 797 of file GeneralUtility.php.

References TYPO3\CMS\Webhooks\Message\$url, and TYPO3\CMS\Core\Utility\HttpUtility\buildUrl().

Referenced by TYPO3\CMS\Core\Html\DefaultSanitizerBuilder\__construct(), TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile(), TYPO3\CMS\Backend\Command\ResetPasswordCommand\execute(), TYPO3\CMS\Core\Tests\Functional\Resource\Driver\LocalDriverTest\getPublicUrlReturnsValidUrlContainingSpecialCharacters(), TYPO3\CMS\Install\Command\SetupCommand\getSiteSetup(), TYPO3\CMS\FrontendLogin\Validation\RedirectUrlValidator\isInLocalDomain(), TYPO3\CMS\Extbase\Validation\Validator\UrlValidator\isValid(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validURLReturnsFalseForInvalidResource(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\validURLReturnsTrueForValidResource().

◆ md5int()

static int 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 572 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\getAdditionalAttributes(), TYPO3\CMS\Backend\Controller\Resource\ResourceController\getResourceResponseData(), TYPO3\CMS\Filelist\Dto\ResourceView\getStateIdentifier(), TYPO3\CMS\Backend\Tree\FileStorageTreeProvider\getStateIdentifier(), and TYPO3\CMS\Filelist\Controller\FileListController\registerAdditionalDocHeaderButtons().

◆ mkdir()

static bool 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 operation was successful

Definition at line 1736 of file GeneralUtility.php.

References $GLOBALS.

◆ mkdir_deep()

static TYPO3\CMS\Core\Utility\GeneralUtility::mkdir_deep ( $directory )

static

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

Parameters

string $directory ‪Target directory to create

Exceptions

Definition at line 1753 of file GeneralUtility.php.

◆ normalizeIPv6()

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

Definition at line 349 of file GeneralUtility.php.

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

◆ revExplode()

static list<string> TYPO3\CMS\Core\Utility\GeneralUtility::revExplode	(	$delimiter,
		$string,
		$limit = `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	$limit	‪Number of array entries

Returns: ‪list<string> Exploded values

Definition at line 882 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\filter(), TYPO3\CMS\IndexedSearch\Domain\Repository\IndexSearchRepository\freeIndexUidWhere(), TYPO3\CMS\Core\Localization\Parser\AbstractXmlParser\getLocalizedFileName(), TYPO3\CMS\Core\Core\SystemEnvironmentBuilder\getRootPathFromScriptPath(), TYPO3\CMS\Core\TypoScript\IncludeTree\TreeFromLineStreamBuilder\importIncludeTyposcriptDirectoryRecursive(), TYPO3\CMS\Backend\Controller\Wizard\EditController\processRequest(), TYPO3\CMS\Backend\Form\Element\InputSlugElement\render(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\revExplodeCorrectlyExplodesStringForGivenPartsCount(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\revExplodeRespectsLimitThreeWhenExploding().

◆ rmdir()

static bool 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 operation was successful

Definition at line 1806 of file GeneralUtility.php.

◆ trimExplode()

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

static

Explodes a string and removes whitespace-only values.

If $removeEmptyValues is set, then all values that contain only whitespace are removed.

Each item will have leading and trailing whitespace removed. However, if the tail items are returned as a single array item, their internal whitespace will not be modified.

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: ‪list<string> Exploded values

Definition at line 916 of file GeneralUtility.php.

◆ underscoredToLowerCamelCase()

static string 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 755 of file GeneralUtility.php.

◆ underscoredToUpperCamelCase()

static string 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 743 of file GeneralUtility.php.

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

◆ validIP()

static bool 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 413 of file GeneralUtility.php.

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

◆ validIPv4()

static bool 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 426 of file GeneralUtility.php.

◆ validIPv6()

static bool 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 439 of file GeneralUtility.php.

◆ writeFile()

static bool 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 1567 of file GeneralUtility.php.

Referenced by TYPO3\CMS\Core\Tests\Functional\DataHandling\Regular\Hooks\PagesTsConfigGuardTest\addSiteConfiguration(), TYPO3\CMS\Core\Log\Writer\FileWriter\createHtaccessFile(), TYPO3\CMS\Core\Log\Writer\FileWriter\createLogFile(), TYPO3\CMS\Core\Resource\ResourceCompressor\createMergedFile(), TYPO3\CMS\Core\Core\ClassLoadingInformation\dumpClassLoadingInformation(), TYPO3\CMS\Install\Service\Session\FileSessionHandler\ensureSessionSavePathExists(), TYPO3\CMS\Backend\Command\LockBackendCommand\execute(), TYPO3\CMS\IndexedSearch\Indexer\indexExternalUrl(), TYPO3\CMS\Core\Resource\ResourceCompressor\initialize(), TYPO3\CMS\Impexp\Import\processSoftReferencesSaveFileCreateRelFile(), TYPO3\CMS\Core\Tests\Unit\Configuration\SiteConfigurationTest\resolveAllExistingSitesReadsConfiguration(), TYPO3\CMS\Core\Resource\ResourceCompressor\retrieveExternalFile(), TYPO3\CMS\Impexp\Export\saveToFile(), TYPO3\CMS\Webhooks\Tests\Functional\WebhookExecutionTest\setUp(), TYPO3\CMS\Frontend\Tests\Functional\Rendering\TitleTagRenderingTest\setUpFrontendSite(), TYPO3\CMS\Core\Tests\Functional\DataHandling\AbstractDataHandlerActionTestCase\setUpFrontendSite(), TYPO3\CMS\Core\Tests\Functional\DataScenarios\AbstractDataHandlerActionTestCase\setUpFrontendSite(), TYPO3\CMS\Core\Configuration\SiteConfiguration\write(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\writeEmConfToFile(), TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility\writeExtensionFiles(), TYPO3\CMS\Core\Resource\ResourceCompressor\writeFileAndCompressed(), TYPO3\CMS\Impexp\Import\writeFilesToTemporaryFolder(), TYPO3\CMS\Impexp\Import\writeFileVerify(), TYPO3\CMS\Core\Configuration\SiteConfiguration\writeSettings(), and TYPO3\CMS\Impexp\Import\writeSysFileRecords().

◆ writeFileToTypo3tempDir()

static string null 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 within the typo3temp/ or Environment::getVarPath() folder - the file path must be prefixed with this path
string	$content	‪Content string to write

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

Reimplemented in TYPO3\CMS\Core\Tests\Unit\Utility\Fixtures\GeneralUtilityFilesystemFixture.

Definition at line 1659 of file GeneralUtility.php.

References TYPO3\CMS\Core\Core\Environment\getProjectPath(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), and TYPO3\CMS\Core\Core\Environment\getVarPath().

Referenced by 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\Remote\TerExtensionRemote\fetchPackageList(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\fixPermissionsSetsPermissionsWithRelativeFileReference(), TYPO3\CMS\Core\Charset\CharsetConverter\initCharset(), TYPO3\CMS\Core\Charset\CharsetConverter\initToASCII(), TYPO3\CMS\Core\Charset\CharsetConverter\initUnicodeData(), TYPO3\CMS\Install\Service\LanguagePackService\languagePackDownload(), TYPO3\CMS\Core\Tests\Unit\Resource\ResourceFactoryTest\retrieveFileOrFolderObjectReturnsFileFromPublicFolderWhenProjectRootIsNotPublic(), TYPO3\CMS\Core\Tests\Unit\Resource\ResourceFactoryTest\retrieveFileOrFolderObjectReturnsFileIfPathIsGiven(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\writeFileToTypo3tempDirFailsWithInvalidPath(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\writeFileToTypo3tempDirWorksWithValidPath().

◆ xml2array()

static mixed 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 1363 of file GeneralUtility.php.

References TYPO3\CMS\Webhooks\Message\$identifier, and TYPO3\CMS\Core\Utility\GeneralUtility\xml2arrayProcess().

Referenced by TYPO3\CMS\Core\DataHandling\DataHandler\checkValueForFlex(), TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\convertDataStructureToArray(), TYPO3\CMS\Core\Service\FlexFormService\convertFlexFormContentToArray(), TYPO3\CMS\Core\DataHandling\DataHandler\copyRecord_procBasedOnFieldType(), TYPO3\CMS\Core\Database\ReferenceIndex\getRelations(), TYPO3\CMS\Backend\Form\FormDataProvider\TcaFlexPrepare\initializeDataValues(), TYPO3\CMS\Form\EventListener\DataStructureIdentifierListener\modifyDataStructureIdentifier(), TYPO3\CMS\Form\Controller\FormFrontendController\overrideByFlexFormSettings(), TYPO3\CMS\Frontend\Plugin\AbstractPlugin\pi_initPIflexForm(), TYPO3\CMS\Core\DataHandling\DataHandler\remapListedDBRecords(), TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\resolveFileDirectives(), TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools\traverseFlexFormXMLData(), TYPO3\CMS\Core\DataHandling\DataHandler\updateFlexFormData(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\xml2arrayUsesCache().

◆ xml2arrayProcess()

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

static

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

References $parser, and TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger().

Referenced by TYPO3\CMS\Core\Utility\GeneralUtility\xml2array(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\xml2ArrayProcessHandlesAttributeTypes(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\xml2ArrayProcessHandlesBigXmlContent(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\xml2arrayProcessHandlesDocumentTag(), TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\xml2arrayProcessHandlesTagNamespaces(), and TYPO3\CMS\Core\Tests\Unit\Utility\GeneralUtilityTest\xml2arrayProcessHandlesWhitespaces().

◆ xmlRecompileFromStructValArray()

static string 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<int,array<string,mixed>> ‪$vals An array of XML parts, see xml2tree

Returns: ‪string Re-compiled XML data.

Definition at line 1492 of file GeneralUtility.php.

Member Data Documentation

◆ $container

ContainerInterface TYPO3\CMS\Core\Utility\GeneralUtility::$container = null

staticprotected

Definition at line 52 of file GeneralUtility.php.

◆ $finalClassNameCache

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

staticprotected

Definition at line 74 of file GeneralUtility.php.

◆ $indpEnvCache

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

staticprotected

Definition at line 79 of file GeneralUtility.php.

◆ $labelArr

if ( $base !==1000 &&$base !==1024) TYPO3\CMS\Core\Utility\GeneralUtility::$labelArr = explode('|', str_replace('"', '', $labels))

Definition at line 669 of file GeneralUtility.php.

◆ $localeInfo

TYPO3\CMS\Core\Utility\GeneralUtility::$localeInfo = localeconv()

Definition at line 672 of file GeneralUtility.php.

◆ $multiplier [1/2]

TYPO3\CMS\Core\Utility\GeneralUtility::$multiplier = floor(($sizeInBytes ? log($sizeInBytes) : 0) / log($base))

Definition at line 674 of file GeneralUtility.php.

◆ $multiplier [2/2]

if ( $sizeInUnits >( $base *.9)) TYPO3\CMS\Core\Utility\GeneralUtility::$multiplier = min($multiplier, count($labelArr) - 1)

Definition at line 679 of file GeneralUtility.php.

◆ $nl

TYPO3\CMS\Core\Utility\GeneralUtility::$nl = $spaceInd >= 0 ? LF : ''

Definition at line 1251 of file GeneralUtility.php.

◆ $nonSingletonInstances

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

staticprotected

Definition at line 66 of file GeneralUtility.php.

◆ $output [1/2]

TYPO3\CMS\Core\Utility\GeneralUtility::$output = ''

Definition at line 1253 of file GeneralUtility.php.

◆ $output [2/2]

foreach ( $array as $k=> $v) if (! $level) return TYPO3\CMS\Core\Utility\GeneralUtility::$output

Definition at line 1348 of file GeneralUtility.php.

◆ $singletonInstances

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

staticprotected

Definition at line 59 of file GeneralUtility.php.

◆ $sizeInBytes

TYPO3\CMS\Core\Utility\GeneralUtility::$sizeInBytes = max($sizeInBytes, 0)

Definition at line 673 of file GeneralUtility.php.

◆ $sizeInUnits

TYPO3\CMS\Core\Utility\GeneralUtility::$sizeInUnits = $sizeInBytes / $base ** $multiplier

Definition at line 675 of file GeneralUtility.php.

◆ $spaceInd

array<string, function explodeUrl2Array($string) { $output = []; $p = explode('&', $string); foreach ($p as $v) { if ($v !== '') { $nameAndValue = explode('=', $v, 2); $output[rawurldecode($nameAndValue[0])] = isset($nameAndValue[1]) ? rawurldecode($nameAndValue[1]) : ''; } } return $output; } public static array function removeDotsFromTS(array $ts): array { $out = []; foreach ($ts as $key => $value) { if (is_array($value)) { $key = rtrim($key, '.'); $out[$key] = self::removeDotsFromTS($value); } else { $out[$key] = $value; } } return $out; } public static array<string, function get_tag_attributes($tag, bool $decodeEntities = false) { $components = self::split_tag_attributes($tag); $name = ''; $valuemode = false; $attributes = []; foreach ($components as $key => $val) { if ($val !== '=') { if ($valuemode) { if ($name) { $attributes[$name] = $decodeEntities ? htmlspecialchars_decode($val) : $val; $name = ''; } } else { if ($key = strtolower(preg_replace('/[^[:alnum:]_\\:\\-]/', '', $val) ?? '')) { $attributes[$key] = ''; $name = $key; } } $valuemode = false; } else { $valuemode = true; } } return $attributes; } public static string[] function split_tag_attributes($tag) { $tag_tmp = trim(preg_replace('/^<[^[:space:]]*/', '', trim($tag)) ?? ''); $tag_tmp = trim(rtrim($tag_tmp, '>')); $value = []; while ($tag_tmp !== '') { $firstChar = $tag_tmp[0]; if ($firstChar === '"' || $firstChar === '\'') { $reg = explode($firstChar, $tag_tmp, 3); $value[] = $reg[1]; $tag_tmp = trim($reg[2] ?? ''); } elseif ($firstChar === '=') { $value[] = '='; $tag_tmp = trim(substr($tag_tmp, 1)); } else { $reg = preg_split('/[[:space:]=]/', $tag_tmp, 2); $value[] = trim($reg[0]); $tag_tmp = trim(substr($tag_tmp, strlen($reg[0]), 1) . ($reg[1] ?? '')); } } reset($value); return $value; } public static string function implodeAttributes(array $arr, $xhtmlSafe = false, $keepBlankAttributes = false) { if ($xhtmlSafe) { $newArr = []; foreach ($arr as $attributeName => $attributeValue) { $attributeName = strtolower($attributeName); if (!isset($newArr[$attributeName])) { $newArr[$attributeName] = htmlspecialchars((string)$attributeValue); } } $arr = $newArr; } $list = []; foreach ($arr as $attributeName => $attributeValue) { if ((string)$attributeValue !== '' || $keepBlankAttributes) { $list[] = $attributeName . '="' . $attributeValue . '"'; } } return implode(' ', $list); } public static string function wrapJS(string $string, array $attributes = []) { if (trim($string)) { $string = ltrim($string, LF); $match = []; if (preg_match('/^(\\t+)/', $string, $match)) { $string = str_replace($match[1], "\t", $string); } return '<script ' . GeneralUtility::implodeAttributes($attributes, true) . '>' . $string . '</script>'; } return ''; } public static mixed function xml2tree($string, $depth = 999, $parserOptions = []) { $parser = xml_parser_create(); $vals = []; $index = []; xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0); xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 0); foreach ($parserOptions as $option => $value) { xml_parser_set_option($parser, $option, $value); } xml_parse_into_struct($parser, $string, $vals, $index); if (xml_get_error_code($parser)) { return 'Line ' . xml_get_current_line_number($parser) . ': ' . xml_error_string(xml_get_error_code($parser)); } xml_parser_free($parser); $stack = [[]]; $stacktop = 0; $startPoint = 0; $tagi = []; foreach ($vals as $key => $val) { $type = $val['type']; if ($type === 'open' || $type === 'complete') { $stack[$stacktop++] = $tagi; if ($depth == $stacktop) { $startPoint = $key; } $tagi = ['tag' => $val['tag']]; if (isset($val['attributes'])) { $tagi['attrs'] = $val['attributes']; } if (isset($val['value'])) { $tagi['values'][] = $val['value']; } } if ($type === 'complete' || $type === 'close') { $oldtagi = $tagi; $tagi = $stack[--$stacktop]; $oldtag = $oldtagi['tag']; unset($oldtagi['tag']); if ($depth == $stacktop + 1) { if ($key - $startPoint > 0) { $partArray = array_slice($vals, $startPoint + 1, $key - $startPoint - 1); $oldtagi['XMLvalue'] = self::xmlRecompileFromStructValArray($partArray); } else { $oldtagi['XMLvalue'] = $oldtagi['values'][0]; } } $tagi['ch'][$oldtag][] = $oldtagi; unset($oldtagi); } if ($type === 'cdata') { $tagi['values'][] = $val['value']; } } return $tagi['ch']; } public static string function array2xml(array $array, $NSprefix = '', $level = 0, $docTag = 'phparray', $spaceInd = 0, array $options = [], array $stackData = []) { $binaryChars = "\0" . chr(1) . chr(2) . chr(3) . chr(4) . chr(5) . chr(6) . chr(7) . chr(8) . chr(11) . chr(12) . chr(14) . chr(15) . chr(16) . chr(17) . chr(18) . chr(19) . chr(20) . chr(21) . chr(22) . chr(23) . chr(24) . chr(25) . chr(26) . chr(27) . chr(28) . chr(29) . chr(30) . chr(31); $indentChar = $spaceInd ? ' ' : "\t"; $indentN = $spaceInd > TYPO3\CMS\Core\Utility\GeneralUtility::$spaceInd

static

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

Note! If you want to use a multi-dimensional string, consider this plain simple PHP code instead:

$result = []; parse_str($queryParametersAsString, $result);

However, if you do magic with a flat structure (e.g. keeping "ext[mykey]" as flat key in a one-dimensional array) then this method is for you.

Parameters

string $string ‪GETvars string

Returns: ‪array<string, string> 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 1250 of file GeneralUtility.php.

◆ else

if (empty( $labels)) if (isset( $defaultFormats[ $labels])) TYPO3\CMS\Core\Utility\GeneralUtility::else

Initial value:

{

$base = (int)$base

Definition at line 664 of file GeneralUtility.php.

Static Public Member Functions

Public Attributes

Static Public Attributes

Static Protected Member Functions

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _GET()

◆ _GP()

◆ _GPmerged()

◆ _POST()

◆ camelCaseToLowerCaseUnderscored()

◆ cmpFQDN()

◆ cmpIP()

◆ cmpIPv4()

◆ cmpIPv6()

◆ createDirectoryPath()

◆ expandList()

◆ fixed_lgd_cs()

◆ fixPermissions()

◆ get_dirs()

◆ getUrl()

◆ hmac()

◆ implodeArrayForUrl()

◆ inList()

◆ intExplode()

◆ isOnCurrentHost()

◆ isValid()

◆ isValidUrl()

◆ md5int()

◆ mkdir()

◆ mkdir_deep()

◆ normalizeIPv6()

◆ revExplode()

◆ rmdir()

◆ trimExplode()

◆ underscoredToLowerCamelCase()

◆ underscoredToUpperCamelCase()

◆ validIP()

◆ validIPv4()

◆ validIPv6()

◆ writeFile()

◆ writeFileToTypo3tempDir()

◆ xml2array()

◆ xml2arrayProcess()

◆ xmlRecompileFromStructValArray()

Member Data Documentation

◆ $container

◆ $finalClassNameCache

◆ $indpEnvCache

◆ $labelArr

◆ $localeInfo

◆ $multiplier [1/2]

◆ $multiplier [2/2]

◆ $nl

◆ $nonSingletonInstances

◆ $output [1/2]

◆ $output [2/2]

◆ $singletonInstances

◆ $sizeInBytes

◆ $sizeInUnits

◆ $spaceInd

◆ else