Introduction

The Arr namespace is part of the Datatype package. Here you can see a list of included functions and their documentation.

every

Signature

function every(array $array, Closure $check = null): bool

Definition

It returns true when every item in the array passes the check, otherwise, it returns false.

If the check is null or not given, it returns true when every item on the every is valid.

Examples

use function Saeghe\Datatype\Arr\every;

echo (int) every(['foo', 'bar', 'baz'], fn ($item) => is_string($item)); // Output: 1
echo (int) every(['foo', 'bar', 'baz'], fn ($item, $key) => is_numeric($key)); // Output: 1
echo (int) every(['foo', 'bar', 'baz'], fn ($item, $key) => strlen($item) > 3); // Output: 0
echo (int) every([1, 2, 3]); // Output: 1
echo (int) every(['foo', 'bar', 'baz']); // Output: 1
echo (int) every([null, 0, '', []]); // Output: 0

first_key

Signature

function first_key(array $array, Closure $condition = null): string|int|null

Definition

It returns the key of the first item in the given array that passes the given condition.

It returns the first key of the array when the condition is null or not given.

It returns null when the given array is empty.

Examples

use function Saeghe\Datatype\Arr\first_key;

echo first_key(['foo' => 1, 'bar' => 2, 'baz' => 2], fn ($item, $key) => $item === 2); // Output: 'bar'
echo first_key(['foo', 'baz']); // Output: 0
assert_true(null === first_key([null => 'foo', 'foo' => 'bar']));
echo first_key([1 => 'bar', 'foo' => 'baz']); // Output: 1
echo first_key('foo' => ['bar'], 'bar' => 'baz'); // Output: 'foo'
assert_true(null === first_key([]));

first

Signature

function first(array $array, Closure $condition = null): mixed

Definition

It returns the value of the first item in the given array that passes the given condition.

It returns the first value of the array when the condition is null or not given.

It returns null when the given array is empty.

Examples

use function Saeghe\Datatype\Arr\first;

assert_true('bar' === first(['foo', 'bar', 'baz'], fn ($item, $key) => Str\first_character($item) === 'b'));
assert_true('foo' === first(['foo', 'baz']));
assert_true(null === first([null, 'foo']));
assert_true(1 === first([1, 'foo']));
assert_true(['bar'] === first(['bar'], 'foo'));
assert_true(null === first([]));

forget

Signature

function forget(array $array, Closure $condition): array

Definition

It unsets items in the given array that matches the given condition.

Examples

use function Saeghe\Datatype\Arr\forget;

$array = ['foo', 'bar', 'baz'];

assert_true([2 => 'baz'] === forget($array, fn ($value, $key) => $value === 'foo' || $key === 1));

has

Signature

function has(array $array, Closure $closure): bool

Definition

It returns true when at least one item in the given array passes the given condition.

Examples

use function Saeghe\Datatype\Arr\has;

assert_true(has(['foo' => 'bar', 'baz' => 'qux'], fn ($item, $key) => $item === 'qux'));
assert_true(has(['foo' => 'bar', 'baz' => 'qux'], fn ($item, $key) => $key === 'baz'));
assert_false(has(['foo' => 'bar', 'baz' => 'qux'], fn ($item, $key) => $key === 0));
assert_false(has(['foo' => 'bar', 'baz' => 'qux'], fn ($item, $key) => $item === null));

insert_after

Signature

function insert_after(array $array, mixed $key, array $additional): array

Definition

It puts the given additional values after the given key in the array.

It puts the given additional values at the end of the array when the given key does not exist.

Examples

use function Saeghe\Datatype\Arr\insert_after;

insert_after(['foo', 'baz'], 0, ['bar']); // Output: ['foo', 'bar', 'baz']
insert_after(['a' => 'foo', 'b' => 'baz'], 'a', ['c' => 'bar']); // Output: ['a' => 'foo', 'c' => 'bar', 'b' => 'baz']
insert_after(['a' => 'foo', 'b' => 'baz'], 'd', ['c' => 'bar']); // Output: ['a' => 'foo', 'b' => 'baz', 'c' => 'bar']

last_key

Signature

function last_key(array $array, Closure $condition = null): null|int|string

Definition

It returns the key of the last item in the given array that passes the given condition.

It returns the last key of the array when the condition is null or not given.

It returns null when the given array is empty.

Examples

use function Saeghe\Datatype\Arr\last_key;

assert_true('baz' === last_key(['foo' => 1, 'bar' => 2, 'baz' => 2], fn ($item, $key) => $item === 2));
assert_true(null === last_key([]));
assert_true(1 === last_key(['foo', 'baz']));
assert_true('' === last_key(['foo' => 'bar', null => 'foo']));
assert_true(1 === last_key(['foo' => 'baz', 1 => 'bar']));
assert_true('foo' === last_key(['bar' => 'baz', 'foo' => ['bar']]));

last

Signature

function last(array $array, Closure $condition = null): mixed

Definition

It returns the value of the last item in the given array that passes the given condition.

It returns the last value of the array when the condition is null or not given.

It returns null when the given array is empty.

Examples

use function Saeghe\Datatype\Arr\last;

assert_true('baz' === last(['foo', 'bar', 'baz'], fn ($item, $key) => first_character($item) === 'b'));
assert_true('baz' === last(['foo', 'baz']));
assert_true(null === last(['foo', null]));
assert_true(1 === last(['foo', 1]));
assert_true(['bar'] === last(['foo', ['bar']]));
assert_true(null === last([]))

map

Signature

function map(array $array, Closure $callback): array

Definition

It maps items in the given array and returns an array by the return values of the given callback for each item.

Examples

use function Saeghe\Datatype\Arr\map;

$array = [1, 2, 3, 4];

assert_true([0, 2, 6, 12] === map($array, fn ($item, $key) => $key * $item));

reduce

Signature

function reduce(array $array, Closure $callback, mixed $carry = null): mixed

Definition

It returns a single value as the result of the given closure against all items in the given array.

It returns the carry when the array is empty

Examples

use function Saeghe\Datatype\Arr\reduce;

assert_true('bar' === reduce(['foo', 'bar', 'baz'], fn ($carry, $value, $key) => $key === 1 ? $value : $carry));
assert_true('bar' === reduce(['foo', 'bar', 'baz'], fn ($carry, $value) => $value === 'bar' ? $value : $carry));
assert_true('foo' === reduce([], fn ($carry, $value, $key) => $value, 'foo'));

take

Signature

function take(array &$array, Closure $condition): mixed

Definition

It takes the first value of the given array where the given condition passes and unsets the item on the original array.

It returns null and keeps array intact when condition does not meet for items.

Examples

use function Saeghe\Datatype\Arr\take;

$arr = ['foo', 'bar', 'baz'];
$result = take($arr, fn ($item, $key) => $item === 'bar');
assert_true('bar' === $result);
assert_true([0 => 'foo', 2 => 'baz'] === $arr);

$arr = ['foo', 'bar', 'baz'];
$result = take($arr, fn ($item, $key) => $item === 'qux');

assert_true(null === $result);
assert_true([0 => 'foo', 1 => 'bar', 2 => 'baz'] === $arr);