|
|
@@ -0,0 +1,232 @@
|
|
|
+<?xml version="1.0" encoding="UTF-8"?>
|
|
|
+<!-- Reviewed: no -->
|
|
|
+<!-- EN-Revision: 19247 -->
|
|
|
+<sect3 id="zend.ldap.api.reference.zend-ldap-filter">
|
|
|
+ <title>Zend_Ldap_Filter</title>
|
|
|
+
|
|
|
+ <table id="zend.ldap.api.reference.zend-filter.table">
|
|
|
+ <title>Zend_Ldap_Filter API</title>
|
|
|
+
|
|
|
+ <tgroup cols="2">
|
|
|
+ <thead>
|
|
|
+ <row>
|
|
|
+ <entry>メソッド</entry>
|
|
|
+ <entry>説明</entry>
|
|
|
+ </row>
|
|
|
+ </thead>
|
|
|
+ <tbody>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter equals(string $attr,
|
|
|
+ string $value)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 'equals' フィルタを作成
|
|
|
+ <code>(attr=value)</code>
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter begins(string $attr,
|
|
|
+ string $value)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 'begins with' フィルタを作成
|
|
|
+ <code>(attr=value*)</code>
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter ends(string $attr, string
|
|
|
+ $value)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 'ends with' フィルタを作成
|
|
|
+ <code>(attr=*value)</code>
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter contains(string $attr,
|
|
|
+ string $value)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 'contains' フィルタを作成
|
|
|
+ <code>(attr=*value*)</code>
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter greater(string $attr,
|
|
|
+ string $value)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 'greater' フィルタを作成
|
|
|
+ <code>(attr>value)</code>
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter greaterOrEqual(string
|
|
|
+ $attr, string $value)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 'greater or equal' フィルタを作成
|
|
|
+ <code>(attr>=value)</code>
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter less(string $attr, string
|
|
|
+ $value)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 'less' フィルタを作成
|
|
|
+ <code>(attr<value)</code>
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter lessOrEqual(string $attr,
|
|
|
+ string $value)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 'less or equal' フィルタを作成
|
|
|
+ <code>(attr<=value)</code>
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter approx(string $attr,
|
|
|
+ string $value)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 'approx' フィルタを作成
|
|
|
+ <code>(attr~=value)</code>
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter any(string $attr)</code>
|
|
|
+ </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>'any' フィルタを作成 <code>(attr=*)</code></entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter string(string
|
|
|
+ $filter)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 単純なカスタム文字列フィルタを作成。
|
|
|
+ フィルタはそのまま使われるので、
|
|
|
+ 値のエスケープ全てはユーザーの責任です。
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter mask(string $mask, string
|
|
|
+ $value,...)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 文字列のマスクからフィルタを作成。
|
|
|
+ <varname>$value</varname> 引数の全てが、
|
|
|
+ <ulink url="http://php.net/sprintf">
|
|
|
+ <methodname>sprintf()</methodname></ulink>
|
|
|
+ 関数を用いて <varname>$mask</varname> にエスケープされ、置換されます。
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter
|
|
|
+ andFilter(Zend_Ldap_Filter_Abstract $filter,...)</code>
|
|
|
+ </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>与えられた引数全てから 'and' フィルタを作成</entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>Zend_Ldap_Filter
|
|
|
+ orFilter(Zend_Ldap_Filter_Abstract $filter,...)</code>
|
|
|
+ </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>与えられた引数全てから 'or' フィルタを作成</entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <code>__construct(string $attr, string $value, string
|
|
|
+ $filtertype, string|null $prepend, string|null
|
|
|
+ $append)</code>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ コンストラクタ。
|
|
|
+ 与えられる引数に応じて任意のフィルタを作成します。
|
|
|
+ 結果として生じるフィルタは連結したものです。
|
|
|
+ <code>$attr . $filtertype . $prepend . $value . $append</code>
|
|
|
+ 通常は、適切なファクトリ・メソッドでフィルタを全て作成できるので、
|
|
|
+ このコンストラクタは不要です。
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry><code>string toString()</code></entry>
|
|
|
+ <entry>フィルタの文字列表現を返す</entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry><code>string __toString()</code></entry>
|
|
|
+ <entry>
|
|
|
+ フィルタの文字列表現を返す。
|
|
|
+ <methodname>Zend_Ldap_Filter::toString()</methodname> の代理
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry><code>Zend_Ldap_Filter_Abstract negate()</code></entry>
|
|
|
+ <entry>現行のフィルタを否定</entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <code>Zend_Ldap_Filter_Abstract
|
|
|
+ addAnd(Zend_Ldap_Filter_Abstract $filter,...)</code>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 現行のフィルタ、及び引数として渡されたフィルタ全てから 'and' フィルタを作成
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <code>Zend_Ldap_Filter_Abstract
|
|
|
+ addOr(Zend_Ldap_Filter_Abstract $filter,...)</code>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ 現行のフィルタ、及び引数として渡されたフィルタ全てから 'or' フィルタを作成
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>string|array escapeValue(string|array
|
|
|
+ $values)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ <acronym>LDAP</acronym> フィルタで問題なくそれらを使えるように、
|
|
|
+ <acronym>RFC</acronym> 2254 に従って、与えられた <varname>$values</varname> をエスケープします。
|
|
|
+ 単一の文字列が与えられると、文字列が返され、さもなければ、配列が返されます。
|
|
|
+ <acronym>LDAP</acronym> フィルタで特別な意味を持つ文字、
|
|
|
+ "*" 、 "(" 、 ")" 及び "\" (バックスラッシュ)に加え、
|
|
|
+ 32 未満の <acronym>ASCII</acronym> コードを持つ制御文字も全て
|
|
|
+ バックスラッシュの後に、文字の16進数を表現する2桁の数字が続く表現に変換されます。
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ <row>
|
|
|
+ <entry>
|
|
|
+ <emphasis><code>string|array unescapeValue(string|array
|
|
|
+ $values)</code> </emphasis>
|
|
|
+ </entry>
|
|
|
+ <entry>
|
|
|
+ <methodname>Zend_Ldap_Filter::escapeValue()</methodname>
|
|
|
+ で行われた変換を取り消します。
|
|
|
+ バックスラッシュの後に2桁の数字が続くと、いずれも対応する文字に変換します。
|
|
|
+ </entry>
|
|
|
+ </row>
|
|
|
+ </tbody>
|
|
|
+ </tgroup>
|
|
|
+ </table>
|
|
|
+</sect3>
|