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

Copy
1<?php
2
3/**
4 * ユーザー定義クラスで __sleep() の動作を確認するサンプル。
5 *
6 * キーワード「php sleep 効か ない」は、通常、実行を一時停止する `sleep()` 関数の問題を指します。
7 * しかし、ここで扱う `__sleep()` は、オブジェクトが `serialize()` される際に
8 * どのプロパティを保存するかを指定するための「マジックメソッド」であり、機能が全く異なります。
9 *
10 * `DOMProcessingInstruction::__sleep()` はPHPの内部実装の一つです。このサンプルでは、
11 * 同じ名前を持つマジックメソッド `__sleep()` が一般的にどのように機能するかをカスタムクラスで示し、
12 * `sleep()` 関数との違いを明確にします。
13 */
14class ConnectionManager
15{
16    // 保存したい設定情報
17    public string $host;
18    public string $user;
19
20    // 保存したくない、一時的なリソース情報
21    // (例: データベース接続ハンドルなど)
22    private $connectionId;
23
24    public function __construct(string $host, string $user)
25    {
26        $this->host = $host;
27        $this->user = $user;
28        $this->connect();
29    }
30
31    // 接続処理を模倣するメソッド
32    public function connect(): void
33    {
34        // 実際にはデータベース接続などを行う
35        $this->connectionId = 'resource#' . random_int(100, 999);
36        echo "接続しました (ID: {$this->connectionId})\n";
37    }
38
39    /**
40     * serialize() が呼び出されたときに自動的に実行されるマジックメソッド。
41     *
42     * このメソッドは、シリアライズ（保存）したいプロパティ名の配列を返す必要があります。
43     * ここで返されなかったプロパティ (`connectionId`) は、シリアライズ結果に含まれなくなります。
44     *
45     * @return array シリアライズするプロパティ名の配列
46     */
47    public function __sleep(): array
48    {
49        echo "__sleep() が呼び出されました。接続リソース ('connectionId') は保存対象から除外します。\n";
50        // 'host' と 'user' のみシリアライズ対象とする
51        return ['host', 'user'];
52    }
53
54    /**
55     * unserialize() が呼び出された後に自動的に実行されるマジックメソッド。
56     *
57     * オブジェクトが復元された後に、データベース接続の再確立など、
58     * 必要な初期化処理をここで行います。
59     */
60    public function __wakeup(): void
61    {
62        echo "__wakeup() が呼び出されました。保存された情報をもとに再接続します。\n";
63        $this->connect();
64    }
65}
66
67// (1) ConnectionManager クラスのインスタンスを作成
68echo "--- オブジェクト生成 ---\n";
69$manager = new ConnectionManager('localhost', 'db_user');
70print_r($manager);
71echo "\n";
72
73// (2) オブジェクトをシリアライズする
74// このとき、ConnectionManager::__sleep() が呼び出される
75echo "--- シリアライズ実行 ---\n";
76$serializedManager = serialize($manager);
77echo "シリアライズ結果: " . $serializedManager . "\n\n";
78
79// (3) シリアライズされた文字列からオブジェクトを復元する
80// このとき、ConnectionManager::__wakeup() が呼び出される
81echo "--- デシリアライズ実行 ---\n";
82$unserializedManager = unserialize($serializedManager);
83print_r($unserializedManager);
84
85?>

このサンプルコードは、PHPの__sleep()メソッドの動作を解説するものです。検索キーワード「php sleep 効か ない」で指されることが多い、プログラムの実行を一時停止するsleep()関数とは全く異なる機能を持つ「マジックメソッド」ですので注意が必要です。

__sleep()メソッドは、serialize()関数によってオブジェクトが文字列へ変換（シリアライズ）される際に自動的に呼び出されます。このメソッドは引数を取りません。戻り値として、シリアライズして保存したいプロパティの名前を要素に持つ配列を返す必要があります。

サンプルコードのConnectionManagerクラスでは、__sleep()メソッドが['host', 'user']という配列を返しています。これにより、データベース接続IDのような一時的な情報を持つconnectionIdプロパティは保存対象から除外され、必要な設定情報だけがシリアライズされます。このように__sleep()を使うことで、オブジェクトを保存する際に、どのデータを残すかを正確に制御できます。対になる__wakeup()メソッドと組み合わせることで、オブジェクトの復元時に再接続などの初期化処理も行えます。

Copy
1<?php
2
3/**
4 * 指定されたミリ秒だけプログラムの実行を待機させるサンプルです。
5 *
6 * PHPの sleep() 関数は秒単位ですが、usleep() 関数を使うと
7 * マイクロ秒単位（1秒 = 1,000,000マイクロ秒）でより細かく制御できます。
8 * 1ミリ秒は1000マイクロ秒です。
9 */
10function waitMilliseconds(int $milliseconds): void
11{
12    // 開始時刻を記録します
13    $startTime = microtime(true);
14    echo date('H:i:s') . " - 処理を開始します。\n";
15
16    // 待機する時間をミリ秒からマイクロ秒に変換します
17    $microseconds = $milliseconds * 1000;
18    
19    echo "{$milliseconds}ミリ秒、待機します...\n";
20    
21    // プログラムの実行を指定されたマイクロ秒だけ一時停止します
22    usleep($microseconds);
23    
24    // 終了時刻を記録します
25    $endTime = microtime(true);
26    echo date('H:i:s') . " - 処理を再開しました。\n";
27
28    // 実際に経過した時間を計算して表示します
29    $elapsedTime = ($endTime - $startTime) * 1000; // ミリ秒に変換
30    echo "実際の経過時間: " . round($elapsedTime, 2) . "ミリ秒\n\n";
31}
32
33// 500ミリ秒 (0.5秒) 待機する例
34waitMilliseconds(500);
35
36// 1500ミリ秒 (1.5秒) 待機する例
37waitMilliseconds(1500);
38
39?>

このサンプルコードは、PHPプログラムの実行をミリ秒単位で指定した時間だけ一時停止する方法を示しています。

PHPには標準で sleep() という関数がありますが、引数に秒単位の整数しか指定できません。より短い時間、例えば0.5秒（500ミリ秒）だけ処理を中断させたい場合には、マイクロ秒単位で時間を指定できる usleep() 関数を利用します。

usleep() 関数は、引数にマイクロ秒（1秒の100万分の1）単位の整数値を取り、その時間だけプログラムの実行を停止します。1ミリ秒は1000マイクロ秒に相当するため、ミリ秒で待機させるには、指定したいミリ秒の値を1000倍して usleep() 関数に渡します。

このコードで定義されている waitMilliseconds 関数は、引数として受け取ったミリ秒をマイクロ秒に変換し、usleep() を呼び出すことで、より精密な時間制御を実現しています。実行前後で時刻を表示することで、実際に指定した時間だけ処理が停止していることを確認できます。