(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)
stream_wrapper_register — Registra un gestor de URL
stream_wrapper_register() permite implementar gestores de protocolo y flujo, para ser utilizados con todas las otras funciones de ficheros, como fopen() , fread() , etc.
protocolEl nombre del gestor a registrar. Los nombres de protocolo válidos deben contener únicamente caracteres alfanuméricos, puntos (.), más (+) o guiones (-).
class
La clase que implementa el protocolo protocol.
flags
Debe ser configurado a STREAM_IS_URL si
protocol es un protocolo de URL. Por omisión,
esta opción vale 0, y es válida para flujos locales.
Esta función retorna true en caso de éxito o false si ocurre un error.
stream_wrapper_register() retorna false si
el protocolo protocol ya tiene un gestor.
Ejemplo #1 Cómo registrar un gestor de flujo
<?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");
}
?>El ejemplo anterior mostrará:
line1 line2 line3 string(18) "line1 line2 line3 "
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!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.