配列の関数
********

.[perex]
このページでは、配列に関わる [Nette\Utils\Arrays |#Arrays]、[#ArrayHash]、[#ArrayList] のクラスを扱います。


インストール:

```shell
composer require nette/utils
```


Arrays
======

[api:Nette\Utils\Arrays] は、配列を扱う便利な関数を集めた静的クラスです。イテレータに対する対応物は [Nette\Utils\Iterables |iterables]です。

以下の例では、次のクラスの別名が定義されているものとします。

```php
use Nette\Utils\Arrays;
```


associate(array $array, string|array $path): array|\stdClass .[method]
----------------------------------------------------------------------

この関数は、指定したパス `$path` に従って `$array` を連想配列やオブジェクトに柔軟に変換します。パスは文字列でも配列でもかまいません。入力配列のキーの名前と、`[]`、`->`、`=`、`|` といった演算子から成ります。パスが正しくない場合は `Nette\InvalidArgumentException` を投げます。

```php
// 単純なキーを使って連想配列に変換します
$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]]
```

```php
// = 演算子であるキーの値を別のキーに割り当てます
$result = Arrays::associate($arr, 'name=age'); // または ['name', '=', 'age']
// $result = ['John' => 11, 'Mary' => null, ...]
```

```php
// -> 演算子でオブジェクトを作ります
$result = Arrays::associate($arr, '->name'); // または ['->', 'name']
// $result = (object) ['John' => ['name' => 'John', 'age' => 11], 'Mary' => ['name' => 'Mary', 'age' => null]]
```

```php
// | 演算子で 2 階層にグループ化します
$result = Arrays::associate($arr, 'name|age'); // または ['name', '|', 'age']
// $result: ['John' => [11 => ['name' => 'John', 'age' => 11]], 'Mary' => ['' => ['name' => 'Mary', 'age' => null]], ...]
```

```php
// [] で配列に追加します
$result = Arrays::associate($arr, 'name[]'); // または ['name', '[]']
// $result: ['John' => [['name' => 'John', 'age' => 11]], 'Mary' => [['name' => 'Mary', 'age' => null]], ...]
```


contains(array $array, $value): bool .[method]
----------------------------------------------

配列に値が含まれているかを調べます。厳密な比較（`===`）を使います。

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


every(array $array, callable $predicate): bool .[method]
--------------------------------------------------------

配列のすべての要素が、渡された `$predicate` 関数（シグネチャは `function ($value, $key, array $array): bool`）の実装するテストを通るかを調べます。

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

[#some()]をご覧ください。


filter(array $array, callable $predicate): array .[method]{data-version:4.0.4}
------------------------------------------------------------------------------

与えられた `$predicate` に一致するキーと値の組をすべて含む新しい配列を返します。コールバックのシグネチャは `function ($value, int|string $key, array $array): bool` です。

```php
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 .[method]
-------------------------------------------------------------------------------------

最初の要素（述語が与えられていれば、それに一致する最初の要素）を返します。そのような要素がなければ、`$else` を呼んだ結果か null を返します。`$predicate` のシグネチャは `function ($value, int|string $key, array $array): bool` です。

`reset()` と違い、内部ポインタは変えません。`$predicate` と `$else` のパラメータはバージョン 4.0.4 からあります。

```php
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
```

[#last()]をご覧ください。


firstKey(array $array, ?callable $predicate=null): int|string|null .[method]{data-version:4.0.4}
------------------------------------------------------------------------------------------------

最初の要素（述語が与えられていれば、それに一致する最初の要素）のキーを返します。そのような要素がなければ null を返します。`$predicate` のシグネチャは `function ($value, int|string $key, array $array): bool` です。

```php
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
```

[#lastKey()]をご覧ください。


flatten(array $array, bool $preserveKeys=false): array .[method]
----------------------------------------------------------------

多階層の配列を 1 階層に平らにします。`$preserveKeys` を true にするとキーを保てます。

```php
$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 .[method]
------------------------------------------------------------------------------

要素 `$array[$key]` を返します。存在しない場合は `Nette\InvalidArgumentException` を投げますが、第 3 引数に既定値が渡されていればそれを返します。

```php
// $array['foo'] が存在しなければ例外を投げます
$value = Arrays::get($array, 'foo');

// $array['foo'] が存在しなければ 'bar' を返します
$value = Arrays::get($array, 'foo', 'bar');
```

`$key` には、入れ子の配列への経路を表す配列も渡せます。

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

$value = Arrays::get($array, ['color', 'favorite']);
// 'red' を返します
```


getRef(array &$array, string|int|array $key): mixed .[method]
-------------------------------------------------------------

指定した配列の要素への参照を取得します。要素が存在しなければ、値 null で作られます。

```php
$valueRef = & Arrays::getRef($array, 'foo');
// $array['foo'] への参照を返します
```

[#get()]と同じく、多次元配列でも働きます。

```php
$value = & Arrays::getRef($array, ['color', 'favorite']);
// $array['color']['favorite'] への参照を返します
```


grep(array $array, string $pattern, bool $invert=false): array .[method]
------------------------------------------------------------------------

値が正規表現 `$pattern` に一致する配列の要素だけを返します。`$invert` が `true` なら、一致*しない*要素を返します。式のコンパイルや実行のエラーは `Nette\RegexpException` を投げます。

```php
$filteredArray = Arrays::grep($array, '~^\d+$~');
// 数字だけから成る配列の要素だけを返します
```


insertAfter(array &$array, string|int|null $key, array $inserted): void .[method]
---------------------------------------------------------------------------------

`$inserted` 配列の中身を、キー `$key` の要素の直後に `$array` へ挿入します。`$key` が `null`（または配列に存在しない）の場合は末尾に挿入します。

```php
$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 .[method]
----------------------------------------------------------------------------------

`$inserted` 配列の中身を、キー `$key` の要素の前に `$array` へ挿入します。`$key` が `null`（または配列に存在しない）の場合は先頭に挿入します。

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


invoke(iterable $callbacks, ...$args): array .[method]
------------------------------------------------------

反復可能なものの中のすべてのコールバックを呼び、その結果の配列を返します。

```php
$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 .[method]
--------------------------------------------------------------------------

反復可能なものの中の各オブジェクトでメソッドを呼び、その結果の配列を返します。

```php
$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 .[method]
------------------------------------

配列がゼロから昇順の数値キーで添字づけられているか、いわゆるリストかを調べます。

```php
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 .[method]
------------------------------------------------------------------------------------

最後の要素（述語が与えられていれば、それに一致する最後の要素）を返します。そのような要素がなければ、`$else` を呼んだ結果か null を返します。`$predicate` のシグネチャは `function ($value, int|string $key, array $array): bool` です。

`end()` と違い、内部ポインタは変えません。`$predicate` と `$else` のパラメータはバージョン 4.0.4 からあります。

```php
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
```

[#first()]をご覧ください。


lastKey(array $array, ?callable $predicate=null): int|string|null .[method]{data-version:4.0.4}
-----------------------------------------------------------------------------------------------

最後の要素（述語が与えられていれば、それに一致する最後の要素）のキーを返します。そのような要素がなければ null を返します。`$predicate` のシグネチャは `function ($value, int|string $key, array $array): bool` です。

```php
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
```

[#firstKey()]をご覧ください。


map(array $array, callable $transformer): array .[method]
---------------------------------------------------------

配列のすべての要素に対して `$transformer` を呼び、その戻り値の配列を返します。コールバックのシグネチャは `function ($value, $key, array $array): mixed` です。

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


mapWithKeys(array $array, callable $transformer): array .[method]
-----------------------------------------------------------------

もとの配列の値とキーを変換して、新しい配列を作ります。`$transformer` 関数のシグネチャは `function ($value, $key, array $array): ?array{$newKey, $newValue}` です。`$transformer` が `null` を返すと、その要素は飛ばされます。残す要素については、返された配列の最初の要素が新しいキー、2 つめが新しい値として使われます。

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

このメソッドは、配列の構造（キーと値を同時に）を変えたいときや、変換のついでに要素を絞り込みたい（不要な要素に対して null を返す）ときに便利です。


mergeTree(array $array1, array $array2): array .[method]
--------------------------------------------------------

2 つの配列を再帰的に統合します。たとえば木構造の統合に便利です。配列に `+` 演算子を適用したのと同じ規則に従います。つまり 2 つめの配列のキーと値の組を 1 つめに足し、キーが衝突した場合は 1 つめの配列の値を残します。

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

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

2 つめの配列の値は常に 1 つめの末尾に付け足されます。2 つめの配列から値 `10` が消えるのは少し分かりにくいかもしれません。大事なのは、この値も 1 つめの配列の値 `5` も、同じ数値キー `0` を割り当てられているという点です。ですから、できあがった配列にはこのキーについて 1 つめの配列の要素だけが入ります。


normalize(array $array, ?string $filling=null): array .[method]
---------------------------------------------------------------

配列を連想配列に正規化します。数値のキーはその値に置き換えられ、新しい値は `$filling` になります。

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

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


pick(array &$array, string|int $key, mixed $default=null): mixed .[method]
--------------------------------------------------------------------------

配列からキー `$key` の要素の値を返し、取り除きます。要素が存在しない場合は例外を投げますが、`$default` が渡されていればそれを返します。

```php
$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 を投げます
```


renameKey(array &$array, string|int $oldKey, string|int $newKey): bool .[method]
--------------------------------------------------------------------------------

配列のキーの名前を変えます。そのキーが配列にあった場合は `true` を返します。

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


getKeyOffset(array $array, string|int $key): ?int .[method]
-----------------------------------------------------------

指定した配列のキーの、ゼロから数えた位置を返します。キーが見つからなければ `null` を返します。

```php
$array = ['first' => 10, 'second' => 20];
$position = Arrays::getKeyOffset($array, 'first'); // 0 を返します
$position = Arrays::getKeyOffset($array, 'second'); // 1 を返します
$position = Arrays::getKeyOffset($array, 'not-exists'); // null を返します
```


some(array $array, callable $predicate): bool .[method]
-------------------------------------------------------

配列の少なくともひとつの要素が、渡された `$predicate` コールバック（シグネチャは `function ($value, $key, array $array): bool`）の実装するテストを通るかを調べます。

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

[#every()]をご覧ください。


toKey(mixed $value): string|int .[method]
-----------------------------------------

値を配列のキー、つまり整数か文字列に変換します。浮動小数点数は切り捨てられ、真偽値は `0` か `1` になり、null は空文字列になり、オブジェクトは例外を投げます。

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


toObject(iterable $array, object $object): object .[method]
-----------------------------------------------------------

反復可能な `$array` の要素を `$object` オブジェクトにコピーし、そのオブジェクトを返します。

```php
$obj = new stdClass;
$array = ['foo' => 1, 'bar' => 2];
Arrays::toObject($array, $obj); // $obj->foo = 1; $obj->bar = 2; を設定します
```


wrap(array $array, string $prefix='', string $suffix=''): array .[method]
-------------------------------------------------------------------------

配列の各要素を文字列にキャストし、`$prefix` と `$suffix` で包みます。

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


ArrayHash
=========

[api:Nette\Utils\ArrayHash] オブジェクトは、汎用の `stdClass` クラスの子孫で、配列のように扱える機能を加えたものです。たとえば角かっこでメンバーにアクセスできます。

```php
$hash = new Nette\Utils\ArrayHash;
$hash['foo'] = 123;
$hash->bar = 456; // オブジェクトの書き方も使えます
$hash->foo; // 123
```

要素数を得るには `count($hash)` 関数が使えます。

配列と同じようにオブジェクトを反復でき、参照を使うこともできます。

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

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

既存の配列は静的メソッド `from()` で `ArrayHash` に変換できます。

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

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

変換は再帰的です。入れ子の配列も `ArrayHash` オブジェクトに変換されます。

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

$hash = Nette\Utils\ArrayHash::from($array);
$hash->inner; // ArrayHash オブジェクト
$hash->inner->a; // 'b'
$hash['inner']['a']; // 'b'
```

この再帰的な振る舞いは第 2 パラメータで無効にできます。

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

`(array)` キャストで配列に戻せます。

```php
$array = (array) $hash;
```


ArrayList
=========

[api:Nette\Utils\ArrayList] は、添字が 0 から昇順の整数だけである線形の配列を表します。

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

既存の配列は静的メソッド `from()` で `ArrayList` に変換できます。

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

要素数を得るには `count($list)` 関数が使えます。

配列と同じようにオブジェクトを反復でき、参照を使うこともできます。

```php
foreach ($list as $key => $value) {
	// ...
}

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

許された範囲（0 から count-1）の外のキーにアクセスしたり、整数でないキーを設定しようとしたりすると `Nette\OutOfRangeException` を投げます。

```php
echo $list[-1]; // Nette\OutOfRangeException を投げます
unset($list[30]); // Nette\OutOfRangeException を投げます
```

キーを削除すると要素の番号が振り直されます。

```php
unset($list[1]);
// ArrayList(0 => 'a', 1 => 'c')
```

`prepend()` メソッドで先頭に新しい要素を追加できます。

```php
$list->prepend('d');
// ArrayList(0 => 'd', 1 => 'a', 2 => 'c')
```