PHP 8.4.1 Released!

    stream_wrapper_register

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

    stream_wrapper_register — Enregistre un gestionnaire d'URL

    Description

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

    stream_wrapper_register() permet d'implémenter des gestionnaires de protocole et de flux, à utiliser avec toutes les autres fonctions de fichiers, comme fopen(), fread(), etc.

    Liste de paramètres

    protocol

    Le nom du gestionnaire à enregistrer. Les noms de protocoles valides doivent contenir uniquement des caractères alphanumériques, points (.), plus (+), ou tiret (-).

    class

    La classe qui implémente le protocole protocol.

    flags

    Doit être configuré à STREAM_IS_URL si protocol est un protocole à URL. Par défaut, cette option vaut 0, et est valable pour les flux locaux.

    Valeurs de retour

    Cette fonction retourne true en cas de succès ou false si une erreur survient.

    stream_wrapper_register() retourne false si le protocole protocol a déjà un gestionnaire.

    Exemples

    Exemple #1 Comment enregistrer un gestionnaire de flux

    <?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");
    }

    ?>

    L'exemple ci-dessus va afficher :

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

    Voir aussi

    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