ldap-search.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: b7cbd468cb4c46d55d43a44cade0eb4590d25dea Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.ldap-search" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>ldap_search</refname>
  <refpurpose>LDAP ツリーを探索する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>LDAP\Result</type><type>array</type><type>false</type></type><methodname>ldap_search</methodname>
   <methodparam><type class="union"><type>LDAP\Connection</type><type>array</type></type><parameter>ldap</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>base</parameter></methodparam>
   <methodparam><type class="union"><type>array</type><type>string</type></type><parameter>filter</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>attributes</parameter><initializer>[]</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>attributes_only</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>sizelimit</parameter><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>timelimit</parameter><initializer>-1</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>deref</parameter><initializer><constant>LDAP_DEREF_NEVER</constant></initializer></methodparam>
   <methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   指定したフィルタを使用し、
   スコープ <constant>LDAP_SCOPE_SUBTREE</constant>
   でディレクトリを検索します。これは、ディレクトリ全体を検索するのと同じ意味です。
  </para>
  &ldap.return-result-array-info;
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ldap</parameter></term>
     <listitem>
      <para>
       &ldap.parameter.ldap;
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>base</parameter></term>
     <listitem>
      <para>
       ディレクトリのベース DN。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>filter</parameter></term>
     <listitem>
      <para>
       検索フィルタは、LDAP ドキュメントに記述されたフォーマットの論理
       演算子を用いて、簡単なものまたは高度なものとすることができます
       (フィルタに関する詳細な情報については、
       <link xlink:href="&url.ldap.filters;">Netscape Directory SDK</link>
       あるいは <link xlink:href="&url.rfc;4515">RFC4515</link>
       を参照ください)。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>attributes</parameter></term>
     <listitem>
      <para>
       必要な属性を、
       <literal>array("mail", "sn", "cn")</literal> のような通常の PHP 文字列配列で保持します。
       "dn" は要求された属性の型によらず常に返されることに注意してください。
      </para>
      <para>
       このパラメータを使用すると、デフォルトの動作よりもかなり効率的になります
       (デフォルトでは、すべての属性とその値を返します)。
       したがって、これを使用することを推奨します。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>attributes_only</parameter></term>
     <listitem>
      <para>
       属性の型のみを取得したい場合は 1 を設定します。
       属性の型および値の両方を取得したい場合は 0
       を設定します (これがデフォルトの挙動です)。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>sizelimit</parameter></term>
     <listitem>
      <para>
       取得するエントリ数の制限を設定します。
       0 は無制限であることを表します。
      </para>
      <note>
       <para>
        このパラメータは、サーバー側で事前に設定されている
        sizelimit を上書きすることはできません。それ以下の値を指定することはできます。
       </para>
       <para>
        ディレクトリサーバーのホストによっては、
        事前に設定された数以上のエントリを返さないようになっているものもあります。
        この場合、サーバーでは、それが結果セットのすべてではないことを通知します。
        このパラメータでエントリ数を制限した場合にも、同じことが起こります。
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>timelimit</parameter></term>
     <listitem>
      <para>
       検索に要する最大秒数を設定します。
       これを 0 にすると無制限であることを表します。
      </para>
      <note>
       <para>
        このパラメータは、サーバー側で事前に設定されている
        timelimit を上書きすることはできません。それ以下の値を指定することはできます。
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>deref</parameter></term>
     <listitem>
      <para>
       検索時のエイリアスの扱いについて指定します。
       以下のいずれかとなります。
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>LDAP_DEREF_NEVER</constant> - (デフォルト)
          エイリアスは参照されません。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>LDAP_DEREF_SEARCHING</constant> -
          エイリアスを参照しますが、検索のベースオブジェクト上にいるときは参照しません。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>LDAP_DEREF_FINDING</constant> -
          エイリアスの参照は、ベースオブジェクト上にいて検索中でない場合に行われます。
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>LDAP_DEREF_ALWAYS</constant> - エイリアスを常に参照します。
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>controls</parameter></term>
     <listitem>
      <para>
       リクエストと一緒に送信する <link linkend="ldap.controls">LDAP コントロール</link> の配列
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &ldap.return-result-array;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      &ldap.changelog.ldap-object;
      &ldap.changelog.return-result-object;
      &ldap.changelog.controls-nullable;
      <row>
       <entry>7.3.0</entry>
       <entry>
        <parameter>controls</parameter> のサポートが追加されました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   以下の例は、"My Company" の全員について姓または名の一部に文字列
   <varname>$person</varname> を含む人の組織単位、姓、名、電子メールアドレスを取得します。
   この例は、複数の属性に関する情報についてサーバーに検索をかける論理
   フィルタを使用します。
   <example>
    <title>LDAP 検索</title>
    <programlisting role="php">
<![CDATA[
<?php
// $ds は、ディレクトリサーバーの LDAP\Connection のインスタンス

// $person は、人名またはその一部。例 "Jo"

$dn = "o=My Company, c=US";
$filter="(|(sn=$person*)(givenname=$person*))";
$justthese = array("ou", "sn", "givenname", "mail");

$sr=ldap_search($ds, $dn, $filter, $justthese);

$info = ldap_get_entries($ds, $sr);

echo $info["count"]." 個のエントリが返されました\n";
?>
]]>
    </programlisting>
   </example>
  </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
-->