<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.stream.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'es',
  ),
  'this' => 
  array (
    0 => 'class.streamwrapper.php',
    1 => 'streamWrapper',
    2 => 'La clase streamWrapper',
  ),
  'up' => 
  array (
    0 => 'book.stream.php',
    1 => 'Flujos',
  ),
  'prev' => 
  array (
    0 => 'php-user-filter.oncreate.php',
    1 => 'php_user_filter::onCreate',
  ),
  'next' => 
  array (
    0 => 'streamwrapper.construct.php',
    1 => 'streamWrapper::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'es',
    'path' => 'reference/stream/streamwrapper.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.streamwrapper.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.streamwrapper" class="reference">

 <h1 class="title">La clase streamWrapper</h1>
 

 <div class="partintro"><p class="verinfo">(PHP 4 &gt;= 4.3.2, PHP 5, PHP 7, PHP 8)</p>

  
  <div class="section" id="streamwrapper.intro">
   <h2 class="title">Introducción</h2>
   <p class="para">
    Permite implementar sus propios gestores de protocolo y flujos para usarlos
    con las demás funciones de sistemas de archivos (como <span class="function"><a href="function.fopen.php" class="function">fopen()</a></span>,
    <span class="function"><a href="function.fread.php" class="function">fread()</a></span> etc.).
   </p>
   <blockquote class="note"><p><strong class="note">Nota</strong>: 
    <p class="para">
     Esta <em>NO</em> es una clase real, sólo es un prototipo de cómo
     debería ser una clase que define su propio protocolo.
    </p>
   </p></blockquote>
   <blockquote class="note"><p><strong class="note">Nota</strong>: 
    <p class="para">
     Implementar los métodos de distinta forma que la descrita aquí puede conducir a
     un comportamiento indefinido.
    </p>
   </p></blockquote>
   <p class="para">
    Una instancia de esta clase se inicializa tan pronto como una función de flujo
    intente acceder al protocolo al que está asociado.
   </p>
  </div>
  

  <div class="section" id="streamwrapper.synopsis">
   <h2 class="title">Sinopsis de la Clase</h2>

   
   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>

    
    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <span class="replaceable">streamWrapper</span>
     </span>
     {</div>
    
    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Propiedades */</div>
    <div class="fieldsynopsis">
     <span class="modifier">public</span>
     <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>
      <var class="varname"><a href="class.streamwrapper.php#streamwrapper.props.context">$<var class="varname">context</var></a></var>;</div>



    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Métodos */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.construct.php" class="methodname">__construct</a></span>()</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.dir-closedir.php" class="methodname">dir_closedir</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.dir-opendir.php" class="methodname">dir_opendir</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$options</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.dir-readdir.php" class="methodname">dir_readdir</a></span>(): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.dir-rewinddir.php" class="methodname">dir_rewinddir</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.mkdir.php" class="methodname">mkdir</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$mode</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$options</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.rename.php" class="methodname">rename</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path_from</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path_to</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.rmdir.php" class="methodname">rmdir</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$options</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-cast.php" class="methodname">stream_cast</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$cast_as</code></span>): <span class="type"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-close.php" class="methodname">stream_close</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-eof.php" class="methodname">stream_eof</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-flush.php" class="methodname">stream_flush</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-lock.php" class="methodname">stream_lock</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$operation</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-metadata.php" class="methodname">stream_metadata</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$option</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-open.php" class="methodname">stream_open</a></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$mode</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$options</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter reference">&$opened_path</code></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-read.php" class="methodname">stream_read</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$count</code></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-seek.php" class="methodname">stream_seek</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$whence</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-set-option.php" class="methodname">stream_set_option</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$option</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$arg1</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$arg2</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-stat.php" class="methodname">stream_stat</a></span>(): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-tell.php" class="methodname">stream_tell</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-truncate.php" class="methodname">stream_truncate</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$new_size</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.stream-write.php" class="methodname">stream_write</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.unlink.php" class="methodname">unlink</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.url-stat.php" class="methodname">url_stat</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$path</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

    <div class="destructorsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="streamwrapper.destruct.php" class="methodname">__destruct</a></span>()</div>

   }</div>
   

  </div>


  
  <div class="section" id="streamwrapper.props">
   <h2 class="title">Propiedades</h2>
   <dl>
    
     <dt id="streamwrapper.props.context">recurso de <var class="varname">context</var></dt>
     <dd>
      <p class="para">
       El <a href="context.php" class="link">contexto</a> actual, o <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> si no
       se pasó ningún contexto a la función que realizó la llamada.
      </p>
      <p class="para">
       Use la función <span class="function"><a href="function.stream-context-get-options.php" class="function">stream_context_get_options()</a></span> para analizar el
       contexto.
      </p>
      <blockquote class="note"><p><strong class="note">Nota</strong>: 
       <p class="para">
        Esta propiedad <em>debe</em> ser pública para que PHP pueda rellenarla
        con el recurso de contexto real.
       </p>
      </p></blockquote>
     </dd>
    
   </dl>
  </div>
  

  <div class="section">
   <h2 class="title">Ver también</h2>
   <p class="para">
    <ul class="simplelist">
     <li><a href="stream.streamwrapper.example-1.php" class="xref">Ejemplo de clase registrada como envoltura de flujo</a></li>
     <li><span class="function"><a href="function.stream-wrapper-register.php" class="function">stream_wrapper_register()</a></span></li>
     <li><span class="function"><a href="function.stream-wrapper-unregister.php" class="function">stream_wrapper_unregister()</a></span></li>
     <li><span class="function"><a href="function.stream-wrapper-restore.php" class="function">stream_wrapper_restore()</a></span></li>
    </ul>
   </p>
  </div>

 </div>

 












































































































































































































<h2>Tabla de contenidos</h2><ul class="chunklist chunklist_reference"><li><a href="streamwrapper.construct.php">streamWrapper::__construct</a> — Construye una nueva envoltura de flujo</li><li><a href="streamwrapper.destruct.php">streamWrapper::__destruct</a> — Destruye una envoltura de flujo existente</li><li><a href="streamwrapper.dir-closedir.php">streamWrapper::dir_closedir</a> — Cerrar un gestor de directorio</li><li><a href="streamwrapper.dir-opendir.php">streamWrapper::dir_opendir</a> — Abrir un gestor de directorio</li><li><a href="streamwrapper.dir-readdir.php">streamWrapper::dir_readdir</a> — Lee un archivo en un directorio</li><li><a href="streamwrapper.dir-rewinddir.php">streamWrapper::dir_rewinddir</a> — Rebobina el gestor de directorio</li><li><a href="streamwrapper.mkdir.php">streamWrapper::mkdir</a> — Crear un directorio</li><li><a href="streamwrapper.rename.php">streamWrapper::rename</a> — Renombra un archivo o directorio</li><li><a href="streamwrapper.rmdir.php">streamWrapper::rmdir</a> — Elimina un directorio</li><li><a href="streamwrapper.stream-cast.php">streamWrapper::stream_cast</a> — Recuperar el recurso subyacente</li><li><a href="streamwrapper.stream-close.php">streamWrapper::stream_close</a> — Cerrar un recurso</li><li><a href="streamwrapper.stream-eof.php">streamWrapper::stream_eof</a> — Comprueba si un puntero a un archivo est&aacute; en el final del archivo (EOF)</li><li><a href="streamwrapper.stream-flush.php">streamWrapper::stream_flush</a> — Vuelca la salida</li><li><a href="streamwrapper.stream-lock.php">streamWrapper::stream_lock</a> — Bloqueo de archivos asesorado</li><li><a href="streamwrapper.stream-metadata.php">streamWrapper::stream_metadata</a> — Cambiar los metadatos del flujo</li><li><a href="streamwrapper.stream-open.php">streamWrapper::stream_open</a> — Abre un archivo o una URL</li><li><a href="streamwrapper.stream-read.php">streamWrapper::stream_read</a> — Lee desde el flujo</li><li><a href="streamwrapper.stream-seek.php">streamWrapper::stream_seek</a> — Coloca el puntero de flujo en una posici&oacute;n</li><li><a href="streamwrapper.stream-set-option.php">streamWrapper::stream_set_option</a> — Cambia las opciones del flujo</li><li><a href="streamwrapper.stream-stat.php">streamWrapper::stream_stat</a> — Recuperar informaci&oacute;n sobre un recurso de archivo</li><li><a href="streamwrapper.stream-tell.php">streamWrapper::stream_tell</a> — Recuperar la posici&oacute;n actual de un flujo</li><li><a href="streamwrapper.stream-truncate.php">streamWrapper::stream_truncate</a> — Truncar un flujo</li><li><a href="streamwrapper.stream-write.php">streamWrapper::stream_write</a> — Escribir en un flujo</li><li><a href="streamwrapper.unlink.php">streamWrapper::unlink</a> — Borrar un archivo</li><li><a href="streamwrapper.url-stat.php">streamWrapper::url_stat</a> — Lee la informaci&oacute;n sobre un fichero</li></ul>
</div>
<?php manual_footer($setup); ?>