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

Copy
1<?php
2
3/**
4 * DOMDocumentFragment クラスの __sleep メソッドの例
5 *
6 * DOMDocumentFragment はシリアライズされる際に、このメソッドが呼ばれる。
7 * シリアライズ対象から除外したいプロパティを指定できる。
8 *
9 * sleep 関数 (ミリ秒単位でのsleepはサポートされていません) とは異なります。
10 */
11class MyDOMDocumentFragment extends DOMDocumentFragment {
12    private $data;
13
14    public function __construct() {
15        parent::__construct();
16        $this->data = "Sensitive data";
17    }
18
19    public function __sleep(): array
20    {
21        // シリアライズ時に $data プロパティを除外する
22        return []; // シリアライズするプロパティがない場合
23        //return ['otherProperty']; // $otherProperty のみシリアライズする場合
24    }
25
26    public function __wakeup(): void
27    {
28        // デシリアライズ後の処理 (必要に応じて実装)
29        // 例: データベース接続の再確立
30        // $this->data = "Default Value"; // デフォルト値を設定
31    }
32
33    public function setData(string $data): void {
34        $this->data = $data;
35    }
36
37    public function getData(): string {
38        return $this->data;
39    }
40}
41
42// 使用例
43$doc = new DOMDocument();
44$fragment = new MyDOMDocumentFragment();
45$fragment->appendXML('<p>This is a fragment.</p>');
46$fragment->setData("My Secret");
47
48$serialized = serialize($fragment);
49
50$unserialized = unserialize($serialized);
51
52echo "Original Data: " . $fragment->getData() . PHP_EOL; //Original Data: My Secret
53
54if ($unserialized instanceof MyDOMDocumentFragment) {
55  echo "Unserialized Data: " . $unserialized->getData() . PHP_EOL; // Unserialized Data: Sensitive data
56
57  // sleep で data がシリアライズされなかったため、wakeup での処理がないので、コンストラクタで初期化した時の値となる。
58}
59
60// sleep 関数の利用 (ミリ秒単位のsleepは PHP ではサポートされていません)
61// sleep(1); // 1秒間スリープ

PHPのDOMDocumentFragmentクラスにおける__sleepメソッドは、オブジェクトがシリアライズ（文字列化）される際に自動的に呼び出される特別なメソッドです。引数はなく、戻り値もありません。

このメソッドの主な役割は、シリアライズの対象となるプロパティを制御することです。__sleepメソッドは、シリアライズしたいプロパティ名を配列で返します。配列を返すことで、指定されたプロパティのみがシリアライズの対象となり、それ以外のプロパティはシリアライズされません。

サンプルコードでは、MyDOMDocumentFragmentクラスがDOMDocumentFragmentを継承し、__sleepメソッドを実装しています。__sleepメソッドは空の配列を返しているため、どのプロパティもシリアライズされません。private $dataプロパティはシリアライズ対象から除外されます。

また、__wakeupメソッドは、オブジェクトがデシリアライズ（文字列からオブジェクトへ復元）される際に自動的に呼び出される特別なメソッドです。このメソッドを利用することで、デシリアライズ後のオブジェクトに対して初期化処理などを行うことができます。サンプルコードではコメントアウトされていますが、データベース接続の再確立やプロパティの初期化処理などを記述できます。

この例では、シリアライズ時にdataプロパティを除外することで、機密情報を保持したままオブジェクトを安全にシリアライズする、といった使い方が可能です。PHPの組み込み関数であるsleep関数とは異なり、__sleepはオブジェクトのシリアライズ処理に関わるメソッドである点に注意してください。sleep関数はプログラムの実行を指定秒数一時停止させるための関数です。PHPの標準のsleep関数ではミリ秒単位の指定はできません。