readline.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: cef062f45e1ba5691158b591381a9a9efc1e346d Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="function.readline" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>readline</refname>
  <refpurpose>Lit une ligne</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>readline</methodname>
   <methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>prompt</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Retourne une ligne entrée par l'utilisateur.
   Vous devez ajouter cette ligne à l'historique vous-même,
   avec la fonction <function>readline_add_history</function>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>prompt</parameter></term>
     <listitem>
      <para>
       Vous pouvez spécifier une &string; à utiliser comme prompt à
       l'utilisateur.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne une &string; depuis l'utilisateur. La ligne retournée a été
   débarrassée du caractère final de nouvelle ligne.
   S'il n'y a plus de données à lire, alors &false; est retourné.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>readline</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Lit 3 commandes de l'utilisateur
for ($i=0; $i < 3; $i++) {
        $line = readline("Commande : ");
        readline_add_history($line);
}

// Liste l'historique
print_r(readline_list_history());

// Liste les variables
print_r(readline_info());
?>
]]>
    </programlisting>
   </example>
  </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
-->