【PHP8.x】CallbackFilterIterator::key()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5// フィルタリング対象の連想配列
6$userPermissions = [
7    'user_1' => 'read',
8    'admin_1' => 'write',
9    'user_2' => 'read',
10    'admin_2' => 'write',
11    'guest' => 'none',
12];
13
14// 配列から ArrayIterator オブジェクトを作成します。
15// イテレータは、配列やオブジェクトを順番に処理するための仕組みです。
16$iterator = new ArrayIterator($userPermissions);
17
18// CallbackFilterIterator を使って、特定のキーを持つ要素をフィルタリングします。
19// 第2引数のコールバック関数が true を返した要素だけが残ります。
20$filterIterator = new CallbackFilterIterator(
21    $iterator,
22    function (string $current, string $key, Iterator $iterator): bool {
23        // キーが 'admin' で始まる要素のみをフィルタリング対象とします。
24        return str_starts_with($key, 'admin');
25    }
26);
27
28echo "キーが 'admin' で始まるユーザー:\n";
29
30// フィルタリングされた結果をループ処理します。
31foreach ($filterIterator as $permission) {
32    // CallbackFilterIterator::key() メソッドを呼び出し、
33    // 現在の要素のキーを取得します。
34    // これにより、フィルタリング条件を満たしたキーが存在することを確認できます。
35    $key = $filterIterator->key();
36    echo "キー: " . $key . ", 権限: " . $permission . "\n";
37}
38
39?>

このPHPサンプルコードは、CallbackFilterIteratorクラスとそのkey()メソッドを使用して、特定の条件に合致するキーを持つ配列要素を抽出する例です。

まず、ユーザーの権限情報を格納した連想配列$userPermissionsを用意します。次に、この配列をArrayIteratorに変換し、それをCallbackFilterIteratorのコンストラクタに渡します。CallbackFilterIteratorは、第二引数で指定されたコールバック関数（条件判定のロジック）がtrueを返す要素だけを通過させるフィルタの役割を果たします。この例では、キーが文字列 'admin' で始まる要素のみを抽出する条件を指定しています。

foreachループを使ってフィルタリングされた結果を順番に処理します。ループ内で$filterIterator->key()を呼び出すと、現在処理している要素のキーを取得できます。このkey()メソッドは引数を取らず、戻り値として現在のキー（この場合は 'admin_1' や 'admin_2' といった文字列）を返します。これにより、フィルタリング条件を満たしたキーが存在することを確認し、そのキーと対応する値（権限）を組み合わせて表示することができます。

Copy
1<?php
2
3/**
4 * CallbackFilterIteratorを使用して、配列のキーと値を特定の条件でフィルタリングし、
5 * その結果のキーと値を出力するサンプルコードです。
6 */
7function demonstrateCallbackFilterIteratorKey(): void
8{
9    // フィルタリング対象のデータ（商品名 => 価格）
10    $products = [
11        'apple'      => 90,
12        'banana'     => 150,
13        'cherry'     => 210,
14        'date'       => 80,
15        'elderberry' => 300,
16    ];
17
18    // 配列を反復処理するためのイテレータを作成します。
19    $iterator = new ArrayIterator($products);
20
21    // フィルタリングの条件を定義するコールバック関数。
22    // 値(価格)が100以上で、かつキー(商品名)の文字数が5文字以上の要素のみを許可します。
23    $filterCallback = function (int $currentValue, string $currentKey, Iterator $iterator): bool {
24        return $currentValue >= 100 && strlen($currentKey) > 5;
25    };
26
27    // CallbackFilterIteratorを作成し、元のイテレータとコールバック関数を渡します。
28    // これにより、コールバック関数がtrueを返した要素だけが残ります。
29    $filterIterator = new CallbackFilterIterator($iterator, $filterCallback);
30
31    echo "フィルタリング後の商品リスト:\n";
32
33    // フィルタリングされたイテレータをループ処理します。
34    // foreachは、内部でイテレータの key() メソッドを呼び出してキーを取得し、
35    // current() メソッドを呼び出して値を取得します。
36    foreach ($filterIterator as $key => $value) {
37        // ここでの $key は、フィルタを通過した要素のキーです。
38        printf("- Key: %s, Value: %d\n", $key, $value);
39    }
40}
41
42// 関数を実行して結果を表示します。
43demonstrateCallbackFilterIteratorKey();

このサンプルコードは、PHPのCallbackFilterIteratorクラスを使い、配列から特定の条件に合う要素だけを抽出する方法を示しています。

まず、商品名（キー）と価格（値）を持つ連想配列を、要素を一つずつ順番に処理できるArrayIteratorに変換します。次に、フィルタリングのルールをコールバック関数で定義します。この例では、「価格が100以上」かつ「キーである商品名の文字数が5文字より大きい」という条件を満たす要素だけを許可しています。

CallbackFilterIteratorは、このコールバック関数がtrueを返した要素のみを通過させる、新しいイテレータを作成します。

foreachループでフィルタリング後の結果を処理する際、ループの内部ではCallbackFilterIteratorのkey()メソッドが自動的に呼び出されます。key()メソッドは引数を取らず、現在処理中の要素（フィルタを通過した要素）のキーを返します。このサンプルでは、'banana'や'cherry'といった商品名が返されます。戻り値の型はmixedで、様々なデータ型のキーに対応可能です。このようにして取得したキーと値を出力することで、条件に合致した商品リストだけが表示されます。