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

Copy
1<?php
2
3/**
4 * 'var://' プロトコルを処理するためのカスタムストリームラッパークラス
5 *
6 * このラッパーは、グローバル変数をファイルのように読み書きできるようにします。
7 * 例:
8 * - file_get_contents('var://my_variable') : $my_variable の値を読み取る
9 * - file_put_contents('var://my_variable', 'new value') : $my_variable に値を書き込む
10 */
11class VariableStreamWrapper
12{
13    /** @var resource|null コンテキストリソース */
14    public $context;
15
16    /** @var int 現在の読み取り/書き込み位置 */
17    private int $position = 0;
18
19    /** @var string 変数の内容を保持するバッファ */
20    private string $content = '';
21
22    /** @var string アクセス対象の変数名 */
23    private string $variableName;
24
25    /**
26     * ストリームを開く際に呼び出される
27     *
28     * @param string $path アクセス先のパス (例: 'var://my_variable')
29     * @param string $mode アクセスモード (例: 'r', 'w')
30     * @param int $options オプションフラグ
31     * @param string|null $opened_path 実際に開いたパスを格納する変数
32     * @return bool 成功した場合に true
33     */
34    public function stream_open(string $path, string $mode, int $options, ?string &$opened_path): bool
35    {
36        // URLからホスト部分（=変数名）を取得
37        $url = parse_url($path);
38        if (!isset($url['host']) || empty($url['host'])) {
39            return false;
40        }
41        $this->variableName = $url['host'];
42
43        // 読み取りモードの場合、グローバル変数から内容を読み込む
44        // 変数が存在しない場合は空文字列として扱う
45        if (str_contains($mode, 'r') || str_contains($mode, '+')) {
46            $this->content = (string)($GLOBALS[$this->variableName] ?? '');
47        }
48
49        $this->position = 0;
50        return true;
51    }
52
53    /**
54     * ストリームからデータを読み取る際に呼び出される
55     *
56     * @param int $count 読み取る最大バイト数
57     * @return string|false 読み取ったデータ、終端で空文字列、エラー時に false
58     */
59    public function stream_read(int $count): string|false
60    {
61        $data = substr($this->content, $this->position, $count);
62        $this->position += strlen($data);
63        return $data;
64    }
65
66    /**
67     * ストリームにデータを書き込む際に呼び出される
68     *
69     * @param string $data 書き込むデータ
70     * @return int 書き込んだバイト数
71     */
72    public function stream_write(string $data): int
73    {
74        // バッファの内容を新しいデータで上書きする (wモードの単純な実装)
75        $this->content = substr_replace($this->content, $data, $this->position);
76        $this->position += strlen($data);
77        return strlen($data);
78    }
79
80    /**
81     * ストリームを閉じる際に呼び出される
82     * 書き込みモードで開かれていた場合、バッファの内容をグローバル変数に反映させる
83     */
84    public function stream_close(): void
85    {
86        $GLOBALS[$this->variableName] = $this->content;
87    }
88
89    /**
90     * ストリームの終端に達したかどうかを判定する際に呼び出される
91     *
92     * @return bool 終端に達していれば true
93     */
94    public function stream_eof(): bool
95    {
96        return $this->position >= strlen($this->content);
97    }
98
99    /**
100     * ファイルの情報を取得する際に呼び出される (例: file_exists())
101     *
102     * @param string $path ファイルパス
103     * @param int $flags フラグ
104     * @return array|false ファイル情報の配列、または失敗時に false
105     */
106    public function url_stat(string $path, int $flags): array|false
107    {
108        $url = parse_url($path);
109        if (!isset($url['host']) || !array_key_exists($url['host'], $GLOBALS)) {
110            // 変数が存在しない場合は false を返す
111            return false;
112        }
113
114        // stat() 関数の戻り値に似た形式で、基本的な情報を返す
115        $content = (string)$GLOBALS[$url['host']];
116        return [
117            'size' => strlen($content),
118            'mode' => 0100644, // 通常のファイル、読み書き可能
119            'mtime' => time(),
120            'atime' => time(),
121            'ctime' => time(),
122        ];
123    }
124}
125
126// --- ここからが実行サンプル ---
127
128// 操作対象のグローバル変数を定義
129$myAppData = 'Initial Value';
130
131// 作成したラッパークラスを 'var' というプロトコル名で登録する
132// これにより 'var://' で始まるパスが VariableStreamWrapper で処理されるようになる
133stream_wrapper_register('var', VariableStreamWrapper::class);
134
135echo "--- 操作前の状態 ---" . PHP_EOL;
136echo '$myAppData の値: ' . $myAppData . PHP_EOL;
137echo PHP_EOL;
138
139// 'var://' プロトコルを使って、ファイルのようにグローバル変数に書き込む
140echo "--- file_put_contents('var://myAppData', ...) を実行 ---" . PHP_EOL;
141file_put_contents('var://myAppData', 'Hello from Custom Stream Wrapper!');
142echo '$myAppData の値: ' . $myAppData . PHP_EOL;
143echo PHP_EOL;
144
145// 'var://' プロトコルを使って、ファイルのようにグローバル変数から読み込む
146echo "--- file_get_contents('var://myAppData') を実行 ---" . PHP_EOL;
147$content = file_get_contents('var://myAppData');
148echo '読み込んだ値: ' . $content . PHP_EOL;
149echo PHP_EOL;
150
151// file_exists() で変数の存在を確認する
152echo "--- file_exists() で存在確認 ---" . PHP_EOL;
153echo "file_exists('var://myAppData'): " . (file_exists('var://myAppData') ? 'true' : 'false') . PHP_EOL;
154echo "file_exists('var://nonExistentVar'): " . (file_exists('var://nonExistentVar') ? 'true' : 'false') . PHP_EOL;
155
156// 登録したラッパーを解除（必須ではないが、後片付けとして推奨される）
157stream_wrapper_unregister('var');
158
159?>

stream_wrapper_register関数は、ユーザーが独自に定義したプロトコルをPHPに登録し、ファイル操作関数で利用できるようにするための関数です。これにより、例えばデータベースやAPI、変数などを、あたかもファイルであるかのように扱うことが可能になります。

第1引数$protocolには、登録したいプロトコル名を文字列で指定します。サンプルコードでは'var'がこれにあたり、以降var://で始まるパスが特別に処理されます。第2引数$classには、そのプロトコルの具体的な振る舞いを実装したクラス名を指定します。このクラスには、ファイルの読み書きなどの処理をメソッドとして定義しておく必要があります。第3引数$flagsは、ラッパーの動作を調整するオプションですが、通常は省略可能です。

この関数は、登録が成功した場合はtrueを、失敗した場合はfalseを返します。

サンプルコードでは、'var'というプロトコルをVariableStreamWrapperクラスに結びつけています。この登録によって、file_put_contents('var://myAppData', ...)のような一般的なファイル書き込み関数が、実際にはグローバル変数$myAppDataの値を更新する、という独自の動作を実現しています。