<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ldap.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.ldap-rename.php',
    1 => 'ldap_rename',
    2 => 'エントリ名を修正する',
  ),
  'up' => 
  array (
    0 => 'ref.ldap.php',
    1 => 'LDAP 関数',
  ),
  'prev' => 
  array (
    0 => 'function.ldap-read.php',
    1 => 'ldap_read',
  ),
  'next' => 
  array (
    0 => 'function.ldap-rename-ext.php',
    1 => 'ldap_rename_ext',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ldap/functions/ldap-rename.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<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, PHP 8)</p><p class="refpurpose"><span class="refname">ldap_rename</span> &mdash; <span class="dc-title">エントリ名を修正する</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>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="class.ldap-connection.php" class="type LDAP\Connection">LDAP\Connection</a></span> <code class="parameter">$ldap</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$dn</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$new_rdn</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$new_parent</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$delete_old_rdn</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$controls</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   <code class="parameter">dn</code> で指定したエントリについて、
   名前の変更または移動を行います。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ldap-rename-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">ldap</code></dt>
     <dd>
      <p class="para">
       <span class="function"><a href="function.ldap-connect.php" class="function">ldap_connect()</a></span> が返す <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span> クラスのインスタンス。
      </p>
     </dd>
    
    
     <dt><code class="parameter">dn</code></dt>
     <dd>
      <p class="para">
       LDAP エンティティの識別名。
      </p>
     </dd>
    
    
     <dt><code class="parameter">new_rdn</code></dt>
     <dd>
      <p class="para">
       新しい RDN。
      </p>
     </dd>
    
    
     <dt><code class="parameter">new_parent</code></dt>
     <dd>
      <p class="para">
       新しい親エントリ。
      </p>
     </dd>
    
    
     <dt><code class="parameter">delete_old_rdn</code></dt>
     <dd>
      <p class="para">
       <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> の場合は古い RDN 値を削除します。それ以外の場合は古い RDN
       値がそのエントリの non-distinguished 値として残されます。
      </p>
     </dd>
    
    
     <dt><code class="parameter">controls</code></dt>
     <dd>
      <p class="para">
       リクエストと一緒に送信する <a href="ldap.controls.php" class="link">LDAP コントロール</a> の配列
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ldap-rename-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></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>8.1.0</td>
 <td>
  引数 <code class="parameter">ldap</code> は、<span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span>
  クラスのインスタンスを期待するようになりました。
  これより前のバージョンでは、有効な <code class="literal">ldap link</code> <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> を期待していました。
 </td>
</tr>

      <tr>
 <td>8.0.0</td>
 <td>
  <code class="parameter">controls</code> は、nullable になりました。
  これより前のバージョンでは、デフォルト値が <code class="literal">[]</code> でした。
 </td>
</tr>

      <tr>
       <td>7.3.0</td>
       <td>
        <code class="parameter">controls</code> のサポートが追加されました。
       </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">注意</strong>: 
   <p class="para">
    この関数は、現在、LDAPv3 でのみ動作します。LDAPv3 でバインドする前に
    <span class="function"><a href="function.ldap-set-option.php" class="function">ldap_set_option()</a></span> を使用する必要があるかもしれません。
    この関数は、OpenLDAP 2.x.x または 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><span class="function"><a href="function.ldap-rename-ext.php" class="function" rel="rdfs-seeAlso">ldap_rename_ext()</a> - エントリ名を修正する</span></li>
    <li><span class="function"><a href="function.ldap-modify.php" class="function" rel="rdfs-seeAlso">ldap_modify()</a> - ldap_mod_replace のエイリアス</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>