【PHP8.x】stream_register_wrapper関数の使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * グローバル変数をストリームとして読み込むためのカスタムラッパークラス
7 *
8 * このクラスは 'var://' というカスタムプロトコルを実装します。
9 * 例えば、file_get_contents('var://my_variable') を実行すると、
10 * グローバル変数 $my_variable の内容を文字列として読み込むことができます。
11 */
12class VariableStreamWrapper
13{
14    /** @var resource|null ストリームコンテキスト */
15    public $context;
16
17    /** @var string 読み込むデータの内容 */
18    private string $data;
19
20    /** @var int 現在の読み取り位置 */
21    private int $position;
22
23    /**
24     * ストリームが開かれるときに呼び出されます。
25     *
26     * @param string $path アクセス先のパス (例: "var://my_variable")
27     * @param string $mode アクセスモード (例: 'r', 'w')
28     * @param int $options ストリームオープン時のオプション
29     * @param ?string &$opened_path 実際に開かれたパスを格納するための参照
30     * @return bool 成功した場合に true, 失敗した場合に false
31     */
32    public function stream_open(string $path, string $mode, int $options, ?string &$opened_path): bool
33    {
34        // URLからホスト部分（変数名）を取得します。
35        $variableName = parse_url($path, PHP_URL_HOST);
36
37        // 変数名が取得できない、またはグローバルスコープに存在しない場合は失敗とします。
38        if ($variableName === null || !array_key_exists($variableName, $GLOBALS)) {
39            return false;
40        }
41
42        // 読み込むデータをプロパティにセットします。
43        $this->data = (string) $GLOBALS[$variableName];
44        $this->position = 0;
45
46        return true;
47    }
48
49    /**
50     * ストリームからデータを読み込むときに呼び出されます。
51     *
52     * @param int $count 読み込む最大バイト数
53     * @return string|false 読み込んだデータ、または終端なら空文字列、エラーなら false
54     */
55    public function stream_read(int $count): string|false
56    {
57        // 現在位置から指定バイト数のデータを切り出します。
58        $chunk = substr($this->data, $this->position, $count);
59        // 読み取り位置を進めます。
60        $this->position += strlen($chunk);
61        return $chunk;
62    }
63
64    /**
65     * ストリームの終端に達したかどうかを判定します。
66     *
67     * @return bool 終端に達した場合は true
68     */
69    public function stream_eof(): bool
70    {
71        return $this->position >= strlen($this->data);
72    }
73
74    /**
75     * ストリームのメタ情報（ファイルサイズなど）を取得します。
76     * fstat() 関数の呼び出しに対応します。
77     *
78     * @return array|false メタ情報の配列、または false
79     */
80    public function stream_stat(): array|false
81    {
82        return ['size' => strlen($this->data)];
83    }
84
85    /**
86     * パスのメタ情報を取得します。
87     * file_exists() や filesize() などの呼び出しに対応します。
88     *
89     * @param string $path アクセス先のパス
90     * @param int $flags STREAM_URL_STAT_LINK または STREAM_URL_STAT_QUIET
91     * @return array|false メタ情報の配列、または false
92     */
93    public function url_stat(string $path, int $flags): array|false
94    {
95        $variableName = parse_url($path, PHP_URL_HOST);
96        if ($variableName !== null && array_key_exists($variableName, $GLOBALS)) {
97            return ['size' => strlen((string)$GLOBALS[$variableName])];
98        }
99        return false;
100    }
101}
102
103// --- これより下が実行部分 ---
104
105// ラッパーが読み込むためのグローバル変数を定義
106$message = "Hello, custom stream wrapper!";
107$user_id = 12345;
108
109// 'var' プロトコルに対して VariableStreamWrapper クラスを登録します。
110// これにより、'var://' で始まるパスがこのクラスで処理されるようになります。
111stream_wrapper_register('var', VariableStreamWrapper::class);
112
113echo "--- 'var://message' の読み込み ---\n";
114// file_get_contents でカスタムプロトコルを使用して変数の内容を読み込む
115$content = file_get_contents('var://message');
116echo $content . "\n\n";
117
118echo "--- 'var://user_id' の読み込み ---\n";
119$content = file_get_contents('var://user_id');
120echo $content . "\n\n";
121
122echo "--- file_exists() による存在確認 ---\n";
123// 存在する変数
124var_dump(file_exists('var://message'));
125// 存在しない変数
126var_dump(file_exists('var://undefined_variable'));
127
128// 後片付けとして、登録したラッパーを解除します。
129stream_wrapper_unregister('var');
130
131?>

stream_wrapper_register関数は、PHPに独自のURLプロトコルを追加するための機能です。これにより、http://やfile://のように、自分で定義したプロトコルをfile_get_contents()などのファイル操作関数で扱えるようになります。

この関数の第1引数$protocolには、登録したいプロトコル名（サンプルでは'var'）を文字列で指定します。第2引数$classnameには、そのプロトコルの処理を担当するクラス名（サンプルではVariableStreamWrapper::class）を指定します。関数は、プロトコルの登録に成功するとtrueを、失敗するとfalseを返します。

サンプルコードでは、stream_wrapper_registerによって'var'プロトコルとVariableStreamWrapperクラスを紐づけています。この登録以降、file_get_contents('var://message')のようなコードが実行されると、PHPはファイルシステムにアクセスする代わりにVariableStreamWrapperクラスのメソッドを呼び出します。その結果、ファイルを読むのと同じ操作で、グローバル変数$messageの内容を取得できています。このように、様々なデータソースをファイルと同じように統一的な方法で扱う仕組みを実装できます。