Praca z tablicami

Ta strona poświęcona jest klasom Nette\Utils\Arrays, ArrayHash i ArrayList, które dotyczą tablic.

Instalacja:

composer require nette/utils

Arrays

Nette\Utils\Arrays to statyczna klasa zawierająca przydatne funkcje do pracy z tablicami. Jej odpowiednikiem dla iteratorów jest Nette\Utils\Iterables.

Poniższe przykłady zakładają utworzony alias:

use Nette\Utils\Arrays;

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

Funkcja elastycznie przekształca tablicę $array w tablicę asocjacyjną lub obiekty zgodnie z podaną ścieżką $path. Ścieżka może być ciągiem znaków lub tablicą. Składa się z nazw kluczy tablicy wejściowej oraz operatorów takich jak ‘[]’, ‘->’, ‘=’, i ‘|’. Rzuca Nette\InvalidArgumentException w przypadku, gdy ścieżka jest nieprawidłowa.

// konwersja na tablicę asocjacyjną według prostego klucza
$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]]

// przypisanie wartości z jednego klucza do innego za pomocą operatora =
$result = Arrays::associate($arr, 'name=age'); // lub ['name', '=', 'age']
// $result = ['John' => 11, 'Mary' => null, ...]

// utworzenie obiektu za pomocą operatora ->
$result = Arrays::associate($arr, '->name'); // lub ['->', 'name']
// $result = (object) ['John' => ['name' => 'John', 'age' => 11], 'Mary' => ['name' => 'Mary', 'age' => null]]

// kombinacja kluczy za pomocą operatora |
$result = Arrays::associate($arr, 'name|age'); // lub ['name', '|', 'age']
// $result: ['John' => ['name' => 'John', 'age' => 11], 'Paul' => ['name' => 'Paul', 'age' => 44]]

// dodanie do tablicy za pomocą []
$result = Arrays::associate($arr, 'name[]'); // lub ['name', '[]']
// $result: ['John' => [['name' => 'John', 'age' => 22], ['name' => 'John', 'age' => 11]]]

contains (array $array, $value): bool

Sprawdza tablicę pod kątem obecności wartości. Używa ścisłego porównania (===).

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

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

Sprawdza, czy wszystkie elementy w tablicy przechodzą test zaimplementowany w $predicate o sygnaturze function ($value, $key, array $array): bool.

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

Zobacz some().

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

Zwraca nową tablicę zawierającą wszystkie pary klucz-wartość pasujące do podanego predykatu. Callback ma sygnaturę 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

Zwraca pierwszy element (pasujący do predykatu, jeśli jest podany). Jeśli taki element nie istnieje, zwraca wynik wywołania $else lub null. Parametr $predicate ma sygnaturę function ($value, int|string $key, array $array): bool.

Nie zmienia wewnętrznego wskaźnika w przeciwieństwie do reset(). Parametry $predicate i $else istnieją od wersji 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

Zobacz last().

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

Zwraca klucz pierwszego elementu (pasującego do predykatu, jeśli jest podany) lub null, jeśli taki element nie istnieje. Predykat $predicate ma sygnaturę 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

Zobacz lastKey().

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

Spłaszcza wielopoziomową tablicę do płaskiej.

$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

Zwraca element $array[$key]. Jeśli nie istnieje, rzuca wyjątek Nette\InvalidArgumentException lub, jeśli podano trzeci parametr $default, zwraca go.

// jeśli $array['foo'] nie istnieje, rzuca wyjątek
$value = Arrays::get($array, 'foo');

// jeśli $array['foo'] nie istnieje, zwraca 'bar'
$value = Arrays::get($array, 'foo', 'bar');

Kluczem $key może być również tablica.

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

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

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

Pobiera referencję do określonego elementu tablicy. Jeśli element nie istnieje, zostanie utworzony z wartością null.

$valueRef = & Arrays::getRef($array, 'foo');
// zwraca referencję do $array['foo']

Podobnie jak funkcja get(), potrafi pracować z tablicami wielowymiarowymi.

$value = & Arrays::getRef($array, ['color', 'favorite']);
// zwraca referencję do $array['color']['favorite']

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

Zwraca tylko te elementy tablicy, których wartość pasuje do wyrażenia regularnego $pattern. Jeśli $invert jest true, zwraca elementy, które nie pasują. Błąd podczas kompilacji lub przetwarzania wyrażenia rzuca wyjątek Nette\RegexpException.

$filteredArray = Arrays::grep($array, '~^\d+$~');
// zwraca tylko elementy tablicy składające się z cyfr

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

Wstawia zawartość tablicy $inserted do tablicy $array tuż za elementem o kluczu $key. Jeśli $key jest null (lub nie ma go w tablicy), wstawia na koniec.

$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

Wstawia zawartość tablicy $inserted do tablicy $array przed elementem o kluczu $key. Jeśli $key jest null (lub nie ma go w tablicy), wstawia na początek.

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

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

