Trabalhando com arrays

Esta página é dedicada às classes Nette\Utils\Arrays, ArrayHash e ArrayList, que dizem respeito a arrays.

Instalação:

composer require nette/utils

Arrays

Nette\Utils\Arrays é uma classe estática que contém funções úteis para trabalhar com arrays. Seu equivalente para iteradores é Nette\Utils\Iterables.

Os exemplos a seguir pressupõem a criação de um alias:

use Nette\Utils\Arrays;

associate (array $array, mixed $path): array|\stdClass

A função transforma flexivelmente o array $array em um array associativo ou objetos de acordo com o caminho $path especificado. O caminho pode ser uma string ou um array. É composto pelos nomes das chaves do array de entrada e operadores como ‘[]’, ‘->’, ‘=’, e ‘|’. Lança Nette\InvalidArgumentException se o caminho for inválido.

// conversão para array associativo por chave simples
$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]]

// atribuição de valores de uma chave para outra usando o operador =
$result = Arrays::associate($arr, 'name=age'); // ou ['name', '=', 'age']
// $result = ['John' => 11, 'Mary' => null, ...]

// criação de objeto usando o operador ->
$result = Arrays::associate($arr, '->name'); // ou ['->', 'name']
// $result = (object) ['John' => ['name' => 'John', 'age' => 11], 'Mary' => ['name' => 'Mary', 'age' => null]]

// combinação de chaves usando o operador |
$result = Arrays::associate($arr, 'name|age'); // ou ['name', '|', 'age']
// $result: ['John' => ['name' => 'John', 'age' => 11], 'Paul' => ['name' => 'Paul', 'age' => 44]]

// adição ao array usando []
$result = Arrays::associate($arr, 'name[]'); // ou ['name', '[]']
// $result: ['John' => [['name' => 'John', 'age' => 22], ['name' => 'John', 'age' => 11]]]

contains (array $array, $value): bool

Testa o array quanto à presença de um valor. Usa comparação estrita (===).

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

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

Testa se todos os elementos no array passam no teste implementado em $predicate com a assinatura function ($value, $key, array $array): bool.

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

Veja some().

filter (array $array, callable $predicate): array

Retorna um novo array contendo todos os pares chave-valor que correspondem ao predicado especificado. O callback tem a assinatura function ($value, int|string $key, array $array): bool.

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

Retorna o primeiro item (correspondente ao predicado, se especificado). Se tal item não existir, retorna o resultado da chamada de $else ou null. O parâmetro $predicate tem a assinatura function ($value, int|string $key, array $array): bool.

Não altera o ponteiro interno, ao contrário de reset(). Os parâmetros $predicate e $else existem desde a versão 4.0.4.

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

Veja last().

firstKey (array $array, ?callable $predicate=null): int|string|null

Retorna a chave do primeiro item (correspondente ao predicado, se fornecido) ou null se tal item não existir. O predicado $predicate tem a assinatura function ($value, int|string $key, array $array): bool.

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

Veja lastKey().

flatten (array $array, bool $preserveKeys=false): array

Achata um array multidimensional em um array plano.

$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

Retorna o elemento $array[$key]. Se não existir, lança uma exceção Nette\InvalidArgumentException ou, se o terceiro parâmetro $default for fornecido, retorna esse valor.

// se $array['foo'] não existir, lança uma exceção
$value = Arrays::get($array, 'foo');

// se $array['foo'] não existir, retorna 'bar'
$value = Arrays::get($array, 'foo', 'bar');

A chave $key também pode ser um array.

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

$value = Arrays::get($array, ['color', 'favorite']);
// retorna 'red'

getRef (array &$array, string|int|array $key): mixed

Obtém uma referência para o elemento especificado do array. Se o elemento não existir, ele será criado com o valor null.

$valueRef = & Arrays::getRef($array, 'foo');
// retorna uma referência para $array['foo']

Assim como a função get(), pode trabalhar com arrays multidimensionais.

$value = & Arrays::getRef($array, ['color', 'favorite']);
// retorna uma referência para $array['color']['favorite']

grep (array $array, string $pattern, bool $invert=false): array

Retorna apenas os elementos do array cujo valor corresponde à expressão regular $pattern. Se $invert for true, retorna os elementos que não correspondem. Um erro durante a compilação ou processamento da expressão lançará uma exceção Nette\RegexpException.

$filteredArray = Arrays::grep($array, '~^\d+$~');
// retorna apenas elementos do array compostos por dígitos

insertAfter (array &$array, string|int|null $key, array $inserted): void

Insere o conteúdo do array $inserted no array $array imediatamente após o elemento com a chave $key. Se $key for null (ou não estiver no array), ele é inserido no final.

$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

Insere o conteúdo do array $inserted no array $array antes do elemento com a chave $key. Se $key for null (ou não estiver no array), ele é inserido no início.

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

invoke (iterable $callbacks, …$args): array

Invoca todos os callbacks e retorna um array de resultados.

$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

Chama um método em cada objeto no array e retorna um array de resultados.

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

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

isList (array $array): bool

Verifica se o array é indexado por uma série ascendente de chaves numéricas a partir de zero, também conhecido como lista.

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

