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

Copy
1<?php
2
3/**
4 * ArrayIterator::getArrayCopy() メソッドの使用例
5 *
6 * このスクリプトは、ArrayIterator クラスの getArrayCopy() メソッドが
7 * 内部で保持している配列の完全なコピーをどのように返すかを示します。
8 * 元の配列を変更せずに、その内容を操作したい場合に便利です。
9 */
10
11// 1. 元となる配列を定義します。
12$originalData = [
13    'id' => 101,
14    'name' => 'Alice',
15    'email' => 'alice@example.com',
16    'roles' => ['admin', 'editor'],
17];
18
19echo "--- 元の配列 ---\n";
20print_r($originalData);
21
22// 2. ArrayIterator オブジェクトを作成し、上記の配列を渡します。
23// ArrayIterator は、配列をオブジェクト指向の方法で反復処理するためのクラスです。
24$arrayIterator = new ArrayIterator($originalData);
25
26// 3. getArrayCopy() メソッドを呼び出して、イテレータが持つ配列のコピーを取得します。
27// このメソッドは、イテレータが内部で保持している配列の「値のコピー」を返します。
28// これにより、元の配列とは独立した新しい配列が得られます。
29$copiedArray = $arrayIterator->getArrayCopy();
30
31echo "\n--- getArrayCopy() で取得したコピー配列 ---\n";
32print_r($copiedArray);
33
34// 4. コピー配列が元の配列とは異なる独立したものであることを示すために、
35// コピー配列の内容を変更してみます。
36$copiedArray['name'] = 'Bob';         // 'name' の値を変更
37$copiedArray['status'] = 'active';    // 新しい要素を追加
38$copiedArray['roles'][] = 'viewer';   // 既存の配列要素に値を追加
39
40echo "\n--- コピー配列を変更後 ---\n";
41print_r($copiedArray);
42
43// 5. 元の配列の内容を確認します。
44// getArrayCopy() はコピーを返すため、元の配列は変更されていないことが分かります。
45echo "\n--- 元の配列 (変更されていないことを確認) ---\n";
46print_r($originalData);
47
48// 結果として、元の配列は変更されず、コピー配列のみが変更されたことが確認できます。
49// これは、getArrayCopy() が配列の「コピー」を返していることを明確に示しています。
50
51?>

PHPのArrayIterator::getArrayCopy()メソッドは、ArrayIteratorオブジェクトが内部で保持している配列の「完全なコピー」を取得するために使用されます。ArrayIteratorは、配列をオブジェクト指向の方法で扱うためのクラスであり、その内部配列を直接操作することなく、内容を閲覧したり反復処理したりできます。

このgetArrayCopy()メソッドは引数を一切必要とせず、呼び出されると、イテレータが保持している元の配列と全く同じ内容を持つ新しいarray型の配列を返します。このとき、返されるのは元の配列そのものではなく、その「値のコピー」であるため、元の配列とは完全に独立した別の配列が生成されます。

サンプルコードでは、まず元の配列をArrayIteratorに渡し、その後getArrayCopy()を呼び出してコピー配列を取得しています。このコピー配列に対して要素の変更や追加を行っても、元の配列は一切変更されていないことが確認できます。これは、getArrayCopy()が元のデータを保護しつつ、その内容を基にした一時的な操作や加工を行いたい場合に非常に有用であることを示しています。元のデータを壊すことなく、安全に配列の内容を操作できる点が最大のメリットです。

Copy
1<?php
2
3/**
4 * ArrayIterator::getArrayCopy() メソッドの使用例
5 *
6 * この関数は、システムエンジニアを目指す初心者向けに、
7 * ArrayIterator クラスの getArrayCopy メソッドの基本的な使い方を示します。
8 * getArrayCopy() は、イテレータが保持している配列の現在の内容を新しい配列として返します。
9 * 返される配列は元のイテレータとは独立したコピーです。
10 */
11function demonstrateArrayIteratorGetArrayCopy(): void
12{
13    // ① 元になる配列を用意します。
14    $originalData = [
15        'itemA' => 100,
16        'itemB' => 200,
17        'itemC' => 300,
18    ];
19
20    echo "--- ① 元のデータ ---\n";
21    print_r($originalData);
22
23    // ② ArrayIterator を使って、この配列をイテレータ化します。
24    // ArrayIterator は、配列のようにキーと値で要素にアクセスできるオブジェクトです。
25    $arrayIterator = new ArrayIterator($originalData);
26
27    echo "\n--- ② ArrayIterator の初期状態のコピーを取得 ---\n";
28    // getArrayCopy() を使って、ArrayIterator が保持している配列の「コピー」を取得します。
29    // この時点でのイテレータの内容が新しい独立した配列として取得されます。
30    $firstCopy = $arrayIterator->getArrayCopy();
31    print_r($firstCopy);
32
33    // ③ ArrayIterator の内容を変更してみます。
34    // offsetSet を使うと、新しい要素を追加したり、既存の要素を変更したりできます。
35    $arrayIterator->offsetSet('itemD', 400); // 新しい要素を追加
36    $arrayIterator->offsetSet('itemA', 150); // 既存の要素を変更
37
38    echo "\n--- ③ ArrayIterator 変更後の状態 ---\n";
39    // 変更後の ArrayIterator の内容を再度 getArrayCopy() で取得します。
40    // このコピーには、変更が反映されています。
41    $secondCopy = $arrayIterator->getArrayCopy();
42    print_r($secondCopy);
43
44    echo "\n--- ④ 最初のコピーと現在の ArrayIterator の比較 ---\n";
45    echo "最初に取得したコピー (\$firstCopy):\n";
46    print_r($firstCopy); // $firstCopy は ArrayIterator の変更の影響を受けていないことを確認
47
48    echo "\n変更後の ArrayIterator の内部データ (\$secondCopy):\n";
49    print_r($secondCopy); // $secondCopy は ArrayIterator の変更が反映されている
50
51    echo "\nポイント: getArrayCopy() は、呼び出された時点の ArrayIterator の内容の\n";
52    echo "          「独立したコピー」を返します。\n";
53    echo "          そのため、コピー取得後に ArrayIterator を変更しても、最初に取得したコピーは変化しません。\n";
54}
55
56// 関数を実行して動作を確認します。
57demonstrateArrayIteratorGetArrayCopy();

PHPのArrayIteratorクラスのgetArrayCopy()メソッドは、イテレータが現在保持している配列の内容を、新しい独立した配列として取得するために使用されます。このメソッドは引数を必要とせず、呼び出された時点のイテレータの状態を反映した新しいarray型を戻り値として返します。

サンプルコードでは、まず元の配列をArrayIteratorとして初期化し、getArrayCopy()を呼び出してこの時点での配列内容のコピー（$firstCopy）を取得しています。

次に、ArrayIteratorのoffsetSetメソッドを使ってイテレータ内部のデータを変更しています。新しい要素の追加や既存要素の更新を行っても、既に取得された$firstCopyには影響がありません。その後、再度getArrayCopy()を呼び出して取得した$secondCopyには、これらの変更が反映された新しい配列が格納されます。

この挙動は、getArrayCopy()が呼び出された時点のイテレータの「スナップショット」を独立した配列として提供するためです。取得されたコピーは元のArrayIteratorとは別物であるため、コピー取得後にイテレータの内容が変更されても、そのコピー自体が自動的に更新されることはありません。これにより、特定の時点の配列状態を確実に保持して扱えるようになります。