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

Copy
1<?php
2
3/**
4 * 特定のキーが存在する場合にのみ要素を許可するカスタムフィルタクラス。
5 *
6 * RecursiveFilterIteratorを継承し、accept()メソッドをオーバーライドすることで
7 * フィルタリングロジックを実装します。
8 */
9class SpecificKeyFilter extends RecursiveFilterIterator
10{
11    private string $targetKey;
12
13    /**
14     * コンストラクタ
15     *
16     * @param RecursiveIterator $iterator フィルタリング対象のイテレータ
17     * @param string $targetKey 検索対象のキー
18     */
19    public function __construct(RecursiveIterator $iterator, string $targetKey)
20    {
21        parent::__construct($iterator);
22        $this->targetKey = $targetKey;
23    }
24
25    /**
26     * 現在の要素を許可するかどうかを判定します。
27     *
28     * @return bool 許可する場合は true, しない場合は false
29     */
30    public function accept(): bool
31    {
32        // 現在の要素が子を持つ場合（=配列である場合）、再帰的に探索を続けるため常に許可します。
33        if ($this->hasChildren()) {
34            return true;
35        }
36
37        // 現在の要素のキーを取得するために RecursiveFilterIterator::key() メソッドを使用します。
38        // 取得したキーが、コンストラクタで指定されたターゲットキーと一致する場合にのみ許可します。
39        // これが「キーが存在するか(key exists)」のチェックに相当します。
40        return $this->key() === $this->targetKey;
41    }
42}
43
44// 1. 再帰的に走査する対象の多次元配列を定義します。
45$data = [
46    'user_id' => 101,
47    'user_name' => 'Alice',
48    'permissions' => [
49        'admin' => false,
50        'editor' => true,
51        // この 'user_id' を見つけたい
52        'user_id' => 202,
53    ],
54    'settings' => [
55        'theme' => 'dark',
56        'notifications' => [
57            'email' => true,
58            'push' => false,
59            // この 'user_id' も見つけたい
60            'user_id' => 303,
61        ],
62    ],
63];
64
65// 2. 配列を再帰的に走査できるイテレータに変換します。
66$arrayIterator = new RecursiveArrayIterator($data);
67
68// 3. 作成したカスタムフィルタを適用し、'user_id' というキーを持つ要素を抽出します。
69$filterIterator = new SpecificKeyFilter($arrayIterator, 'user_id');
70
71// 4. フィルタリングされた結果を、再帰的にたどってフラットなリストとして扱えるようにします。
72$iterator = new RecursiveIteratorIterator($filterIterator);
73
74echo "キーが 'user_id' である要素を検索します:\n";
75
76// 5. フィルタリングされた結果をループ処理します。
77foreach ($iterator as $key => $value) {
78    // $key には $filterIterator->key() が返した値が入ります。
79    printf("キー '%s' が見つかりました。値: %s\n", $key, $value);
80}
81
82?>

RecursiveFilterIterator::key()メソッドは、イテレータが現在指し示している要素のキーを取得するために使用します。このメソッドに引数はありません。戻り値は現在の要素のキーで、配列のキーは文字列や数値など様々であるため、型はmixedとなります。

このサンプルコードでは、多次元配列の中から'user_id'という特定のキーを持つ要素だけを再帰的に探し出すカスタムフィルタSpecificKeyFilterを実装しています。フィルタリングの核心はaccept()メソッド内にあります。ここで$this->key()を呼び出すことで、現在調べている要素のキーを取得し、コンストラクタで指定された検索対象のキー（'user_id'）と一致するかどうかを比較しています。この処理が、PHPで「特定のキーが存在するか（key exists）」をチェックする役割を果たしています。一致した場合にのみaccept()メソッドはtrueを返し、その要素が最終的な結果に含まれるようになります。

最終的に、フィルタリングされたイテレータをforeachでループ処理すると、ネストの深さに関わらず、キーが'user_id'であるすべての要素が見つけ出され、そのキーと値が出力されます。

Copy
1<?php
2
3/**
4 * RecursiveFilterIteratorを継承し、キーに基づいて要素をフィルタリングするクラス。
5 */
6class KeyFilter extends RecursiveFilterIterator
7{
8    /**
9     * イテレータに要素を含めるかどうかを判定します。
10     *
11     * このメソッドは、再帰的な探索中に各要素に対して呼び出されます。
12     * trueを返すとその要素は結果に含まれ、falseを返すと除外されます。
13     *
14     * @return bool 現在の要素を含める場合は true、それ以外は false。
15     */
16    public function accept(): bool
17    {
18        // 現在の要素が子（配列など）を持つ場合、その中身をさらに探索するため常にtrueを返します。
19        if ($this->hasChildren()) {
20            return true;
21        }
22
23        // RecursiveFilterIterator::key() を使って現在の要素のキーを取得します。
24        // ここでは、キーが'product_id'である要素のみを許可するフィルタを実装します。
25        return $this->key() === 'product_id';
26    }
27}
28
29// サンプルデータとして、ネストされた配列を定義します。
30$products = [
31    'category' => 'electronics',
32    'items' => [
33        [
34            'product_id' => 'A-001',
35            'name' => 'Laptop',
36            'price' => 120000,
37        ],
38        [
39            'product_id' => 'B-002',
40            'name' => 'Mouse',
41            'price' => 3000,
42        ],
43    ],
44];
45
46// 1. 配列を再帰的に走査するための RecursiveArrayIterator を作成します。
47$arrayIterator = new RecursiveArrayIterator($products);
48
49// 2. 作成した KeyFilter を使って RecursiveArrayIterator をラップします。
50$filterIterator = new KeyFilter($arrayIterator);
51
52// 3. フィルタリングされた結果をフラットに（一次元的に）処理するための
53//    RecursiveIteratorIterator を作成します。
54$iterator = new RecursiveIteratorIterator($filterIterator);
55
56echo "フィルタリングされた結果 (キーが 'product_id' の要素のみ):\n";
57
58// 4. フィルタリングされたイテレータをループ処理します。
59//    foreach ループ内で使われる $key は、内部的にイテレータの key() メソッドを呼び出します。
60//    同様に $value は current() メソッドを呼び出します。
61foreach ($iterator as $key => $value) {
62    // フィルタ条件に一致した要素のキーと値を出力します。
63    printf("- Key: '%s', Value: '%s'\n", $key, $value);
64}
65
66?>

このPHPサンプルコードは、多次元配列のような階層構造を持つデータから、特定のキーを持つ要素だけを効率的に取り出す方法を示しています。この処理の中心となるのがRecursiveFilterIteratorクラスのkey()メソッドです。

key()メソッドは、再帰的な処理の過程で、イテレータが現在指し示している要素のキーを取得する役割を持ちます。このメソッドに引数はなく、戻り値として現在の要素のキー（このサンプルの場合は文字列）を返します。

サンプルコードでは、まずRecursiveFilterIteratorを継承したKeyFilterクラスを定義しています。そのクラス内のaccept()メソッドで、$this->key()を使って現在の要素のキーを取得し、それが'product_id'という文字列と一致するかどうかを判定しています。この判定結果がtrueの場合のみ、その要素は最終的な結果に含まれます。

このようにkey()メソッドを利用することで、値ではなくキーに基づいてデータをフィルタリングできます。最終的にforeachループを実行すると、ネストされた配列の中からキーが'product_id'である要素のキーと値だけが正確に出力されます。