<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Predefined Constants</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ldap.resources.html">Resource Types</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ldap.using.html">Using the PHP LDAP calls</a></div>
<div class="up"><a href="book.ldap.html">LDAP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ldap.constants" class="appendix">
<h1>Predefined Constants</h1>
<p class="simpara">
The constants below are defined by this extension, and
will only be available when the extension has either
been compiled into PHP or dynamically loaded at runtime.
</p>
<dl>
<dt id="constant.ldap-deref-never">
<strong><code>LDAP_DEREF_NEVER</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Alias dereferencing rule - Never.
</span>
</dd>
<dt id="constant.ldap-deref-searching">
<strong><code>LDAP_DEREF_SEARCHING</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Alias dereferencing rule - Searching.
</span>
</dd>
<dt id="constant.ldap-deref-finding">
<strong><code>LDAP_DEREF_FINDING</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Alias dereferencing rule - Finding.
</span>
</dd>
<dt id="constant.ldap-deref-always">
<strong><code>LDAP_DEREF_ALWAYS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Alias dereferencing rule - Always.
</span>
</dd>
<dt id="constant.ldap-opt-deref">
<strong><code>LDAP_OPT_DEREF</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies alternative rules for following aliases at the server.
</span>
</dd>
<dt id="constant.ldap-opt-sizelimit">
<strong><code>LDAP_OPT_SIZELIMIT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<p class="para">
Specifies the maximum number of entries that can be
returned on a search operation.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="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.
</span>
</p></blockquote>
</dd>
<dt id="constant.ldap-opt-timelimit">
<strong><code>LDAP_OPT_TIMELIMIT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the number of seconds to wait for search results.
</span>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="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.
</span>
</p></blockquote>
</dd>
<dt id="constant.ldap-opt-network-timeout">
<strong><code>LDAP_OPT_NETWORK_TIMEOUT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Option for <span class="function"><a href="function.ldap-set-option.html" class="function">ldap_set_option()</a></span> to allow setting network timeout.
(Available as of PHP 5.3.0)
</span>
</dd>
<dt id="constant.ldap-opt-protocol-version">
<strong><code>LDAP_OPT_PROTOCOL_VERSION</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the LDAP protocol to be used (V2 or V3).
</span>
</dd>
<dt id="constant.ldap-opt-error-number">
<strong><code>LDAP_OPT_ERROR_NUMBER</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Latest session error number.
</span>
</dd>
<dt id="constant.ldap-opt-referrals">
<strong><code>LDAP_OPT_REFERRALS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies whether to automatically follow referrals returned
by the LDAP server.
</span>
</dd>
<dt id="constant.ldap-opt-restart">
<strong><code>LDAP_OPT_RESTART</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Determines whether or not the connection should be implicitly restarted.
</span>
</dd>
<dt id="constant.ldap-opt-host-name">
<strong><code>LDAP_OPT_HOST_NAME</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Sets/gets a space-separated of hosts when trying to connect.
</span>
</dd>
<dt id="constant.ldap-opt-error-string">
<strong><code>LDAP_OPT_ERROR_STRING</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Alias of <strong><code>LDAP_OPT_DIAGNOSTIC_MESSAGE</code></strong>.
</span>
</dd>
<dt id="constant.ldap-opt-diagnostic-message">
<strong><code>LDAP_OPT_DIAGNOSTIC_MESSAGE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Gets the latest session error message.
</span>
</dd>
<dt id="constant.ldap-opt-matched-dn">
<strong><code>LDAP_OPT_MATCHED_DN</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Sets/gets the matched DN associated with the connection.
</span>
</dd>
<dt id="constant.ldap-opt-server-controls">
<strong><code>LDAP_OPT_SERVER_CONTROLS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies a default list of server controls to be sent with each request.
</span>
</dd>
<dt id="constant.ldap-opt-client-controls">
<strong><code>LDAP_OPT_CLIENT_CONTROLS</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies a default list of client controls to be processed with each request.
</span>
</dd>
<dt id="constant.ldap-opt-debug-level">
<strong><code>LDAP_OPT_DEBUG_LEVEL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies a bitwise level for debug traces.
</span>
</dd>
<dt id="constant.ldap-opt-x-keepalive-idle">
<strong><code>LDAP_OPT_X_KEEPALIVE_IDLE</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the number of seconds a connection needs to remain idle before TCP starts sending keepalive probes.
</span>
</dd>
<dt id="constant.ldap-opt-x-keepalive-probes">
<strong><code>LDAP_OPT_X_KEEPALIVE_PROBES</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the maximum number of keepalive probes TCP should send before dropping the connection.
</span>
</dd>
<dt id="constant.ldap-opt-x-keepalive-interval">
<strong><code>LDAP_OPT_X_KEEPALIVE_INTERVAL</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the interval in seconds between individual keepalive probes.
</span>
</dd>
<dt id="constant.ldap-opt-x-tls-cacertdir">
<strong><code>LDAP_OPT_X_TLS_CACERTDIR</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the path of the directory containing CA certificates.
</span>
</dd>
<dt id="constant.ldap-opt-x-tls-cacertfile">
<strong><code>LDAP_OPT_X_TLS_CACERTFILE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the full-path of the CA certificate file.
</span>
</dd>
<dt id="constant.ldap-opt-x-tls-certfile">
<strong><code>LDAP_OPT_X_TLS_CERTFILE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the full-path of the certificate file.
</span>
</dd>
<dt id="constant.ldap-opt-x-tls-cipher-suite">
<strong><code>LDAP_OPT_X_TLS_CIPHER_SUITE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the allowed cipher suite.
</span>
</dd>
<dt id="constant.ldap-opt-x-tls-crlcheck">
<strong><code>LDAP_OPT_X_TLS_CRLCHECK</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the CRL evaluation strategy. This must be one of: <strong><code>LDAP_OPT_X_TLS_CRL_NONE</code></strong>,<strong><code>LDAP_OPT_X_TLS_CRL_PEER</code></strong>, <strong><code>LDAP_OPT_X_TLS_CRL_ALL</code></strong>.
</span>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
This option is only valid for OpenSSL.
</span>
</p></blockquote>
</dd>
<dt id="constant.ldap-opt-x-tls-crlfile">
<strong><code>LDAP_OPT_X_TLS_CRLFILE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the full-path of the CRL file.
</span>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
This option is only valid for GnuTLS.
</span>
</p></blockquote>
</dd>
<dt id="constant.ldap-opt-x-tls-dhfile">
<strong><code>LDAP_OPT_X_TLS_DHFILE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the full-path of the file containing the parameters for Diffie-Hellman ephemeral key exchange.
</span>
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
This option is ignored by GnuTLS and Mozilla NSS.
</span>
</p></blockquote>
</dd>
<dt id="constant.ldap-opt-x-tls-keyfile">
<strong><code>LDAP_OPT_X_TLS_KEYFILE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the full-path of the certificate key file.
</span>
</dd>
<dt id="constant.ldap-opt-x-tls-protocol-min">
<strong><code>LDAP_OPT_X_TLS_PROTOCOL_MIN</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the minimum protocol version. This can be one of: <strong><code>LDAP_OPT_X_TLS_PROTOCOL_SSL2</code></strong>,<strong><code>LDAP_OPT_X_TLS_PROTOCOL_SSL3</code></strong>, <strong><code>LDAP_OPT_X_TLS_PROTOCOL_TLS1_0</code></strong>, <strong><code>LDAP_OPT_X_TLS_PROTOCOL_TLS1_1</code></strong>, <strong><code>LDAP_OPT_X_TLS_PROTOCOL_TLS1_2</code></strong>
</span>
</dd>
<dt id="constant.ldap-opt-x-tls-random-file">
<strong><code>LDAP_OPT_X_TLS_RANDOM_FILE</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Sets/gets the random file when one of the system default ones are not available.
</span>
</dd>
<dt id="constant.ldap-opt-x-tls-require-cert">
<strong><code>LDAP_OPT_X_TLS_REQUIRE_CERT</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
Specifies the certificate checking checking strategy. This must be one of: <strong><code>LDAP_OPT_X_TLS_NEVER</code></strong>,<strong><code>LDAP_OPT_X_TLS_HARD</code></strong>, <strong><code>LDAP_OPT_X_TLS_DEMAND</code></strong>,
<strong><code>LDAP_OPT_X_TLS_ALLOW</code></strong>, <strong><code>LDAP_OPT_X_TLS_TRY</code></strong>.
(Available as of PHP 7.0.0)
</span>
</dd>
<dt id="constant.gslc-ssl-no-auth">
<strong><code>GSLC_SSL_NO_AUTH</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
SSL Authentication Mode - No authentication required. (Only for Oracle LDAP)
</span>
</dd>
<dt id="constant.gslc-ssl-oneway-auth">
<strong><code>GSLC_SSL_ONEWAY_AUTH</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
SSL Authentication Mode - Only server authentication required. (Only for Oracle LDAP)
</span>
</dd>
<dt id="constant.gslc-ssl-twoway-auth">
<strong><code>GSLC_SSL_TWOWAY_AUTH</code></strong>
(<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>)
</dt>
<dd>
<span class="simpara">
SSL Authentication Mode - Both server and client authentication required. (Only for Oracle LDAP)
</span>
</dd>
<dt id="constant.ldap-exop-start-tls">
<strong><code>LDAP_EXOP_START_TLS</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Extended Operation constant - Start TLS (RFC 4511).
</span>
</dd>
<dt id="constant.ldap-exop-modify-passwd">
<strong><code>LDAP_EXOP_MODIFY_PASSWD</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Extended Operation constant - Modify password (RFC 3062).
</span>
</dd>
<dt id="constant.ldap-exop-refresh">
<strong><code>LDAP_EXOP_REFRESH</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Extended Operation Constant - Refresh (RFC 2589).
</span>
</dd>
<dt id="constant.ldap-exop-who-am-i">
<strong><code>LDAP_EXOP_WHO_AM_I</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Extended Operation Constant - WHOAMI (RFC 4532).
</span>
</dd>
<dt id="constant.ldap-exop-turn">
<strong><code>LDAP_EXOP_TURN</code></strong>
(<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)
</dt>
<dd>
<span class="simpara">
Extended Operation Constant - Turn (RFC 4531).
</span>
</dd>
</dl>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ldap.resources.html">Resource Types</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ldap.using.html">Using the PHP LDAP calls</a></div>
<div class="up"><a href="book.ldap.html">LDAP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
