ArrayUtils Class Reference

Public Member Functions
	ksortMultibyte (array &$sort, $locale)
	decorateArray ($array, $prefix='decorated_', $forceSetAll=false)
	flatten (array $data, $path='', $separator='/')
	recursiveDiff (array $originalArray, array $newArray)

Detailed Description

Class ArrayUtils

@api

Since

100.0.2

Definition at line 14 of file ArrayUtils.php.

Member Function Documentation

decorateArray()

decorateArray	(		$array,
			$prefix = 'decorated_',
			$forceSetAll = false
	)

Decorate a plain array of arrays or objects The array actually can be an object with Iterator interface

Keys with prefix_* will be set: *_is_first - if the element is first *_is_odd / *_is_even - for odd/even elements *_is_last - if the element is last

The respective key/attribute will be set to element, depending on object it is or array. \Magento\Framework\DataObject is supported.

$forceSetAll true will cause to set all possible values for all elements. When false (default), only non-empty values will be set.

Parameters

array	$array
string	$prefix
bool	$forceSetAll

Returns

array @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 64 of file ArrayUtils.php.

    {
        // check if array or an object to be iterated given
        if (!(is_array($array) || is_object($array))) {
            return $array;
        }

        $keyIsFirst = "{$prefix}is_first";
        $keyIsOdd = "{$prefix}is_odd";
        $keyIsEven = "{$prefix}is_even";
        $keyIsLast = "{$prefix}is_last";

        $count = count($array);
        // this will force Iterator to load
        $index = 0;
        $isEven = false;
        foreach ($array as $key => $element) {
            if (is_object($element)) {
                $this->_decorateArrayObject($element, $keyIsFirst, 0 === $index, $forceSetAll || 0 === $index);
                $this->_decorateArrayObject($element, $keyIsOdd, !$isEven, $forceSetAll || !$isEven);
                $this->_decorateArrayObject($element, $keyIsEven, $isEven, $forceSetAll || $isEven);
                $isEven = !$isEven;
                $index++;
                $this->_decorateArrayObject(
                    $element,
                    $keyIsLast,
                    $index === $count,
                    $forceSetAll || $index === $count
                );
            } elseif (is_array($element)) {
                if ($forceSetAll || 0 === $index) {
                    $array[$key][$keyIsFirst] = 0 === $index;
                }
                if ($forceSetAll || !$isEven) {
                    $array[$key][$keyIsOdd] = !$isEven;
                }
                if ($forceSetAll || $isEven) {
                    $array[$key][$keyIsEven] = $isEven;
                }
                $isEven = !$isEven;
                $index++;
                if ($forceSetAll || $index === $count) {
                    $array[$key][$keyIsLast] = $index === $count;
                }
            }
        }
        return $array;
    }

flatten()

flatten	(	array	$data,
			$path = '',
			$separator = '/'
	)

Expands multidimensional array into flat structure.

Example:

[
    'default' => [
        'web' => 2
    ]
]

Expands to:

[
    'default/web' => 2,
]

Parameters

array	$data	The data to be flatten
string	$path	The leading path
string	$separator	The path parts separator

Returns

array

Since

101.0.0

Definition at line 156 of file ArrayUtils.php.

    {
        $result = [];
        $path = $path ? $path . $separator : '';

        foreach ($data as $key => $value) {
            $fullPath = $path . $key;

            if (!is_array($value)) {
                $result[$fullPath] = $value;

                continue;
            }

            $result = array_merge(
                $result,
                $this->flatten($value, $fullPath, $separator)
            );
        }

        return $result;
    }

ksortMultibyte()

ksortMultibyte	(	array &	$sort,
			$locale
	)

Sorts array with multibyte string keys

Parameters

array	$sort
string	$locale

Returns

array|bool

Definition at line 23 of file ArrayUtils.php.

    {
        if (empty($sort)) {
            return false;
        }
        $oldLocale = setlocale(LC_COLLATE, "0");
        // use fallback locale if $localeCode is not available

        if (strpos($locale, '.UTF8') === false) {
            $locale .= '.UTF8';
        }

        setlocale(LC_COLLATE, $locale, 'C.UTF-8', 'en_US.utf8');
        ksort($sort, SORT_LOCALE_STRING);
        setlocale(LC_COLLATE, $oldLocale);

        return $sort;
    }

recursiveDiff()

recursiveDiff	(	array	$originalArray,
		array	$newArray
	)

Search for array differences recursively.

Parameters

array	$originalArray	The array to compare from
array	$newArray	The array to compare with

Returns

array Diff array

Since

101.0.0

Definition at line 187 of file ArrayUtils.php.

    {
        $diff = [];

        foreach ($originalArray as $key => $value) {
            if (array_key_exists($key, $newArray)) {
                if (is_array($value)) {
                    $valueDiff = $this->recursiveDiff($value, $newArray[$key]);
                    if (count($valueDiff)) {
                        $diff[$key] = $valueDiff;
                    }
                } else {
                    if ($value != $newArray[$key]) {
                        $diff[$key] = $value;
                    }
                }
            } else {
                $diff[$key] = $value;
            }
        }

        return $diff;
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Stdlib/ArrayUtils.php