stream_wrapper_register

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

    stream_wrapper_register — Register a URL wrapper implemented as a PHP class

    Опис

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

    Allows you to implement your own protocol handlers and streams for use with all the other filesystem functions (such as fopen(), fread() etc.).

    Параметри

    protocol

    The wrapper name to be registered. Valid protocol names must contain alphanumerics, dots (.), plusses (+), or hyphens (-) only.

    class

    The classname which implements the protocol.

    flags

    Should be set to STREAM_IS_URL if protocol is a URL protocol. Default is 0, local stream.

    Значення, що повертаються

    Повертає true у разі успіху або false в разі помилки.

    stream_wrapper_register() will return false if the protocol already has a handler.

    Приклади

    Приклад #1 How to register a stream wrapper

    <?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
"

    Прогляньте також

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋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.
    ＋add a note
    To Top