【PHP8.x】array_all()関数の使い方

Copy
1<?php
2
3/**
4 * Checks if all elements in an array satisfy a given condition.
5 *
6 * This function iterates over each element of the array and applies the callback function.
7 * If the callback returns a falsy value for any element, the function immediately returns false.
8 * If all elements pass the check (i.e., the callback returns a truthy value for all), it returns true.
9 *
10 * @param array $array The input array.
11 * @param callable $callback The callback function to apply to each element.
12 *                           It should accept a single argument (the array element)
13 *                           and return a boolean indicating whether the element satisfies the condition.
14 * @return bool True if all elements satisfy the condition, false otherwise.
15 */
16function array_all(array $array, callable $callback): bool
17{
18    foreach ($array as $element) {
19        if (!$callback($element)) {
20            return false; // Return false immediately if any element fails the condition
21        }
22    }
23    return true; // Return true if all elements passed the condition
24}
25
26// --- サンプルコードの利用例 ---
27
28// 例1: 全ての数字が偶数であるかチェック
29$numbers1 = [2, 4, 6, 8];
30$areAllEven1 = array_all($numbers1, function (int $num): bool {
31    return $num % 2 === 0;
32});
33echo "すべての数字 [2, 4, 6, 8] は偶数ですか？ " . ($areAllEven1 ? 'はい' : 'いいえ') . PHP_EOL; // 出力: はい
34
35// 例2: 偶数ではない数字が含まれる場合
36$numbers2 = [1, 2, 4, 6];
37$areAllEven2 = array_all($numbers2, function (int $num): bool {
38    return $num % 2 === 0;
39});
40echo "すべての数字 [1, 2, 4, 6] は偶数ですか？ " . ($areAllEven2 ? 'はい' : 'いいえ') . PHP_EOL; // 出力: いいえ
41
42// 例3: 全ての文字列が特定の長さ以上であるかチェック
43$words1 = ["apple", "banana", "cherry"];
44$areAllLongEnough1 = array_all($words1, function (string $word): bool {
45    return strlen($word) > 4;
46});
47echo "すべての単語 ['apple', 'banana', 'cherry'] は4文字より長いですか？ " . ($areAllLongEnough1 ? 'はい' : 'いいえ') . PHP_EOL; // 出力: はい
48
49// 例4: 条件を満たさない文字列が含まれる場合
50$words2 = ["cat", "dog", "elephant"];
51$areAllLongEnough2 = array_all($words2, function (string $word): bool {
52    return strlen($word) > 4;
53});
54echo "すべての単語 ['cat', 'dog', 'elephant'] は4文字より長いですか？ " . ($areAllLongEnough2 ? 'はい' : 'いいえ') . PHP_EOL; // 出力: いいえ
55
56// 例5: 空の配列の場合 (空配列は常に条件を満たすと見なされる)
57$emptyArray = [];
58$areAllTrueInEmpty = array_all($emptyArray, function ($item): bool {
59    return true; // このコールバックは実行されないが、形式的に必要
60});
61echo "空の配列のすべての要素は条件を満たしますか？ " . ($areAllTrueInEmpty ? 'はい' : 'いいえ') . PHP_EOL; // 出力: はい

PHPのarray_all関数は、配列のすべての要素が特定の条件を満たすかどうかを確認するための機能です。

この関数は二つの引数を取ります。一つ目の引数である$arrayには、チェックしたい配列を指定します。二つ目の引数である$callbackには、各要素に対して適用する条件を定義した関数を渡します。この$callback関数は、配列の各要素を一つずつ受け取り、その要素が条件を満たす場合はtrueを、満たさない場合はfalseを返すように作成します。

array_all関数は、配列のすべての要素が$callback関数の条件を満たした場合にtrueを返します。もし、一つでも条件を満たさない要素が見つかった場合、その時点で処理を中断し、すぐにfalseを返します。これにより、無駄な処理を省くことができます。

例えば、配列のすべての数字が偶数であるか、またはすべての文字列が特定の長さ以上であるかといった多様なチェックに利用できます。この関数を使うことで、配列全体の条件適合性を効率的に確認できるようになります。

