<?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 => 'fr',
  ),
  'this' => 
  array (
    0 => 'class.streamwrapper.php',
    1 => 'streamWrapper',
    2 => 'La classe streamWrapper',
  ),
  'up' => 
  array (
    0 => 'book.stream.php',
    1 => 'Flux',
  ),
  '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' => 'fr',
    '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 classe 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">Introduction</h2>
   <p class="para">
    Permet la création de gestionnaires de protocoles et de flux,
    à utiliser avec toutes les fonctions système, telles que 
    <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">Note</strong>: 
    <p class="para">
     Cette classe <em>n&#039;est pas</em> une classe concrète : 
     c&#039;est juste un prototype d&#039;une classe qui définirait son propre
     protocole.
    </p>
   </p></blockquote>
   <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
     Implémenter les méthodes d&#039;une manière qui n&#039;est pas décrite
     dans la documentation peut mener à des comportements indéfinis.
    </p>
   </p></blockquote>
   <p class="para">
    Une instance de cette classe est initialisée aussitôt que 
    les fonctions de flux tentent d&#039;accéder à une ressource avec 
    un protocole.
   </p>
  </div>


  <div class="section" id="streamwrapper.synopsis">
   <h2 class="title">Synopsis de la classe</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">/* Propriétés */</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éthodes */</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">Propriétés</h2>
   <dl>
    
     <dt id="streamwrapper.props.context">resource <var class="varname">context</var></dt>
     <dd>
      <p class="para">
       Le <a href="context.php" class="link">contexte</a> courant, ou <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> 
       si aucun contexte n&#039;a été passé à la fonction.
      </p>
      <p class="para">
       Utiliser la fonction <span class="function"><a href="function.stream-context-get-options.php" class="function">stream_context_get_options()</a></span>
       pour analyser le contexte.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        Cette propriété <em>doit</em> être public, pour
        que PHP puisse la remplir avec la ressource de contexte.
       </p>
      </p></blockquote>
     </dd>
    
   </dl>
  </div>


 <div class="section">
  <h2 class="title">Voir aussi</h2>
  <p class="para">
   <ul class="simplelist">
    <li><a href="stream.streamwrapper.example-1.php" class="xref">Exemple de classe enregistr&eacute;e comme gestionnaire de flux</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>Sommaire</h2><ul class="chunklist chunklist_reference"><li><a href="streamwrapper.construct.php">streamWrapper::__construct</a> — Construit un nouveau gestionnaire de flux</li><li><a href="streamwrapper.destruct.php">streamWrapper::__destruct</a> — D&eacute;truit un gestionnaire de flux existant</li><li><a href="streamwrapper.dir-closedir.php">streamWrapper::dir_closedir</a> — Ferme une ressource de dossier</li><li><a href="streamwrapper.dir-opendir.php">streamWrapper::dir_opendir</a> — Ouvre un dossier en lecture</li><li><a href="streamwrapper.dir-readdir.php">streamWrapper::dir_readdir</a> — Lit un fichier dans un dossier</li><li><a href="streamwrapper.dir-rewinddir.php">streamWrapper::dir_rewinddir</a> — Remet au d&eacute;but une ressource de dossier</li><li><a href="streamwrapper.mkdir.php">streamWrapper::mkdir</a> — Cr&eacute;e un dossier</li><li><a href="streamwrapper.rename.php">streamWrapper::rename</a> — Renomme un fichier ou un dossier</li><li><a href="streamwrapper.rmdir.php">streamWrapper::rmdir</a> — Supprime un dossier</li><li><a href="streamwrapper.stream-cast.php">streamWrapper::stream_cast</a> — Lit la ressource sous-jacente de flux</li><li><a href="streamwrapper.stream-close.php">streamWrapper::stream_close</a> — Ferme une ressource de flux</li><li><a href="streamwrapper.stream-eof.php">streamWrapper::stream_eof</a> — Teste la fin de fichier sur un pointeur de fichier</li><li><a href="streamwrapper.stream-flush.php">streamWrapper::stream_flush</a> — Exp&eacute;die le contenu</li><li><a href="streamwrapper.stream-lock.php">streamWrapper::stream_lock</a> — Verrouillage logique de fichiers</li><li><a href="streamwrapper.stream-metadata.php">streamWrapper::stream_metadata</a> — Change les metadata du flux</li><li><a href="streamwrapper.stream-open.php">streamWrapper::stream_open</a> — Ouvre un fichier ou une URL</li><li><a href="streamwrapper.stream-read.php">streamWrapper::stream_read</a> — Lit dans le flux</li><li><a href="streamwrapper.stream-seek.php">streamWrapper::stream_seek</a> — Place le pointeur de flux &agrave; une position</li><li><a href="streamwrapper.stream-set-option.php">streamWrapper::stream_set_option</a> — Change les options du flux</li><li><a href="streamwrapper.stream-stat.php">streamWrapper::stream_stat</a> — Lit les informations sur une ressource de fichier</li><li><a href="streamwrapper.stream-tell.php">streamWrapper::stream_tell</a> — Lit la position courante dans un flux</li><li><a href="streamwrapper.stream-truncate.php">streamWrapper::stream_truncate</a> — Tronque un flux</li><li><a href="streamwrapper.stream-write.php">streamWrapper::stream_write</a> — &Eacute;crit dans un flux</li><li><a href="streamwrapper.unlink.php">streamWrapper::unlink</a> — Efface un fichier</li><li><a href="streamwrapper.url-stat.php">streamWrapper::url_stat</a> — Lit les informations sur un fichier</li></ul>
</div>
<?php manual_footer($setup); ?>