<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.readline.php',
    1 => 'readline',
    2 => 'L&ecirc; uma linha',
  ),
  'up' => 
  array (
    0 => 'ref.readline.php',
    1 => 'Fun&ccedil;&otilde;es da extens&atilde;o Readline',
  ),
  'prev' => 
  array (
    0 => 'ref.readline.php',
    1 => 'Fun&ccedil;&otilde;es da extens&atilde;o Readline',
  ),
  'next' => 
  array (
    0 => 'function.readline-add-history.php',
    1 => 'readline_add_history',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/readline/functions/readline.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.readline" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">readline</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">readline</span> &mdash; <span class="dc-title">Lê uma linha</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.readline-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>readline</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$prompt</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   Lê uma única linha do usuário. Esta linha precisa ser adicionada manualmente
   ao histórico usando <span class="function"><a href="function.readline-add-history.php" class="function">readline_add_history()</a></span>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.readline-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">prompt</code></dt>
    <dd>
     <span class="simpara">
      Pode-se especificar uma string que será o prompt para o usuário.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.readline-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="simpara">
   Retorna uma string do usuário. A linha retornada tem o caractere de
   nova linha removido do final.
   Se não houver mais dados para ler, então <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> é retornado.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.readline-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 <span class="function"><strong>readline()</strong></span></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: #FF8000">// Obtém três comandos do usuário<br /></span><span style="color: #007700">for (</span><span style="color: #0000BB">$i</span><span style="color: #007700">=</span><span style="color: #0000BB">0</span><span style="color: #007700">; </span><span style="color: #0000BB">$i </span><span style="color: #007700">&lt; </span><span style="color: #0000BB">3</span><span style="color: #007700">; </span><span style="color: #0000BB">$i</span><span style="color: #007700">++) {<br />        </span><span style="color: #0000BB">$line </span><span style="color: #007700">= </span><span style="color: #0000BB">readline</span><span style="color: #007700">(</span><span style="color: #DD0000">"Command: "</span><span style="color: #007700">);<br />        </span><span style="color: #0000BB">readline_add_history</span><span style="color: #007700">(</span><span style="color: #0000BB">$line</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">// Mostra o histórico<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">readline_list_history</span><span style="color: #007700">());<br /><br /></span><span style="color: #FF8000">// Mostra as variáveis<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">readline_info</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


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