Funzioni per gli array

Questa pagina tratta le classi Nette\Utils\Arrays, ArrayHash e ArrayList, che riguardano gli array.

Installazione:

composer require nette/utils

Arrays

Nette\Utils\Arrays è una classe statica che contiene utili funzioni per lavorare con gli array. Il suo equivalente per gli iteratori è Nette\Utils\Iterables.

Gli esempi seguenti presuppongono che sia definito questo alias di classe:

use Nette\Utils\Arrays;

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

Questa funzione trasforma in modo flessibile l'array $array in un array associativo o in oggetti secondo il percorso $path indicato. Il percorso può essere una stringa o un array. È composto dai nomi delle chiavi dell'array in ingresso e da operatori come [], ->, = e |. Solleva Nette\InvalidArgumentException se il percorso non è valido.

// converte in un array associativo usando una semplice chiave
$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]]

// assegna i valori di una chiave a un'altra con l'operatore =
$result = Arrays::associate($arr, 'name=age'); // oppure ['name', '=', 'age']
// $result = ['John' => 11, 'Mary' => null, ...]

// crea un oggetto con l'operatore ->
$result = Arrays::associate($arr, '->name'); // oppure ['->', 'name']
// $result = (object) ['John' => ['name' => 'John', 'age' => 11], 'Mary' => ['name' => 'Mary', 'age' => null]]

// raggruppa su due livelli con l'operatore |
$result = Arrays::associate($arr, 'name|age'); // oppure ['name', '|', 'age']
// $result: ['John' => [11 => ['name' => 'John', 'age' => 11]], 'Mary' => ['' => ['name' => 'Mary', 'age' => null]], ...]

// aggiunge a un array con []
$result = Arrays::associate($arr, 'name[]'); // oppure ['name', '[]']
// $result: ['John' => [['name' => 'John', 'age' => 11]], 'Mary' => [['name' => 'Mary', 'age' => null]], ...]

contains (array $array, $value): bool

Verifica la presenza di un valore in un array. Usa il confronto rigoroso (===).

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

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

Verifica se tutti gli elementi dell'array superano il test implementato dalla funzione $predicate indicata, con la firma function ($value, $key, array $array): bool.

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

Vedi some().

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

Restituisce un nuovo array con tutte le coppie chiave-valore che soddisfano il $predicate indicato. La callback ha la firma function ($value, int|string $key, array $array): bool.

Arrays::filter(
	['a' => 1, 'b' => 2, 'c' => 3],
	fn($v) => $v < 3,
);
// restituisce ['a' => 1, 'b' => 2]

first (array $array, ?callable $predicate=null, ?callable $else=null): mixed

Restituisce il primo elemento (che soddisfa il predicato indicato, se presente). Se un elemento del genere non esiste, restituisce il risultato della chiamata a $else oppure null. Il $predicate ha la firma function ($value, int|string $key, array $array): bool.

Non modifica il puntatore interno, a differenza di reset(). I parametri $predicate e $else esistono dalla versione 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

Vedi last().

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

Restituisce la chiave del primo elemento (che soddisfa il predicato indicato, se presente) oppure null se un elemento del genere non esiste. Il $predicate ha la firma 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

Vedi lastKey().

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

Appiattisce un array a più livelli in uno a livello singolo. Le chiavi si possono conservare impostando $preserveKeys a true.

$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

Restituisce l'elemento $array[$key]. Se non esiste, solleva Nette\InvalidArgumentException, a meno che non sia indicato un valore predefinito come terzo argomento, che viene allora restituito.

// se $array['foo'] non esiste, solleva un'eccezione
$value = Arrays::get($array, 'foo');

// se $array['foo'] non esiste, restituisce 'bar'
$value = Arrays::get($array, 'foo', 'bar');

$key può essere anche un array che rappresenta un percorso dentro un array annidato.

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

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

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

Ottiene un riferimento all'elemento indicato dell'array. Se l'elemento non esiste, viene creato con valore null.

$valueRef = & Arrays::getRef($array, 'foo');
// restituisce un riferimento a $array['foo']

Funziona con gli array multidimensionali, come get().

$value = & Arrays::getRef($array, ['color', 'favorite']);
// restituisce un riferimento a $array['color']['favorite']

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

Restituisce solo gli elementi dell'array il cui valore corrisponde all'espressione regolare $pattern. Se $invert è true, restituisce gli elementi che non corrispondono. Un errore di compilazione o di esecuzione dell'espressione solleva Nette\RegexpException.

$filteredArray = Arrays::grep($array, '~^\d+$~');
// restituisce solo gli elementi dell'array composti da cifre

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

Inserisce il contenuto dell'array $inserted nell'array $array subito dopo l'elemento con chiave $key. Se $key è null (o non esiste nell'array), l'inserimento avviene alla fine.

$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

