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

getArrayCopyメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年12月27日

基本的な使い方

getArrayCopyメソッドは、RecursiveArrayIteratorオブジェクトが内部で保持している配列のコピーを、新しい配列として取得するメソッドです。RecursiveArrayIteratorは、多次元配列を含む配列の各要素を順番に処理するために使われるオブジェクトです。このメソッドを呼び出すと、イテレータが対象としている配列の全要素を含む、新しい配列が返されます。重要な点は、返されるのが元の配列への参照ではなく、その内容を完全に複製した独立した配列であるということです。したがって、getArrayCopyメソッドで取得した配列の内容を変更しても、RecursiveArrayIteratorが保持している元の配列データには一切影響がありません。この特性により、イテレーション処理の特定時点での配列の状態をスナップショットとして安全に保存したり、元のデータを破壊することなく配列のコピーを別の処理に引き渡したりすることが可能になります。多次元配列を扱っている場合でも、その構造全体がコピーされます。

構文(syntax)


1<?php
2
3$data = [
4    'fruit' => 'apple',
5    'vegetable' => [
6        'green' => 'spinach',
7        'red' => 'tomato'
8    ]
9];
10
11$iterator = new RecursiveArrayIterator($data);
12
13$arrayCopy = $iterator->getArrayCopy();
14
15var_dump($arrayCopy);

引数(parameters)

引数なし

引数はありません

戻り値(return)

array

RecursiveArrayIterator::getArrayCopy は、現在のイテレータが保持している配列のコピーを返します。このコピーは、現在のイテレータの位置に関わらず、常に元の配列全体を表します。

サンプルコード

PHP RecursiveArrayIteratorで配列コピーを取得する


1<?php
2
3/**
4 * RecursiveArrayIterator::getArrayCopy() メソッドのサンプル
5 *
6 * このメソッドは、RecursiveArrayIterator がラップしている配列のコピーを返します。
7 * 元の配列（またはイテレータが現在指しているサブ配列）と全く同じ内容の新しい配列を生成します。
8 */
9
10// 1. RecursiveArrayIterator の元となる多次元配列を準備します。
11$originalData = [
12    'items' => [
13        'apple' => 100,
14        'banana' => 150,
15        'orange' => 120,
16    ],
17    'category' => 'fruit',
18    'status' => 'available',
19    'details' => [
20        'location' => 'store A',
21        'warehouse' => 'W1',
22    ],
23];
24
25echo "--- 元の配列 ---\n";
26print_r($originalData);
27
28// 2. RecursiveArrayIterator のインスタンスを作成します。
29//    これにより、$originalData 配列を再帰的に反復処理できるようになります。
30$iterator = new RecursiveArrayIterator($originalData);
31
32// 3. getArrayCopy() メソッドを使用して、イテレータが持つ配列のコピーを取得します。
33//    このメソッドは、RecursiveArrayIterator が内部で操作している配列の
34//    「トップレベル」のコピーを新しい配列として返します。
35$copiedArray = $iterator->getArrayCopy();
36
37echo "\n--- getArrayCopy() で取得した配列 ---\n";
38print_r($copiedArray);
39
40// 4. getArrayCopy() は元の配列の「コピー」を返すため、
41//    元の配列とコピーされた配列は異なるオブジェクト（メモリ位置）になります。
42//    しかし、その内容は同じです。
43//    例: $originalData と $copiedArray を厳密に比較すると false になります。
44//    var_dump($originalData === $copiedArray); // 結果: bool(false)
45
46// 5. イテレータがサブ配列を指している場合でも、getArrayCopy() はトップレベルの配列全体を返します。
47//    例えば、$iterator を 'items' のサブ配列に移動させたとしても結果は同じです。
48$subIterator = $iterator->getChildren(); // 'items' サブ配列のイテレータを取得 (このコードではここでは使わないが例として)
49
50echo "\n--- 配列の値の確認 ---\n";
51echo "元の配列の 'category': " . $originalData['category'] . "\n";
52echo "コピーされた配列の 'category': " . $copiedArray['category'] . "\n";
53
54?>

PHPのRecursiveArrayIterator::getArrayCopy()メソッドは、多次元配列を再帰的に操作するRecursiveArrayIteratorオブジェクトが内部で管理している配列の「コピー」を、新しい配列として取得する際に利用します。このメソッドは引数を必要とせず、呼び出すとイテレータが保持する配列全体の複製をarray型として返します。

サンプルコードでは、まず多次元配列$originalDataを用意し、それを元にRecursiveArrayIteratorのインスタンスを作成します。次に$iterator->getArrayCopy()を呼び出すことで、$originalDataと全く同じ内容を持つ、しかしメモリ上では独立した新しい配列$copiedArrayが生成されます。

