doc-fr/reference/filesystem/functions/fread.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ae5b5761e220b355014d0845e060ea1669befe7a Maintainer: jpauli Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.fread" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>fread</refname>
  <refpurpose>Lecture du fichier en mode binaire</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>fread</methodname>
   <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
   <methodparam><type>int</type><parameter>length</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>fread</function> lit jusqu'à <parameter>length</parameter>
   octets dans le fichier référencé par <parameter>stream</parameter>.
   La lecture s'arrête lorsqu'une des conditions suivantes apparaît :
   <itemizedlist>
    <listitem>
     <simpara>
      <parameter>length</parameter> octets ont été lus
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      la fin du fichier est atteinte
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      un paquet devient disponible ou le temps
      <link linkend="function.socket-set-timeout">
      socket timeout</link> est passé (pour les flux réseau)
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      si le flux est lu depuis le buffer, et qu'il ne représente pas un fichier
      plein, alors au moins une lecture d'un nombre d'octets équivalent à la taille
      du bloc (habituellement 8192) est réalisée ; suivants les données du buffer
      précédent, la taille des données retournées peut être supérieure à la taille
      du bloc.
     </simpara>
    </listitem>
   </itemizedlist>
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>stream</parameter></term>
     <listitem>
      &fs.file.pointer;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>length</parameter></term>
     <listitem>
      <para>
       Taille <parameter>length</parameter> d'octets à lire.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne la chaîne lue, &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>fread</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Lit un fichier, et le place dans une chaîne
$filename = "/usr/local/something.txt";
$handle = fopen($filename, "r");
$contents = fread($handle, filesize($filename));
fclose($handle);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Exemple avec <function>fread</function> et un fichier binaire</title>
    <warning>
     <para>
      Sur les systèmes qui différencient les fichiers
      textes et binaires (i.e. Windows) le fichier doit être
      ouvert avec la lettre 'b' ajoutée au paramètre
      de mode de la fonction <function>fopen</function>.
     </para>
    </warning>
    <programlisting role="php">
<![CDATA[
<?php
$filename = "c:\\files\\somepic.gif";
$handle = fopen($filename, "rb");
$contents = fread($handle, filesize($filename));
fclose($handle);
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
   <example>
    <title>Exemple avec <function>fread</function> et un fichier distant</title>
    <warning>
     <para>
      Lorsque vous lisez depuis n'importe quelle source qui n'est pas un fichier local,
      comme des flux retournés lors de la lecture de
      <link linkend="features.remote-files">fichiers distants</link> ou depuis
      <function>popen</function> et <function>fsockopen</function>, la lecture
      s'arrête après la réception d'un paquet. Il faut donc faire des 
      boucles pour collecter les données par paquet, comme présenté
      ci-dessous.
     </para>
    </warning>
    <programlisting role="php">
<![CDATA[
<?php
$handle = fopen("http://www.example.com/", "rb");
$contents = stream_get_contents($handle);
fclose($handle);
?>
]]>
    </programlisting>
    <programlisting role="php">
<![CDATA[
<?php
$handle = fopen("http://www.example.com/", "rb");
if (FALSE === $handle) {
    exit("Echec lors de l'ouverture du flux vers l'URL");
}

$contents = '';

while (!feof($handle)) {
    $contents .= fread($handle, 8192);
}
fclose($handle);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

<refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    Si vous voulez lire le contenu d'un fichier dans une chaîne de
    caractères, utilisez plutôt <function>file_get_contents</function>
    qui est bien plus rapide que le code ci-dessus.
   </para>
  </note>
  <note>
   <para>
    Noter que la fonction <function>fread</function> lit la position
    courante du pointeur de fichier. Utilisez la fonction
    <function>ftell</function> pour trouver la position courante du pointeur
    et la fonction <function>rewind</function> pour réinitiliaser la position du
    pointeur.
   </para>
  </note>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>fwrite</function></member>
    <member><function>fopen</function></member>
    <member><function>fsockopen</function></member>
    <member><function>popen</function></member>
    <member><function>fgets</function></member>
    <member><function>fgetss</function></member>
    <member><function>fscanf</function></member>
    <member><function>file</function></member>
    <member><function>fpassthru</function></member>
    <member><function>fseek</function></member>
    <member><function>ftell</function></member>
    <member><function>rewind</function></member>
    <member><function>unpack</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
-->