<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.strings.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.addcslashes.php',
    1 => 'addcslashes',
    2 => 'Escapa string com barras invertidas no estilo C',
  ),
  'up' => 
  array (
    0 => 'ref.strings.php',
    1 => 'Fun&ccedil;&otilde;es de String',
  ),
  'prev' => 
  array (
    0 => 'ref.strings.php',
    1 => 'Fun&ccedil;&otilde;es de String',
  ),
  'next' => 
  array (
    0 => 'function.addslashes.php',
    1 => 'addslashes',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/strings/functions/addcslashes.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.addcslashes" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">addcslashes</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">addcslashes</span> &mdash; <span class="dc-title">Escapa string com barras invertidas no estilo C</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.addcslashes-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>addcslashes</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$string</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$characters</code></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   Retorna uma string com barras invertidas antes dos caracteres que estão
   listados no parâmetro <code class="parameter">characters</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.addcslashes-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">string</code></dt>
     <dd>
      <p class="para">
       A string a ser escapada.
      </p>
     </dd>
    
    
     <dt><code class="parameter">characters</code></dt>
     <dd>
      <p class="para">
       Uma lista de caracteres a serem escapados. Se
       <code class="parameter">characters</code> contiver caracteres
       <code class="literal">\n</code>, <code class="literal">\r</code> etc., eles serão
       convertidos no estilo da linguagem C, enquanto que outros caracteres não alfanuméricos
       com códigos ASCII menores que 32 e maiores que 126 serão convertidos para
       a representação octal.
      </p>
      <p class="para">
       Ao definir uma sequência de caracteres no argumento <code class="parameter">characters</code>
       certifique-se que são conhecidos todos os caracteres que aparecem entre aqueles
       definidos como o início e o final do intervalo.
       <div class="example" id="example-1">
        <p><strong>Exemplo #1 <span class="function"><strong>addcslashes()</strong></span> com intervalos</strong></p>
        <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">addcslashes</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo[ ]'</span><span style="color: #007700">, </span><span style="color: #DD0000">'A..z'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// saída:  \f\o\o\[ \]<br />// Todas as letras maiúsculas e minúsculas serão escapadas<br />// ... mas também os caracteres [\]^_`<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
        </div>

       </div>
       Adicionamente, se o primeiro caractere em uma sequência possuir um código ASCII maior
       que o segundo caractere na sequência, na verdade nenhum intervalo será
       construído. Apenas os caracteres do início, do final e o caractere &quot;.&quot; serão
       escapados. Use a função <span class="function"><a href="function.ord.php" class="function">ord()</a></span> para encontrar o
       código ASCII de um caractere.
       <div class="example" id="example-2">
        <p><strong>Exemplo #2 <span class="function"><strong>addcslashes()</strong></span> com caracteres na ordem incorreta</strong></p>
        <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">addcslashes</span><span style="color: #007700">(</span><span style="color: #DD0000">"zoo['.']"</span><span style="color: #007700">, </span><span style="color: #DD0000">'z..A'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// saída:  \zoo['\.']<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
        </div>

       </div>
      </p>
      <p class="para">
       Cuidado ao escapar os caracteres 0, a, b, f, n, r, t e
       v. Eles serão convertidos para \0, \a, \b, \f, \n, \r, \t e \v, que são
       sequências de escape predefinidas em C. Muitas dessas sequências são
       também definidas em outras linguagens derivadas do C, incluindo o PHP, o que significa que
       pode não ser obtido o resultado desejado se a saída de
       <span class="function"><strong>addcslashes()</strong></span> for usada para gerar código nessas linguagens
       com estes caracteres definidos no parâmetro <code class="parameter">characters</code>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.addcslashes-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna a string escapada.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.addcslashes-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
    Parâmetro <code class="parameter">characters</code> definido para algo como &quot;\0..\37&quot;, que
    escapa todos os caracteres com código entre 0 e 31 (octal \37).
   <div class="example" id="example-3">
    <p><strong>Exemplo #3 Exemplo de <span class="function"><strong>addcslashes()</strong></span></strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$not_escaped </span><span style="color: #007700">= </span><span style="color: #DD0000">"PHP isThirty\nYears Old!\tYay to the Elephant!\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$escaped </span><span style="color: #007700">= </span><span style="color: #0000BB">addcslashes</span><span style="color: #007700">(</span><span style="color: #0000BB">$not_escaped</span><span style="color: #007700">, </span><span style="color: #DD0000">"\0..\37!@\177..\377"</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$escaped</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.addcslashes-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.stripcslashes.php" class="function" rel="rdfs-seeAlso">stripcslashes()</a> - Remove o escape de strings escapadas com addcslashes</span></li>
    <li><span class="function"><a href="function.stripslashes.php" class="function" rel="rdfs-seeAlso">stripslashes()</a> - Desfaz os escapes de uma string escapada</span></li>
    <li><span class="function"><a href="function.addslashes.php" class="function" rel="rdfs-seeAlso">addslashes()</a> - Adiciona barras invertidas a uma string</span></li>
    <li><span class="function"><a href="function.htmlspecialchars.php" class="function" rel="rdfs-seeAlso">htmlspecialchars()</a> - Converte caracteres especiais para entidades HTML</span></li>
    <li><span class="function"><a href="function.quotemeta.php" class="function" rel="rdfs-seeAlso">quotemeta()</a> - Escapa meta caracteres</span></li>
   </ul>
  </p>
 </div>


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