Wywołuje wszystkie callbacki i zwraca tablicę wyników.

$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

Wywołuje metodę na każdym obiekcie w tablicy i zwraca tablicę wyników.

$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

Sprawdza, czy tablica jest indeksowana według rosnącej serii kluczy numerycznych od zera, a.k.a 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

Zwraca ostatni element (pasujący do predykatu, jeśli jest podany). Jeśli taki element nie istnieje, zwraca wynik wywołania $else lub null. Parametr $predicate ma sygnaturę function ($value, int|string $key, array $array): bool.

Nie zmienia wewnętrznego wskaźnika w przeciwieństwie do end(). Parametry $predicate i $else istnieją od wersji 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

Zobacz first().

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

Zwraca klucz ostatniego elementu (pasującego do predykatu, jeśli jest podany) lub null, jeśli taki element nie istnieje. Predykat $predicate ma sygnaturę 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

Zobacz firstKey().

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

Wywołuje $transformer na wszystkich elementach w tablicy i zwraca tablicę zwróconych wartości. Callback ma sygnaturę 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

Tworzy nową tablicę przez transformację wartości i kluczy oryginalnej tablicy. Funkcja $transformer ma sygnaturę function ($value, $key, array $array): ?array{$newKey, $newValue}. Jeśli $transformer zwróci null, element jest pomijany. Dla zachowanych elementów pierwszy element zwróconej tablicy jest używany jako nowy klucz, a drugi element jako nowa wartość.

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

Ta metoda jest przydatna w sytuacjach, gdy potrzebujesz zmienić strukturę tablicy (klucze i wartości jednocześnie) lub filtrować elementy podczas transformacji (zwracając null dla niechcianych elementów).

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

Rekurencyjnie łączy dwie tablice. Przydaje się na przykład do łączenia struktur drzewiastych. Podczas łączenia kieruje się tymi samymi zasadami co operator + zastosowany do tablic, tj. do pierwszej tablicy dodaje pary klucz/wartość z drugiej tablicy, a w przypadku kolizji kluczy pozostawia wartość z pierwszej tablicy.

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

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

Wartości z drugiej tablicy są zawsze dodawane na koniec pierwszej. Trochę mylące może wydawać się zniknięcie wartości 10 z drugiej tablicy. Należy zdać sobie sprawę, że ta wartość, podobnie jak wartość 5 w pierwszej tablicy, mają przypisany ten sam klucz numeryczny 0, dlatego w wynikowej tablicy znajduje się tylko element z pierwszej tablicy.

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

Normalizuje tablicę do tablicy asocjacyjnej. Klucze numeryczne zastępuje ich wartościami, nową wartością będzie $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

Zwraca i usuwa wartość elementu z tablicy. Jeśli nie istnieje, rzuca wyjątek lub zwraca wartość $default, jeśli jest podana.

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

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

Zmienia nazwę klucza w tablicy. Zwraca true, jeśli klucz został znaleziony w tablicy.

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

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

Zwraca pozycję danego klucza w tablicy. Pozycja jest numerowana od 0. W przypadku, gdy klucz nie zostanie znaleziony, funkcja zwróci null.

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

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

Sprawdza, czy przynajmniej jeden element w tablicy przechodzi test zaimplementowany w $predicate o sygnaturze function ($value, $key, array $array): bool.

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

Zobacz every().

toKey (mixed $key): string|int

Konwertuje wartość na klucz tablicy, który jest albo liczbą całkowitą, albo ciągiem znaków.

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

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

Kopiuje elementy tablicy $array do obiektu $object, który następnie zwraca.

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

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

Każdy element w tablicy rzutuje na ciąg znaków i otacza prefiksem $prefix oraz sufiksem $suffix.

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

ArrayHash

Obiekt Nette\Utils\ArrayHash jest potomkiem generycznej klasy stdClass i rozszerza ją o możliwość traktowania go jak tablicy, czyli na przykład dostępu do elementów za pomocą nawiasów kwadratowych:

$hash = new Nette\Utils\ArrayHash;
$hash['foo'] = 123;
$hash->bar = 456; // jednocześnie działa również zapis obiektowy
$hash->foo; // 123

Można używać funkcji count($hash) do sprawdzania liczby elementów.

Nad obiektem można iterować tak samo jak w przypadku tablicy, również z referencją:

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

foreach ($hash as $key => &$value) {
	$value = 'nowa wartość';
}

Istniejącą tablicę możemy przekształcić na ArrayHash za pomocą metody from():

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

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

Konwersja jest rekurencyjna:

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

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

Można temu zapobiec drugim parametrem:

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

Transformacja z powrotem na tablicę:

$array = (array) $hash;

ArrayList

Nette\Utils\ArrayList reprezentuje tablicę liniową, gdzie indeksy są wyłącznie liczbami całkowitymi rosnącymi od 0.

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

Istniejącą tablicę możemy przekształcić na ArrayList za pomocą metody from():

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

Można używać funkcji count($list) do sprawdzania liczby elementów.