mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
ea99bf7969
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343579 c90b9560-bf6c-de11-be94-00142212c4b1
511 lines
14 KiB
XML
511 lines
14 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<appendix xml:id="ldap.constants" xmlns="http://docbook.org/ns/docbook">
|
|
&reftitle.constants;
|
|
&extension.constants;
|
|
<variablelist>
|
|
<varlistentry xml:id="constant.ldap-deref-never">
|
|
<term>
|
|
<constant>LDAP_DEREF_NEVER</constant>
|
|
(<type>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>integer</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>string</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>string</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>string</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>string</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>integer</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>string</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>string</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>string</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>integer</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>string</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>integer</type>)
|
|
</term>
|
|
<listitem>
|
|
<simpara>
|
|
Specifies the certificate checking 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>integer</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>integer</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>integer</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 (RFC 4511).
|
|
</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 (RFC 3062).
|
|
</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 (RFC 2589).
|
|
</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 (RFC 4532).
|
|
</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 (RFC 4531).
|
|
</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:
|
|
-->
|