<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.readline.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'uk',
  ),
  'this' => 
  array (
    0 => 'function.readline-callback-handler-install.php',
    1 => 'readline_callback_handler_install',
    2 => 'Initializes the readline callback interface and terminal, prints the prompt and returns immediately',
  ),
  'up' => 
  array (
    0 => 'ref.readline.php',
    1 => 'Readline Функції',
  ),
  'prev' => 
  array (
    0 => 'function.readline-add-history.php',
    1 => 'readline_add_history',
  ),
  'next' => 
  array (
    0 => 'function.readline-callback-handler-remove.php',
    1 => 'readline_callback_handler_remove',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/readline/functions/readline-callback-handler-install.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.readline-callback-handler-install" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">readline_callback_handler_install</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">readline_callback_handler_install</span> &mdash; <span class="dc-title">Initializes the readline callback interface and terminal, prints the prompt and returns immediately</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.readline-callback-handler-install-description">
  <h3 class="title">Опис</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>readline_callback_handler_install</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$prompt</code></span>, <span class="methodparam"><span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>): <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>

  <p class="para rdfs-comment">
   Sets up a readline callback interface then prints
   <code class="parameter">prompt</code> and immediately returns.  
   Calling this function twice without removing the previous
   callback interface will automatically and conveniently overwrite the old
   interface.
  </p>
  <p class="para">
   The callback feature is useful when combined with
   <span class="function"><a href="function.stream-select.php" class="function">stream_select()</a></span> as it allows interleaving of IO and
   user input, unlike <span class="function"><a href="function.readline.php" class="function">readline()</a></span>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.readline-callback-handler-install-parameters">
  <h3 class="title">Параметри</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">prompt</code></dt>
     <dd>
      <p class="para">
       The prompt message.
      </p>
     </dd>
    
    
     <dt><code class="parameter">callback</code></dt>
     <dd>
      <p class="para">
       The <code class="parameter">callback</code> function takes one parameter; the
       user input returned.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.readline-callback-handler-install-returnvalues">
  <h3 class="title">Значення, що повертаються</h3>
  <p class="para">
   Завжди повертає <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>.
  </p>
 </div>

 
 <div class="refsect1 examples" id="refsect1-function.readline-callback-handler-install-examples">
  <h3 class="title">Приклади</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Приклад #1 Readline Callback Interface Example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">rl_callback</span><span style="color: #007700">(</span><span style="color: #0000BB">$ret</span><span style="color: #007700">)<br />{<br />    global </span><span style="color: #0000BB">$c</span><span style="color: #007700">, </span><span style="color: #0000BB">$prompting</span><span style="color: #007700">;<br /><br />    echo </span><span style="color: #DD0000">"You entered: </span><span style="color: #0000BB">$ret</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$c</span><span style="color: #007700">++;<br /><br />    if (</span><span style="color: #0000BB">$c </span><span style="color: #007700">&gt; </span><span style="color: #0000BB">10</span><span style="color: #007700">) {<br />        </span><span style="color: #0000BB">$prompting </span><span style="color: #007700">= </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br />        </span><span style="color: #0000BB">readline_callback_handler_remove</span><span style="color: #007700">();<br />    } else {<br />        </span><span style="color: #0000BB">readline_callback_handler_install</span><span style="color: #007700">(</span><span style="color: #DD0000">"[</span><span style="color: #0000BB">$c</span><span style="color: #DD0000">] Enter something: "</span><span style="color: #007700">, </span><span style="color: #DD0000">'rl_callback'</span><span style="color: #007700">);<br />    }<br />}<br /><br /></span><span style="color: #0000BB">$c </span><span style="color: #007700">= </span><span style="color: #0000BB">1</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$prompting </span><span style="color: #007700">= </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">readline_callback_handler_install</span><span style="color: #007700">(</span><span style="color: #DD0000">"[</span><span style="color: #0000BB">$c</span><span style="color: #DD0000">] Enter something: "</span><span style="color: #007700">, </span><span style="color: #DD0000">'rl_callback'</span><span style="color: #007700">);<br /><br />while (</span><span style="color: #0000BB">$prompting</span><span style="color: #007700">) {<br />    </span><span style="color: #0000BB">$w </span><span style="color: #007700">= </span><span style="color: #0000BB">NULL</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$e </span><span style="color: #007700">= </span><span style="color: #0000BB">NULL</span><span style="color: #007700">;<br />    </span><span style="color: #0000BB">$n </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_select</span><span style="color: #007700">(</span><span style="color: #0000BB">$r </span><span style="color: #007700">= array(</span><span style="color: #0000BB">STDIN</span><span style="color: #007700">), </span><span style="color: #0000BB">$w</span><span style="color: #007700">, </span><span style="color: #0000BB">$e</span><span style="color: #007700">, </span><span style="color: #0000BB">null</span><span style="color: #007700">);<br />    if (</span><span style="color: #0000BB">$n </span><span style="color: #007700">&amp;&amp; </span><span style="color: #0000BB">in_array</span><span style="color: #007700">(</span><span style="color: #0000BB">STDIN</span><span style="color: #007700">, </span><span style="color: #0000BB">$r</span><span style="color: #007700">)) {<br />        </span><span style="color: #FF8000">// read a character, will call the callback when a newline is entered<br />        </span><span style="color: #0000BB">readline_callback_read_char</span><span style="color: #007700">();<br />    }<br />}<br /><br />echo </span><span style="color: #DD0000">"Prompting disabled. All done.\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.readline-callback-handler-install-seealso">
  <h3 class="title">Прогляньте також</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.readline-callback-handler-remove.php" class="function" rel="rdfs-seeAlso">readline_callback_handler_remove()</a> - Removes a previously installed callback handler and restores terminal settings</span></li>
    <li><span class="function"><a href="function.readline-callback-read-char.php" class="function" rel="rdfs-seeAlso">readline_callback_read_char()</a> - Reads a character and informs the readline callback interface when a line is received</span></li>
    <li><span class="function"><a href="function.stream-select.php" class="function" rel="rdfs-seeAlso">stream_select()</a> - Runs the equivalent of the select() system call on the given
   arrays of streams with a timeout specified by seconds and microseconds</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>