mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +00:00
3e54df359b
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@339913 c90b9560-bf6c-de11-be94-00142212c4b1
81 lines
2.3 KiB
XML
81 lines
2.3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.ldap-explode-dn" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ldap_explode_dn</refname>
|
|
<refpurpose>Splits DN into its component parts</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>ldap_explode_dn</methodname>
|
|
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>with_attrib</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Splits the DN returned by <function>ldap_get_dn</function> and breaks it
|
|
up into its component parts. Each part is known as Relative Distinguished
|
|
Name, or RDN.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>dn</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The distinguished name of an LDAP entity.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>with_attrib</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Used to request if the RDNs are returned with only values or their
|
|
attributes as well. To get RDNs with the attributes (i.e. in
|
|
attribute=value format) set <parameter>with_attrib</parameter> to 0
|
|
and to get only values set it to 1.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns an array of all DN components, &return.falseforfailure;.
|
|
The first element in the array has <literal>count</literal> key and
|
|
represents the number of returned values, next elements are numerically
|
|
indexed DN components.
|
|
</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
|
|
-->
|