PHP Interface LdapTools\Operation\LdapOperationInterface

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

Public Methods

Method Description
addControl ( variadic $controls ) Add LDAP controls to the operation.
addPostOperation ( variadic $operation ) Add an operation that should be executed after this operation.
addPreOperation ( variadic $operation ) Add an operation that should be executed before this operation.
getArguments ( ) : array Gets an array of arguments that will be passed to the LDAP function for executing this operation.
getControls ( ) : LdapControl[] Get the controls set for the operation.
getLdapFunction ( ) : string Gets the name of the LDAP function needed to execute this operation.
getLogArray ( ) : array Get an array of keys/values related to the operation. This allows for ease of use within a logger.
getName ( ) : string Get the readable name that this operation represents. This is to be used in messages/exceptions.
getPostOperations ( ) : LdapTools\Operation\LdapOperationInterface[] Get operations that should be executed after this operation.
getPreOperations ( ) : LdapTools\Operation\LdapOperationInterface[] Get operations that should be executed before this operation.
getServer ( ) : null | string Get the server that should be used for the operation.
setServer ( string | null $server ) Set the LDAP server that should be used for the operation.

Method Details

addControl() public method

Add LDAP controls to the operation.
public addControl ( variadic $controls )
$controls variadic

addPostOperation() public method

Add an operation that should be executed after this operation.
public addPostOperation ( variadic $operation )
$operation variadic

addPreOperation() public method

Add an operation that should be executed before this operation.
public addPreOperation ( variadic $operation )
$operation variadic

getArguments() public method

Gets an array of arguments that will be passed to the LDAP function for executing this operation.
public getArguments ( ) : array
return array

getControls() public method

Get the controls set for the operation.
public getControls ( ) : LdapControl[]
return LdapTools\Connection\LdapControl[]

getLdapFunction() public method

Gets the name of the LDAP function needed to execute this operation.
public getLdapFunction ( ) : string
return string

getLogArray() public method

Get an array of keys/values related to the operation. This allows for ease of use within a logger.
public getLogArray ( ) : array
return array

getName() public method

Get the readable name that this operation represents. This is to be used in messages/exceptions.
public getName ( ) : string
return string

getPostOperations() public method

Get operations that should be executed after this operation.
public getPostOperations ( ) : LdapTools\Operation\LdapOperationInterface[]
return LdapTools\Operation\LdapOperationInterface[]

getPreOperations() public method

Get operations that should be executed before this operation.
public getPreOperations ( ) : LdapTools\Operation\LdapOperationInterface[]
return LdapTools\Operation\LdapOperationInterface[]

getServer() public method

Get the server that should be used for the operation.
public getServer ( ) : null | string
return null | string

setServer() public method

Set the LDAP server that should be used for the operation.
public setServer ( string | null $server )
$server string | null