Dizi Fonksiyonları

Bu sayfa, dizilerle ilgili Nette\Utils\Arrays, ArrayHash ve ArrayList sınıflarını ele alır.

Kurulum:

composer require nette/utils

Arrays

Nette\Utils\Arrays, dizilerle çalışmaya yarayan kullanışlı fonksiyonlar içeren statik bir sınıftır. Iterator'lar için karşılığı Nette\Utils\Iterables sınıfıdır.

Aşağıdaki örnekler, şu sınıf takma adının tanımlandığını varsayar:

use Nette\Utils\Arrays;

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

Bu fonksiyon, $array dizisini belirtilen $path yoluna göre esnek bir şekilde ilişkisel diziye ya da nesnelere dönüştürür. Yol bir dize ya da bir dizi olabilir. Girdi dizisindeki anahtar adlarından ve [], ->, =, | gibi operatörlerden oluşur. Yol geçersizse Nette\InvalidArgumentException fırlatır.

// basit bir anahtar kullanarak ilişkisel diziye dönüştürme
$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]]

// = operatörüyle bir anahtardan diğerine değer atama
$result = Arrays::associate($arr, 'name=age'); // ya da ['name', '=', 'age']
// $result = ['John' => 11, 'Mary' => null, ...]

// -> operatörüyle nesne oluşturma
$result = Arrays::associate($arr, '->name'); // ya da ['->', 'name']
// $result = (object) ['John' => ['name' => 'John', 'age' => 11], 'Mary' => ['name' => 'Mary', 'age' => null]]

// | operatörüyle iki düzeyde gruplama
$result = Arrays::associate($arr, 'name|age'); // ya da ['name', '|', 'age']
// $result: ['John' => [11 => ['name' => 'John', 'age' => 11]], 'Mary' => ['' => ['name' => 'Mary', 'age' => null]], ...]

// [] ile diziye ekleme
$result = Arrays::associate($arr, 'name[]'); // ya da ['name', '[]']
// $result: ['John' => [['name' => 'John', 'age' => 11]], 'Mary' => [['name' => 'Mary', 'age' => null]], ...]

contains (array $array, $value): bool

Bir dizide belirli bir değerin bulunup bulunmadığını sınar. Katı karşılaştırma (===) kullanır.

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

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

Dizideki tüm öğelerin, function ($value, $key, array $array): bool imzasına sahip $predicate fonksiyonuyla gerçekleştirilen sınamayı geçip geçmediğini sınar.

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

Bkz. some().

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

Verilen $predicate ile eşleşen tüm anahtar-değer çiftlerini içeren yeni bir dizi döndürür. Callback'in imzası function ($value, int|string $key, array $array): bool şeklindedir.

Arrays::filter(
	['a' => 1, 'b' => 2, 'c' => 3],
	fn($v) => $v < 3,
);
// ['a' => 1, 'b' => 2] döndürür

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

İlk öğeyi (predicate verilmişse ona uyan ilk öğeyi) döndürür. Böyle bir öğe yoksa $else çağrısının sonucunu ya da null döndürür. $predicate imzası function ($value, int|string $key, array $array): bool şeklindedir.

reset() fonksiyonunun aksine iç işaretçiyi değiştirmez. $predicate ve $else parametreleri 4.0.4 sürümünden beri vardır.

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

Bkz. last().

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

İlk öğenin (predicate verilmişse ona uyan ilk öğenin) anahtarını, böyle bir öğe yoksa null döndürür. $predicate imzası function ($value, int|string $key, array $array): bool şeklindedir.

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

Bkz. lastKey().

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

Çok düzeyli bir diziyi tek düzeye indirger. $preserveKeys true yapılırsa anahtarlar korunabilir.

$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

$array[$key] öğesini döndürür. Öğe yoksa Nette\InvalidArgumentException fırlatır; üçüncü argüman olarak bir varsayılan değer verilmişse onu döndürür.

// $array['foo'] yoksa istisna fırlatır
$value = Arrays::get($array, 'foo');

// $array['foo'] yoksa 'bar' döndürür
$value = Arrays::get($array, 'foo', 'bar');

$key, iç içe bir diziye giden yolu temsil eden bir dizi de olabilir.

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

$value = Arrays::get($array, ['color', 'favorite']);
// 'red' döndürür

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

Belirtilen dizi öğesine bir referans alır. Öğe yoksa null değeriyle oluşturulur.

$valueRef = & Arrays::getRef($array, 'foo');
// $array['foo'] öğesine referans döndürür

get() gibi çok boyutlu dizilerle de çalışır.

$value = & Arrays::getRef($array, ['color', 'favorite']);
// $array['color']['favorite'] öğesine referans döndürür

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

Yalnızca değeri $pattern düzenli ifadesiyle eşleşen dizi öğelerini döndürür. $invert true ise eşleşmeyen öğeleri döndürür. İfadedeki bir derleme ya da çalışma zamanı hatası Nette\RegexpException fırlatır.

$filteredArray = Arrays::grep($array, '~^\d+$~');
// yalnızca rakamlardan oluşan dizi öğelerini döndürür

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

$inserted dizisinin içeriğini, $array içinde $key anahtarlı öğenin hemen ardına ekler. $key null ise (ya da dizide yoksa) sona eklenir.

$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

$inserted dizisinin içeriğini, $array içinde $key anahtarlı öğeden önce ekler. $key null ise (ya da dizide yoksa) başa eklenir.

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

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

