<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.ldap-exop.php',
    1 => 'ldap_exop',
    2 => 'Realiza uma opera&ccedil;&atilde;o estendida',
  ),
  'up' => 
  array (
    0 => 'ref.ldap.php',
    1 => 'Fun&ccedil;&otilde;es do LDAP',
  ),
  'prev' => 
  array (
    0 => 'function.ldap-escape.php',
    1 => 'ldap_escape',
  ),
  'next' => 
  array (
    0 => 'function.ldap-exop-passwd.php',
    1 => 'ldap_exop_passwd',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/ldap/functions/ldap-exop.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ldap-exop" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ldap_exop</h1>
  <p class="verinfo">(PHP 7 &gt;= 7.2.0, PHP 8)</p><p class="refpurpose"><span class="refname">ldap_exop</span> &mdash; <span class="dc-title">Realiza uma operação estendida</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ldap-exop-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ldap_exop</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.ldap-connection.php" class="type LDAP\Connection">LDAP\Connection</a></span> <code class="parameter">$ldap</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$request_oid</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$request_data</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$controls</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter reference">&$response_data</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter reference">&$response_oid</code><span class="initializer"> = ?</span></span><br>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>

  <p class="para rdfs-comment">
   Realiza uma operação estendida no <code class="parameter">ldap</code> especificado com
   o OID da operação em <code class="parameter">request_oid</code> e os dados em
   <code class="parameter">request_data</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ldap-exop-parameters">
  <h3 class="title">Parâmetros</h3>
  <dl>
   
    <dt><code class="parameter">ldap</code></dt>
    <dd>
     <p class="para">
      Uma instância de <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span>, retornada por <span class="function"><a href="function.ldap-connect.php" class="function">ldap_connect()</a></span>.
     </p>
    </dd>
   
   
    <dt><code class="parameter">request_oid</code></dt>
    <dd>
     <p class="para">
       O OID da requisição de operação estendida. Pode-se usar uma das constantes <strong><code><a href="ldap.constants.php#constant.ldap-exop-start-tls">LDAP_EXOP_START_TLS</a></code></strong>, <strong><code><a href="ldap.constants.php#constant.ldap-exop-modify-passwd">LDAP_EXOP_MODIFY_PASSWD</a></code></strong>, <strong><code><a href="ldap.constants.php#constant.ldap-exop-refresh">LDAP_EXOP_REFRESH</a></code></strong>, <strong><code><a href="ldap.constants.php#constant.ldap-exop-who-am-i">LDAP_EXOP_WHO_AM_I</a></code></strong>, <strong><code><a href="ldap.constants.php#constant.ldap-exop-turn">LDAP_EXOP_TURN</a></code></strong> ou uma string com o OID da operação que deseja-se enviar.
     </p>
    </dd>
   
   
    <dt><code class="parameter">request_data</code></dt>
    <dd>
     <p class="para">
       Os dados da requisição de operação estendida. Pode ser NULL para algumas operações como <strong><code><a href="ldap.constants.php#constant.ldap-exop-who-am-i">LDAP_EXOP_WHO_AM_I</a></code></strong>, e pode ser necessário ser codificado com BER.
     </p>
    </dd>
   
   
    <dt><code class="parameter">controls</code></dt>
    <dd>
     <p class="para">
      Array de <a href="ldap.controls.php" class="link">Controles LDAP</a> que são enviados com a requisição.
     </p>
    </dd>
   
   
    <dt><code class="parameter">response_data</code></dt>
    <dd>
     <p class="para">
       Será preenchido com os dados de resposta da operação estendida se fornecido.
       Se não fornecido, pode-se utilizar ldap_parse_exop no objeto de resultado
       mais tarde para obter estes dados.
     </p>
    </dd>
   
   
    <dt><code class="parameter">response_oid</code></dt>
    <dd>
     <p class="para">
       Será preenchido com o OID da resposta se informado, geralmente igual ao OID da requisição.
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ldap-exop-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Quando usado com <code class="parameter">response_data</code>, retorna <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> em caso de sucesso ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de erro.
   Quando usado sem <code class="parameter">response_data</code>, retorna um identificador de resultado ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de erro.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.ldap-exop-changelog">
  <h3 class="title">Registro de Alterações</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Versão</th>
       <th>Descrição</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
 <td>8.1.0</td>
 <td>
  O parâmetro <code class="parameter">ldap</code> agora espera uma instância de <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span>;
  anteriormente, um <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="literal">ldap link</code> válido era esperado.
 </td>
</tr>

      <tr>
       <td>7.3.0</td>
       <td>
        Adicionado suporte para <code class="parameter">controls</code>.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.ldap-exop-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Operação estendida &#039;Whoami&#039;</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$ds </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">);  </span><span style="color: #FF8000">// assumindo que o servidor LDAP é local<br /><br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">$ds</span><span style="color: #007700">) {<br />    </span><span style="color: #FF8000">// faz ligação com dn apropriado para acesso de atualização<br />    </span><span style="color: #0000BB">$bind </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_bind</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #DD0000">"cn=root, o=My Company, c=US"</span><span style="color: #007700">, </span><span style="color: #DD0000">"secret"</span><span style="color: #007700">);<br />    if (!</span><span style="color: #0000BB">$bind</span><span style="color: #007700">) {<br />      echo </span><span style="color: #DD0000">"Não foi possível ligar ao servidor"</span><span style="color: #007700">;<br />      exit;<br />    }<br /><br />    </span><span style="color: #FF8000">// Chama a operação estendida WHOAMI<br />    </span><span style="color: #0000BB">$r </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_exop</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">LDAP_EXOP_WHO_AM_I</span><span style="color: #007700">);<br /><br />    </span><span style="color: #FF8000">// Interpreta o objeto de resultado<br />    </span><span style="color: #0000BB">ldap_parse_exop</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">$r</span><span style="color: #007700">, </span><span style="color: #0000BB">$retdata</span><span style="color: #007700">);<br />    </span><span style="color: #FF8000">// Mostra: string(31) "dn:cn=root, o=My Company, c=US"<br />    </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retdata</span><span style="color: #007700">);<br /><br />    </span><span style="color: #FF8000">// O mesmo usando $response_data parameter<br />    </span><span style="color: #0000BB">$success </span><span style="color: #007700">= </span><span style="color: #0000BB">ldap_exop</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">LDAP_EXOP_WHO_AM_I</span><span style="color: #007700">, </span><span style="color: #0000BB">NULL</span><span style="color: #007700">, </span><span style="color: #0000BB">NULL</span><span style="color: #007700">, </span><span style="color: #0000BB">$retdata</span><span style="color: #007700">, </span><span style="color: #0000BB">$retoid</span><span style="color: #007700">);<br />    if (</span><span style="color: #0000BB">$success</span><span style="color: #007700">) {<br />      </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$retdata</span><span style="color: #007700">);<br />    }<br /><br />    </span><span style="color: #0000BB">ldap_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">);<br />} else {<br />    echo </span><span style="color: #DD0000">"Não foi possível conectar ao servidor LDAP"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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


 <div class="refsect1 seealso" id="refsect1-function.ldap-exop-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.ldap-parse-result.php" class="function" rel="rdfs-seeAlso">ldap_parse_result()</a> - Extrai informa&ccedil;&atilde;o de resultado</span></li>
    <li><span class="function"><a href="function.ldap-parse-exop.php" class="function" rel="rdfs-seeAlso">ldap_parse_exop()</a> - Interpreta o objeto de resultado de uma opera&ccedil;&atilde;o estendida LDAP</span></li>
    <li><span class="function"><a href="function.ldap-exop-whoami.php" class="function" rel="rdfs-seeAlso">ldap_exop_whoami()</a> - Facilitador para opera&ccedil;&atilde;o estendida WHOAMI</span></li>
    <li><span class="function"><a href="function.ldap-exop-refresh.php" class="function" rel="rdfs-seeAlso">ldap_exop_refresh()</a> - Facilitador para opera&ccedil;&atilde;o estendida REFRESH</span></li>
    <li><span class="function"><a href="function.ldap-exop-passwd.php" class="function" rel="rdfs-seeAlso">ldap_exop_passwd()</a> - Facilitador para opera&ccedil;&atilde;o estendida PASSWD</span></li>
   </ul>
  </p>
 </div>



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