PHP Class LdapTools\Operation\RenameOperation

Author: Chad Sikorra ([email protected])
Inheritance: implements LdapTools\Operation\LdapOperationInterface, use trait LdapOperationTrait
Show file Open project: ldaptools/ldaptools

Protected Properties

Property Type Description
$properties array

Public Methods

Method Description
__construct ( string $dn, null | string $newRdn = null, null | string $newLocation = null, boolean $deleteOldRdn = true )
getArguments ( )
getDeleteOldRdn ( ) : null | boolean Get whether or not the old RDN is removed after the operation.
getDn ( ) : null | string The distinguished name for an add, delete, or move operation.
getLdapFunction ( )
getLogArray ( )
getName ( )
getNewLocation ( ) : null | string Get the DN of the container/ou/parent that the object will be moved to.
getNewRdn ( ) : string Get the new RDN that the LDAP object will have.
setDeleteOldRdn ( boolean $delete ) Set whether or not the old RDN is removed after the operation. If your intent is to move the object, then this should be set to true typically.
setDn ( string $dn ) Set the distinguished name that the operation is working on.
setNewLocation ( null | string $dn ) Set the DN of the container/ou/parent that the object will be moved to. If the object is not moving, but rather just being renamed, then this should be set to null.
setNewRdn ( string $rdn ) Set the new RDN that the LDAP object will have (ie. "cn=Foo")

Method Details

__construct() public method

public __construct ( string $dn, null | string $newRdn = null, null | string $newLocation = null, boolean $deleteOldRdn = true )
$dn string The DN of the LDAP object to rename.
$newRdn null | string The new RDN in the form of "CN=NewName"
$newLocation null | string The new container/OU it should be placed. Leave null if only changing the RDN.
$deleteOldRdn boolean Whether the old RDN should be deleted.

getArguments() public method

public getArguments ( )

getDeleteOldRdn() public method

Get whether or not the old RDN is removed after the operation.
public getDeleteOldRdn ( ) : null | boolean
return null | boolean

getDn() public method

The distinguished name for an add, delete, or move operation.
public getDn ( ) : null | string
return null | string

getLdapFunction() public method

public getLdapFunction ( )

getLogArray() public method

public getLogArray ( )

getName() public method

public getName ( )

getNewLocation() public method

Get the DN of the container/ou/parent that the object will be moved to.
public getNewLocation ( ) : null | string
return null | string

getNewRdn() public method

Get the new RDN that the LDAP object will have.
public getNewRdn ( ) : string
return string

setDeleteOldRdn() public method

Set whether or not the old RDN is removed after the operation. If your intent is to move the object, then this should be set to true typically.
public setDeleteOldRdn ( boolean $delete )
$delete boolean

setDn() public method

Set the distinguished name that the operation is working on.
public setDn ( string $dn )
$dn string

setNewLocation() public method

Set the DN of the container/ou/parent that the object will be moved to. If the object is not moving, but rather just being renamed, then this should be set to null.
public setNewLocation ( null | string $dn )
$dn null | string

setNewRdn() public method

Set the new RDN that the LDAP object will have (ie. "cn=Foo")
public setNewRdn ( string $rdn )
$rdn string

Property Details

$properties protected property

protected array $properties
return array