📄 function.ldap-set-option.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Set the value of the given option</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ldap-search.html">ldap_search</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ldap-set-rebind-proc.html">ldap_set_rebind_proc</a></div> <div class="up"><a href="ref.ldap.html">LDAP Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div id="function.ldap-set-option" class="refentry"> <div class="refnamediv"> <h1 class="refname">ldap_set_option</h1> <p class="verinfo">(PHP 4 >= 4.0.4, PHP 5)</p><p class="refpurpose"><span class="refname">ldap_set_option</span> — <span class="dc-title">Set the value of the given option</span></p> </div> <div class="refsect1 description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><b><b>ldap_set_option</b></b></span> ( <span class="methodparam"><span class="type">resource</span> <tt class="parameter">$link_identifier</tt></span> , <span class="methodparam"><span class="type">int</span> <tt class="parameter">$option</tt></span> , <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <tt class="parameter">$newval</tt></span> )</div> <p class="para rdfs-comment"> Sets the value of the specified option to be <i><tt class="parameter">newval</tt></i>. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">link_identifier</tt></i></span> <dd> <p class="para"> An LDAP link identifier, returned by <a href="function.ldap-connect.html" class="function">ldap_connect()</a>. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">option</tt></i></span> <dd> <p class="para"> The parameter <i><tt class="parameter">option</tt></i> can be one of: <table class="informaltable"> <colgroup> <thead valign="middle"> <tr valign="middle"> <th colspan="1">Option</th> <th colspan="1">Type</th> </tr> </thead> <tbody valign="middle" class="tbody"> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_DEREF</tt></b></td> <td colspan="1" rowspan="1" align="left">integer</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_SIZELIMIT</tt></b></td> <td colspan="1" rowspan="1" align="left">integer</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_TIMELIMIT</tt></b></td> <td colspan="1" rowspan="1" align="left">integer</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_NETWORK_TIMEOUT</tt></b></td> <td colspan="1" rowspan="1" align="left">integer</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_PROTOCOL_VERSION</tt></b></td> <td colspan="1" rowspan="1" align="left">integer</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_ERROR_NUMBER</tt></b></td> <td colspan="1" rowspan="1" align="left">integer</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_REFERRALS</tt></b></td> <td colspan="1" rowspan="1" align="left">bool</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_RESTART</tt></b></td> <td colspan="1" rowspan="1" align="left">bool</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_HOST_NAME</tt></b></td> <td colspan="1" rowspan="1" align="left">string</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_ERROR_STRING</tt></b></td> <td colspan="1" rowspan="1" align="left">string</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_MATCHED_DN</tt></b></td> <td colspan="1" rowspan="1" align="left">string</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_SERVER_CONTROLS</tt></b></td> <td colspan="1" rowspan="1" align="left">array</td> </tr> <tr valign="middle"> <td colspan="1" rowspan="1" align="left"><b><tt>LDAP_OPT_CLIENT_CONTROLS</tt></b></td> <td colspan="1" rowspan="1" align="left">array</td> </tr> </tbody> </colgroup> </table> </p> <p class="para"> <b><tt>LDAP_OPT_SERVER_CONTROLS</tt></b> and <b><tt>LDAP_OPT_CLIENT_CONTROLS</tt></b> require a list of controls, this means that the value must be an array of controls. A control consists of an <em class="emphasis">oid</em> identifying the control, an optional <em class="emphasis">value</em>, and an optional flag for <em class="emphasis">criticality</em>. In PHP a control is given by an array containing an element with the key <em class="emphasis">oid</em> and string value, and two optional elements. The optional elements are key <em class="emphasis">value</em> with string value and key <em class="emphasis">iscritical</em> with boolean value. <em class="emphasis">iscritical</em> defaults to <em class="emphasis"><b><tt>FALSE</tt></b></em> if not supplied. See <a href="http://www.openldap.org/devel/cvsweb.cgi/~checkout~/doc/drafts/draft-ietf-ldapext-ldap-c-api-xx.txt" class="link external">» draft-ietf-ldapext-ldap-c-api-xx.txt</a> for details. See also the second example below. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">newval</tt></i></span> <dd> <p class="para"> The new value for the specified <i><tt class="parameter">option</tt></i>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <b><tt>TRUE</tt></b> on success or <b><tt>FALSE</tt></b> on failure. </p> </div> <div class="refsect1 examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example"> <p><b>Example #1 Set protocol version</b></p> <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// $ds is a valid link identifier for a directory server<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">ldap_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">LDAP_OPT_PROTOCOL_VERSION</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">"Using LDAPv3"</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">"Failed to set protocol version to 3"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span></span></code></div> </div> </div> <div class="example"> <p><b>Example #2 Set server controls</b></p> <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// $ds is a valid link identifier for a directory server<br />// control with no value<br /></span><span style="color: #0000BB">$ctrl1 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"oid" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"1.2.752.58.10.1"</span><span style="color: #007700">, </span><span style="color: #DD0000">"iscritical" </span><span style="color: #007700">=> </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// iscritical defaults to FALSE<br /></span><span style="color: #0000BB">$ctrl2 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"oid" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"1.2.752.58.1.10"</span><span style="color: #007700">, </span><span style="color: #DD0000">"value" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"magic"</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// try to set both controls<br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">ldap_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$ds</span><span style="color: #007700">, </span><span style="color: #0000BB">LDAP_OPT_SERVER_CONTROLS</span><span style="color: #007700">, array(</span><span style="color: #0000BB">$ctrl1</span><span style="color: #007700">, </span><span style="color: #0000BB">$ctrl2</span><span style="color: #007700">))) {<br /> echo </span><span style="color: #DD0000">"Failed to set server controls"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span></span></code></div> </div> </div> </p> </div> <div class="refsect1 notes"> <h3 class="title">Notes</h3> <blockquote><p><b class="note">Note</b>: This function is only available when using OpenLDAP 2.x.x OR Netscape Directory SDK x.x. <br /> </p></blockquote> </div> <div class="refsect1 seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="function.ldap-get-option.html" class="function" rel="rdfs-seeAlso">ldap_get_option()</a></li> </ul> </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ldap-search.html">ldap_search</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ldap-set-rebind-proc.html">ldap_set_rebind_proc</a></div> <div class="up"><a href="ref.ldap.html">LDAP Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -