<?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-read.php',
    1 => 'ldap_read',
    2 => 'エントリを読み込む',
  ),
  'up' => 
  array (
    0 => 'ref.ldap.php',
    1 => 'LDAP 関数',
  ),
  'prev' => 
  array (
    0 => 'function.ldap-parse-result.php',
    1 => 'ldap_parse_result',
  ),
  'next' => 
  array (
    0 => 'function.ldap-rename.php',
    1 => 'ldap_rename',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ldap/functions/ldap-read.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ldap-read" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ldap_read</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">ldap_read</span> &mdash; <span class="dc-title">エントリを読み込む</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ldap-read-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ldap_read</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="class.ldap-connection.php" class="type LDAP\Connection">LDAP\Connection</a></span>|<span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$ldap</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$base</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$filter</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$attributes</code><span class="initializer"> = []</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$attributes_only</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$sizelimit</code><span class="initializer"> = -1</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$timelimit</code><span class="initializer"> = -1</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$deref</code><span class="initializer"> = <strong><code><a href="ldap.constants.php#constant.ldap-deref-never">LDAP_DEREF_NEVER</a></code></strong></span></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"><span class="type"><a href="class.ldap-result.php" class="type LDAP\Result">LDAP\Result</a></span>|<span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   指定したフィルタ <code class="parameter">filter</code>
   を使用し、スコープ <strong><code>LDAP_SCOPE_BASE</code></strong>
   でディレクトリを検索します。これは、
   ディレクトリからエントリを読み込むことと同じ意味です。
  </p>
   <p class="para">並列検索も可能です。並列検索を行うには、単一の <span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span> のインスタンスではなく、それの配列を使用します。同じベース DN を使用したくない場合や全ての検索について同じフィルタを使用したくない場合、ベース DN の配列またはフィルタの配列を使用することが可能です。これらの配列は、<span class="classname"><a href="class.ldap-connection.php" class="classname">LDAP\Connection</a></span> の配列と同じ大きさである必要があります。これは、その配列の最初が一回の検索で使用され、2 番目のエントリが他の検索で使用されるといったようになるからです。並列検索を実行する際、エラーの場合を除き、<span class="classname"><a href="class.ldap-result.php" class="classname">LDAP\Result</a></span> の配列が返されます。エラーの場合は、返される値は <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> になります。</p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ldap-read-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">base</code></dt>
     <dd>
      <p class="para">
       ディレクトリのベース DN。
      </p>
     </dd>
    
    
     <dt><code class="parameter">filter</code></dt>
     <dd>
      <p class="para">
       空のフィルタは指定できません。
       このエントリに関する全ての情報を完全に取得したい場合は、
       <code class="literal">objectClass=*</code> というフィルタを使用してください。
       ディレクトリサーバーで使用されるエントリの型が分かっている場合、
       <code class="literal">objectClass=inetOrgPerson</code>
       のように適切なフィルタを使用することができます。
      </p>
     </dd>
    
    
     <dt><code class="parameter">attributes</code></dt>
     <dd>
      <p class="para">
       必要な属性を、
       array(&quot;mail&quot;, &quot;sn&quot;, &quot;cn&quot;) のような通常の PHP 文字列配列で保持します。
       &quot;dn&quot; は要求された属性の型によらず常に返されることに注意してください。
      </p>
      <p class="para">
       このパラメータを使用すると、デフォルトの動作よりもかなり効率的になります
       (デフォルトでは、すべての属性とその値を返します)。
       したがって、これを使用することを推奨します。
      </p>
     </dd>
    
    
     <dt><code class="parameter">attributes_only</code></dt>
     <dd>
      <p class="para">
       属性の型のみを取得したい場合は 1 を設定します。
       属性の型および値の両方を取得したい場合は 0
       を設定します (これがデフォルトの挙動です)。
      </p>
     </dd>
    
    
     <dt><code class="parameter">sizelimit</code></dt>
     <dd>
      <p class="para">
       取得するエントリ数の制限を設定します。
       0 は無制限であることを表します。
      </p>
      <blockquote class="note"><p><strong class="note">注意</strong>: 
       <p class="para">
        このパラメータは、サーバー側で事前に設定されている
        sizelimit を上書きすることはできません。それ以下の値を指定することはできます。
       </p>
       <p class="para">
        ディレクトリサーバーのホストによっては、
        事前に設定された数以上のエントリを返さないようになっているものもあります。
        この場合、サーバーでは、それが結果セットのすべてではないことを通知します。
        このパラメータでエントリ数を制限した場合にも、同じことが起こります。
       </p>
      </p></blockquote>
     </dd>
    
    
     <dt><code class="parameter">timelimit</code></dt>
     <dd>
      <p class="para">
       検索に要する最大秒数を設定します。
       これを 0 にすると無制限であることを表します。
      </p>
      <blockquote class="note"><p><strong class="note">注意</strong>: 
       <p class="para">
        このパラメータは、サーバー側で事前に設定されている
        timelimit を上書きすることはできません。それ以下の値を指定することはできます。
       </p>
      </p></blockquote>
     </dd>
    
    
     <dt><code class="parameter">deref</code></dt>
     <dd>
      <p class="para">
       検索時のエイリアスの扱いについて指定します。
       以下のいずれかとなります。
       <ul class="itemizedlist">
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="ldap.constants.php#constant.ldap-deref-never">LDAP_DEREF_NEVER</a></code></strong> - (デフォルト)
          エイリアスは参照されません。
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="ldap.constants.php#constant.ldap-deref-searching">LDAP_DEREF_SEARCHING</a></code></strong> -
          エイリアスを参照しますが、検索のベースオブジェクト上にいるときは参照しません。
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="ldap.constants.php#constant.ldap-deref-finding">LDAP_DEREF_FINDING</a></code></strong> -
          エイリアスの参照は、ベースオブジェクト上にいて検索中でない場合に行われます。
         </span>
        </li>
        <li class="listitem">
         <span class="simpara">
          <strong><code><a href="ldap.constants.php#constant.ldap-deref-always">LDAP_DEREF_ALWAYS</a></code></strong> - エイリアスを常に参照します。
          always.
         </span>
        </li>
       </ul>
      </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-read-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   <span class="classname"><a href="class.ldap-result.php" class="classname">LDAP\Result</a></span> のインスタンスか、<span class="classname"><a href="class.ldap-result.php" class="classname">LDAP\Result</a></span> のインスタンスの配列を返します。失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.ldap-read-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.1.0</td>
 <td>
  <span class="classname"><a href="class.ldap-result.php" class="classname">LDAP\Result</a></span>
  クラスのインスタンスを返すようになりました。
  これより前のバージョンでは、<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><?php manual_footer($setup); ?>