Функции для массивов
********************

.[perex]
Эта страница посвящена классам [Nette\Utils\Arrays |#Arrays], [#ArrayHash] и [#ArrayList], связанным с массивами.


Установка:

```shell
composer require nette/utils
```


Arrays
======

[api:Nette\Utils\Arrays] - статический класс с полезными функциями для работы с массивами. Его аналог для итераторов - [Nette\Utils\Iterables |iterables].

В следующих примерах предполагается, что определён такой псевдоним класса:

```php
use Nette\Utils\Arrays;
```


associate(array $array, string|array $path): array|\stdClass .[method]
----------------------------------------------------------------------

Эта функция гибко преобразует `$array` в ассоциативный массив или объекты по указанному пути `$path`. Путь может быть строкой или массивом. Он состоит из имён ключей входного массива и операторов вроде `[]`, `->`, `=` и `|`. Выбрасывает `Nette\InvalidArgumentException`, если путь некорректен.

```php
// преобразование в ассоциативный массив по простому ключу
$arr = [
    ['name' => 'John', 'age' => 11],
    ['name' => 'Mary', 'age' => null],
    // ...
];
$result = Arrays::associate($arr, 'name');
// $result = ['John' => ['name' => 'John', 'age' => 11], 'Mary' => ['name' => 'Mary', 'age' => null]]
```

```php
// присваивание значений из одного ключа другому с помощью оператора =
$result = Arrays::associate($arr, 'name=age'); // или ['name', '=', 'age']
// $result = ['John' => 11, 'Mary' => null, ...]
```

```php
// создание объекта с помощью оператора ->
$result = Arrays::associate($arr, '->name'); // или ['->', 'name']
// $result = (object) ['John' => ['name' => 'John', 'age' => 11], 'Mary' => ['name' => 'Mary', 'age' => null]]
```

```php
// группировка на двух уровнях с помощью оператора |
$result = Arrays::associate($arr, 'name|age'); // или ['name', '|', 'age']
// $result: ['John' => [11 => ['name' => 'John', 'age' => 11]], 'Mary' => ['' => ['name' => 'Mary', 'age' => null]], ...]
```

```php
// добавление в массив с помощью []
$result = Arrays::associate($arr, 'name[]'); // или ['name', '[]']
// $result: ['John' => [['name' => 'John', 'age' => 11]], 'Mary' => [['name' => 'Mary', 'age' => null]], ...]
```


contains(array $array, $value): bool .[method]
----------------------------------------------

Проверяет наличие значения в массиве. Использует строгое сравнение (`===`).

```php
Arrays::contains([1, 2, 3], 1);    // true
Arrays::contains(['1', false], 1); // false
```


every(array $array, callable $predicate): bool .[method]
--------------------------------------------------------

Проверяет, проходят ли все элементы массива проверку, реализованную переданной функцией `$predicate` с сигнатурой `function ($value, $key, array $array): bool`.

```php
$array = [1, 30, 39, 29, 10, 13];
$isBelowThreshold = fn($value) => $value < 40;
$res = Arrays::every($array, $isBelowThreshold); // true
```

См. [#some()].


filter(array $array, callable $predicate): array .[method]{data-version:4.0.4}
------------------------------------------------------------------------------

Возвращает новый массив со всеми парами ключ-значение, отвечающими заданному `$predicate`. Callback имеет сигнатуру `function ($value, int|string $key, array $array): bool`.

```php
Arrays::filter(
	['a' => 1, 'b' => 2, 'c' => 3],
	fn($v) => $v < 3,
);
// возвращает ['a' => 1, 'b' => 2]
```


first(array $array, ?callable $predicate=null, ?callable $else=null): mixed .[method]
-------------------------------------------------------------------------------------

Возвращает первый элемент (отвечающий заданному предикату, если он указан). Если такого элемента нет, возвращает результат вызова `$else` или null. `$predicate` имеет сигнатуру `function ($value, int|string $key, array $array): bool`.

В отличие от `reset()`, не меняет внутренний указатель. Параметры `$predicate` и `$else` существуют начиная с версии 4.0.4.

```php
Arrays::first([1, 2, 3]);                   // 1
Arrays::first([1, 2, 3], fn($v) => $v > 2); // 3
Arrays::first([]);                          // null
Arrays::first([], else: fn() => false);     // false
```

См. [#last()].


firstKey(array $array, ?callable $predicate=null): int|string|null .[method]{data-version:4.0.4}
------------------------------------------------------------------------------------------------

Возвращает ключ первого элемента (отвечающего заданному предикату, если он указан) или null, если такого элемента нет. `$predicate` имеет сигнатуру `function ($value, int|string $key, array $array): bool`.

```php
Arrays::firstKey([1, 2, 3]);                   // 0
Arrays::firstKey([1, 2, 3], fn($v) => $v > 2); // 2
Arrays::firstKey(['a' => 1, 'b' => 2]);        // 'a'
Arrays::firstKey([]);                          // null
```

См. [#lastKey()].


flatten(array $array, bool $preserveKeys=false): array .[method]
----------------------------------------------------------------

Схлопывает многоуровневый массив в одноуровневый. Ключи можно сохранить, установив `$preserveKeys` в true.

```php
$array = Arrays::flatten([1, 2, [3, 4, [5, 6]]]);
// $array = [1, 2, 3, 4, 5, 6];
```


get(array $array, string|int|array $key, mixed $default=null): mixed .[method]
------------------------------------------------------------------------------

Возвращает элемент `$array[$key]`. Если его нет, выбрасывает `Nette\InvalidArgumentException`, если только третьим аргументом не задано значение по умолчанию, которое тогда и возвращается.

```php
// если $array['foo'] не существует, выбрасывает исключение
$value = Arrays::get($array, 'foo');

// если $array['foo'] не существует, возвращает 'bar'
$value = Arrays::get($array, 'foo', 'bar');
```

`$key` может быть и массивом, представляющим путь внутрь вложенного массива.

```php
$array = ['color' => ['favorite' => 'red'], 5];

$value = Arrays::get($array, ['color', 'favorite']);
// возвращает 'red'
```


getRef(array &$array, string|int|array $key): mixed .[method]
-------------------------------------------------------------

Возвращает ссылку на указанный элемент массива. Если элемента нет, он будет создан со значением null.

```php
$valueRef = & Arrays::getRef($array, 'foo');
// возвращает ссылку на $array['foo']
```

Работает и с многомерными массивами, как [#get()].

```php
$value = & Arrays::getRef($array, ['color', 'favorite']);
// возвращает ссылку на $array['color']['favorite']
```


grep(array $array, string $pattern, bool $invert=false): array .[method]
------------------------------------------------------------------------

Возвращает только те элементы массива, значение которых соответствует регулярному выражению `$pattern`. Если `$invert` равно `true`, возвращает элементы, которые *не* соответствуют. Ошибка компиляции или выполнения выражения выбрасывает `Nette\RegexpException`.

```php
$filteredArray = Arrays::grep($array, '~^\d+$~');
// возвращает только элементы массива, состоящие из цифр
```


insertAfter(array &$array, string|int|null $key, array $inserted): void .[method]
---------------------------------------------------------------------------------

Вставляет содержимое массива `$inserted` в `$array` сразу после элемента с ключом `$key`. Если `$key` равен `null` (или отсутствует в массиве), вставка происходит в конец.

```php
$array = ['first' => 10, 'second' => 20];
Arrays::insertAfter($array, 'first', ['hello' => 'world']);
// $array = ['first' => 10, 'hello' => 'world', 'second' => 20];
```


insertBefore(array &$array, string|int|null $key, array $inserted): void .[method]
----------------------------------------------------------------------------------

Вставляет содержимое массива `$inserted` в `$array` перед элементом с ключом `$key`. Если `$key` равен `null` (или отсутствует в массиве), вставка происходит в начало.

```php
$array = ['first' => 10, 'second' => 20];
Arrays::insertBefore($array, 'first', ['hello' => 'world']);
// $array = ['hello' => 'world', 'first' => 10, 'second' => 20];
```


invoke(iterable $callbacks, ...$args): array .[method]
------------------------------------------------------

Вызывает все callback-функции из итерируемого объекта и возвращает массив результатов.

```php
$callbacks = [
	'+' => fn($a, $b) => $a + $b,
	'*' => fn($a, $b) => $a * $b,
];

$array = Arrays::invoke($callbacks, 5, 11);
// $array = ['+' => 16, '*' => 55];
```


invokeMethod(iterable $objects, string $method, ...$args): array .[method]
--------------------------------------------------------------------------

Вызывает метод у каждого объекта в итерируемом объекте и возвращает массив результатов.

```php
$objects = ['a' => $obj1, 'b' => $obj2];

$array = Arrays::invokeMethod($objects, 'foo', 1, 2);
// $array = ['a' => $obj1->foo(1, 2), 'b' => $obj2->foo(1, 2)];
```


isList(mixed $value): bool .[method]
------------------------------------

Проверяет, индексирован ли массив по возрастающим числовым ключам начиная с нуля, то есть является ли он списком.

```php
Arrays::isList(['a', 'b', 'c']); // true
Arrays::isList([4 => 1, 2, 3]); // false
Arrays::isList(['a' => 1, 'b' => 2]); // false
```


last(array $array, ?callable $predicate=null, ?callable $else=null): mixed .[method]
------------------------------------------------------------------------------------

Возвращает последний элемент (отвечающий заданному предикату, если он указан). Если такого элемента нет, возвращает результат вызова `$else` или null. `$predicate` имеет сигнатуру `function ($value, int|string $key, array $array): bool`.

В отличие от `end()`, не меняет внутренний указатель. Параметры `$predicate` и `$else` существуют начиная с версии 4.0.4.

```php
Arrays::last([1, 2, 3]);                   // 3
Arrays::last([1, 2, 3], fn($v) => $v < 3); // 2
Arrays::last([]);                          // null
Arrays::last([], else: fn() => false);     // false
```

См. [#first()].


lastKey(array $array, ?callable $predicate=null): int|string|null .[method]{data-version:4.0.4}
-----------------------------------------------------------------------------------------------

Возвращает ключ последнего элемента (отвечающего заданному предикату, если он указан) или null, если такого элемента нет. `$predicate` имеет сигнатуру `function ($value, int|string $key, array $array): bool`.

```php
Arrays::lastKey([1, 2, 3]);                    // 2
Arrays::lastKey([1, 2, 3], fn($v) => $v < 3);  // 1
Arrays::lastKey(['a' => 1, 'b' => 2]);         // 'b'
Arrays::lastKey([]);                           // null
```

См. [#firstKey()].


map(array $array, callable $transformer): array .[method]
---------------------------------------------------------

Вызывает `$transformer` для всех элементов массива и возвращает массив возвращённых значений. Callback имеет сигнатуру `function ($value, $key, array $array): mixed`.

```php
$array = ['foo', 'bar', 'baz'];
$res = Arrays::map($array, fn($value) => $value . $value);
// $res = ['foofoo', 'barbar', 'bazbaz']
```


mapWithKeys(array $array, callable $transformer): array .[method]
-----------------------------------------------------------------

Создаёт новый массив, преобразуя значения и ключи исходного массива. Функция `$transformer` имеет сигнатуру `function ($value, $key, array $array): ?array{$newKey, $newValue}`. Если `$transformer` возвращает `null`, элемент пропускается. Для сохранённых элементов первый элемент возвращённого массива используется как новый ключ, а второй - как новое значение.

```php
$array = ['a' => 1, 'b' => 2];
$result = Arrays::mapWithKeys($array, fn($v, $k) => $v > 1 ? [$v * 2, strtoupper($k)] : null);
// [4 => 'B']
```

Этот метод полезен в ситуациях, когда нужно изменить структуру массива (одновременно ключи и значения) или отфильтровать элементы во время преобразования (возвращая null для ненужных).


mergeTree(array $array1, array $array2): array .[method]
--------------------------------------------------------

Рекурсивно объединяет два массива. Это полезно, например, для объединения древовидных структур. Он следует тем же правилам, что и оператор `+`, применённый к массивам, то есть добавляет пары ключ-значение из второго массива в первый, а при столкновении ключей сохраняет значение из первого массива.

```php
$array1 = ['color' => ['favorite' => 'red'], 5];
$array2 = [10, 'color' => ['favorite' => 'green', 'blue']];

$array = Arrays::mergeTree($array1, $array2);
// $array = ['color' => ['favorite' => 'red', 'blue'], 5];
```

Значения из второго массива всегда добавляются в конец первого. Исчезновение значения `10` из второго массива может показаться немного запутанным. Важно понимать, что и этому значению, и значению `5` из первого массива присвоен один и тот же числовой ключ `0`. Поэтому в получившемся массиве для этого ключа остаётся только элемент из первого массива.


normalize(array $array, ?string $filling=null): array .[method]
---------------------------------------------------------------

Нормализует массив в ассоциативный. Числовые ключи заменяются своими значениями, а новым значением становится `$filling`.

```php
$array = Arrays::normalize([1 => 'first', 'a' => 'second']);
// $array = ['first' => null, 'a' => 'second'];
```

```php
$array = Arrays::normalize([1 => 'first', 'a' => 'second'], 'foobar');
// $array = ['first' => 'foobar', 'a' => 'second'];
```


pick(array &$array, string|int $key, mixed $default=null): mixed .[method]
--------------------------------------------------------------------------

Возвращает и удаляет из массива значение элемента с ключом `$key`. Если элемента нет, выбрасывает исключение или возвращает `$default`, если он задан.

```php
$array = [1 => 'foo', 'x' => 'bar'];
$a = Arrays::pick($array, 'x');
// $a = 'bar'
$b = Arrays::pick($array, 'not-exists', 'foobar');
// $b = 'foobar'
$c = Arrays::pick($array, 'not-exists');
// выбрасывает Nette\InvalidArgumentException
```


renameKey(array &$array, string|int $oldKey, string|int $newKey): bool .[method]
--------------------------------------------------------------------------------

Переименовывает ключ в массиве. Возвращает `true`, если ключ был найден в массиве.

```php
$array = ['first' => 10, 'second' => 20];
Arrays::renameKey($array, 'first', 'renamed');
// $array = ['renamed' => 10, 'second' => 20];
```


getKeyOffset(array $array, string|int $key): ?int .[method]
-----------------------------------------------------------

Возвращает позицию заданного ключа массива, отсчитываемую с нуля. Возвращает `null`, если ключ не найден.

```php
$array = ['first' => 10, 'second' => 20];
$position = Arrays::getKeyOffset($array, 'first'); // возвращает 0
$position = Arrays::getKeyOffset($array, 'second'); // возвращает 1
$position = Arrays::getKeyOffset($array, 'not-exists'); // возвращает null
```


some(array $array, callable $predicate): bool .[method]
-------------------------------------------------------

Проверяет, проходит ли хотя бы один элемент массива проверку, реализованную переданным callback `$predicate` с сигнатурой `function ($value, $key, array $array): bool`.

```php
$array = [1, 2, 3, 4];
$isEven = fn($value) => $value % 2 === 0;
$res = Arrays::some($array, $isEven); // true
```

См. [#every()].


toKey(mixed $value): string|int .[method]
-----------------------------------------

Преобразует значение в ключ массива, то есть в целое число или строку. Числа с плавающей точкой усекаются, логические значения превращаются в `0` или `1`, null становится пустой строкой, а объекты вызывают исключение.

```php
Arrays::toKey('1');  // 1
Arrays::toKey('01'); // '01'
```


toObject(iterable $array, object $object): object .[method]
-----------------------------------------------------------

Копирует элементы итерируемого объекта `$array` в объект `$object` и затем возвращает этот объект.

```php
$obj = new stdClass;
$array = ['foo' => 1, 'bar' => 2];
Arrays::toObject($array, $obj); // устанавливает $obj->foo = 1; $obj->bar = 2;
```


wrap(array $array, string $prefix='', string $suffix=''): array .[method]
-------------------------------------------------------------------------

Приводит каждый элемент массива к строке и оборачивает его в `$prefix` и `$suffix`.

```php
$array = Arrays::wrap(['a' => 'red', 'b' => 'green'], '<<', '>>');
// $array = ['a' => '<<red>>', 'b' => '<<green>>'];
```


ArrayHash
=========

Объект [api:Nette\Utils\ArrayHash] - потомок общего класса `stdClass`, расширяющий его возможностью обращаться с ним как с массивом, например обращаться к членам через квадратные скобки:

```php
$hash = new Nette\Utils\ArrayHash;
$hash['foo'] = 123;
$hash->bar = 456; // объектная запись тоже работает
$hash->foo; // 123
```

Число элементов можно получить функцией `count($hash)`.

Объект можно обходить как массив, в том числе по ссылке:

```php
foreach ($hash as $key => $value) {
	// ...
}

foreach ($hash as $key => &$value) {
	$value = 'new value';
}
```

Существующие массивы можно превратить в `ArrayHash` статическим методом `from()`:

```php
$array = ['foo' => 123, 'bar' => 456];

$hash = Nette\Utils\ArrayHash::from($array);
$hash->foo; // 123
$hash->bar; // 456
```

Преобразование рекурсивно: все вложенные массивы тоже превращаются в объекты `ArrayHash`.

```php
$array = ['foo' => 123, 'inner' => ['a' => 'b']];

$hash = Nette\Utils\ArrayHash::from($array);
$hash->inner; // объект ArrayHash
$hash->inner->a; // 'b'
$hash['inner']['a']; // 'b'
```

Это рекурсивное поведение можно отключить вторым параметром:

```php
$hash = Nette\Utils\ArrayHash::from($array, false);
$hash->inner; // массив
```

Обратно в массив преобразуется приведением `(array)`:

```php
$array = (array) $hash;
```


ArrayList
=========

[api:Nette\Utils\ArrayList] представляет линейный массив, индексы которого - только целые числа, возрастающие от 0.

```php
$list = new Nette\Utils\ArrayList;
$list[] = 'a';
$list[] = 'b';
$list[] = 'c';
// ArrayList(0 => 'a', 1 => 'b', 2 => 'c')
count($list); // 3
```

Существующие массивы можно превратить в `ArrayList` статическим методом `from()`:

```php
$array = ['foo', 'bar'];
$list = Nette\Utils\ArrayList::from($array);
```

Число элементов можно получить функцией `count($list)`.

Объект можно обходить как массив, в том числе по ссылке:

```php
foreach ($list as $key => $value) {
	// ...
}

foreach ($list as $key => &$value) {
	$value = 'new value';
}
```

Обращение к ключам вне допустимого диапазона (от 0 до count-1) или попытка задать нецелочисленные ключи выбрасывает `Nette\OutOfRangeException`:

```php
echo $list[-1]; // выбрасывает Nette\OutOfRangeException
unset($list[30]); // выбрасывает Nette\OutOfRangeException
```

Удаление ключа приводит к перенумерации элементов:

```php
unset($list[1]);
// ArrayList(0 => 'a', 1 => 'c')
```

Новый элемент можно добавить в начало методом `prepend()`:

```php
$list->prepend('d');
// ArrayList(0 => 'd', 1 => 'a', 2 => 'c')
```