Arr
class Arr (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Dynamically handle calls to the class.
Determine whether the given value is array accessible.
Determine whether the given value is arrayable.
Add an element to an array using "dot" notation if it doesn't exist.
Get an array item from an array using "dot" notation.
Get a boolean item from an array using "dot" notation.
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.
Convert a flatten "dot" notation array into an expanded array.
Get all of the given array except for a specified array of keys.
Get all of the given array except for a specified array of values.
Determine if the given key exists in the provided array.
Return the first element in an iterable passing a given truth test.
Return the last element in an array passing a given truth test.
Take the first or last {$limit} items from an array.
Flatten a multi-dimensional array into a single level.
Get a float item from an array using "dot" notation.
Remove one or many array items from a given array using "dot" notation.
Get the underlying array of items from the given argument.
Get an item from an array using "dot" notation.
Check if an item or items exist in an array using "dot" notation.
Determine if all keys exist in an array using "dot" notation.
Determine if any of the keys exist in an array using "dot" notation.
Determine if all items pass the given truth test.
Determine if some items pass the given truth test.
Get an integer item from an array using "dot" notation.
Determines if an array is associative.
Determines if an array is a list.
Join all items using a string. The final items can use a separate glue string.
Key an associative array by a field or using a callback.
Prepend the key names of an associative array.
Get a subset of the items from the given array.
Get a subset of the items from the given array by value.
Select an array of values from an array.
Explode the "value" and "key" arguments passed to "pluck".
Run a map over each of the items in the array.
Run an associative map over each of the items.
Run a map over each nested chunk of items.
Push an item onto the beginning of an array.
Get a value from the array, and remove it.
Convert the array into a query string.
Get one or a specified number of random values from an array.
Set an array item to a given value using "dot" notation.
Push an item into an array using "dot" notation.
Shuffle the given array and return the result.
Get the first item in the array, but only if exactly one item exists. Otherwise, throw an exception.
Sort the array using the given callback or "dot" notation.
Sort the array in descending order using the given callback or "dot" notation.
Recursively sort an array by keys and values.
Recursively sort an array by keys and values in descending order.
Get a string item from an array using "dot" notation.
Conditionally compile classes from an array into a CSS class list.
Conditionally compile styles from an array into a style list.
Filter the array using the given callback.
Filter the array using the negation of the given callback.
Partition the array into two arrays using the given callback.
Filter items where the value is not null.
If the given value is not an array and not null, wrap it in one.
Details
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
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 JsonSerializable ? true : false)))))
arrayable(mixed $value)
Determine whether the given value is arrayable.
static array
add(array $array, string|int|float $key, mixed $value)
Add an element to an array using "dot" notation if it doesn't exist.
static array
array(ArrayAccess|array $array, string|int|null $key, array|null $default = null)
Get an array item from an array using "dot" notation.
static bool
boolean(ArrayAccess|array $array, string|int|null $key, bool|null $default = null)
Get a boolean item from an array using "dot" notation.
static array
collapse(iterable $array)
Collapse an array of arrays into a single array.
static TValue>>
crossJoin(TValue> ...$arrays)
Cross join the given arrays, returning all possible permutations.
static TValue[]}
divide(TValue> $array)
Divide an array into two arrays. One with keys and the other with values.
static array
dot(iterable $array, string $prepend = '', int $depth = INF)
Flatten a multi-dimensional associative array with dots.
static array
undot(iterable $array)
Convert a flatten "dot" notation array into an expanded array.
static array
except(array $array, array|string|int|float $keys)
Get all of the given array except for a specified array of keys.
static array
exceptValues(array $array, mixed $values, bool $strict = false)
Get all of the given array except for a specified array of values.
static bool
exists(ArrayAccess|array $array, string|int|float $key)
Determine if the given key exists in the provided array.
static TValue|TFirstDefault
first(TValue> $array, callable|null $callback = null, TFirstDefault|TFirstDefault $default = null)
Return the first element in an iterable passing a given truth test.
static TValue|TLastDefault
last(TValue> $array, callable|null $callback = null, TLastDefault|TLastDefault $default = null)
Return the last element in an array passing a given truth test.
static array
take(array $array, int $limit)
Take the first or last {$limit} items from an array.
static array
flatten(iterable $array, int $depth = INF)
Flatten a multi-dimensional array into a single level.
static float
float(ArrayAccess|array $array, string|int|null $key, float|null $default = null)
Get a float item from an array using "dot" notation.
static void
forget(array $array, array|string|int|float $keys)
Remove one or many array items from a given array using "dot" notation.
static TValue>)
from(TValue>|TValue>|TValue>|TValue>|TValue>|Jsonable|JsonSerializable|object $items)
Get the underlying array of items from the given argument.
static mixed
get(ArrayAccess|array $array, string|int|null $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
hasAll(ArrayAccess|array $array, string|array $keys)
Determine if all keys exist in an array using "dot" notation.
static bool
hasAny(ArrayAccess|array $array, string|array $keys)
Determine if any of the keys exist in an array using "dot" notation.
static bool
every(iterable $array, callable $callback)
Determine if all items pass the given truth test.
static bool
some(iterable $array, callable $callback)
Determine if some items pass the given truth test.
static int
integer(ArrayAccess|array $array, string|int|null $key, int|null $default = null)
Get an integer item from an array using "dot" notation.
static ($array is list ? false : true)
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 is list ? true : false)
isList(array $array)
Determines if an array is a list.
An array is a "list" if all array keys are sequential integers starting from 0 with no gaps in between.
static string
join(array $array, string $glue, string $finalGlue = '')
Join all items using a string. The final items can use a separate glue string.
static array
keyBy(iterable $array, callable|array|string $keyBy)
Key an associative array by a field or using a callback.
static array
prependKeysWith(array $array, string $prependWith)
Prepend the key names of an associative array.
static array
only(array $array, array|string $keys)
Get a subset of the items from the given array.
static array
onlyValues(array $array, mixed $values, bool $strict = false)
Get a subset of the items from the given array by value.
static array
select(array $array, array|string $keys)
Select an array of values from an array.
static array
pluck(iterable $array, string|array|int|Closure|null $value, string|array|Closure|null $key = null)
Pluck an array of values from an array.
static protected array
explodePluckParameters(Closure|array|string $value, string|array|Closure|null $key)
Explode the "value" and "key" arguments passed to "pluck".
static array
map(array $array, callable $callback)
Run a map over each of the items in the array.
static array
mapWithKeys(array $array, callable $callback)
Run an associative map over each of the items.
The callback should return an associative array with a single key/value pair.
static TValue>
mapSpread(array $array, callable $callback)
Run a map over each nested chunk of items.
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|int $key, mixed $default = null)
Get a value from the array, and remove it.
static string
query(array $array)
Convert the array into a query string.
static ($number is null ? mixed : array)
random(array $array, int|null $number = null, bool $preserveKeys = false)
Get one or a specified number of random values from an array.
static array
set(array $array, string|int|null $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
push(ArrayAccess|array $array, string|int|null $key, mixed ...$values)
Push an item into an array using "dot" notation.
static array
shuffle(array $array)
Shuffle the given array and return the result.
static
sole(array $array, callable|null $callback = null)
Get the first item in the array, but only if exactly one item exists. Otherwise, throw an exception.
static TValue>
sort(TValue> $array, callable|string|null|TValue): -1|0|1)|SortDirection|"asc"|"desc"}> $callback = null)
Sort the array using the given callback or "dot" notation.
static TValue>
sortDesc(TValue> $array, callable|string|null|TValue): -1|0|1)|array{string, "asc"|"desc"}> $callback = null)
Sort the array in descending order using the given callback or "dot" notation.
static TValue>
sortRecursive(TValue> $array, SORT_REGULAR|SORT_NUMERIC|SORT_STRING|SORT_LOCALE_STRING|SORT_NATURAL|SORT_FLAG_CASE> $options = SORT_REGULAR, SortDirection|bool $descending = false)
Recursively sort an array by keys and values.
static TValue>
sortRecursiveDesc(TValue> $array, SORT_REGULAR|SORT_NUMERIC|SORT_STRING|SORT_LOCALE_STRING|SORT_NATURAL|SORT_FLAG_CASE> $options = SORT_REGULAR)
Recursively sort an array by keys and values in descending order.
static string
string(ArrayAccess|array $array, string|int|null $key, string|null $default = null)
Get a string item from an array using "dot" notation.
static ($array is array<string, false> ? "" : ($array is "" ? "" : ($array is array{} ? "" : non-empty-string)))
toCssClasses(array<string, bool>|array<int, string|int>|string $array)
Conditionally compile classes from an array into a CSS class list.
static ($array is array<string, false> ? "" : ($array is "" ? "" : ($array is array{} ? "" : non-empty-string)))
toCssStyles(array<string, bool>|array<int, string|int>|string $array)
Conditionally compile styles from an array into a style list.
static TValue>
where(TValue> $array, callable $callback)
Filter the array using the given callback.
static TValue>
reject(TValue> $array, callable $callback)
Filter the array using the negation of the given callback.
static TValue>>
partition(TValue> $array, callable $callback)
Partition the array into two arrays using the given callback.
static TValue>
whereNotNull(TValue|null> $array)
Filter items where the value is not null.
static TValue}))
wrap(TValue>|TValue|null $value)
If the given value is not an array and not null, wrap it in one.
Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.