php man page for ldap_modify_batch

LDAP_MODIFY_BATCH(3)							 1						      LDAP_MODIFY_BATCH(3)

ldap_modify_batch - Batch and execute modifications on an LDAP entry

SYNOPSIS
       bool ldap_modify_batch (resource  $link_identifier, string  $dn, array  $entry)

DESCRIPTION
	Modifies an existing entry in the LDAP directory. Allows detailed specification of the modifications to perform.

PARAMETERS
	      o $link_identifier
		- An LDAP link identifier, returned by ldap_connect(3).

	      o $dn
		- The distinguished name of an LDAP entity.

	      o $entry
		-  An  array  that  specifies  the modifications to make. Each entry in this array is an associative array with two or three keys:
		attrib maps to the name of the attribute to modify, modtype maps to the type of modification to perform,  and  (depending  on  the
		type  of  modification)  values  maps  to  an array of attribute values relevant to the modification.  Possible values for modtype
		include:

		     o LDAP_MODIFY_BATCH_ADD - Each value specified through values is added (as an additional value) to  the  attribute  named	by
		       attrib.

		     o LDAP_MODIFY_BATCH_REMOVE  - Each value specified through values is removed from the attribute named by attrib. Any value of
		       the attribute not contained in the values array will remain untouched.

		     o LDAP_MODIFY_BATCH_REMOVE_ALL - All values are removed from the attribute named by attrib. A values entry must not  be  pro-
		       vided.

		     o LDAP_MODIFY_BATCH_REPLACE  -  All  current  values  of the attribute named by attrib are replaced with the values specified
		       through values.

	       Note that any value for attrib must be a string, any value for values must be an array of strings, and any value for  modtype  must
	      be one of the LDAP_MODIFY_BATCH_* constants listed above.

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      Add a telephone number to a contact

	      <?php
	      $dn = "cn=John Smith,ou=Wizards,dc=example,dc=com";
	      $modifs = [
		  [
		      "attrib"	=> "telephoneNumber",
		      "modtype" => LDAP_MODIFY_BATCH_ADD,
		      "values"	=> ["+1 555 555 1717"],
		  ],
	      ];
	      ldap_modify_batch($connection, $dn, $modifs);
	      ?>

       Example #2

	      Rename a user

	      <?php
	      $dn = "cn=John Smith,ou=Wizards,dc=example,dc=com";
	      $modifs = [
		  [
		      "attrib"	=> "sn",
		      "modtype" => LDAP_MODIFY_BATCH_REPLACE,
		      "values"	=> ["Smith-Jones"],
		  ],
		  [
		      "attrib"	=> "givenName",
		      "modtype" => LDAP_MODIFY_BATCH_REPLACE,
		      "values"	=> ["Jack"],
		  ],
	      ];
	      ldap_modify_batch($connection, $dn, $modifs);
	      ldap_rename($connection, $dn, "cn=Jack Smith-Jones", NULL, TRUE);
	      ?>

       Example #3

	      Add two e-mail addresses to a user

	      <?php
	      $dn = "cn=Jack Smith-Jones,ou=Wizards,dc=example,dc=com";
	      $modifs = [
		  [
		      "attrib"	=> "mail",
		      "modtype" => LDAP_MODIFY_BATCH_ADD,
		      "values"	=> [
			  "jack.smith@example.com",
			  "jack.smith-jones@example.com",
		      ],
		  ],
	      ];
	      ldap_modify_batch($connection, $dn, $modifs);
	      ?>

       Example #4

	      Change a user's password

	      <?php
	      $dn = "cn=Jack Smith-Jones,ou=Wizards,dc=example,dc=com";
	      $modifs = [
		  [
		      "attrib"	=> "userPassword",
		      "modtype" => LDAP_MODIFY_BATCH_REMOVE,
		      "values"	=> ["Tr0ub4dor&3"],
		  ],
		  [
		      "attrib"	=> "userPassword",
		      "modtype" => LDAP_MODIFY_BATCH_ADD,
		      "values"	=> ["correct horse battery staple"],
		  ],
	      ];
	      ldap_modify_batch($connection, $dn, $modifs);
	      ?>

       Example #5

	      Change a user's password (Active Directory)

	      <?php
	      function adifyPw($pw)
	      {
		  return iconv("UTF-8", "UTF-16LE", '"' . $pw . '"');
	      }

	      $dn = "cn=Jack Smith-Jones,ou=Wizards,dc=ad,dc=example,dc=com";
	      $modifs = [
		  [
		      "attrib"	=> "unicodePwd",
		      "modtype" => LDAP_MODIFY_BATCH_REMOVE,
		      "values"	=> [adifyPw("Tr0ub4dor&3")],
		  ],
		  [
		      "attrib"	=> "unicodePwd",
		      "modtype" => LDAP_MODIFY_BATCH_ADD,
		      "values"	=> [adifyPw("correct horse battery staple")],
		  ],
	      ];
	      ldap_modify_batch($connection, $dn, $modifs);

PHP Documentation Group 												      LDAP_MODIFY_BATCH(3)