archived-doc-en/reference/ldap/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="ldap.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 &reftitle.constants;
 &extension.constants;
 <variablelist>
  <varlistentry xml:id="constant.ldap-deref-never">
   <term>
    <constant>LDAP_DEREF_NEVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Alias dereferencing rule - Never.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-deref-searching">
   <term>
    <constant>LDAP_DEREF_SEARCHING</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Alias dereferencing rule - Searching.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-deref-finding">
   <term>
    <constant>LDAP_DEREF_FINDING</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Alias dereferencing rule - Finding.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-deref-always">
   <term>
    <constant>LDAP_DEREF_ALWAYS</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Alias dereferencing rule - Always.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-deref">
   <term>
    <constant>LDAP_OPT_DEREF</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies alternative rules for following aliases at the server.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-sizelimit">
   <term>
    <constant>LDAP_OPT_SIZELIMIT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <para>
     Specifies the maximum number of entries that can be
     returned on a search operation.
    </para>
    <note>
     <simpara>
      The actual size limit for operations is also bounded
      by the server's configured maximum number of return entries.
      The lesser of these two settings is the actual size limit.
     </simpara>
    </note>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-timelimit">
   <term>
    <constant>LDAP_OPT_TIMELIMIT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the number of seconds to wait for search results.
    </simpara>
    <note>
     <simpara>
      The actual time limit for operations is also bounded
      by the server's configured maximum time.
      The lesser of these two settings is the actual time limit.
     </simpara>
    </note>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-network-timeout">
   <term>
    <constant>LDAP_OPT_NETWORK_TIMEOUT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Option for <function>ldap_set_option</function> to allow setting network timeout.
     (Available as of PHP 5.3.0)
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-protocol-version">
   <term>
    <constant>LDAP_OPT_PROTOCOL_VERSION</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the LDAP protocol to be used (V2 or V3).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-error-number">
   <term>
    <constant>LDAP_OPT_ERROR_NUMBER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Latest session error number.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-referrals">
   <term>
    <constant>LDAP_OPT_REFERRALS</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies whether to automatically follow referrals returned
     by the LDAP server.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-restart">
   <term>
    <constant>LDAP_OPT_RESTART</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Determines whether or not the connection should be implicitly restarted.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-host-name">
   <term>
    <constant>LDAP_OPT_HOST_NAME</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Sets/gets a space-separated of hosts when trying to connect.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-error-string">
   <term>
    <constant>LDAP_OPT_ERROR_STRING</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Alias of <constant>LDAP_OPT_DIAGNOSTIC_MESSAGE</constant>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-diagnostic-message">
   <term>
    <constant>LDAP_OPT_DIAGNOSTIC_MESSAGE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Gets the latest session error message.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-matched-dn">
   <term>
    <constant>LDAP_OPT_MATCHED_DN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Sets/gets the matched DN associated with the connection.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-server-controls">
   <term>
    <constant>LDAP_OPT_SERVER_CONTROLS</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies a default list of server controls to be sent with each request.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-client-controls">
   <term>
    <constant>LDAP_OPT_CLIENT_CONTROLS</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies a default list of client controls to be processed with each request.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-debug-level">
   <term>
    <constant>LDAP_OPT_DEBUG_LEVEL</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies a bitwise level for debug traces.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-keepalive-idle">
   <term>
    <constant>LDAP_OPT_X_KEEPALIVE_IDLE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the number of seconds a connection needs to remain idle before TCP starts sending keepalive probes.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-keepalive-probes">
   <term>
    <constant>LDAP_OPT_X_KEEPALIVE_PROBES</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the maximum number of keepalive probes TCP should send before dropping the connection.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-keepalive-interval">
   <term>
    <constant>LDAP_OPT_X_KEEPALIVE_INTERVAL</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the interval in seconds between individual keepalive probes.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-cacertdir">
   <term>
    <constant>LDAP_OPT_X_TLS_CACERTDIR</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the path of the directory containing CA certificates.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-cacertfile">
   <term>
    <constant>LDAP_OPT_X_TLS_CACERTFILE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the full-path of the CA certificate file.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-certfile">
   <term>
    <constant>LDAP_OPT_X_TLS_CERTFILE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the full-path of the certificate file.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-cipher-suite">
   <term>
    <constant>LDAP_OPT_X_TLS_CIPHER_SUITE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the allowed cipher suite.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-crlcheck">
   <term>
    <constant>LDAP_OPT_X_TLS_CRLCHECK</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the CRL evaluation strategy. This must be one of: <constant>LDAP_OPT_X_TLS_CRL_NONE</constant>,<constant>LDAP_OPT_X_TLS_CRL_PEER</constant>, <constant>LDAP_OPT_X_TLS_CRL_ALL</constant>.
    </simpara>
    <note>
     <simpara>
      This option is only valid for OpenSSL.
     </simpara>
    </note>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-crlfile">
   <term>
    <constant>LDAP_OPT_X_TLS_CRLFILE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the full-path of the CRL file.
    </simpara>
    <note>
     <simpara>
      This option is only valid for GnuTLS.
     </simpara>
    </note>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-dhfile">
   <term>
    <constant>LDAP_OPT_X_TLS_DHFILE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the full-path  of the file containing the parameters for Diffie-Hellman ephemeral key exchange.
    </simpara>
    <note>
     <simpara>
      This option is ignored by GnuTLS and Mozilla NSS.
     </simpara>
    </note>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-keyfile">
   <term>
    <constant>LDAP_OPT_X_TLS_KEYFILE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the full-path of the certificate key file.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-protocol-min">
   <term>
    <constant>LDAP_OPT_X_TLS_PROTOCOL_MIN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the minimum protocol version. This can be one of: <constant>LDAP_OPT_X_TLS_PROTOCOL_SSL2</constant>,<constant>LDAP_OPT_X_TLS_PROTOCOL_SSL3</constant>, <constant>LDAP_OPT_X_TLS_PROTOCOL_TLS1_0</constant>, <constant>LDAP_OPT_X_TLS_PROTOCOL_TLS1_1</constant>, <constant>LDAP_OPT_X_TLS_PROTOCOL_TLS1_2</constant>
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-random-file">
   <term>
    <constant>LDAP_OPT_X_TLS_RANDOM_FILE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Sets/gets the random file when one of the system default ones are not available.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-require-cert">
   <term>
    <constant>LDAP_OPT_X_TLS_REQUIRE_CERT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies the certificate checking strategy. This must be one of: <constant>LDAP_OPT_X_TLS_NEVER</constant>,<constant>LDAP_OPT_X_TLS_HARD</constant>, <constant>LDAP_OPT_X_TLS_DEMAND</constant>,
