mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
234 lines
6.8 KiB
XML
234 lines
6.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.ldap-set-option" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>ldap_set_option</refname>
|
|
<refpurpose>Set the value of the given option</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ldap_set_option</methodname>
|
|
<methodparam><type>resource</type><parameter>link_identifier</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>option</parameter></methodparam>
|
|
<methodparam><type>mixed</type><parameter>newval</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Sets the value of the specified option to be <parameter>newval</parameter>.
|
|
</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="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Option</entry>
|
|
<entry>Type</entry>
|
|
<entry>Available 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>PHP 5.3.0</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>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
<para>
|
|
<constant>LDAP_OPT_SERVER_CONTROLS</constant> and
|
|
<constant>LDAP_OPT_CLIENT_CONTROLS</constant> require a list of
|
|
controls, this means that the value must be an array of controls. A
|
|
control consists of an <emphasis>oid</emphasis> identifying the control,
|
|
an optional <emphasis>value</emphasis>, and an optional flag for
|
|
<emphasis>criticality</emphasis>. In PHP a control is given by an
|
|
array containing an element with the key <emphasis>oid</emphasis>
|
|
and string value, and two optional elements. The optional
|
|
elements are key <emphasis>value</emphasis> with string value
|
|
and key <emphasis>iscritical</emphasis> with boolean value.
|
|
<emphasis>iscritical</emphasis> defaults to <emphasis>&false;</emphasis>
|
|
if not supplied. See <link
|
|
xlink:href="&url.ldap.openldap-c-api;">draft-ietf-ldapext-ldap-c-api-xx.txt</link>
|
|
for details. See also the second example below.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>newval</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The new value for the specified <parameter>option</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Set protocol version</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// $ds is a valid link identifier for a directory server
|
|
if (ldap_set_option($ds, LDAP_OPT_PROTOCOL_VERSION, 3)) {
|
|
echo "Using LDAPv3";
|
|
} else {
|
|
echo "Failed to set protocol version to 3";
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
<example>
|
|
<title>Set server controls</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// $ds is a valid link identifier for a directory server
|
|
// control with no value
|
|
$ctrl1 = array("oid" => "1.2.752.58.10.1", "iscritical" => true);
|
|
// iscritical defaults to FALSE
|
|
$ctrl2 = array("oid" => "1.2.752.58.1.10", "value" => "magic");
|
|
// try to set both controls
|
|
if (!ldap_set_option($ds, LDAP_OPT_SERVER_CONTROLS, array($ctrl1, $ctrl2))) {
|
|
echo "Failed to set server controls";
|
|
}
|
|
?>
|
|
]]>
|
|
</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_get_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
|
|
-->
|