1. class
  2. Illuminate
  3. Support
  4. Arr

Arr

class Arr (View source)

Traits

Macroable

Methods

static  void
macro( string $name, callable $macro)

Register a custom macro.

from Macroable
static  bool
hasMacro( string $name)

Checks if macro is registered.

from Macroable
static  mixed
__callStatic( string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable
mixed
__call( string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable
static  bool
accessible( mixed $value)

Determine whether the given value is array accessible.

static  array
add( array $array, string $key, mixed $value)

Add an element to an array using "dot" notation if it doesn't exist.

static  array
build( array $array, callable $callback)

Build a new array using a callback.

static  array
collapse( array $array)

Collapse an array of arrays into a single array.

static  array
divide( array $array)

Divide an array into two arrays. One with keys and the other with values.

static  array
dot( array $array, string $prepend = '')

Flatten a multi-dimensional associative array with dots.

static  array
except( array $array, array|string $keys)

Get all of the given array except for a specified array of items.

static  bool
exists( ArrayAccess|array $array, string|int $key)

Determine if the given key exists in the provided array.

static  mixed
first( array $array, callable $callback = null, mixed $default = null)

Return the first element in an array passing a given truth test.

static  mixed
last( array $array, callable $callback = null, mixed $default = null)

Return the last element in an array passing a given truth test.

static  array
flatten( array $array, int $depth = INF)

Flatten a multi-dimensional array into a single level.

static  void
forget( array $array, array|string $keys)

Remove one or many array items from a given array using "dot" notation.

static  mixed
get( ArrayAccess|array $array, string $key, mixed $default = null)

Get an item from an array using "dot" notation.

static  bool
has( ArrayAccess|array $array, string $key)

Check if an item exists in an array using "dot" notation.

static  bool
isAssoc( array $array)

Determines if an array is associative.

static  array
only( array $array, array|string $keys)

Get a subset of the items from the given array.

static  array
pluck( array $array, string|array $value, string|array|null $key = null)

Pluck an array of values from an array.

static  array
prepend( array $array, mixed $value, mixed $key = null)

Push an item onto the beginning of an array.

static  mixed
pull( array $array, string $key, mixed $default = null)

Get a value from the array, and remove it.

static  array
set( array $array, string $key, mixed $value)

Set an array item to a given value using "dot" notation.

static  array
sort( array $array, callable $callback)

Sort the array using the given callback.

static  array
sortRecursive( array $array)

Recursively sort an array by keys and values.

static  array
where( array $array, callable $callback)

Filter the array using the given callback.

Details

in Macroable at line line 24
static void macro( string $name, callable $macro)

Register a custom macro.

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line line 35
static bool hasMacro( string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line line 49
static mixed __callStatic( string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line line 71
mixed __call( string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line line 18
static bool accessible( mixed $value)

Determine whether the given value is array accessible.

Parameters

mixed $value

Return Value

bool

at line line 31
static array add( array $array, string $key, mixed $value)

Add an element to an array using "dot" notation if it doesn't exist.

Parameters

array $array
string $key
mixed $value

Return Value

array

at line line 49
static array build( array $array, callable $callback)

Build a new array using a callback.

Parameters

array $array
callable $callback

Return Value

array

at line line 68
static array collapse( array $array)

Collapse an array of arrays into a single array.

Parameters

array $array

Return Value

array

at line line 91
static array divide( array $array)

Divide an array into two arrays. One with keys and the other with values.

Parameters

array $array

Return Value

array

at line line 103
static array dot( array $array, string $prepend = '')

Flatten a multi-dimensional associative array with dots.

Parameters

array $array
string $prepend

Return Value

array

at line line 125
static array except( array $array, array|string $keys)

Get all of the given array except for a specified array of items.

Parameters

array $array
array|string $keys

Return Value

array

at line line 139
static bool exists( ArrayAccess|array $array, string|int $key)

Determine if the given key exists in the provided array.

Parameters

ArrayAccess|array $array
string|int $key

Return Value

bool

at line line 156
static mixed first( array $array, callable $callback = null, mixed $default = null)

Return the first element in an array passing a given truth test.

Parameters

array $array
callable $callback
mixed $default

Return Value

mixed

at line line 179
static mixed last( array $array, callable $callback = null, mixed $default = null)

Return the last element in an array passing a given truth test.

Parameters

array $array
callable $callback
mixed $default

Return Value

mixed

at line line 195
static array flatten( array $array, int $depth = INF)

Flatten a multi-dimensional array into a single level.

Parameters

array $array
int $depth

Return Value

array

at line line 225
static void forget( array $array, array|string $keys)

Remove one or many array items from a given array using "dot" notation.

Parameters

array $array
array|string $keys

Return Value

void

at line line 270
static mixed get( ArrayAccess|array $array, string $key, mixed $default = null)

Get an item from an array using "dot" notation.

Parameters

ArrayAccess|array $array
string $key
mixed $default

Return Value

mixed

at line line 302
static bool has( ArrayAccess|array $array, string $key)

Check if an item exists in an array using "dot" notation.

Parameters

ArrayAccess|array $array
string $key

Return Value

bool

at line line 335
static bool isAssoc( array $array)

Determines if an array is associative.

An array is "associative" if it doesn't have sequential numerical keys beginning with zero.

Parameters

array $array

Return Value

bool

at line line 349
static array only( array $array, array|string $keys)

Get a subset of the items from the given array.

Parameters

array $array
array|string $keys

Return Value

array

at line line 362
static array pluck( array $array, string|array $value, string|array|null $key = null)

Pluck an array of values from an array.

Parameters

array $array
string|array $value
string|array|null $key

Return Value

array

at line line 410
static array prepend( array $array, mixed $value, mixed $key = null)

Push an item onto the beginning of an array.

Parameters

array $array
mixed $value
mixed $key

Return Value

array

at line line 429
static mixed pull( array $array, string $key, mixed $default = null)

Get a value from the array, and remove it.

Parameters

array $array
string $key
mixed $default

Return Value

mixed

at line line 448
static array set( array $array, string $key, mixed $value)

Set an array item to a given value using "dot" notation.

If no key is given to the method, the entire array will be replaced.

Parameters

array $array
string $key
mixed $value

Return Value

array

at line line 481
static array sort( array $array, callable $callback)

Sort the array using the given callback.

Parameters

array $array
callable $callback

Return Value

array

at line line 492
static array sortRecursive( array $array)

Recursively sort an array by keys and values.

Parameters

array $array

Return Value

array

at line line 516
static array where( array $array, callable $callback)

Filter the array using the given callback.

Parameters

array $array
callable $callback

Return Value

array