stream-get-contents.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 8f0d3cbca16a0655d88c9dc2c9c5ac486e9ae020 Maintainer: jpauli Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.stream-get-contents" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>stream_get_contents</refname> 
  <refpurpose>Lit tout un flux dans une chaîne</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>stream_get_contents</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>length</parameter><initializer>&null;</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>-1</initializer></methodparam>
  </methodsynopsis>
  <para> 
   <function>stream_get_contents</function> est identique à 
   <function>file_get_contents</function>, sauf qu'elle opère sur
   un pointeur de fichier déjà ouvert et retourne le contenu restant, allant jusqu'à
   <parameter>length</parameter> octets, dans une chaîne et commençant à la position
   <parameter>offset</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter> (<type>resource</type>)</term>
     <listitem>
      <para>
       Une &resource; de flux (e.g. retournée par la fonction <function>fopen</function>)
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter> (&integer;)</term>
     <listitem>
      <para>
       Le nombre maximal d'octets à lire. Par défaut, &null; 
       (lit tout le contenu restant du buffer).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter> (&integer;)</term>
     <listitem>
      <para>
       Se déplace à la position spécifiée avant la lecture. Si le nombre
       passé est négatif, aucun déplacement ne sera effectué et la lecture
       commencera de la position courante.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une &string;&return.falseforfailure;.
  </para>
 </refsect1>
 
 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>length</parameter> est désormais nullable.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
  <example>
   <title>Exemple avec <function>stream_get_contents</function></title>
   <programlisting role="php">
<![CDATA[
<?php

if ($stream = fopen('http://www.example.com', 'r')) {
    // affiche toute la page, en commençant à la position 10
    echo stream_get_contents($stream, -1, 10);

    fclose($stream);
}


if ($stream = fopen('http://www.exemple.net', 'r')) {
    // Affichage des 5 premiers octets
    echo stream_get_contents($stream, 5);

    fclose($stream);
}

?>
]]>
   </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.bin-safe;

 <note>
   <para>
    Lorsque vous spécifiez une valeur de <parameter>length</parameter> autre que &null;, cette fonction allouera
    immédiatement un tampon interne de cette taille, même si le
    contenu réel est significativement plus court.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fgets</function></member>
    <member><function>fread</function></member>
    <member><function>fpassthru</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->