sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-24 04:48:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
php-doc-en/reference/ldap/functions/ldap-get-option.xml
Jean-Sebastien Hedde 27a75ae3cb Adds PHP versions to LDAP-Options (thanks to heiglandreas) 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@342577 c90b9560-bf6c-de11-be94-00142212c4b1
2017-06-09 12:12:00 +00:00

290 lines
8.2 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ldap-get-option" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ldap_get_option</refname>
<refpurpose>Get the current value for given option</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ldap_get_option</methodname>
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter role="reference">retval</parameter></methodparam>
</methodsynopsis>
<para>
Sets <parameter>retval</parameter> to the value of the specified option.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>link_identifier</parameter></term>
<listitem>
<para>
An LDAP link identifier, returned by <function>ldap_connect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
The parameter <parameter>option</parameter> can be one of:
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry>Option</entry>
<entry>Type</entry>
<entry>since</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>LDAP_OPT_DEREF</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_SIZELIMIT</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_TIMELIMIT</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_NETWORK_TIMEOUT</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_PROTOCOL_VERSION</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_ERROR_NUMBER</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_REFERRALS</constant></entry>
<entry>bool</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_RESTART</constant></entry>
<entry>bool</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_HOST_NAME</constant></entry>
<entry>string</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_ERROR_STRING</constant></entry>
<entry>string</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_MATCHED_DN</constant></entry>
<entry>string</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_SERVER_CONTROLS</constant></entry>
<entry>array</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_CLIENT_CONTROLS</constant></entry>
<entry>array</entry>
<entry></entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_KEEPALIVE_IDLE</constant></entry>
<entry>int</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_KEEPALIVE_PROBES</constant></entry>
<entry>int</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_KEEPALIVE_INTERVAL</constant></entry>
<entry>int</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CACERTDIR</constant></entry>
<entry>string</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CACERTFILE</constant></entry>
<entry>string</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CERTFILE</constant></entry>
<entry>string</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CIPHER_SUITE</constant></entry>
<entry>string</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CRLCHECK</constant></entry>
<entry>integer</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CRL_NONE</constant></entry>
<entry>integer</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CRL_PEER</constant></entry>
<entry>integer</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CRL_ALL</constant></entry>
<entry>integer</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_CRLFILE</constant></entry>
<entry>string</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_DHFILE</constant></entry>
<entry>string</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_KEYILE</constant></entry>
<entry>string</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_PACKAGE</constant></entry>
<entry>string</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_PROTOCOL_MIN</constant></entry>
<entry>integer</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_RANDOM_FILE</constant></entry>
<entry>string</entry>
<entry>7.1</entry>
</row>
<row>
<entry><constant>LDAP_OPT_X_TLS_REQUIRE_CERT</constant></entry>
<entry>integer</entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>retval</parameter></term>
<listitem>
<para>
This will be set to the option value.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Check protocol version</title>
<programlisting role="php">
<![CDATA[
<?php
// $ds is a valid link identifier for a directory server
if (ldap_get_option($ds, LDAP_OPT_PROTOCOL_VERSION, $version)) {
echo "Using protocol version $version\n";
} else {
echo "Unable to determine protocol version\n";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
This function is only available when using OpenLDAP 2.x.x OR Netscape
Directory SDK x.x.
</para>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ldap_set_option</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Reference in a new issue View git blame Copy permalink