php-doc-en/reference/ldap/functions/ldap-mod-add.xml
Christoph Michael Becker 76f8c0151d Update ext/ldap signatures to match PHP-8
Partial merge of <https://github.com/php/doc-en/pull/242>.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351955 c90b9560-bf6c-de11-be94-00142212c4b1
2020-12-08 00:13:38 +00:00

133 lines
3.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ldap-mod-add" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ldap_mod_add</refname>
<refpurpose>Add attribute values to current attributes</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ldap_mod_add</methodname>
<methodparam><type>resource</type><parameter>ldap</parameter></methodparam>
<methodparam><type>string</type><parameter>dn</parameter></methodparam>
<methodparam><type>array</type><parameter>entry</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>controls</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Adds one or more attribute values to the specified <parameter>dn</parameter>.
To add a whole new object see <function>ldap_add</function> function.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ldap</parameter></term>
<listitem>
<para>
An LDAP link identifier, returned by <function>ldap_connect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dn</parameter></term>
<listitem>
<para>
The distinguished name of an LDAP entity.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>entry</parameter></term>
<listitem>
<para>
An associative array listing the attirbute values to add. If an attribute was not existing yet it will be added. If an attribute is existing you can only add values to it if it supports multiple values.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>controls</parameter></term>
<listitem>
<para>
Array of <link linkend="ldap.controls">LDAP Controls</link> to send with the request.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</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.controls-nullable;
<row>
<entry>7.3</entry>
<entry>
Support for <parameter>controls</parameter> added
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.bin-safe;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ldap_mod_add_ext</function></member>
<member><function>ldap_mod_del</function></member>
<member><function>ldap_mod_replace</function></member>
<member><function>ldap_modify_batch</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
-->