stream_wrapper_register

(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)

stream_wrapper_register — PHP のクラスとして実装された URL ラッパーを登録する

説明

stream_wrapper_register(string $protocol, string $class, int $flags = 0): bool

自分で作ったプロトコルハンドラとストリームを実装し、それを fopen() や fread() といったファイルシステムの関数と利用することを可能にします。

パラメータ

protocol: 登録したいラッパー名。有効なプロトコル名には、アルファベットと数値、ドット(.)、プラス文字(+)、ハイフン(-) のみが含まれています。
class: protocol を実装したクラス名。
flags: protocol が URL プロトコルである場合は STREAM_IS_URL を設定しなければなりません。デフォルトは 0 で、ローカルストリームを意味します。

戻り値

成功した場合に true を、失敗した場合に false を返します。

stream_wrapper_register() は、 protocol というハンドラが既にある場合、 false を返します。

例

例1 ストリームラッパーの登録方法

<?php
$existed = in_array("var", stream_get_wrappers());
if ($existed) {
    stream_wrapper_unregister("var");
}
stream_wrapper_register("var", "VariableStream");
$myvar = "";

$fp = fopen("var://myvar", "r+");

fwrite($fp, "line1\n");
fwrite($fp, "line2\n");
fwrite($fp, "line3\n");

rewind($fp);
while (!feof($fp)) {
    echo fgets($fp);
}
fclose($fp);
var_dump($myvar);

if ($existed) {
    stream_wrapper_restore("var");
}

?>

上の例の出力は以下となります。

line1
line2
line3
string(18) "line1
line2
line3
"

参考

streamWrapper プロトタイプクラス
ストリームラッパーとして登録するクラスの例
stream_wrapper_unregister() - URL ラッパーの登録を解除する
stream_wrapper_restore() - 事前に登録を解除された組み込みラッパーを復元する
stream_get_wrappers() - 登録されているストリームのラッパーのリストを取得する

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 2 notes

down

cellog at php dot net ¶

19 years ago

If you plan to use your wrapper in a require_once you need to define stream_stat().  If you plan to allow any other tests like is_file()/is_dir(), you have to define url_stat().

stream_stat() must define the size of the file, or it will never be included.  url_stat() must define mode, or is_file()/is_dir()/is_executable(), and any of those functions affected by clearstatcache() simply won't work.

It's not documented, but directories must be a mode like 040777 (octal), and files a mode like 0100666.  If you wish the file to be executable, use 7s instead of 6s.  The last 3 digits are exactly the same thing as what you pass to chmod.  040000 defines a directory, and 0100000 defines a file.  It would be really helpful to add this to the official manual!

down

jhannus at php dot net ¶

19 years ago

It is worth noting that if your wrapper supports stream_flush() then when you flcose() your stream this function will be called prior to closing the stream.

＋add a note