ArrayManager Class Reference

Public Member Functions
	exists ($path, array $data, $delimiter=self::DEFAULT_PATH_DELIMITER)
	get ($path, array $data, $defaultValue=null, $delimiter=self::DEFAULT_PATH_DELIMITER)
	set ($path, array $data, $value, $delimiter=self::DEFAULT_PATH_DELIMITER)
	replace ($path, array $data, $value, $delimiter=self::DEFAULT_PATH_DELIMITER)
	move ($path, $targetPath, array $data, $overwrite=false, $delimiter=self::DEFAULT_PATH_DELIMITER)
	merge ($path, array $data, array $value, $delimiter=self::DEFAULT_PATH_DELIMITER)
	populate ($path, array $data, $delimiter=self::DEFAULT_PATH_DELIMITER)
	remove ($path, array $data, $delimiter=self::DEFAULT_PATH_DELIMITER)
	findPaths ( $indexes, array $data, $startPath=null, $internalPath=null, $maxResults=null, $delimiter=self::DEFAULT_PATH_DELIMITER)
	findPath ( $indexes, array $data, $startPath=null, $internalPath=null, $delimiter=self::DEFAULT_PATH_DELIMITER)
	slicePath ($path, $offset, $length=null, $delimiter=self::DEFAULT_PATH_DELIMITER)

Data Fields
const	DEFAULT_PATH_DELIMITER = '/'

Protected Member Functions
	find ($path, array &$data, $delimiter, $populate=false)

Protected Attributes
	$parentNode
	$nodeIndex

Detailed Description

Provides methods for nested array manipulations

@api

Since

100.1.0

Definition at line 14 of file ArrayManager.php.

Member Function Documentation

exists()

