Функции итератора
*****************

.[perex]{data-version:4.0.4}
[api:Nette\Utils\Iterables] это статический класс с функциями для работы с итераторами. Его аналог для массивов - [Nette\Utils\Arrays |arrays].


Установка:

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

Все примеры предполагают создание псевдонима:

```php
use Nette\Utils\Iterables;
```


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

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

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


containsKey(iterable $iterable, $value): bool .[method]
-------------------------------------------------------

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

```php
Iterables::containsKey(new ArrayIterator([1, 2, 3]), 0);  // true
Iterables::containsKey(new ArrayIterator([1, 2, 3]), 4);  // false
```


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

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

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

См. [some() |#some()].


filter(iterable $iterable, callable $predicate): Generator .[method]
--------------------------------------------------------------------

Итератор, который фильтрует элементы в соответствии с предикатом. Предикат имеет сигнатуру `function ($value, $key, iterable $iterable): bool`. Сохраняет исходные ключи.

```php
$iterator = new ArrayIterator([1, 2, 3]);
$iterator = Iterables::filter($iterator, fn($v) => $v < 3);
// 1, 2
```


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

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

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


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

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

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


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

Итератор, преобразующий значения путем вызова `$transformer`. Имеет сигнатуру `function ($value, $key, iterable $iterable): bool`. Сохраняет исходные ключи.

```php
$iterator = new ArrayIterator([1, 2, 3]);
$iterator = Iterables::map($iterator, fn($v) => $v * 2);
// 2, 4, 6
```


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

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

```php
$iterator = new ArrayIterator([1, 30, 39, 29, 10, 13]);
$isEven = fn($value) => $value % 2 === 0;
$res = Iterables::some($iterator, $isEven); // true
```

См. [every() |#every()].