<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.ldap.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'ldap.controls.php',
    1 => 'Controles LDAP',
    2 => 'Controles LDAP',
  ),
  'up' => 
  array (
    0 => 'book.ldap.php',
    1 => 'LDAP',
  ),
  'prev' => 
  array (
    0 => 'ldap.using.php',
    1 => 'Usando as chamadas LDAP do PHP',
  ),
  'next' => 
  array (
    0 => 'ldap.examples.php',
    1 => 'Exemplos',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/ldap/controls.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="ldap.controls" class="chapter">
 <h1 class="title">Controles LDAP</h1>

 <p class="para">
   Controles são objetos especiais que podem ser enviados junto com uma
   requisição LDAP para alterar o comportamento do servidor LDAP durante a realização
   da requisição. Pode também haver controles enviados pelo servidor
   junto com a resposta para fornecer mais informação, normalmente
   para responder a um objeto de controle da requisição.
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="para">
    Nem todos os controles são suportados por todos os servidores LDAP. Para saber quais controles
    são suportados por um servidor, é necessário consultar o DSE raiz lendo-se um
    DN vazio com o filtro (objectClass=*).
   </p>
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Testando suporte ao controle de resultados paginados</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// $ds é um identificador válido de ligação a um servidor de diretório<br /><br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_read</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #DD0000">''</span><span style="color: #007700">, </span><span style="color: #DD0000">'(objectClass=*)'</span><span style="color: #007700">, [</span><span style="color: #DD0000">'supportedControl'</span><span style="color: #007700">]);<br />if (!</span><span style="color: #0000BB">in_array</span><span style="color: #007700">(</span><span style="color: #0000BB">LDAP_CONTROL_PAGEDRESULTS</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">$result</span><span style="color: #007700">)[</span><span style="color: #0000BB">0</span><span style="color: #007700">][</span><span style="color: #DD0000">'supportedcontrol'</span><span style="color: #007700">])) {<br />  die(</span><span style="color: #DD0000">"Este servidor não suporte controle de resultados paginados."</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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

 <p class="para">
   A partir do PHP 7.3, pode-se enviar controle com a requisição em todas
   as funções de requisição usando o parâmetro <code class="parameter">controls</code>. Quando uma versão
   &quot;ext&quot; de uma função existir, deve-se usá-la se for desejado
   acessar o objeto de resposta completa e ser capaz de analisar
   controles de resposta a partir dele usando <span class="function"><a href="function.ldap-parse-result.php" class="function">ldap_parse_result()</a></span>.
 </p>

 <p class="para">
   <code class="parameter">controls</code> deve ser um array contendo um array para cada controle a enviar,
   contendo as seguintes chaves:
   <dl>
    
     <dt>
      oid
      (<span class="type"><a href="language.types.string.php" class="type string">string</a></span>)
     </dt>
     <dd>
      <span class="simpara">
       O OID do controle. Deve-se usar constantes
       LDAP_CONTROL_* para isto. Consulte as <a href="ldap.constants.php" class="link">constantes LDAP</a>.
      </span>
     </dd>
    
    
     <dt>
      iscritical
      (<span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>)
     </dt>
     <dd>
      <span class="simpara">
       Se um controle for observado como crítico, a requisição falhará se o
       constrole não for suportado pelo servidor, ou se houver falha em sua
       aplicação. Observe que alguns controles devem ser sempre marcados como críticos
       como citado na RFC que os introduz. O padrão é <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
      </span>
     </dd>
    
    
     <dt>
      value
      (<span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span>)
     </dt>
     <dd>
      <span class="simpara">
       Se aplicável, o valor do controle. Leia a seguir para mais informação.
      </span>
     </dd>
    
   </dl>

 </p>

 <p class="para">
   A maior parte dos valores de controle são enviados ao servidor com codificação BER.
   O usuário pode aplicar a codificação BER por conta própria, ou pode-se
   passar um array com as chaves corretas de forma que a codificação é
   feita automaticamente.
   Controles que suportam ser passados como um array são:
  <ul class="itemizedlist">
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-pagedresults">LDAP_CONTROL_PAGEDRESULTS</a></code></strong>
     Chaves esperadas são [size] e [cookie]
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-assert">LDAP_CONTROL_ASSERT</a></code></strong>
     Chave esperada é filter
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-valuesreturnfilter">LDAP_CONTROL_VALUESRETURNFILTER</a></code></strong>
     Chave esperada é filter
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-pre-read">LDAP_CONTROL_PRE_READ</a></code></strong>
     Chave esperada é attrs
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-post-read">LDAP_CONTROL_POST_READ</a></code></strong>
     Chave esperada é attrs
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-sortrequest">LDAP_CONTROL_SORTREQUEST</a></code></strong>
     Espera um array de arrays com chaves attr, [oid], [reverse].
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-vlvrequest">LDAP_CONTROL_VLVREQUEST</a></code></strong>
     Chaves esperadas são before, after, attrvalue|(offset, count), [context]
    </p>
   </li>
  </ul>
 </p>

 <p class="para">
   Os controles a seguir não precisam de nenhum valor:
  <ul class="itemizedlist">
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-passwordpolicyrequest">LDAP_CONTROL_PASSWORDPOLICYREQUEST</a></code></strong>
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-managedsait">LDAP_CONTROL_MANAGEDSAIT</a></code></strong>
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-dontusecopy">LDAP_CONTROL_DONTUSECOPY</a></code></strong>
    </p>
   </li>
  </ul>
 </p>

 <p class="para">
   O controle <strong><code><a href="ldap.constants.php#constant.ldap-control-proxy-authz">LDAP_CONTROL_PROXY_AUTHZ</a></code></strong> é um caso especial
   já que não é esperado que seu valor seja codificado com BER, por usso pode-se usar
   diretamente uma string para seu valor.
 </p>

 <p class="para">
   Quando controles são analisados por <span class="function"><a href="function.ldap-parse-result.php" class="function">ldap_parse_result()</a></span>, valores são
   convertidos em array se suportado.
   Isto é suportado para:
  <ul class="itemizedlist">
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-passwordpolicyresponse">LDAP_CONTROL_PASSWORDPOLICYRESPONSE</a></code></strong>
     Chaves são expire, grace, [error]
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-pagedresults">LDAP_CONTROL_PAGEDRESULTS</a></code></strong>
     Chaves são size, cookie
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-pre-read">LDAP_CONTROL_PRE_READ</a></code></strong>
     Chaves são dn e nomes de atributo LDAP
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-post-read">LDAP_CONTROL_POST_READ</a></code></strong>
     Chaves são dn e nomes de atributo LDAP
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-sortresponse">LDAP_CONTROL_SORTRESPONSE</a></code></strong>
     Chaves são errcode, [attribute]
    </p>
   </li>
   <li class="listitem">
    <p class="para">
     <strong><code><a href="ldap.constants.php#constant.ldap-control-vlvresponse">LDAP_CONTROL_VLVRESPONSE</a></code></strong>
     Chaves são target, count, errcode, context
    </p>
   </li>
  </ul>
 </p>
</div>
<?php manual_footer($setup); ?>