Static Public Member Functions
static	filterByValueRecursive ($needle= '', array $haystack=array())

static	isValidPath (array $array, $path, $delimiter= '/')

static	getValueByPath (array $array, $path, $delimiter= '/')

static	setValueByPath (array $array, $path, $value, $delimiter= '/')

static	removeByPath (array $array, $path, $delimiter= '/')

static	sortByKeyRecursive (array $array)

static	sortArraysByKey (array $arrays, $key, $ascending=true)

static	arrayExport (array $array=array(), $level=0)

static	flatten (array $array, $prefix= '')

static	intersectRecursive (array $source, array $mask=array())

static	renumberKeysToAvoidLeapsIfKeysAreAllNumeric (array $array=array(), $level=0)

static	mergeRecursiveWithOverrule (array &$original, array $overrule, $addKeys=true, $includeEmptyValues=true, $enableUnsetFeature=true)

static	inArray (array $in_array, $item)

static	removeArrayEntryByValue (array $array, $cmpValue)

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

static	remapArrayKeys (array &$array, array $mappingTable)

static	arrayDiffAssocRecursive (array $array1, array $array2)

static	naturalKeySortRecursive (array &$array)

Detailed Description

Class with helper functions for array handling

Definition at line 20 of file core/Classes/Utility/ArrayUtility.php.

Member Function Documentation

static arrayDiffAssocRecursive	(	array	$array1,
		array	$array2
	)

static

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

Parameters

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

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

Definition at line 667 of file core/Classes/Utility/ArrayUtility.php.

References elseif.

Referenced by GeneralUtility\arrayDiffAssocRecursive(), UriBuilder\buildBackendUri(), ContentObjectRenderer\getQueryArguments(), DataHandlerHook\processCmdmap_deleteAction(), and DataHandler\unsetElementsToBeDeleted().

static arrayExport	(	array	$array = `array()`,
			$level = `0`
	)

static

Exports an array as string. Similar to var_export(), but representation follows the PSR-2 and TYPO3 core CGL.

See unit tests for detailed examples

Parameters

array	$array	Array to export
int	$level	Internal level used for recursion, do not set from outside!

Returns: string String representation of array

Exceptions

\RuntimeException

Definition at line 303 of file core/Classes/Utility/ArrayUtility.php.

Referenced by ConfigurationManager\writeLocalConfiguration().

static filterByValueRecursive	(		$needle = `''`,
		array	$haystack = `array()`
	)

static

Reduce an array by a search value and keep the array structure.

Comparison is type strict:

For a given needle of type string, integer, array or boolean, value and value type must match to occur in result array
For a given object, an object within the array must be a reference to the same object to match (not just different instance of same class)

Example:

