<?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 => 'de',
  ),
  'this' => 
  array (
    0 => 'function.ldap-exop.php',
    1 => 'ldap_exop',
    2 => 'Performs an extended operation',
  ),
  'up' => 
  array (
    0 => 'ref.ldap.php',
    1 => 'LDAP Funktionen',
  ),
  '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' => 'en',
    '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">Performs an extended operation</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ldap-exop-description">
  <h3 class="title">Beschreibung</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">function</span> <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="simpara">
   Performs an extended operation on the specified <code class="parameter">ldap</code> with
   <code class="parameter">request_oid</code> the <abbr>OID</abbr> of the operation and
   <code class="parameter">request_data</code> the data.
  </p>
  <div class="warning"><strong class="warning">Warnung</strong>
   <p class="simpara">
    Using more than 4 parameters has been deprecated,
    use <span class="function"><a href="function.ldap-exop-sync.php" class="function">ldap_exop_sync()</a></span> instead.
   </p>
  </div>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ldap-exop-parameters">
  <h3 class="title">Parameter-Liste</h3>
  <dl>
   
    <dt><code class="parameter">ldap</code></dt>
    <dd>
     <span class="simpara">
      Eine <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span>Instanz, die von  <span class="function"><a href="function.ldap-connect.php" class="function">ldap_connect()</a></span> zurückgegeben wurde.
     </span>
    </dd>
   
   
    <dt><code class="parameter">request_oid</code></dt>
    <dd>
     <span class="simpara">
      The extended operation request <abbr>OID</abbr>.
      Can be one of the
      <strong><code><a href="ldap.constants.php#constant.ldap-exop-start-tls">LDAP_EXOP_<span class="replaceable">*</span></a></code></strong>
      constants,
      or a string with the <abbr>OID</abbr> of the operation.
     </span>
    </dd>
   
   
    <dt><code class="parameter">request_data</code></dt>
    <dd>
     <span class="simpara">
       The extended operation request data. May be NULL for some operations like
      <strong><code><a href="ldap.constants.php#constant.ldap-exop-who-am-i">LDAP_EXOP_WHO_AM_I</a></code></strong>, may also need to be <abbr>BER</abbr> encoded.
     </span>
    </dd>
   
   
    <dt><code class="parameter">controls</code></dt>
    <dd>
     <span class="simpara">
      Array of <a href="ldap.controls.php" class="link">LDAP Controls</a> to send with the request.
     </span>
    </dd>
   
   
    <dt><code class="parameter">response_data</code></dt>
    <dd>
     <span class="simpara">
      Will be filled with the extended operation response data if provided.
      If not provided <span class="function"><a href="function.ldap-parse-exop.php" class="function">ldap_parse_exop()</a></span> may be used on the
      result object later to get this data.
     </span>
    </dd>
   
   
    <dt><code class="parameter">response_oid</code></dt>
    <dd>
     <span class="simpara">
      Will be filled with the response <abbr>OID</abbr> if provided,
      usually equal to the request <abbr>OID</abbr>.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ldap-exop-returnvalues">
  <h3 class="title">Rückgabewerte</h3>
  <p class="simpara">
   When used with <code class="parameter">response_data</code>, returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on error.
   When used without <code class="parameter">response_data</code>, returns a result identifier or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on error.
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.ldap-exop-changelog">
  <h3 class="title">Changelog</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>Version</th>
      <th>Beschreibung</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.4.0</td>
      <td>
       Using more than 4 parameters has been deprecated,
       use <span class="function"><a href="function.ldap-exop-sync.php" class="function">ldap_exop_sync()</a></span> instead.
      </td>
     </tr>

     <tr>
 <td>8.1.0</td>
 <td>
  Der Parameter <code class="parameter">ldap</code> erwartet nun eine <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span>-Instanz;
  vorher wurde eine gültige <code class="literal">ldap link</code>-<a href="language.types.resource.php" class="link">Ressource</a> erwartet.
 </td>
</tr>

     <tr>
      <td>7.3.0</td>
      <td>
       Support for <code class="parameter">controls</code> added
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.ldap-exop-examples">
  <h3 class="title">Beispiele</h3>
  <div class="example" id="example-1">
    <p><strong>Beispiel #1 Whoami extended operation</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">// assuming the LDAP server is on this host<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">// bind with appropriate dn to give update access<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">"Unable to bind to LDAP server"</span><span style="color: #007700">;<br />      exit;<br />    }<br /><br />    </span><span style="color: #FF8000">// Call WHOAMI EXOP<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">// Parse the result object<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">// Output: 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">// Same thing using $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">"Unable to connect to LDAP server"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ldap-exop-seealso">
  <h3 class="title">Siehe auch</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.ldap-exop-sync.php" class="function" rel="rdfs-seeAlso">ldap_exop_sync()</a> - Performs an extended operation</span></li>
   <li><span class="function"><a href="function.ldap-exop-whoami.php" class="function" rel="rdfs-seeAlso">ldap_exop_whoami()</a> - WHOAMI extended operation helper</span></li>
   <li><span class="function"><a href="function.ldap-exop-refresh.php" class="function" rel="rdfs-seeAlso">ldap_exop_refresh()</a> - Refresh extended operation helper</span></li>
   <li><span class="function"><a href="function.ldap-exop-passwd.php" class="function" rel="rdfs-seeAlso">ldap_exop_passwd()</a> - PASSWD extended operation helper</span></li>
   <li><span class="function"><a href="function.ldap-parse-result.php" class="function" rel="rdfs-seeAlso">ldap_parse_result()</a> - Extrahiert Informationen aus einem Ergebnis</span></li>
   <li><span class="function"><a href="function.ldap-parse-exop.php" class="function" rel="rdfs-seeAlso">ldap_parse_exop()</a> - Parse result object from an LDAP extended operation</span></li>
  </ul>
 </div>


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