<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ldap.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'uk',
  ),
  'this' => 
  array (
    0 => 'function.ldap-escape.php',
    1 => 'ldap_escape',
    2 => 'Escape a string for use in an LDAP filter or DN',
  ),
  'up' => 
  array (
    0 => 'ref.ldap.php',
    1 => 'Функції LDAP',
  ),
  'prev' => 
  array (
    0 => 'function.ldap-error.php',
    1 => 'ldap_error',
  ),
  'next' => 
  array (
    0 => 'function.ldap-exop.php',
    1 => 'ldap_exop',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ldap/functions/ldap-escape.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ldap-escape" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ldap_escape</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.6.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">ldap_escape</span> &mdash; <span class="dc-title">Escape a string for use in an LDAP filter or DN</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ldap-escape-description">
  <h3 class="title">Опис</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ldap_escape</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$value</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$ignore</code><span class="initializer"> = &quot;&quot;</span></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   Escapes <code class="parameter">value</code> for use in the context implied by
   <code class="parameter">flags</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ldap-escape-parameters">
  <h3 class="title">Параметри</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">value</code></dt>
     <dd>
      <p class="para">
       The value to escape.
      </p>
     </dd>
    
    
     <dt><code class="parameter">ignore</code></dt>
     <dd>
      <p class="para">
       Characters to ignore when escaping.
      </p>
     </dd>
    
    
     <dt><code class="parameter">flags</code></dt>
     <dd>
      <p class="para">
       The context the escaped string will be used in:
       <strong><code><a href="ldap.constants.php#constant.ldap-escape-filter">LDAP_ESCAPE_FILTER</a></code></strong> for filters to be used with
       <span class="function"><a href="function.ldap-search.php" class="function">ldap_search()</a></span>, or
       <strong><code><a href="ldap.constants.php#constant.ldap-escape-dn">LDAP_ESCAPE_DN</a></code></strong> for DNs.
       If neither flag is passed, all chars are escaped.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ldap-escape-returnvalues">
  <h3 class="title">Значення, що повертаються</h3>
  <p class="para">
   Returns the escaped string.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.ldap-escape-examples">
  <h3 class="title">Приклади</h3>
  <p class="para">
   When building an LDAP filter, you should use ldap_escape with LDAP_ESCAPE_FILTER flag.
   <div class="example" id="example-1">
    <p><strong>Приклад #1 Searching for an email address</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">// $ds is a valid LDAP\Connection instance for a directory server<br /><br />// $mail is an email address provided by the user in a form<br /><br /></span><span style="color: #0000BB">$base   </span><span style="color: #007700">= </span><span style="color: #DD0000">"o=My Company, c=US"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$filter </span><span style="color: #007700">= </span><span style="color: #DD0000">"(mail="</span><span style="color: #007700">.</span><span style="color: #0000BB">ldap_escape</span><span style="color: #007700">(</span><span style="color: #0000BB">$mail</span><span style="color: #007700">, </span><span style="color: #DD0000">""</span><span style="color: #007700">, </span><span style="color: #0000BB">LDAP_ESCAPE_FILTER</span><span style="color: #007700">).</span><span style="color: #DD0000">")"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$sr </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_search</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">$base</span><span style="color: #007700">, </span><span style="color: #0000BB">$filter</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"sn"</span><span style="color: #007700">, </span><span style="color: #DD0000">"givenname"</span><span style="color: #007700">, </span><span style="color: #DD0000">"mail"</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">$info </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_get_entries</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">$sr</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">$info</span><span style="color: #007700">[</span><span style="color: #DD0000">"count"</span><span style="color: #007700">].</span><span style="color: #DD0000">" entries returned\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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

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