Iterable içindeki tüm callback'leri çağırır ve sonuçlardan oluşan bir dizi döndürür.

$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

Iterable içindeki her nesnede bir metodu çağırır ve sonuçlardan oluşan bir dizi döndürür.

$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

Dizinin sıfırdan başlayarak artan sayısal anahtarlarla indekslenip indekslenmediğini, yani bir liste olup olmadığını denetler.

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

Son öğeyi (predicate verilmişse ona uyan son öğeyi) döndürür. Böyle bir öğe yoksa $else çağrısının sonucunu ya da null döndürür. $predicate imzası function ($value, int|string $key, array $array): bool şeklindedir.

end() fonksiyonunun aksine iç işaretçiyi değiştirmez. $predicate ve $else parametreleri 4.0.4 sürümünden beri vardır.

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

Bkz. first().

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

Son öğenin (predicate verilmişse ona uyan son öğenin) anahtarını, böyle bir öğe yoksa null döndürür. $predicate imzası function ($value, int|string $key, array $array): bool şeklindedir.

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

Bkz. firstKey().

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

Dizideki tüm öğelerde $transformer fonksiyonunu çağırır ve dönüş değerlerinden oluşan bir dizi döndürür. Callback'in imzası function ($value, $key, array $array): mixed şeklindedir.

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

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

Özgün dizinin değerlerini ve anahtarlarını dönüştürerek yeni bir dizi oluşturur. $transformer fonksiyonunun imzası function ($value, $key, array $array): ?array{$newKey, $newValue} şeklindedir. $transformer null döndürürse öğe atlanır. Korunan öğelerde, döndürülen dizinin ilk öğesi yeni anahtar, ikinci öğesi yeni değer olarak kullanılır.

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

Bu metot, bir dizinin yapısını (anahtarları ve değerleri aynı anda) değiştirmeniz ya da dönüşüm sırasında öğeleri filtrelemeniz (istenmeyen öğeler için null döndürerek) gereken durumlarda işe yarar.

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

İki diziyi özyinelemeli olarak birleştirir. Örneğin ağaç yapılarını birleştirmek için kullanışlıdır. Dizilere uygulanan + operatörüyle aynı kuralları izler; yani ikinci dizideki anahtar/değer çiftlerini birinciye ekler ve anahtar çakışmasında birinci dizideki değeri korur.

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

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

İkinci dizideki değerler her zaman birincinin sonuna eklenir. İkinci dizideki 10 değerinin yok olması biraz kafa karıştırıcı görünebilir. Şunu fark etmek önemli: bu değere de, birinci dizideki 5 değerine de aynı sayısal anahtar 0 atanmıştır. Bu yüzden sonuç dizisi bu anahtar için yalnızca birinci dizideki öğeyi içerir.

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

Bir diziyi ilişkisel diziye normalleştirir. Sayısal anahtarların yerini değerleri alır, yeni değer ise $filling olur.

$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

$key anahtarlı öğenin değerini diziden döndürür ve kaldırır. Öğe yoksa istisna fırlatır ya da verilmişse $default değerini döndürür.

$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');
// Nette\InvalidArgumentException fırlatır

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

Bir dizideki anahtarı yeniden adlandırır. Anahtar dizide bulunduysa true döndürür.

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

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

Verilen dizi anahtarının sıfırdan başlayan konumunu döndürür. Anahtar bulunamazsa null döndürür.

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

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

Dizideki en az bir öğenin, function ($value, $key, array $array): bool imzasına sahip $predicate callback'iyle gerçekleştirilen sınamayı geçip geçmediğini sınar.

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

Bkz. every().

toKey (mixed $value): string|int

Bir değeri, tam sayı ya da dize olan bir dizi anahtarına dönüştürür. Kayan noktalı sayılar kırpılır, boolean değerler 0 ya da 1 olur, null boş dizeye dönüşür, nesneler ise istisna fırlatır.

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

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

Iterable $array öğelerini $object nesnesine kopyalar ve ardından nesneyi döndürür.

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

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

Dizideki her öğeyi dizeye dönüştürür ve $prefix ile $suffix arasına alır.

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

ArrayHash

Nette\Utils\ArrayHash nesnesi, genel stdClass sınıfının bir torunudur ve onu dizi gibi ele alınabilme yeteneğiyle genişletir; örneğin üyelere köşeli parantezlerle erişilebilir:

$hash = new Nette\Utils\ArrayHash;
$hash['foo'] = 123;
$hash->bar = 456; // nesne yazımı da çalışır
$hash->foo; // 123

Öğe sayısını almak için count($hash) fonksiyonunu kullanabilirsiniz.

Nesne üzerinde dizide olduğu gibi, hatta referansla da yineleme yapabilirsiniz:

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

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

Var olan diziler, statik from() metoduyla ArrayHash nesnesine dönüştürülebilir:

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

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

Dönüşüm özyinelemelidir: alt diziler de ArrayHash nesnelerine dönüştürülür.

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

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

Bu özyinelemeli davranış ikinci parametreyle kapatılabilir:

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

(array) dönüşümüyle geri diziye çevirin:

$array = (array) $hash;

ArrayList

Nette\Utils\ArrayList, indekslerin yalnızca 0'dan artan tam sayılar olduğu doğrusal bir diziyi temsil eder.

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

Var olan diziler, statik from() metoduyla ArrayList nesnesine dönüştürülebilir:

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

Öğe sayısını almak için count($list) fonksiyonunu kullanabilirsiniz.