readline-callback-handler-install.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 2ab6e3ff1677d26786a443fa370719bfb4eba9cb Maintainer: sammywg Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.readline-callback-handler-install" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>readline_callback_handler_install</refname>
  <refpurpose>Initialisiert das readline-Callback-Interface und das Terminal,
   gibt den Prompt aus und springt direkt zurück</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>true</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>
   Initialisiert ein readline-Callback-Interface, gibt danach den
   <parameter>prompt</parameter> aus und springt direkt zurück. Der doppelte
   Aufruf der Funktion ohne Zurücksetzen des verwendeten Callback-Interfaces
   wird automatisch und in geeigneter Weise das alte Interface überschreiben.
  </para>
  <para>
   Die Callback-Fähigkeiten sind hilfreich, wenn sie mit
   <function>stream_select</function> kombiniert werden, da dies eine
   Verschränkung von IO und Benutzereingaben wie mittels <function>readline</function>
   ermöglicht.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>prompt</parameter></term>
     <listitem>
      <para>
       Die Prompt-Message.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>callback</parameter></term>
     <listitem>
      <para>
       Die <parameter>callback</parameter>-Funktion benötigt einen Parameter;
       die Benutzereingabe wird zurückgegeben.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.true.always;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Readline-Callback-Interface-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php
function rl_callback($ret)
{
    global $c, $prompting;

    echo "Sie haben eingegeben: $ret\n";
    $c++;

    if ($c > 10) {
        $prompting = false;
        readline_callback_handler_remove();
    } else {
        readline_callback_handler_install("[$c] Geben Sie etwas ein: ", 'rl_callback');
    }
}

$c = 1;
$prompting = true;

readline_callback_handler_install("[$c] Geben Sie etwas ein: ", 'rl_callback');

while ($prompting) {
    $w = NULL;
    $e = NULL;
    $n = stream_select($r = array(STDIN), $w, $e, null);
    if ($n && in_array(STDIN, $r)) {
        // Liest das aktuelle Zeichen und ruft die Callbackfunktion auf, wenn ein
        // Newline-Zeichen eingegeben wurde
        readline_callback_read_char();
    }
}

echo "Eingabe deaktiviert. Komplett ausgeführt.\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
-->