Inserisce il contenuto dell'array $inserted nell'array $array prima dell'elemento con chiave $key. Se $key è null (o non esiste nell'array), l'inserimento avviene all'inizio.

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

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

Chiama tutte le callback dell'iterabile e restituisce un array dei risultati.

$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

Chiama un metodo su ogni oggetto di un iterabile e restituisce un array dei risultati.

$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

Controlla se l'array è indicizzato con chiavi numeriche crescenti a partire da zero, cioè se è un elenco.

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

Restituisce l'ultimo elemento (che soddisfa il predicato indicato, se presente). Se un elemento del genere non esiste, restituisce il risultato della chiamata a $else oppure null. Il $predicate ha la firma function ($value, int|string $key, array $array): bool.

Non modifica il puntatore interno, a differenza di end(). I parametri $predicate e $else esistono dalla versione 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

Vedi first().

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

Restituisce la chiave dell'ultimo elemento (che soddisfa il predicato indicato, se presente) oppure null se un elemento del genere non esiste. Il $predicate ha la firma 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

Vedi firstKey().

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

Chiama $transformer su tutti gli elementi dell'array e restituisce un array dei valori di ritorno. La callback ha la firma function ($value, $key, array $array): mixed.

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

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

Crea un nuovo array trasformando i valori e le chiavi dell'array originale. La funzione $transformer ha la firma function ($value, $key, array $array): ?array{$newKey, $newValue}. Se $transformer restituisce null, l'elemento viene saltato. Per gli elementi conservati, il primo elemento dell'array restituito viene usato come nuova chiave e il secondo come nuovo valore.

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

Questo metodo è utile nelle situazioni in cui dovete cambiare la struttura di un array (chiavi e valori insieme) oppure filtrare gli elementi durante la trasformazione (restituendo null per quelli indesiderati).

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

Unisce ricorsivamente due array. È utile per esempio per unire strutture ad albero. Segue le stesse regole dell'operatore + applicato agli array, cioè aggiunge al primo array le coppie chiave/valore del secondo e, in caso di collisione delle chiavi, mantiene il valore del primo array.

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

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

I valori del secondo array vengono sempre aggiunti in fondo al primo. La sparizione del valore 10 del secondo array può sembrare un po' confusa. È importante rendersi conto che a questo valore, come al valore 5 del primo array, è assegnata la stessa chiave numerica 0. L'array risultante contiene quindi, per questa chiave, solo l'elemento del primo array.

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

Normalizza un array trasformandolo in un array associativo. Le chiavi numeriche vengono sostituite dai loro valori e il nuovo valore diventa $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

Restituisce e rimuove dall'array il valore dell'elemento con chiave $key. Se l'elemento non esiste, solleva un'eccezione oppure restituisce $default, se indicato.

$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');
// solleva Nette\InvalidArgumentException

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

Rinomina una chiave dell'array. Restituisce true se la chiave è stata trovata nell'array.

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

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

Restituisce la posizione, a partire da zero, della chiave indicata dell'array. Restituisce null se la chiave non viene trovata.

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

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

Verifica se almeno un elemento dell'array supera il test implementato dalla callback $predicate indicata, con la firma function ($value, $key, array $array): bool.

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

Vedi every().

toKey (mixed $value): string|int

Converte un valore in una chiave di array, che è un intero o una stringa. I float vengono troncati, i booleani convertiti in 0 o 1, null diventa una stringa vuota e gli oggetti sollevano un'eccezione.

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

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

Copia gli elementi dell'iterabile $array nell'oggetto $object e poi restituisce l'oggetto.

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

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

Converte in stringa ogni elemento dell'array e lo racchiude tra $prefix e $suffix.

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

ArrayHash

L'oggetto Nette\Utils\ArrayHash è un discendente della classe generica stdClass e la estende con la possibilità di essere trattato come un array, per esempio accedendo ai membri con le parentesi quadre:

$hash = new Nette\Utils\ArrayHash;
$hash['foo'] = 123;
$hash->bar = 456; // funziona anche la notazione a oggetti
$hash->foo; // 123

Per ottenere il numero di elementi potete usare la funzione count($hash).

Potete scorrere l'oggetto come fareste con un array, anche per riferimento:

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

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

Gli array esistenti si possono trasformare in ArrayHash con il metodo statico from():

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

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

La trasformazione è ricorsiva: anche gli eventuali sotto-array vengono convertiti in oggetti ArrayHash.

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

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

Questo comportamento ricorsivo si può disattivare con il secondo parametro:

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

La trasformazione inversa in array si ottiene con la conversione (array):

$array = (array) $hash;

ArrayList

Nette\Utils\ArrayList rappresenta un array lineare in cui gli indici sono solo interi crescenti a partire da 0.

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

Gli array esistenti si possono trasformare in ArrayList con il metodo statico from():

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

Per ottenere il numero di elementi potete usare la funzione count($list).