Retorna o último item (correspondente ao predicado, se especificado). Se tal item não existir, retorna o resultado da chamada de $else ou null. O parâmetro $predicate tem a assinatura function ($value, int|string $key, array $array): bool.

Não altera o ponteiro interno, ao contrário de end(). Os parâmetros $predicate e $else existem desde a versão 4.0.4.

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

Veja first().

lastKey (array $array, ?callable $predicate=null): int|string|null

Retorna a chave do último item (correspondente ao predicado, se fornecido) ou null se tal item não existir. O predicado $predicate tem a assinatura function ($value, int|string $key, array $array): bool.

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

Veja firstKey().

map (array $array, callable $transformer): array

Chama $transformer em todos os elementos do array e retorna um array dos valores retornados. O callback tem a assinatura function ($value, $key, array $array): bool.

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

mapWithKeys (array $array, callable $transformer): array

Cria um novo array transformando os valores e chaves do array original. A função $transformer tem a assinatura function ($value, $key, array $array): ?array{$newKey, $newValue}. Se $transformer retornar null, o elemento é ignorado. Para os elementos mantidos, o primeiro elemento do array retornado é usado como a nova chave e o segundo elemento como o novo valor.

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

Este método é útil em situações onde você precisa alterar a estrutura do array (chaves e valores simultaneamente) ou filtrar elementos durante a transformação (retornando null para elementos indesejados).

mergeTree (array $array1, array $array2): array

Mescla recursivamente dois arrays. É útil, por exemplo, para mesclar estruturas de árvore. Ao mesclar, segue as mesmas regras que o operador + aplicado a arrays, ou seja, adiciona pares chave/valor do segundo array ao primeiro e, em caso de colisão de chaves, mantém o valor do primeiro array.

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

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

Os valores do segundo array são sempre adicionados ao final do primeiro. O desaparecimento do valor 10 do segundo array pode parecer um pouco confuso. É preciso perceber que este valor, assim como o valor 5 no primeiro array, têm a mesma chave numérica 0 atribuída, portanto, no array resultante, há apenas o elemento do primeiro array.

normalize (array $array, ?string $filling=null): array

Normaliza um array para um array associativo. As chaves numéricas são substituídas por seus valores, e o novo valor será $filling.

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

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

pick (array &$array, string|int $key, ?mixed $default=null): mixed

Retorna e remove o valor de um elemento do array. Se não existir, lança uma exceção ou retorna o valor $default, se fornecido.

$array = [1 => 'foo', null => 'bar'];
$a = Arrays::pick($array, null);
// $a = 'bar'
$b = Arrays::pick($array, 'not-exists', 'foobar');
// $b = 'foobar'
$c = Arrays::pick($array, 'not-exists');
// throws Nette\InvalidArgumentException

renameKey (array &$array, string|int $oldKey, string|int $newKey): bool

Renomeia uma chave em um array. Retorna true se a chave foi encontrada no array.

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

getKeyOffset (array $array, string|int $key): ?int

Retorna a posição de uma determinada chave no array. A posição é numerada a partir de 0. Se a chave não for encontrada, a função retorna null.

$array = ['first' => 10, 'second' => 20];
$position = Arrays::getKeyOffset($array, 'first'); // retorna 0
$position = Arrays::getKeyOffset($array, 'second'); // retorna 1
$position = Arrays::getKeyOffset($array, 'not-exists'); // retorna null

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

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

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

Veja every().

toKey (mixed $key): string|int

Converte um valor para uma chave de array, que é um inteiro ou uma string.

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

toObject (iterable $array, object $object): object

Copia os elementos do array $array para o objeto $object, que é então retornado.

$obj = new stdClass;
$array = ['foo' => 1, 'bar' => 2];
Arrays::toObject($array, $obj); // define $obj->foo = 1; $obj->bar = 2;

wrap (array $array, string $prefix=`''`, string $suffix=`''`): array

Converte cada item no array para uma string e o envolve com o prefixo $prefix e o sufixo $suffix.

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

ArrayHash

O objeto Nette\Utils\ArrayHash é um descendente da classe genérica stdClass e a estende com a capacidade de tratá-lo como um array, por exemplo, acessando membros usando colchetes:

$hash = new Nette\Utils\ArrayHash;
$hash['foo'] = 123;
$hash->bar = 456; // a notação de objeto também funciona
$hash->foo; // 123

A função count($hash) pode ser usada para obter o número de elementos.

É possível iterar sobre o objeto da mesma forma que um array, inclusive com referência:

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

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

Podemos transformar um array existente em um ArrayHash usando o método from():

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

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

A conversão é recursiva:

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

$hash = Nette\Utils\ArrayHash::from($array);
$hash->inner; // objeto ArrayHash
$hash->inner->a; // 'b'
$hash['inner']['a']; // 'b'

Isso pode ser evitado com o segundo parâmetro:

$hash = Nette\Utils\ArrayHash::from($array, false);
$hash->inner; // array

Transformação de volta para array:

$array = (array) $hash;

ArrayList

Nette\Utils\ArrayList representa um array linear onde os índices são apenas inteiros crescentes a partir de 0.

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

Podemos transformar um array existente em um ArrayList usando o método from():

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

A função count($list) pode ser usada para obter o número de elementos.