Arr

Converts an iterable, null, or stdClass to an array.

Recursively converts an iterable to nested arrays.

Return the values from a single column in the $input array, identified by the $columnKey.

Optionally, an $indexKey may be provided to index the values in the returned array by the values from the $indexKey column in the input array.

Example:

$data = [
    ['id' => 10, 'name' => 'Alice'],
    ['id' => 20, 'name' => 'Bob'],
    ['id' => 30, 'name' => 'Carson'],
];

Arr::column($data, 'name');
// => ['Alice', 'Bob', 'Carson']

Arr::column($data, 'name', 'id');
// => [10 => 'Alice', 20 => 'Bob', 30 => 'Carson']

Note: This matches the array_column function, however; it accepts an iterable not just an array, it allows for mapping a list of objects implementing ArrayAccess, and allows for mapping a list of object properties (which was added to the builtin function in PHP 7.0).

Returns whether a key exists from an array or ArrayAccess object using path syntax to check nested data.

This method does not allow for keys that contain /.

Example:

// Check if the the bar key of a set of nested arrays exists.
// This is equivalent to isset($data['foo']['baz']['bar']) but won't
// throw warnings for missing keys.
Arr::has($data, 'foo/baz/bar');

Note: Using isset() with nested data, like isset($data['a']['b']), won't call offsetExists for 'a'. It calls offsetGet('a') and if 'a' doesn't exist and an isset check isn't done in offsetGet, a warning is triggered. It could be argued that that ArrayAccess object should fix this in their implementation of offsetGet, and I would agree. Regardless I think this is nicer syntax.

Gets a value from an array or ArrayAccess object using path syntax to retrieve nested data.

Example:

// Get the bar key of a set of nested arrays.
// This is equivalent to $data['foo']['baz']['bar'] but won't
// throw warnings for missing keys.
Arr::get($data, 'foo/baz/bar');

This method does not allow for keys that contain /.

This code is adapted from Michael Dowling in his Guzzle library.

Sets a value in a nested array or ArrayAccess object using path syntax to set nested data.

Inner arrays will be created as needed to set the value.

Example:

// Set an item at a nested structure
Arr::set($data, 'nested/path/hello', 'world');

// Append to a list in a nested structure
Arr::get($data, 'foo/baz');
// => null
Arr::set($data, 'foo/baz/[]', 'a');
Arr::set($data, 'foo/baz/[]', 'b');
Arr::get($data, 'foo/baz');
// => ['a', 'b']

This function does not support keys that contain / or [] characters because these are special tokens used when traversing the data structure. A value may be appended to an existing array by using [] as the final key of a path.

Note: To set values in arrays that are in ArrayAccess objects their offsetGet() method needs to be able to return arrays by reference. See MutableBag for an example of this.

This code is adapted from Michael Dowling in his Guzzle library.

Removes and returns a value from an array or ArrayAccess object using path syntax to remove nested data.

Example:

Arr::remove($data, 'foo/bar');
// => 'baz'
Arr::remove($data, 'foo/bar');
// => null

This function does not support keys that contain /.

Note: To remove values in arrays that are in ArrayAccess objects their offsetGet() method needs to be able to return arrays by reference. See MutableBag for an example of this.

Returns whether the value is an array or an object implementing ArrayAccess.

Asserts that the given value is an array or an object implementing ArrayAccess.

Returns whether the $iterable is an associative mapping.

Note: Empty arrays are not.

Returns whether the $iterable is an indexed list - zero indexed and sequential.

Note: Empty iterables are.

Returns an array with the $callable applied to each leaf value in the $iterable.

This converts all Traversable objects to arrays.

Replaces values from second iterable into first iterable recursively.

This differs from array_replace_recursive in a couple ways:

• Lists (indexed arrays) from second array completely replace list in first array.

• Null values from second array do not replace lists or associative arrays in first (they do still replace scalar values).

This converts all Traversable objects to arrays.

Flattens an iterable.

Example:

// Flatten one level
Arr::flatten([[1, 2], [[3]], 4])
// => [1, 2, [3], 4]

// Flatten all levels
Arr::flatten([[1, 2], [[3]], 4], INF)
// => [1, 2, 3, 4]