<constant>LDAP_OPT_X_TLS_ALLOW</constant>, <constant>LDAP_OPT_X_TLS_TRY</constant>.
     (Available as of PHP 7.0.0)
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.gslc-ssl-no-auth">
   <term>
    <constant>GSLC_SSL_NO_AUTH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     SSL Authentication Mode - No authentication required. (Only for Oracle LDAP)
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.gslc-ssl-oneway-auth">
   <term>
    <constant>GSLC_SSL_ONEWAY_AUTH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     SSL Authentication Mode - Only server authentication required. (Only for Oracle LDAP)
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.gslc-ssl-twoway-auth">
   <term>
    <constant>GSLC_SSL_TWOWAY_AUTH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     SSL Authentication Mode - Both server and client authentication required. (Only for Oracle LDAP)
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.ldap-exop-start-tls">
   <term>
    <constant>LDAP_EXOP_START_TLS</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Extended Operation constant - Start TLS (<link xlink:href="&url.rfc;4511">RFC 4511</link>).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-exop-modify-passwd">
   <term>
    <constant>LDAP_EXOP_MODIFY_PASSWD</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Extended Operation constant - Modify password (<link xlink:href="&url.rfc;3062">RFC 3062</link>).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-exop-refresh">
   <term>
    <constant>LDAP_EXOP_REFRESH</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Extended Operation Constant - Refresh (<link xlink:href="&url.rfc;2589">RFC 2589</link>).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-exop-who-am-i">
   <term>
    <constant>LDAP_EXOP_WHO_AM_I</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Extended Operation Constant - WHOAMI (<link xlink:href="&url.rfc;4532">RFC 4532</link>).
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-exop-turn">
   <term>
    <constant>LDAP_EXOP_TURN</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Extended Operation Constant - Turn (<link xlink:href="&url.rfc;4531">RFC 4531</link>).
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.ldap-control-managedsait">
   <term>
    <constant>LDAP_CONTROL_MANAGEDSAIT</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Manage DSA IT (<link xlink:href="&url.rfc;3296">RFC 3296</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-proxy-authz">
   <term>
    <constant>LDAP_CONTROL_PROXY_AUTHZ</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Proxied Authorization (<link xlink:href="&url.rfc;4730">RFC 4370</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-subentries">
   <term>
    <constant>LDAP_CONTROL_SUBENTRIES</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Subentries (<link xlink:href="&url.rfc;3672">RFC 3672</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-valuesreturnfilter">
   <term>
    <constant>LDAP_CONTROL_VALUESRETURNFILTER</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Filter returned values (<link xlink:href="&url.rfc;3876">RFC 3876</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-assert">
   <term>
    <constant>LDAP_CONTROL_ASSERT</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Assertion (<link xlink:href="&url.rfc;45282">RFC 4528</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-pre-read">
   <term>
    <constant>LDAP_CONTROL_PRE_READ</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Pre read (<link xlink:href="&url.rfc;4527">RFC 4527</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-post-read">
   <term>
    <constant>LDAP_CONTROL_POST_READ</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Post read (<link xlink:href="&url.rfc;4527">RFC 4527</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-sortrequest">
   <term>
    <constant>LDAP_CONTROL_SORTREQUEST</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Sort request (<link xlink:href="&url.rfc;2891">RFC 2891</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-sortresponse">
   <term>
    <constant>LDAP_CONTROL_SORTRESPONSE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Sort response (<link xlink:href="&url.rfc;2891">RFC 2891</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-pagedresults">
   <term>
    <constant>LDAP_CONTROL_PAGEDRESULTS</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Paged results (<link xlink:href="&url.rfc;2696">RFC 2696</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-authzid-request">
   <term>
    <constant>LDAP_CONTROL_AUTHZID_REQUEST</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Authorization Identity Request (<link xlink:href="&url.rfc;3829">RFC 3829</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-authzid-response">
   <term>
    <constant>LDAP_CONTROL_AUTHZID_RESPONSE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Authorization Identity Response (<link xlink:href="&url.rfc;3829">RFC 3829</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-sync">
   <term>
    <constant>LDAP_CONTROL_SYNC</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Content Synchronization Operation (<link xlink:href="&url.rfc;4533">RFC 4533</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-sync-state">
   <term>
    <constant>LDAP_CONTROL_SYNC_STATE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Content Synchronization Operation State (<link xlink:href="&url.rfc;4533">RFC 4533</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-sync-done">
   <term>
    <constant>LDAP_CONTROL_SYNC_DONE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Content Synchronization Operation Done (<link xlink:href="&url.rfc;4533">RFC 4533</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-dontusecopy">
   <term>
    <constant>LDAP_CONTROL_DONTUSECOPY</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Don't Use Copy (<link xlink:href="&url.rfc;6171">RFC 6171</link>).
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-passwordpolicyrequest">
   <term>
    <constant>LDAP_CONTROL_PASSWORDPOLICYREQUEST</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Password Policy Request.
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-passwordpolicyresponse">
   <term>
    <constant>LDAP_CONTROL_PASSWORDPOLICYRESPONSE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Password Policy Response.
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-x-incremental-values">
   <term>
    <constant>LDAP_CONTROL_X_INCREMENTAL_VALUES</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Active Directory Incremental Values.
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-x-domain-scope">
   <term>
    <constant>LDAP_CONTROL_X_DOMAIN_SCOPE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Active Directory Domain Scope.
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-x-permissive-modify">
   <term>
    <constant>LDAP_CONTROL_X_PERMISSIVE_MODIFY</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Active Directory Permissive Modify.
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-x-search-options">
   <term>
    <constant>LDAP_CONTROL_X_SEARCH_OPTIONS</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Active Directory Search Options.
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-x-tree-delete">
   <term>
    <constant>LDAP_CONTROL_X_TREE_DELETE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Active Directory Tree Delete.
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-x-extended-dn">
   <term>
    <constant>LDAP_CONTROL_X_EXTENDED_DN</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Active Directory Extended DN.
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-vlvrequest">
   <term>
    <constant>LDAP_CONTROL_VLVREQUEST</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Virtual List View Request.
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-control-vlvresponse">
   <term>
    <constant>LDAP_CONTROL_VLVRESPONSE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     Control Constant - Virtual List View Response.
     Available as of PHP 7.3.0.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.ldap-escape-dn">
   <term>
    <constant>LDAP_ESCAPE_DN</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Escape a string for use in an LDAP DN.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-escape-filter">
   <term>
    <constant>LDAP_ESCAPE_FILTER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Escape a string for use in an LDAP filter.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.ldap-modify-batch-attrib">
   <term>
    <constant>LDAP_MODIFY_BATCH_ATTRIB</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The key of the modifications array containing the attributes:
     <literal>attrib</literal>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-modify-batch-modtype">
   <term>
    <constant>LDAP_MODIFY_BATCH_MODTYPE</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The key of the modifications array containing the type of modification:
     <literal>modtype</literal>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-modify-batch-values">
   <term>
    <constant>LDAP_MODIFY_BATCH_VALUES</constant>
    (<type>string</type>)
   </term>
   <listitem>
    <simpara>
     The key of the modifications array containing the values:
     <literal>values</literal>.
    </simpara>
   </listitem>
  </varlistentry>

   <varlistentry xml:id="constant.ldap-modify-batch-add">
   <term>
    <constant>LDAP_MODIFY_BATCH_ADD</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Add values to an attribute of an LDAP entry.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-modify-batch-remove">
   <term>
    <constant>LDAP_MODIFY_BATCH_REMOVE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Remove values from an attribute of an LDAP entry.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-modify-batch-remove-all">
   <term>
    <constant>LDAP_MODIFY_BATCH_REMOVE_ALL</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Remove all values from an attribute of an LDAP entry.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-modify-batch-replace">
   <term>
    <constant>LDAP_MODIFY_BATCH_REPLACE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Replace all current values of an LDAP entry attribute with the specified values.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.ldap-opt-timeout">
   <term>
    <constant>LDAP_OPT_TIMEOUT</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Specifies a timeout (in seconds) after which calls to synchronous LDAP APIs
     will abort if no response is received.
     Also controls the timeout when communicating with the KDC in case of SASL bind.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.ldap-opt-x-sasl-authcid">
   <term>
    <constant>LDAP_OPT_X_SASL_AUTHCID</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Return the SASL authentication identity.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-sasl-authzid">
   <term>
    <constant>LDAP_OPT_X_SASL_AUTHZID</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Return the SASL authorization identity.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-sasl-mech">
   <term>
    <constant>LDAP_OPT_X_SASL_MECH</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Return the SASL mechanism.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-sasl-nocanon">
   <term>
    <constant>LDAP_OPT_X_SASL_NOCANON</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Set/get the <literal>NOCANON</literal> flag.
     When unset, the hostname is canonicalized.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-sasl-realm">
   <term>
    <constant>LDAP_OPT_X_SASL_REALM</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Return the SASL realm.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-sasl-username">
   <term>
    <constant>LDAP_OPT_X_SASL_USERNAME</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Return the SASL username.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.ldap-opt-x-tls-allow">
   <term>
    <constant>LDAP_OPT_X_TLS_ALLOW</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The peer certificate is requested.
     If no certificate is provided, the session proceeds normally.
     If a bad certificate is provided,
     it will be ignored and the session proceeds normally.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-demand">
   <term>
    <constant>LDAP_OPT_X_TLS_DEMAND</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The peer certificate is requested.
     If no certificate is provided, or a bad certificate is provided,
     the session is immediately terminated.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-hard">
   <term>
    <constant>LDAP_OPT_X_TLS_HARD</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     &Alias; <constant>LDAP_OPT_X_TLS_DEMAND</constant>.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-never">
   <term>
    <constant>LDAP_OPT_X_TLS_NEVER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The peer certificate is not requested or checked.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-try">
   <term>
    <constant>LDAP_OPT_X_TLS_TRY</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The peer certificate is requested.
     If no certificate is provided, the session proceeds normally.
     If a bad certificate is provided, the session is immediately terminated.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.ldap-opt-x-tls-crl-all">
   <term>
    <constant>LDAP_OPT_X_TLS_CRL_ALL</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Check the CRL for a whole certificate chain.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-crl-none">
   <term>
    <constant>LDAP_OPT_X_TLS_CRL_NONE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     No CRL checks are performed.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-crl-peer">
   <term>
    <constant>LDAP_OPT_X_TLS_CRL_PEER</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Check the CRL of the peer certificate.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.ldap-opt-x-tls-package">
   <term>
    <constant>LDAP_OPT_X_TLS_PACKAGE</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     Return the name of the underlying TLS implementation.
    </simpara>
   </listitem>
  </varlistentry>

  <varlistentry xml:id="constant.ldap-opt-x-tls-protocol-ssl2">
   <term>
    <constant>LDAP_OPT_X_TLS_PROTOCOL_SSL2</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The SSL 2.0 protocol.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-protocol-ssl3">
   <term>
    <constant>LDAP_OPT_X_TLS_PROTOCOL_SSL3</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The SSL 3 protocol.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-protocol-tls1-0">
   <term>
    <constant>LDAP_OPT_X_TLS_PROTOCOL_TLS1_0</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The TLS 1.0 protocol.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-protocol-tls1-1">
   <term>
    <constant>LDAP_OPT_X_TLS_PROTOCOL_TLS1_1</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The TLS 1.1 protocol.
    </simpara>
   </listitem>
  </varlistentry>
  <varlistentry xml:id="constant.ldap-opt-x-tls-protocol-tls1-2">
   <term>
    <constant>LDAP_OPT_X_TLS_PROTOCOL_TLS1_2</constant>
    (<type>int</type>)
   </term>
   <listitem>
    <simpara>
     The TLS 1.2 protocol.
    </simpara>
   </listitem>
  </varlistentry>

 </variablelist>
</appendix>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->