この「コピー」とは、元の配列とは別の場所に作られた独立したデータであることを意味します。そのため、コピーされた配列の内容を変更しても、元の配列には影響しません。また、RecursiveArrayIteratorが特定のサブ配列を指していても、getArrayCopy()は常にイテレータが最初にラップした「トップレベル」の配列全体をコピーして返します。これにより、イテレータの状態にかかわらず元のデータ全体の構造を安全に取得でき、データの分析や加工を行う際に非常に役立ちます。

このメソッドは、RecursiveArrayIteratorがラップしている元の配列全体のコピーを生成し、新しい配列として返します。イテレータが現在サブ配列を指していても、常にトップレベルの配列全体がコピーされる点にご注意ください。返される配列は、元の配列とは完全に独立したものですので、コピーを修正しても元の配列には影響しません。配列全体を安全に操作したい場合や、イテレータの状態に影響されずに配列の現在のスナップショットが必要な場合に活用できます。

PHP RecursiveArrayIterator getArrayCopy()で配列コピーを取得する


1<?php
2
3/**
4 * RecursiveArrayIterator の getArrayCopy() メソッドの使用例を示します。
5 *
6 * RecursiveArrayIterator は配列を再帰的に走査するためのイテレータです。
7 * getArrayCopy() メソッドは、イテレータが現在保持している配列のコピーを返します。
8 */
9function demonstrateGetArrayCopy(): void
10{
11    // 1. サンプルとなる多次元配列を定義します。
12    $originalData = [
13        'items' => [
14            'fruit' => ['apple', 'banana'],
15            'vegetable' => ['carrot', 'potato'],
16        ],
17        'categories' => ['food', 'drink'],
18        'count' => 3,
19    ];
20
21    echo "--- 元の配列 ---\n";
22    var_dump($originalData);
23
24    // 2. RecursiveArrayIterator をインスタンス化します。
25    //    これにより、$originalData を再帰的に反復処理する準備ができます。
26    $iterator = new RecursiveArrayIterator($originalData);
27
28    // 3. getArrayCopy() メソッドを呼び出し、イテレータが保持する配列のコピーを取得します。
29    //    このメソッドは、イテレータが初期化された時点の配列（またはイテレータ内で変更された配列）
30    //    の完全なコピーを返します。
31    $copiedArray = $iterator->getArrayCopy();
32
33    echo "\n--- getArrayCopy() で取得した配列のコピー ---\n";
34    var_dump($copiedArray);
35
36    // 4. 元の配列とコピーされた配列が別物であることを確認します。
37    //    例えば、元の配列を変更しても、コピーされた配列には影響しません。
38    $originalData['count'] = 10; // 元の配列の要素を変更
39    $originalData['new_item'] = 'test'; // 元の配列に新しい要素を追加
40
41    echo "\n--- 元の配列を変更した後 ---\n";
42    var_dump($originalData);
43
44    echo "\n--- getArrayCopy() で取得した配列のコピー（変更なし） ---\n";
45    var_dump($copiedArray); // $copiedArray は元の変更の影響を受けていないことを確認
46}
47
48// 関数を実行して、getArrayCopy() の動作を確認します。
49demonstrateGetArrayCopy();

PHPのRecursiveArrayIteratorは、多次元配列のような複雑な構造の配列を、あたかも単一のリストのように順番に処理（イテレート）するための便利なクラスです。このクラスを利用すると、配列の奥深くにある要素にも簡単にアクセスできます。

そのRecursiveArrayIteratorクラスに用意されているgetArrayCopy()メソッドは、現在イテレータが内部に保持している配列の「完全なコピー」を取得するために使われます。このメソッドは引数を一切必要とせず、呼び出すだけで現在の配列内容が新しい配列として返されます。戻り値の型はarrayです。

サンプルコードでは、まず多次元配列を定義し、それを元にRecursiveArrayIteratorのインスタンスを作成しています。そして、getArrayCopy()を呼び出すことで、イテレータが初期化された時点の配列と同じ内容を持つ新しい配列が生成され、$copiedArrayに代入されます。

ここで重要なのは、getArrayCopy()が「コピー」を返す点です。これは、元の配列に対して後から変更（要素の追加や値の変更など）を加えても、取得した$copiedArrayにはその変更が一切反映されないことを意味します。つまり、イテレータを初期化した時点の配列の状態を安全に保持したい場合に非常に役立ちます。このメソッドを使うことで、元のデータに影響を与えることなく、その時点のスナップショットとして配列の内容を独立して利用できます。

RecursiveArrayIteratorのgetArrayCopy()メソッドは、イテレータが現在保持している配列の「完全に独立したコピー」を返します。元の配列への参照ではなく、全く新しい配列が生成されるため、メソッド呼び出し後に元の配列の内容を変更しても、取得したコピーには影響しません。この独立性は、サンプルコードの「元の配列を変更した後」の出力で明確に確認できます。主に、イテレータが処理を開始する前の配列の構造や内容を「スナップショット」として保持したい場合に役立ちます。ただし、元の配列が非常に大きい場合、コピーを作成することでメモリ使用量が増加する可能性があるため、その点にご注意ください。