PHP 8.4.0 RC2 available for testing

stream_wrapper_register

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

stream_wrapper_registerРегистрирует URL-обёртку, которую реализовали как PHP-класс

Описание

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

Функция разрешает реализовать пользовательские обработчики протоколов и потоков для работы с другими функциями, которые работают с файловой системом (например, fopen(), fread() и т. д.).

Список параметров

protocol

Название регистрируемой обёртки. Допустимые имена протоколов должны содержать только буквы, цифры, точки (.), плюсы (+) или дефисы (-).

class

Название класса, который реализует протокол из параметра protocol.

flags

Для параметра требуется установить значение STREAM_IS_URL, если параметр protocol — URL-протокол. Значение по умолчанию равняется 0 — локальный поток.

Возвращаемые значения

Функция возвращает true в случае успешного выполнения или false, если возникла ошибка.

Функция stream_wrapper_register() будет возвращать false, если у протокола protocol уже есть обработчик.

Примеры

Пример #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
"

Смотрите также

add a note

User Contributed Notes 2 notes

up
10
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!
up
2
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.
To Top