【PHP8.x】__cloneメソッドの使い方

Copy
1<?php
2
3/**
4 * ネストされたオブジェクトを持つデータクラス。
5 * これがディープコピーの対象となる部分です。
6 */
7class NestedData
8{
9    public string $value;
10
11    public function __construct(string $value)
12    {
13        $this->value = $value;
14    }
15}
16
17/**
18 * オブジェクトのクローンとディープコピーの概念を示すクラス。
19 * PHPのErrorクラスの__cloneメソッドも、内部的にオブジェクトが複製される際に
20 * その状態を適切に初期化するために利用されます（ユーザーが直接制御することはできません）。
21 */
22class MyObjectWithNestedData
23{
24    public string $id;
25    public NestedData $data;
26
27    public function __construct(string $id, NestedData $data)
28    {
29        $this->id = $id;
30        $this->data = $data;
31    }
32
33    /**
34     * PHPのオブジェクトが「clone」キーワードで複製された後に自動的に呼び出されるマジックメソッド。
35     * このメソッド内でネストされたオブジェクトも「clone」することで、ディープコピーを実現します。
36     * もしこのメソッドがなければ、`$this->data` は元のオブジェクトと同じNestedDataインスタンスを参照し、
37     * シャローコピー（浅いコピー）となります。
38     */
39    public function __clone()
40    {
41        // ネストされたオブジェクトをクローンすることで、
42        // オリジナルとクローンされたオブジェクトがそれぞれ独立したNestedDataインスタンスを持つようになる。
43        // これが「ディープコピー」です。
44        $this->data = clone $this->data;
45    }
46}
47
48// 1. オリジナルオブジェクトの作成
49$originalNestedData = new NestedData("オリジナルの詳細データ");
50$originalObject = new MyObjectWithNestedData("OBJ-001", $originalNestedData);
51
52echo "--- オリジナルオブジェクトの状態 ---\n";
53echo "ID: " . $originalObject->id . "\n";
54echo "Data Value: " . $originalObject->data->value . "\n";
55echo "NestedDataオブジェクトID: " . spl_object_id($originalObject->data) . "\n\n";
56
57// 2. オリジナルオブジェクトのクローン
58// この操作により、MyObjectWithNestedData::__clone() メソッドが呼び出され、
59// ネストされたNestedDataオブジェクトもクローンされます（ディープコピー）。
60$clonedObject = clone $originalObject;
61
62echo "--- クローンされたオブジェクトの状態 ---\n";
63echo "ID: " . $clonedObject->id . "\n";
64echo "Data Value: " . $clonedObject->data->value . "\n";
65echo "NestedDataオブジェクトID: " . spl_object_id($clonedObject->data) . "\n\n";
66
67// 3. オリジナルオブジェクトの値を変更
68// ディープコピーが正しく行われていれば、クローンされたオブジェクトには影響しません。
69$originalObject->id = "OBJ-MODIFIED";
70$originalObject->data->value = "変更されたオリジナルデータ";
71
72echo "--- オリジナルオブジェクト変更後の状態 ---\n";
73echo "ID: " . $originalObject->id . "\n";
74echo "Data Value: " . $originalObject->data->value . "\n\n";
75
76echo "--- オリジナル変更後のクローンされたオブジェクトの状態（変化なし）---\n";
77echo "ID: " . $clonedObject->id . "\n"; // id (プリミティブ) はシャローコピーなので、ここではオリジナルの変更が反映されない (参照渡しではないため)
78echo "Data Value: " . $clonedObject->data->value . "\n\n"; // ディープコピーされたため、オリジナル変更の影響を受けない
79
80echo "--- 比較結果 ---\n";
81echo "オリジナルとクローンされたMyObjectWithNestedDataは別のインスタンス: " . (spl_object_id($originalObject) !== spl_object_id($clonedObject) ? "はい" : "いいえ") . "\n";
82echo "オリジナルとクローンされたNestedDataは別のインスタンス（ディープコピー）: " . (spl_object_id($originalObject->data) !== spl_object_id($clonedObject->data) ? "はい" : "いいえ") . "\n";

