Funções de iterador

Nette\Utils\Iterables é uma classe estática com funções para trabalhar com iteradores. Sua contraparte para matrizes é Nette\Utils\Arrays.

Instalação:

composer require nette/utils

Todos os exemplos pressupõem a criação de um alias:

use Nette\Utils\Iterables;

contains(iterable $iterable, $value): bool

Testa a presença de um valor no iterador. Usa comparação rigorosa (===).

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

containsKey(iterable $iterable, $value): bool

Testa a presença de uma chave no iterador. Usa comparação rigorosa (===).

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

every(iterable $iterable, callable $predicate): bool

Testa se todos os elementos do iterador passam em um teste implementado em $predicate com a assinatura function ($value, $key, iterable $iterable): bool.

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

Consulte some().

filter(iterable $iterable, callable $predicate): Generator

Iterador que filtra elementos de acordo com um predicado. O predicado tem a assinatura function ($value, $key, iterable $iterable): bool. Mantém as chaves originais.

$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

Retorna o primeiro item (que corresponde ao predicado, se especificado). Se esse item não existir, retorna o resultado da chamada para $else ou nulo. O parâmetro $predicate tem a assinatura function ($value, $key, iterable $iterable): bool.

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

Retorna a chave do primeiro item (que corresponde ao predicado, se especificado). Se esse item não existir, retorna o resultado da chamada para $else ou nulo. O predicado tem a assinatura function ($value, $key, iterable $iterable): bool.

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

Iterador que transforma valores chamando $transformer. Ele tem a assinatura function ($value, $key, iterable $iterable): bool. Mantém as chaves originais.

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

some(iterable $iterable, callable $predicate): bool

Testa se pelo menos um elemento do iterador passa em um teste implementado em $predicate com a assinatura function ($value, $key, iterable $iterable): bool.

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

Consulte every().