uTools-Manuals/docs/php/ldap_rename.html
2019-04-08 23:22:26 +08:00

178 lines
4.9 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Modify the name of an entry</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.ldap-rename" class="refentry">
<div class="refnamediv">
<h1 class="refname">ldap_rename</h1>
<p class="verinfo">(PHP 4 &gt;= 4.0.5, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">ldap_rename</span> &mdash; <span class="dc-title">Modify the name of an entry</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ldap-rename-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>ldap_rename</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link_identifier</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$dn</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$newrdn</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$newparent</code></span>
, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$deleteoldrdn</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$serverctrls</code><span class="initializer"> = array()</span></span>
] ) : <span class="type">bool</span></div>
<p class="para rdfs-comment">
The entry specified by <code class="parameter">dn</code> is renamed/moved.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ldap-rename-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">link_identifier</code></dt>
<dd>
<p class="para">
An LDAP link identifier, returned by <span class="function"><a href="ldap_connect.html" class="function">ldap_connect()</a></span>.
</p>
</dd>
<dt>
<code class="parameter">dn</code></dt>
<dd>
<p class="para">
The distinguished name of an LDAP entity.
</p>
</dd>
<dt>
<code class="parameter">newrdn</code></dt>
<dd>
<p class="para">
The new RDN.
</p>
</dd>
<dt>
<code class="parameter">newparent</code></dt>
<dd>
<p class="para">
The new parent/superior entry.
</p>
</dd>
<dt>
<code class="parameter">deleteoldrdn</code></dt>
<dd>
<p class="para">
If <strong><code>TRUE</code></strong> the old RDN value(s) is removed, else the old RDN value(s)
is retained as non-distinguished values of the entry.
</p>
</dd>
<dt>
<code class="parameter">serverctrls</code></dt>
<dd>
<p class="para">
Array of <a href="ldap.controls.html" class="link">LDAP Controls</a> to send with the request.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ldap-rename-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
成功时返回 <strong><code>TRUE</code></strong> 或者在失败时返回 <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.ldap-rename-changelog">
<h3 class="title">更新日志</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>版本</th>
<th>说明</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>7.3</td>
<td>
Support for <code class="parameter">serverctrls</code> added
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.ldap-rename-notes">
<h3 class="title">注释</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function currently only works with LDAPv3. You may have to use
<span class="function"><a href="ldap_set_option.html" class="function">ldap_set_option()</a></span> prior to binding to use LDAPv3. This
function is only available when using OpenLDAP 2.x.x OR Netscape
Directory SDK x.x.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.ldap-rename-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="ldap_rename_ext.html" class="function" rel="rdfs-seeAlso">ldap_rename_ext()</a> - Modify the name of an entry</span></li>
<li class="member"><span class="function"><a href="ldap_modify.html" class="function" rel="rdfs-seeAlso">ldap_modify()</a> - 别名 ldap_mod_replace</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>