【PHP8.x】array_find関数の使い方

Copy
1<?php
2
3/**
4 * 配列内で、指定されたコールバック関数を満たす最初の要素のキーを返す。
5 *
6 * @param array    $array    検索対象の配列
7 * @param callable $callback 各要素に対して実行するコールバック関数。
8 *                           引数として要素の値とキーを受け取り、真偽値を返す。
9 *
10 * @return mixed 見つかった場合は最初の要素のキー、見つからない場合は null を返す。
11 */
12function array_find_key(array $array, callable $callback): mixed
13{
14    foreach ($array as $key => $value) {
15        if ($callback($value, $key)) {
16            return $key;
17        }
18    }
19
20    return null;
21}
22
23// 使用例
24$data = [
25    'apple' => 'red',
26    'banana' => 'yellow',
27    'grape' => 'purple',
28];
29
30$key = array_find_key(
31    $data,
32    function (string $value, string $key): bool {
33        return $value === 'yellow';
34    }
35);
36
37if ($key !== null) {
38    echo "キーが見つかりました: " . $key . PHP_EOL; // キーが見つかりました: banana
39} else {
40    echo "キーは見つかりませんでした。" . PHP_EOL;
41}
42
43$key = array_find_key(
44    $data,
45    function (string $value, string $key): bool {
46        return $key === 'orange';
47    }
48);
49
50if ($key !== null) {
51    echo "キーが見つかりました: " . $key . PHP_EOL;
52} else {
53    echo "キーは見つかりませんでした。" . PHP_EOL; // キーは見つかりませんでした。
54}

array_find_key関数は、PHP 8で配列の中から特定の条件を満たす要素のキーを検索するために使用できるユーザー定義関数です。この関数は、検索対象の配列 $array と、各要素に対して実行されるコールバック関数 $callback の2つの引数を取ります。

$callback 関数は、配列の各要素の値とキーを引数として受け取り、条件を満たすかどうかを真偽値（trueまたはfalse）で返します。array_find_key 関数は、$callback が true を返した最初の要素のキーを返します。もし配列内に条件を満たす要素が見つからない場合は、null を返します。

サンプルコードでは、$data という配列から値が 'yellow' である要素のキーを検索する例と、キーが 'orange' である要素を検索する例を示しています。最初の例では 'banana' というキーが見つかり、2番目の例では条件を満たす要素がないため "キーは見つかりませんでした。" と表示されます。

この関数を利用することで、配列の要素を一つずつ調べて条件に合うキーを探す手間を省き、より簡潔なコードで目的のキーを取得できます。システムエンジニアを目指す上で、配列操作は頻繁に行う処理の一つですので、この関数のような便利なツールを理解しておくことは非常に重要です。

Copy
1<?php
2
3/**
4 * Find the first element in an array that satisfies a callback function.
5 *
6 * This is a polyfill for array_find function which is not available in PHP.
7 *
8 * @param array    $array    The array to search.
9 * @param callable $callback The callback function.
10 *                           It should accept the element value as the first argument,
11 *                           and the element key as the second argument.
12 *                           It should return a boolean value indicating whether the element matches.
13 *
14 * @return mixed The value of the first element that satisfies the callback, or null if no element matches.
15 */
16if (!function_exists('array_find')) {
17    function array_find(array $array, callable $callback): mixed
18    {
19        foreach ($array as $key => $value) {
20            if ($callback($value, $key)) {
21                return $value;
22            }
23        }
24
25        return null;
26    }
27}
28
29// Example usage:
30$numbers = [1, 2, 3, 4, 5];
31
32$evenNumber = array_find($numbers, function ($number) {
33    return $number % 2 === 0;
34});
35
36echo "First even number: " . ($evenNumber ?? 'Not found') . PHP_EOL; // Output: First even number: 2
37
38$oddNumberGreaterThanThree = array_find($numbers, function ($number) {
39    return $number % 2 !== 0 && $number > 3;
40});
41
42echo "First odd number greater than 3: " . ($oddNumberGreaterThanThree ?? 'Not found') . PHP_EOL; // Output: First odd number greater than 3: 5
43
44$stringArray = ['apple', 'banana', 'cherry'];
45$longString = array_find($stringArray, function ($str) {
46    return strlen($str) > 5;
47});
48
49echo "First string longer than 5 characters: " . ($longString ?? 'Not found') . PHP_EOL; // Output: First string longer than 5 characters: banana

PHP 8のarray_find関数は、配列の中から指定した条件を満たす最初の要素を検索します。このサンプルコードは、PHPに標準でarray_find関数が存在しない場合に、同様の機能を提供するポリフィル（代替実装）です。

array_find関数は、第一引数に検索対象の配列、第二引数にコールバック関数を受け取ります。コールバック関数は、配列の各要素に対して実行され、要素が条件を満たすかどうかを真偽値で返します。コールバック関数は、要素の値とキーを引数として受け取ります。

関数は、コールバック関数がtrueを返した最初の要素の値を返します。もし、どの要素も条件を満たさない場合は、nullを返します。

サンプルコードでは、数値配列から最初の偶数を見つけたり、3より大きい最初の奇数を見つけたり、文字列配列から5文字より長い最初の文字列を見つける例が示されています。これらの例を通して、array_find関数が様々なデータ型や条件で使用できることがわかります。 ??演算子は、array_find関数がnullを返した場合に、"Not found"という文字列を表示するために使用されています。これは、結果が見つからなかった場合の代替値を簡単に指定できる便利な機能です。