-
Notifications
You must be signed in to change notification settings - Fork 70
/
ldap-read.xml
229 lines (224 loc) · 9.77 KB
/
ldap-read.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: b7cbd468cb4c46d55d43a44cade0eb4590d25dea Maintainer: bfl Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ldap-read" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ldap_read</refname>
<refpurpose>Читает запись</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>LDAP\Result</type><type>array</type><type>false</type></type><methodname>ldap_read</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>
Функция выполняет поиск для заданного фильтра <parameter>filter</parameter>
в каталоге в каталоге с областью действия <constant>LDAP_SCOPE_BASE</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>
Пустой фильтр не допустим. Если необходимо получить абсолютно всю информацию
для этой записи, используйте фильтр <literal>objectClass=*</literal>.
Если известно какие типы записи используются на сервере каталогов, то можно
использовать соответствующий фильтр, такой как <literal>objectClass=inetOrgPerson</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>attributes</parameter></term>
<listitem>
<para>
Массив необходимых атрибутов, например, <literal>array("mail", "sn", "cn")</literal>.
Обратите внимание, что "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>4.0.5</entry>
<entry>
Была добавлена поддержка параллельного поиска.
Для более подробной информации смотрите <function>ldap_search</function>.
</entry>
</row>
<row>
<entry>7.3.0</entry>
<entry>
Добавлена поддержка параметра <parameter>controls</parameter>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->