exists	(		$path,
		array	$data,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Check if node exists

Parameters

array | string	$path
array	$data
string	$delimiter

Returns

bool

Since

100.1.0

Definition at line 42 of file ArrayManager.php.

    {
        return $this->find($path, $data, $delimiter);
    }

find()

find (   $path, array &  $data,   $delimiter,   $populate = false  )

protected

Finds node in nested array and saves its index and parent node reference

Parameters

array | string	$path
array	$data
string	$delimiter
bool	$populate

Returns

bool

Since

100.1.0

Definition at line 194 of file ArrayManager.php.

    {
        if (is_array($path)) {
            $path = implode($delimiter, $path);
        }

        if ($path === null) {
            return false;
        }

        $currentNode = &$data;
        $path = explode($delimiter, $path);

        foreach ($path as $index) {
            if (!is_array($currentNode)) {
                return false;
            }

            if (!array_key_exists($index, $currentNode)) {
                if (!$populate) {
                    return false;
                }

                $currentNode[$index] = [];
            }

            $this->nodeIndex = $index;
            $this->parentNode = &$currentNode;
            $currentNode = &$currentNode[$index];
        }

        return true;
    }

findPath()

findPath	(		$indexes,
		array	$data,
			$startPath = null,
			$internalPath = null,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Get first matching path for elements with specified indexes

Parameters

array | mixed	$indexes
array	$data
string | array | null	$startPath
string | array | null	$internalPath
string	$delimiter

Returns

string|null

Since

100.1.0

Definition at line 300 of file ArrayManager.php.

      {
        $paths = $this->findPaths($indexes, $data, $startPath, $internalPath, 1, $delimiter);

        return $paths ? reset($paths) : null;
    }

findPaths()

findPaths	(		$indexes,
		array	$data,
			$startPath = null,
			$internalPath = null,
			$maxResults = null,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Get matching paths for elements with specified indexes

Parameters

array | mixed	$indexes
array	$data
string | array | null	$startPath
string | array | null	$internalPath
int | null	$maxResults
string	$delimiter

Returns

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

Since

100.1.0

Definition at line 242 of file ArrayManager.php.

      {
        $indexes = (array)$indexes;
        $startPath = is_array($startPath) ? implode($delimiter, $startPath) : $startPath;
        $internalPath = is_array($internalPath) ? implode($delimiter, $internalPath) : $internalPath;
        $data = $startPath !== null ? $this->get($startPath, $data, [], $delimiter) : $data;
        $checkList = [$startPath => ['start' => $startPath === null, 'children' => $data]];
        $paths = [];

        while ($checkList) {
            $nextCheckList = [];

            foreach ($checkList as $path => $config) {
                foreach ($config['children'] as $childIndex => $childData) {
                    $childPath = $path . (!$config['start'] ? $delimiter : '') . $childIndex;

                    if (in_array($childIndex, $indexes, true)) {
                        $paths[] = $childPath;

                        if ($maxResults !== null && count($paths) >= $maxResults) {
                            return $paths;
                        }
                    }

                    $searchData = $internalPath !== null && is_array($childData)
                        ? $this->get($internalPath, $childData, null, $delimiter)
                        : $childData;

                    if (!empty($searchData) && is_array($searchData)) {
                        $searchPath = $childPath . ($internalPath !== null ? $delimiter . $internalPath : '');
                        $nextCheckList[$searchPath] = ['start' => false, 'children' => $searchData];
                    }
                }
            }

            $checkList = $nextCheckList;
        }

        return $paths;
    }

get()

get	(		$path,
		array	$data,
			$defaultValue = null,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Retrieve node

Parameters

array | string	$path
array	$data
null	$defaultValue
string	$delimiter

Returns

mixed|null

Since

100.1.0

Definition at line 57 of file ArrayManager.php.

    {
        return $this->find($path, $data, $delimiter) ? $this->parentNode[$this->nodeIndex] : $defaultValue;
    }

merge()

merge	(		$path,
		array	$data,
		array	$value,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Merge value with node and return modified data

Parameters

array | string	$path
array	$data
array	$value
string	$delimiter

Returns

array

Since

100.1.0

Definition at line 138 of file ArrayManager.php.

    {
        if ($this->find($path, $data, $delimiter) && is_array($this->parentNode[$this->nodeIndex])) {
            $this->parentNode[$this->nodeIndex] = array_replace_recursive(
                $this->parentNode[$this->nodeIndex],
                $value
            );
        }

        return $data;
    }

move()

move	(		$path,
			$targetPath,
		array	$data,
			$overwrite = false,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Move value from one location to another

Parameters

array | string	$path
string	$targetPath
array	$data
bool	$overwrite
string	$delimiter

Returns

array

Since

100.1.0

Definition at line 111 of file ArrayManager.php.

    {
        if ($this->find($path, $data, $delimiter)) {
            $parentNode = &$this->parentNode;
            $nodeIndex = &$this->nodeIndex;

            if ((!$this->find($targetPath, $data, $delimiter) || $overwrite)
                && $this->find($targetPath, $data, $delimiter, true)
            ) {
                $this->parentNode[$this->nodeIndex] = $parentNode[$nodeIndex];
                unset($parentNode[$nodeIndex]);
            }
        }

        return $data;
    }

populate()

populate	(		$path,
		array	$data,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Populate nested array if possible and needed

Parameters

array | string	$path
array	$data
string	$delimiter

Returns

array

Since

100.1.0

Definition at line 159 of file ArrayManager.php.

    {
        $this->find($path, $data, $delimiter, true);

        return $data;
    }

remove()

remove	(		$path,
		array	$data,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Remove node and return modified data

Parameters

array | string	$path
array	$data
string	$delimiter

Returns

array

Since

100.1.0

Definition at line 175 of file ArrayManager.php.

    {
        if ($this->find($path, $data, $delimiter)) {
            unset($this->parentNode[$this->nodeIndex]);
        }

        return $data;
    }

replace()

replace	(		$path,
		array	$data,
			$value,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Set value into existing node and return modified data

Parameters

array | string	$path
array	$data
mixed	$value
string	$delimiter

Returns

array

Since

100.1.0

Definition at line 91 of file ArrayManager.php.

    {
        if ($this->find($path, $data, $delimiter)) {
            $this->parentNode[$this->nodeIndex] = $value;
        }

        return $data;
    }

set()

set	(		$path,
		array	$data,
			$value,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Set value into node and return modified data

Parameters

array | string	$path
array	$data
mixed	$value
string	$delimiter

Returns

array

Since

100.1.0

Definition at line 72 of file ArrayManager.php.

    {
        if ($this->find($path, $data, $delimiter, true)) {
            $this->parentNode[$this->nodeIndex] = $value;
        }

        return $data;
    }

slicePath()

slicePath	(		$path,
			$offset,
			$length = null,
			$delimiter = self::DEFAULT_PATH_DELIMITER
	)

Retrieve slice of specified path

Parameters

string	$path
int	$offset
int | null	$length
string	$delimiter

Returns

string

Since

100.1.0

Definition at line 322 of file ArrayManager.php.

    {
        return implode($delimiter, array_slice(explode($delimiter, $path), $offset, $length));
    }

Field Documentation

$nodeIndex

$nodeIndex

protected

Definition at line 31 of file ArrayManager.php.

$parentNode

$parentNode

protected

Definition at line 25 of file ArrayManager.php.

DEFAULT_PATH_DELIMITER

const DEFAULT_PATH_DELIMITER = '/'

Default node delimiter for path

Definition at line 19 of file ArrayManager.php.

---

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

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