Arr
class Arr
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
Methods
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Determine whether the given value is array accessible.
Add an element to an array using "dot" notation if it doesn't exist.
Collapse an array of arrays into a single array.
Cross join the given arrays, returning all possible permutations.
Divide an array into two arrays. One with keys and the other with values.
Flatten a multi-dimensional associative array with dots.
Get all of the given array except for a specified array of items.
Determine if the given key exists in the provided array.
Return the first element in an array passing a given truth test.
Return the last element in an array passing a given truth test.
Flatten a multi-dimensional array into a single level.
Remove one or many array items from a given array using "dot" notation.
Get an item from an array using "dot" notation.
Check if an item or items exist in an array using "dot" notation.
Determines if an array is associative.
Get a subset of the items from the given array.
Pluck an array of values from an array.
Explode the "value" and "key" arguments passed to "pluck".
Push an item onto the beginning of an array.
Get a value from the array, and remove it.
Get one or a specified number of random values from an array.
Set an array item to a given value using "dot" notation.
Shuffle the given array and return the result.
Sort the array using the given callback or "dot" notation.
Recursively sort an array by keys and values.
Filter the array using the given callback.
If the given value is not an array, wrap it in one.
Details
in
Macroable at line 24
static void
macro(string $name, callable $macro)
Register a custom macro.
in
Macroable at line 35
static bool
hasMacro(string $name)
Checks if macro is registered.
in
Macroable at line 49
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
in
Macroable at line 71
mixed
__call(string $method, array $parameters)
Dynamically handle calls to the class.
at line 19
static bool
accessible(mixed $value)
Determine whether the given value is array accessible.
at line 32
static array
add(array $array, string $key, mixed $value)
Add an element to an array using "dot" notation if it doesn't exist.
at line 47
static array
collapse(array $array)
Collapse an array of arrays into a single array.
at line 70
static array
crossJoin(array ...$arrays)
Cross join the given arrays, returning all possible permutations.
at line 97
static array
divide(array $array)
Divide an array into two arrays. One with keys and the other with values.
at line 109
static array
dot(array $array, string $prepend = '')
Flatten a multi-dimensional associative array with dots.
at line 131
static array
except(array $array, array|string $keys)
Get all of the given array except for a specified array of items.
at line 145
static bool
exists(ArrayAccess|array $array, string|int $key)
Determine if the given key exists in the provided array.
at line 162
static mixed
first(array $array, callable $callback = null, mixed $default = null)
Return the first element in an array passing a given truth test.
at line 191
static mixed
last(array $array, callable $callback = null, mixed $default = null)
Return the last element in an array passing a given truth test.
at line 207
static array
flatten(array $array, int $depth = INF)
Flatten a multi-dimensional array into a single level.
at line 229
static void
forget(array $array, array|string $keys)
Remove one or many array items from a given array using "dot" notation.
at line 274
static mixed
get(ArrayAccess|array $array, string $key, mixed $default = null)
Get an item from an array using "dot" notation.
at line 306
static bool
has(ArrayAccess|array $array, string|array $keys)
Check if an item or items exist in an array using "dot" notation.
at line 349
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.
at line 363
static array
only(array $array, array|string $keys)
Get a subset of the items from the given array.
at line 376
static array
pluck(array $array, string|array $value, string|array|null $key = null)
Pluck an array of values from an array.
at line 411
static protected array
explodePluckParameters(string|array $value, string|array|null $key)
Explode the "value" and "key" arguments passed to "pluck".
at line 428
static array
prepend(array $array, mixed $value, mixed $key = null)
Push an item onto the beginning of an array.
at line 447
static mixed
pull(array $array, string $key, mixed $default = null)
Get a value from the array, and remove it.
at line 465
static mixed
random(array $array, int|null $number = null)
Get one or a specified number of random values from an array.
at line 506
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.
at line 538
static array
shuffle(array $array)
Shuffle the given array and return the result.
at line 552
static array
sort(array $array, callable|string $callback)
Sort the array using the given callback or "dot" notation.
at line 563
static array
sortRecursive(array $array)
Recursively sort an array by keys and values.
at line 587
static array
where(array $array, callable $callback)
Filter the array using the given callback.
at line 598
static array
wrap(mixed $value)
If the given value is not an array, wrap it in one.