Needle: 'findMe'
Given array: array( 'foo' => 'noMatch', 'bar' => 'findMe', 'foobar => array( 'foo' => 'findMe', ), );
Result: array( 'bar' => 'findMe', 'foobar' => array( 'foo' => findMe', ), );

See the unit tests for more examples and expected behaviour

Parameters

mixed	$needle	The value to search for
array	$haystack	The array in which to search

Returns: array $haystack array reduced matching $needle values

Definition at line 55 of file core/Classes/Utility/ArrayUtility.php.

References elseif.

Referenced by ExtensionManagementUtility\addTcaSelectItem().

static flatten	(	array	$array,
			$prefix = `''`
	)

static

Converts a multidimensional array to a flat representation.

See unit tests for more details

Example:

array: array( 'first.' => array( 'second' => 1 ) )
result: array( 'first.second' => 1 )

Example:

array: array( 'first' => array( 'second' => 1 ) )
result: array( 'first.second' => 1 )

Parameters

array	$array	The (relative) array to be converted
string	$prefix	The (relative) prefix to be used (e.g. 'section.')

Returns: array

Definition at line 385 of file core/Classes/Utility/ArrayUtility.php.

Referenced by ConfigurationItemRepository\mergeWithExistingConfiguration().

static getValueByPath	(	array	$array,
			$path,
			$delimiter = `'/'`
	)

static

Returns a value by given path

Example

array: array( 'foo' => array( 'bar' => array( 'baz' => 42 ) ) );
path: foo/bar/baz
return: 42

If a path segments contains a delimiter character, the path segment must be enclosed by " (double quote), see unit tests for details

Parameters

array	$array	Input array
string	$path	Path within the array
string	$delimiter	Defined path delimiter, default /

Returns: mixed

Exceptions

\RuntimeException

Definition at line 131 of file core/Classes/Utility/ArrayUtility.php.

Referenced by ConfigurationManager\getConfigurationValueByPath(), ConfigurationManager\getDefaultConfigurationValueByPath(), BackendLayoutView\getIdentifiersToBeExcluded(), and ConfigurationManager\getLocalConfigurationValueByPath().

static inArray	(	array	$in_array,
			$item
	)

static

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

Parameters

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

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

Definition at line 566 of file core/Classes/Utility/ArrayUtility.php.

Referenced by BackendUtility\blindGroupNames(), AbstractMenuContentObject\filterMenuPages(), JavaScriptMenuContentObject\generate_level(), GeneralUtility\inArray(), and AjaxRequestHandler\setContentFormat().

static intersectRecursive	(	array	$source,
		array	$mask = `array()`
	)

static

Determine the intersections between two arrays, recursively comparing keys A complete sub array of $source will be preserved, if the key exists in $mask.

See unit tests for more examples and edge cases.

Example:

source: array( 'key1' => 'bar', 'key2' => array( 'subkey1' => 'sub1', 'subkey2' => 'sub2', ), 'key3' => 'baz', )
mask: array( 'key1' => NULL, 'key2' => array( 'subkey1' => exists', ), )
return: array( 'key1' => 'bar', 'key2' => array( 'subkey1' => 'sub1', ), )

Parameters

array	$source	Source array
array	$mask	Array that has the keys which should be kept in the source array

Returns: array Keys which are present in both arrays with values of the source array

Definition at line 435 of file core/Classes/Utility/ArrayUtility.php.

static isValidPath	(	array	$array,
			$path,
			$delimiter = `'/'`
	)

static

Checks if a given path exists in array

Example:

array: array( 'foo' => array( 'bar' = 'test', ) );
path: 'foo/bar'
return: TRUE

Parameters

array	$array	Given array
string	$path	Path to test, 'foo/bar/foobar'
string	$delimiter	Delimiter for path, default /

Returns: bool TRUE if path exists in array

Definition at line 95 of file core/Classes/Utility/ArrayUtility.php.

Referenced by BackendLayoutView\getIdentifiersToBeExcluded(), ConfigurationManager\isValidLocalConfigurationPath(), and ConfigurationManager\removeLocalConfigurationKeysByPath().

static keepItemsInArray	(	array	$array,
			$keepItems,
			$getValueFunc = `null`
	)

static

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

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

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

Parameters

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

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

Definition at line 618 of file core/Classes/Utility/ArrayUtility.php.

References GeneralUtility\trimExplode().

Referenced by GeneralUtility\keepItemsInArray(), and AbstractItemProvider\removeItemsByKeepItemsPageTsConfig().

static mergeRecursiveWithOverrule	(	array &	$original,
		array	$overrule,
			$addKeys = `true`,
			$includeEmptyValues = `true`,
			$enableUnsetFeature = `true`
	)

static

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

This method takes the original array by reference for speed optimization with large arrays

The differences to the existing PHP function array_merge_recursive() are:

Keys of the original array can be unset via the overrule array. ($enableUnsetFeature)
Much more control over what is actually merged. ($addKeys, $includeEmptyValues)
Elements or the original array get overwritten if the same key is present in the overrule array.

Parameters

array	$original	Original array. It will be modified by this method and contains the result afterwards!
array	$overrule	Overrule array, overruling the original array
bool	$addKeys	If set to FALSE, keys that are NOT found in $original will not be set. Thus only existing value can/will be overruled from overrule array.
bool	$includeEmptyValues	If set, values from $overrule will overrule if they are empty or zero.
bool	$enableUnsetFeature	If set, special values "__UNSET" can be used in the overrule array in order to unset array keys in the original array.

Returns: void

Definition at line 522 of file core/Classes/Utility/ArrayUtility.php.

References elseif.

Referenced by GeneralUtility\_GETset(), GeneralUtility\_GPmerged(), TcaColumnsOverrides\addData(), PageTsConfigMerged\addData(), InlineOverrideChildTca\addData(), ExtensionManagementUtility\addExtJSModule(), TcaInlineConfiguration\addInlineSelectorAndUniqueConfiguration(), UriBuilder\buildBackendUri(), DataHandler\checkValueForFlex(), ConfigurationManager\createLocalConfigurationFromFactoryConfiguration(), ConfigurationManager\exportConfiguration(), ConfigurationForm\ext_mergeIncomingWithExisting(), DataHandler\fillInFieldArray(), TypoScriptFrontendController\getConfigArray(), SuggestWizard\getConfigurationForTable(), ConfigurationManager\getConfigurationValueByPath(), ContentObjectRenderer\getData(), ExtensionManagementUtility\getFileFieldTCAConfig(), BackendUtility\getPagesTSconfig(), LocallangXmlParser\getParsedData(), ContentObjectRenderer\getQueryArguments(), DataHandler\getTableEntries(), CategoryRegistry\getTcaFieldConfiguration(), AbstractFunctionModule\incLocalLang(), LanguageService\includeLLFile(), NewContentElementController\init(), PaginateController\initializeAction(), GeneralUtility\linkThisUrl(), ValidatorTask\loadModTsConfig(), LocalizationFactory\localizationOverride(), AbstractNode\mergeChildReturnIntoExistingResult(), FormResultCompiler\mergeResult(), ConfigurationItemRepository\mergeWithExistingConfiguration(), TypoScriptFrontendController\mergingWithGetVars(), FormEngineUtility\overrideFieldConf(), AbstractPlugin\pi_linkTP_keepPIvars(), AbstractPlugin\pi_setPiVarDefaults(), ConfigurationManager\updateLocalConfiguration(), and UriBuilder\uriFor().

static naturalKeySortRecursive ( array & $array )

static

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

Parameters

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

Returns: bool always TRUE

Definition at line 688 of file core/Classes/Utility/ArrayUtility.php.

Referenced by GeneralUtility\naturalKeySortRecursive().

static remapArrayKeys	(	array &	$array,
		array	$mappingTable
	)

static

Rename Array keys with a given mapping table

Parameters

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

Definition at line 649 of file core/Classes/Utility/ArrayUtility.php.

Referenced by GeneralUtility\remapArrayKeys().

static removeArrayEntryByValue	(	array	$array,
			$cmpValue
	)

static

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

Parameters

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

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

Definition at line 583 of file core/Classes/Utility/ArrayUtility.php.

References elseif.

Referenced by VersionModuleController\pageSubContent(), GeneralUtility\removeArrayEntryByValue(), and UserSettingsController\removeFromList().

static removeByPath	(	array	$array,
			$path,
			$delimiter = `'/'`
	)

static

Remove a sub part from an array specified by path

Parameters

array	$array	Input array to manipulate
string	$path	Path to remove from array
string	$delimiter	Path delimiter

Returns: array Modified array

Exceptions

\RuntimeException

Definition at line 217 of file core/Classes/Utility/ArrayUtility.php.

Referenced by ConfigurationManager\removeLocalConfigurationKeysByPath().

static renumberKeysToAvoidLeapsIfKeysAreAllNumeric	(	array	$array = `array()`,
			$level = `0`
	)

static

Renumber the keys of an array to avoid leaps if keys are all numeric.

Is called recursively for nested arrays.

Example:

Given array(0 => 'Zero' 1 => 'One', 2 => 'Two', 4 => 'Three') as input, it will return array(0 => 'Zero' 1 => 'One', 2 => 'Two', 3 => 'Three')

Will treat keys string representations of number (ie. '1') equal to the numeric value (ie. 1).

Example: Given array('0' => 'Zero', '1' => 'One' ) it will return array(0 => 'Zero', 1 => 'One')

Parameters

array	$array	Input array
int	$level	Internal level used for recursion, do not set from outside!

Returns: array

Definition at line 479 of file core/Classes/Utility/ArrayUtility.php.

Referenced by ConfigurationManager\writeLocalConfiguration().

static setValueByPath	(	array	$array,
			$path,
			$value,
			$delimiter = `'/'`
	)

static

Modifies or sets a new value in an array by given path

Example:

array: array( 'foo' => array( 'bar' => 42, ), );
path: foo/bar
value: 23
return: array( 'foo' => array( 'bar' => 23, ), );

Parameters

array	$array	Input array to manipulate
string	$path	Path in array to search for
mixed	$value	Value to set at path location in array
string	$delimiter	Path delimiter