Copy
1<?php
2
3/**
4 * PHPの配列のすべての要素が、指定されたコールバック関数によって定義された条件を満たすかどうかをチェックします。
5 *
6 * この関数は、提供されたリファレンス情報に基づき実装されたもので、PHPの標準ライブラリには直接は存在しません。
7 * 配列の各要素に対し、コールバック関数を適用し、すべてのコールバックがtrueを返した場合にのみtrueを返します。
8 * 途中で一つでもfalseを返した場合、即座にfalseを返します。
9 *
10 * PHPの連想配列では、同じキーを複数回使用して値を設定した場合、後の値が前の値を上書きします。
11 * したがって、最終的に配列内に同じキーが重複して存在することはありません。
12 * この関数は、そのような上書き後の配列の「すべての要素」が特定の条件を満たすかを検証するのに使用できます。
13 *
14 * @param array $array チェックする配列。
15 * @param callable $callback 各要素に適用するコールバック関数。
16 *                           この関数は現在の要素の値とキーを引数として受け取り、bool値を返す必要があります。
17 *                           例: `fn($value, $key) => $value > 0`
18 * @return bool すべての要素がコールバックによって定義された条件を満たす場合は true、そうでなければ false を返します。
19 */
20function array_all(array $array, callable $callback): bool
21{
22    foreach ($array as $key => $value) {
23        // コールバックがfalseを返した場合、すべての要素が条件を満たしていないため、すぐにfalseを返す
24        if (!$callback($value, $key)) {
25            return false;
26        }
27    }
28    // ループが最後まで実行された場合、すべての要素がコールバックの条件を満たしている
29    return true;
30}
31
32// --- サンプルコードの利用例 ---
33
34// PHPの連想配列の特性を示す配列
35// 'itemA' キーは2回登場しますが、2番目の値(40)が1番目の値(10)を上書きします。
36// そのため、最終的に配列内に重複するキーは存在せず、各キーは一意の値を持ちます。
37$data_with_overwritten_key = [
38    'itemA' => 10,
39    'itemB' => 20,
40    'itemC' => 30,
41    'itemA' => 40, // ここで'itemA'の値が10から40に上書きされる
42];
43
44echo "--- 配列の初期状態 (キー上書き後) ---\n";
45print_r($data_with_overwritten_key);
46echo "\n";
47
48// 例1: 配列のすべての値が20より大きいかチェック
49// 最終的な配列は ['itemA' => 40, 'itemB' => 20, 'itemC' => 30] となります。
50// この場合、'itemB' の値が 20 なので、条件 ( > 20) を満たしません。
51$all_values_greater_than_20 = array_all($data_with_overwritten_key, function ($value) {
52    return $value > 20;
53});
54echo "すべての値が20より大きいですか？ " . ($all_values_greater_than_20 ? 'はい' : 'いいえ') . "\n"; // いいえ
55
56// 例2: 配列のすべての値が数値であるかチェック
57$all_values_are_numbers = array_all($data_with_overwritten_key, function ($value) {
58    return is_numeric($value);
59});
60echo "すべての値が数値ですか？ " . ($all_values_are_numbers ? 'はい' : 'いいえ') . "\n"; // はい
61
62// 例3: 配列のすべてのキーが文字列であるかチェック
63// PHPの連想配列のキーは常に文字列か整数として扱われます。ここではすべて文字列です。
64$all_keys_are_strings = array_all($data_with_overwritten_key, function ($value, $key) {
65    return is_string($key);
66});
67echo "すべてのキーが文字列ですか？ " . ($all_keys_are_strings ? 'はい' : 'いいえ') . "\n"; // はい
68
69// すべての要素が条件を満たすケース
70$positive_data = [
71    'alpha' => 100,
72    'beta' => 200,
73    'gamma' => 300,
74];
75$all_values_greater_than_99 = array_all($positive_data, fn ($value) => $value > 99);
76echo "['alpha' => 100, ...] のすべての値が99より大きいですか？ " . ($all_values_greater_than_99 ? 'はい' : 'いいえ') . "\n"; // はい

array_all関数は、PHPの配列のすべての要素が特定の条件を満たすかどうかをチェックするために使用します。この関数は、与えられた配列の各要素に対して、指定されたコールバック関数を適用します。コールバック関数は、現在の要素の値とそのキーを引数として受け取り、条件を満たす場合はtrueを、満たさない場合はfalseを返すように作成します。

もし配列のすべての要素がコールバック関数の条件を満たした場合にのみ、array_all関数はtrueを返します。途中で一つでも条件を満たさない要素があった場合、その時点で処理を中断し、falseを返します。

PHPの連想配列では、同じキーを複数回指定して値を設定した場合、後から設定された値が前の値を上書きします。そのため、最終的に配列内に同じキーが重複して存在することはありません。array_all関数は、この上書き後の配列の各要素に対して検証を行います。これにより、配列全体が特定のビジネスルールやデータ型要件に合致しているかを効率的に確認することができます。

