Arr
class Arr (View source)
Traits
| Macroable |
Properties
| static protected array | $macros | The registered string macros. | from 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 | collapse(array $array) Collapse an array of arrays into a single array. | |
| static array | crossJoin(array $arrays) Cross join the given arrays, returning all possible permutations. | |
| 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|array $keys) Check if an item or items exist 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 | explodePluckParameters(string|array $value, string|array|null $key) Explode the "value" and "key" arguments passed to "pluck". | |
| 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 mixed | random(array $array, int|null $number = null) Get one or a specified number of random values from an array. | |
| static array | set(array $array, string $key, mixed $value) Set an array item to a given value using "dot" notation. | |
| static array | shuffle(array $array) Shuffle the given array and return the result. | |
| static array | sort(array $array, callable|string $callback) Sort the array using the given callback or "dot" notation. | |
| 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. | |
| static array | wrap(mixed $value) If the given value is not an array, wrap it in one. |
Details
static void macro(string $name, callable $macro)
Register a custom macro.
static bool hasMacro(string $name)
Checks if macro is registered.
static mixed __callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed __call(string $method, array $parameters)
Dynamically handle calls to the class.
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 collapse(array $array)
Collapse an array of arrays into a single array.
static array crossJoin(array $arrays)
Cross join the given arrays, returning all possible permutations.
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|array $keys)
Check if an item or items exist in an array using "dot" notation.
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.
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 protected array explodePluckParameters(string|array $value, string|array|null $key)
Explode the "value" and "key" arguments passed to "pluck".
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 mixed random(array $array, int|null $number = null)
Get one or a specified number of random values from an array.
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.
static array shuffle(array $array)
Shuffle the given array and return the result.
static array sort(array $array, callable|string $callback)
Sort the array using the given callback or "dot" notation.
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.
static array wrap(mixed $value)
If the given value is not an array, wrap it in one.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Support/Arr.html