PHP Class LdapTools\Ldif\LdifEntryBuilder

Author: Chad Sikorra ([email protected])
Show file Open project: ldaptools/ldaptools

Public Methods

Method Description
add ( string $dn = null, array $attributes = [] ) : LdifEntryAdd Create a LDIF add entry type.
delete ( string $dn ) : LdifEntryDelete Create a LDIF delete entry type.
moddn ( string $dn ) : LdifEntryModDn Create a LDIF entry to modify the DN of a LDAP object.
modify ( $dn ) : LdifEntryModify Create a LDIF modify entry type.
move ( string $dn, string $newLocation, boolean $deleteOldRdn = true ) : LdifEntryModDn Create a LDIF entry to move a LDAP object to a new OU/container.
rename ( string $dn, string $name, boolean $deleteOldRdn = false ) : LdifEntryModRdn Create a LDIF entry to rename a LDAP object (the RDN).

Method Details

add() public method

Create a LDIF add entry type.
public add ( string $dn = null, array $attributes = [] ) : LdifEntryAdd
$dn string
$attributes array The attribute [key => value] array to be added.
return LdapTools\Ldif\Entry\LdifEntryAdd

delete() public method

Create a LDIF delete entry type.
public delete ( string $dn ) : LdifEntryDelete
$dn string
return LdapTools\Ldif\Entry\LdifEntryDelete

moddn() public method

Create a LDIF entry to modify the DN of a LDAP object.
public moddn ( string $dn ) : LdifEntryModDn
$dn string The DN to modify.
return LdapTools\Ldif\Entry\LdifEntryModDn

modify() public method

Create a LDIF modify entry type.
public modify ( $dn ) : LdifEntryModify
$dn
return LdapTools\Ldif\Entry\LdifEntryModify

move() public method

Create a LDIF entry to move a LDAP object to a new OU/container.
public move ( string $dn, string $newLocation, boolean $deleteOldRdn = true ) : LdifEntryModDn
$dn string The DN for the LDAP object to move.
$newLocation string The DN of the new location.
$deleteOldRdn boolean Whether or not the old RDN should be deleted.
return LdapTools\Ldif\Entry\LdifEntryModDn

rename() public method

Create a LDIF entry to rename a LDAP object (the RDN).
public rename ( string $dn, string $name, boolean $deleteOldRdn = false ) : LdifEntryModRdn
$dn string
$name string The new name.
$deleteOldRdn boolean Whether or not the old RDN should be deleted.
return LdapTools\Ldif\Entry\LdifEntryModRdn