Copy
1<?php
2
3/**
4 * 指定された配列の全ての要素が、指定されたコールバック関数によるテストに合格するかどうかをチェックします。
5 *
6 * @param array    $array    チェックする配列
7 * @param callable $callback 各要素に対して実行するコールバック関数。引数として要素の値を受け取り、bool値を返す必要があります。
8 *
9 * @return bool 配列の全ての要素がコールバック関数によるテストに合格した場合はtrue、そうでない場合はfalse。
10 */
11function array_all(array $array, callable $callback): bool
12{
13    foreach ($array as $value) {
14        if (!$callback($value)) {
15            return false; // いずれかの要素がテストに失敗した場合、falseを返す
16        }
17    }
18
19    return true; // 全ての要素がテストに合格した場合、trueを返す
20}
21
22// サンプル使用例
23$numbers = [2, 4, 6, 8, 10];
24
25// 全ての要素が偶数かどうかをチェックするコールバック関数
26$isEven = function (int $number): bool {
27    return $number % 2 === 0;
28};
29
30// array_all関数を使用して、配列の全ての要素が偶数かどうかをチェック
31$allEven = array_all($numbers, $isEven);
32
33// 結果を出力
34var_dump($allEven); // bool(true)

array_all関数は、PHP 8で配列のすべての要素が、指定されたコールバック関数によるテストに合格するかどうかを判定する関数です。システムエンジニアを目指す初心者の方にも理解しやすいように、具体的な例を交えながら説明します。

この関数は、第一引数に検査対象の配列 $array を、第二引数に各要素に対して実行するコールバック関数 $callback を受け取ります。コールバック関数は、配列の各要素の値を引数として受け取り、その要素がテストに合格したかどうかを示す真偽値（bool）を返す必要があります。

array_all関数は、配列内のすべての要素に対してコールバック関数を実行し、いずれかの要素がコールバック関数でfalseを返した場合、直ちにfalseを返します。つまり、配列の中に条件を満たさない要素が一つでも存在すれば、全体のテストは失敗となります。

一方、配列内のすべての要素がコールバック関数でtrueを返した場合、array_all関数はtrueを返します。これは、配列のすべての要素が指定された条件を満たしていることを意味します。

サンプルコードでは、$numbersという配列のすべての要素が偶数であるかどうかをチェックしています。$isEvenというコールバック関数は、与えられた数値が偶数であればtrueを、奇数であればfalseを返します。array_all($numbers, $isEven)を実行することで、$numbers配列のすべての要素が偶数であるかどうかが判定され、結果がvar_dumpによって出力されます。この例では、すべての要素が偶数であるため、bool(true)が出力されます。

Copy
1<?php
2
3/**
4 * array_fill_keys() 関数の使用例を示します。
5 * 指定されたキー配列の各要素を新しい配列のキーとして使用し、
6 * すべてのキーに同じ値を割り当てて配列を生成します。
7 */
8function demonstrateArrayFillKeys(): void
9{
10    // 新しい配列のキーとして使用する値の配列を定義します。
11    $keys = ['apple', 'banana', 'orange'];
12
13    // すべてのキーに割り当てる値を定義します。
14    $fillValue = 'fruit';
15
16    // array_fill_keys() を使用して配列を生成します。
17    // 'apple' => 'fruit', 'banana' => 'fruit', 'orange' => 'fruit' のような配列ができます。
18    $newArray = array_fill_keys($keys, $fillValue);
19
20    echo "元のキー配列:\n";
21    print_r($keys);
22    echo "\n";
23
24    echo "割り当てる値: " . $fillValue . "\n";
25    echo "\n";
26
27    echo "array_fill_keys() で生成された配列:\n";
28    print_r($newArray);
29}
30
31// 関数を実行して結果を表示します。
32demonstrateArrayFillKeys();
33
34?>

array_fill_keys()関数は、指定されたキーの配列と一つの値を使って、新しい連想配列を効率的に生成するためのPHPの標準関数です。

この関数は二つの引数を取ります。第一引数array $keysには、新しい配列のキーとして使用したい要素を含む配列を指定します。例えば、['apple', 'banana']のような文字列の配列や、数値の配列などを渡すことができます。第二引数mixed $valueには、$keys配列で指定されたすべてのキーに共通して割り当てる値を指定します。この値は文字列、数値、真偽値など、あらゆる型のデータを設定できます。

array_fill_keys()は、$keys配列の各要素を新しい配列のキーとして使用し、それらのキーすべてに$value引数で指定した値を割り当てた新しい連想配列を戻り値として返します。例えば、キーとして['apple', 'banana']、値として'fruit'を指定した場合、['apple' => 'fruit', 'banana' => 'fruit']のような配列が生成されます。

サンプルコードでは、['apple', 'banana', 'orange']というキー配列と、'fruit'という割り当てる値をarray_fill_keys()関数に渡しています。これにより、各フルーツの名前がキーとなり、そのすべてに'fruit'という値が設定された新しい配列が作成され、その内容が表示されることを確認できます。この関数は、複数のキーに同じデフォルト値を設定したい場合に特に役立ちます。