Files
doc-fr/reference/readline/functions/readline-callback-handler-install.xml
2021-09-24 04:13:47 +01:00

145 lines
3.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 5106807f258ed4b465f89b9faf4375f628e02b98 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.readline-callback-handler-install" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>readline_callback_handler_install</refname>
<refpurpose>Initialise l'interface et le terminal de rappel de readline, affiche le prompt et retourne immédiatement</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>readline_callback_handler_install</methodname>
<methodparam><type>string</type><parameter>prompt</parameter></methodparam>
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
</methodsynopsis>
<para>
Définie une interface de rappel pour readline, affiche le
<parameter>prompt</parameter> et retourne immédiatement.
Appeler cette fonction deux fois sans effacer au préalable l'interface
de rappel précédente effacera automatiquement
et proprement l'ancienne interface.
</para>
<para>
La fonctionnalité de rappel est très utile lorsque combinée
à la fonction <function>stream_select</function> permettant
l'interconnexion IO / entrée utilisateur, à la différence de
<function>readline</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>prompt</parameter></term>
<listitem>
<para>
Le message de prompt.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
<para>
La fonction <parameter>callback</parameter> prend
un paramètre : l'entrée utilisateur retournée.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple d'interface de rappel de Readline</title>
<programlisting role="php">
<![CDATA[
<?php
function rl_callback($ret)
{
global $c, $prompting;
echo "You entered: $ret\n";
$c++;
if ($c > 10) {
$prompting = false;
readline_callback_handler_remove();
} else {
readline_callback_handler_install("[$c] Entrer quelque chose : ", 'rl_callback');
}
}
$c = 1;
$prompting = true;
readline_callback_handler_install("[$c] Entrer quelque chose : ", 'rl_callback');
while ($prompting) {
$w = NULL;
$e = NULL;
$n = stream_select($r = array(STDIN), $w, $e, null);
if ($n && in_array(STDIN, $r)) {
// lit un caractère, appellera la fonction de callback lorsqu'une nouvelle ligne est entrée
readline_callback_read_char();
}
}
echo "Le prompt est désactivé. Tout a été effectué.\n";
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>readline_callback_handler_remove</function></member>
<member><function>readline_callback_read_char</function></member>
<member><function>stream_select</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
-->