Files
php-doc-ru/reference/ldap/functions/ldap-get-values.xml
2021-01-03 21:01:46 +03:00

150 lines
5.2 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 76f8c0151d9a99d2f96e154da050e64305862b21 Maintainer: bfl Status: ready -->
<!-- Reviewed: yes Maintainer: lex -->
<!-- $Revision$ -->
<refentry xml:id="function.ldap-get-values" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ldap_get_values</refname>
<refpurpose>Получает все значения из записи результата</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>array</type><type>false</type></type><methodname>ldap_get_values</methodname>
<methodparam><type>resource</type><parameter>ldap</parameter></methodparam>
<methodparam><type>resource</type><parameter>entry</parameter></methodparam>
<methodparam><type>string</type><parameter>attribute</parameter></methodparam>
</methodsynopsis>
<para>
Читает все значения атрибута в записи результата.
</para>
<para>
Эта функция требует <parameter>entry</parameter>,
а следовательно, перед ней должны быть запущена одна из функций
ldap поиска и один из результатов их вызова для получения отдельной
записи.
</para>
<para>
В создаваемом приложении необходимо будет использовать сложные конструкции
для поиска определённых атрибутов (таких как "фамилия" или "почта")
или необходимо будет использовать функцию <function>ldap_get_attributes</function>,
чтобы разобрать, какие атрибуты существуют для данной записи.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ldap</parameter></term>
<listitem>
<para>
Идентификатор ссылки LDAP, возвращенный <function>ldap_connect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>entry</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>attribute</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает массив значений для атрибута в случае успеха, и &false;
в случае ошибки. Число значений может быть найдено по индексу
"count" в результирующем массиве. Отдельные значения могут быть
доступны по целочисленным индексам в массиве.
Первый индекс 0.
</para>
<para>
LDAP позволяет хранить больше чем одну запись для атрибута, таким
образом, можно, например, сохранить много адресов электронной почты
для записи каталога одного человека, все маркированные атрибутом
"mail"
<informalexample>
<literallayout>
return_value["count"] = число значений атрибута
return_value[0] = первое значение атрибута
return_value[i] = i-ое значение атрибута <!-- yaspeller ignore -->
</literallayout>
</informalexample>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Список всех значений атрибута "mail" для записи каталога</title>
<programlisting role="php">
<![CDATA[
<?php
// $ds верный идентификатор ссылки на сервер директории
// $sr верный результат поиска в директории ldap
// $entry верный идентификатор записи из вызова функции
// вернувшей запись директории
$values = ldap_get_values($ds, $entry, "mail");
echo $values["count"] . " адреса email для этой записи.<br />";
for ($i=0; $i < $values["count"]; $i++) {
echo $values[$i] . "<br />";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ldap_get_values_len</function></member>
</simplelist>
</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
-->