Arrays
Table of Contents
Packages
Functions
- array_exclude() : array<string|int, mixed>
- Exclude from an array all the elements that match the provided values.
- array_extract() : array<string|int, mixed>
- Extract from an array all the elements of the input array matching the provided values.
- array_interchange() : array<string|int, mixed>
- Interchange the values of two elements in an array.
- array_omit() : array<string|int, mixed>
- Create a copy of the input array while omiting specific keys.
- array_pick() : array<string|int, mixed>
- Create a new array by picking elements from the input array corresponding to a specific set of keys.
- array_remap() : array<string|int, mixed>
- Applies a (generator) callback to the elements of a given array, allowing the remapping of its keys in the process.
- array_zip() : array<string|int, array<string|int, TValue>>
- Perform a zip operation on multiple arrays.
Functions
array_exclude()
Exclude from an array all the elements that match the provided values.
array_exclude(array<string|int, TValue> $array, TValue ...$values) : array<string|int, mixed>
Parameters
- $array : array<string|int, TValue>
-
The input array.
- $values : TValue
-
The values to be excluded from array.
Tags
Return values
array<string|int, mixed> —Returns a new array containing all the elements in array except for those with values present in values.
array_extract()
Extract from an array all the elements of the input array matching the provided values.
array_extract(array<string|int, mixed> $array, TValue ...$values) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $values : TValue
-
The values to be extracted from array.
Tags
Return values
array<string|int, mixed>array_interchange()
Interchange the values of two elements in an array.
array_interchange(array<string|int, mixed> $array, TKey $key1, TKey $key2) : array<string|int, mixed>
If either of the keys doesn't exist in array, then the other key will
be set to null, and a PHP Warning will be emitted.
Parameters
- $array : array<string|int, mixed>
- $key1 : TKey
- $key2 : TKey
Return values
array<string|int, mixed>array_omit()
Create a copy of the input array while omiting specific keys.
array_omit(array<string|int, mixed> $array, TKey ...$keys) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $keys : TKey
-
The keys of the elements to be omitted from array.
Tags
Return values
array<string|int, mixed> —Returns a new array containing all the elements in array except for those with keys present in keys.
array_pick()
Create a new array by picking elements from the input array corresponding to a specific set of keys.
array_pick(array<string|int, mixed> $array, TKey ...$keys) : array<string|int, mixed>
Parameters
- $array : array<string|int, mixed>
- $keys : TKey
-
The keys of the elements to pick from array.
Tags
Return values
array<string|int, mixed>array_remap()
Applies a (generator) callback to the elements of a given array, allowing the remapping of its keys in the process.
array_remap(callable(TKey $key, TValue $value): mixed $callback, array<string|int, mixed> $array) : array<string|int, mixed>
array_remap() returns an array containing the results of applying a callback with the corresponding key and value of array used as arguments.
If callback is a generator
function, then it's possible to provide a new key for the resulting array
element using yield from $key => $value.
If the same key is yielded more than once, then the later yield will override the previous one.
Parameters
- $callback : callable(TKey $key, TValue $value): mixed
-
A callable to run for each key-value pair in the array.
- $array : array<string|int, mixed>
Return values
array<string|int, mixed> —Returns an array containing the results of applying the callback function to the corresponding key-value pair of array used as arguments for the callback.
array_zip()
Perform a zip operation on multiple arrays.
array_zip(array<string|int, TValue> $array, array<string|int, TValue> ...$arrays) : array<string|int, array<string|int, TValue>>
Parameters
- $array : array<string|int, TValue>
-
An array to zip.
- $arrays : array<string|int, TValue>
-
Supplementary list of array arguments to zip.
Return values
array<string|int, array<string|int, TValue>> —Returns an array whose elements are each an array holding the elements of the input arrays at the same index.