PHPにおいてオブジェクトを複製する際には、cloneキーワードを使用します。この操作によって、元のオブジェクトのプロパティ値が新しいオブジェクトにコピーされますが、デフォルトでは「シャローコピー（浅いコピー）」が行われます。これは、オブジェクト内に別のオブジェクトがネストされている場合、そのネストされたオブジェクト自体は複製されず、元のオブジェクトと同じインスタンスを参照する状態となることを意味します。

もしネストされたオブジェクトも独立した別のインスタンスとして複製したい場合、「ディープコピー（深いコピー）」が必要となります。これを実現するために、PHPではクラス内に__cloneというマジックメソッドを定義することができます。

__cloneメソッドは、オブジェクトがcloneキーワードによって複製された直後に、自動的に呼び出される特別なメソッドです。このメソッドは引数を受け取らず、戻り値もありません（void）。開発者はこのメソッドの中で、ネストされたオブジェクトも個別にcloneする処理を記述することで、ディープコピーを実現します。

サンプルコードでは、MyObjectWithNestedDataクラスが__cloneメソッドを実装しています。このメソッド内で$this->data = clone $this->data;と記述することで、内部のNestedDataオブジェクトも複製し、originalObjectとclonedObjectがそれぞれ独立したNestedDataインスタンスを持つようにしています。これにより、一方のオブジェクトのdataプロパティを変更しても、もう一方に影響を与えません。

なお、PHPの内部クラスであるErrorクラスにも__cloneメソッドが存在しますが、これはPHPの内部処理でエラーオブジェクトが複製される際に、その状態を適切に初期化するために利用されるものであり、開発者が直接制御するものではありません。

Copy
1<?php
2
3class MyClass
4{
5    public $data;
6
7    public function __construct(array $data)
8    {
9        $this->data = $data;
10    }
11
12    public function __clone()
13    {
14        // deep copy を行う
15        $this->data = unserialize(serialize($this->data));
16    }
17}
18
19$original = new MyClass(['a' => 1, 'b' => ['c' => 2]]);
20$cloned = clone $original;
21
22// 元のオブジェクトを変更
23$original->data['a'] = 3;
24$original->data['b']['c'] = 4;
25
26// cloned オブジェクトは変更されない
27print_r($original->data); // 出力: Array ( [a] => 3 [b] => Array ( [c] => 4 ) )
28print_r($cloned->data);   // 出力: Array ( [a] => 1 [b] => Array ( [c] => 2 ) )
29
30?>

PHP 8における Error クラスの __clone メソッド（クローンマジックメソッド）のサンプルコードについて解説します。このメソッドは、オブジェクトが clone 演算子によって複製される際に自動的に呼び出されます。

サンプルコードでは、MyClass というクラスを定義し、コンストラクタで配列データを $data プロパティに格納しています。__clone メソッドは、この $data プロパティの深いコピー (deep copy) を実現するために実装されています。

通常のオブジェクトの複製（シャローコピー）では、プロパティが参照型（配列やオブジェクトなど）の場合、参照だけがコピーされるため、元のオブジェクトと複製されたオブジェクトが同じデータ領域を共有してしまいます。つまり、一方を変更すると他方も影響を受けます。

__clone メソッド内で unserialize(serialize($this->data)) を実行することで、配列を一旦シリアライズ（文字列に変換）し、再度アンシリアライズ（元の配列に戻す）しています。これにより、新しいメモリ領域に $data プロパティのデータがコピーされ、元のオブジェクトと複製されたオブジェクトは完全に独立したデータを持つようになります。

サンプルコードでは、元のオブジェクト ($original) の $data プロパティを変更していますが、複製されたオブジェクト ($cloned) の $data プロパティは変更されていません。これは、__clone メソッドによって深いコピーが正しく行われたことを示しています。__clone メソッドは引数を持たず、戻り値もありません (void)。オブジェクトの複製処理をカスタマイズするために使用されます。