stream_wrapper_register

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

stream_wrapper_register — Registra un gestor de URL

Descripción

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

stream_wrapper_register() permite implementar gestores de protocolo y flujo, para ser utilizados con todas las otras funciones de ficheros, como fopen(), fread(), etc.

Parámetros

protocol: El 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.

Valores devueltos

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.

Ejemplos

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
"

Ver también

El prototipo de clase streamWrapper
Ejemplo de clase registrada como envoltura de flujo
stream_wrapper_unregister() - Deja de registrar una envoltura de URL
stream_wrapper_restore() - Restablece una envoltura incluida que se dejó de registrar previamente
stream_get_wrappers() - Lista los gestores de flujo