PHP Class LdapTools\BatchModify\Batch

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

Protected Properties

Property Type Description
$attribute The attribute name the batch action will modify.
$modtype The batch modification type to perform.
$values The values for the batch action.

Public Methods

Method Description
__construct ( integer $modtype, string $attribute, array $values = [] )
getAttribute ( ) : string Get the attribute for this batch.
getModType ( ) : integer Get the modtype for this batch.
getValues ( ) : array Get the values for this batch action.
isTypeAdd ( ) : boolean A convenience function to check if this batch type is an ADD action.
isTypeRemove ( ) : boolean A convenience function to check if this batch type is a REMOVE action.
isTypeRemoveAll ( ) : boolean A convenience function to check if this batch type is a REMOVE_ALL action.
isTypeReplace ( ) : boolean A convenience function to check if this batch type is a REPLACE action.
setAttribute ( string $attribute ) Set the attribute for this batch.
setModType ( integer $modtype ) Set the modtype for this batch.
setValues ( $values ) Set the values for this batch.
toArray ( ) : array Get the array representation of this batch action.

Protected Methods

Method Description
isType ( string $type ) : boolean Checks of this is a specific modtype.
resolve ( array $values ) : array Allows for an anonymous function to produce the final value.

Method Details

__construct() public method

public __construct ( integer $modtype, string $attribute, array $values = [] )
$modtype integer
$attribute string
$values array

getAttribute() public method

Get the attribute for this batch.
public getAttribute ( ) : string
return string

getModType() public method

Get the modtype for this batch.
public getModType ( ) : integer
return integer

getValues() public method

Get the values for this batch action.
public getValues ( ) : array
return array

isType() protected method

Checks of this is a specific modtype.
protected isType ( string $type ) : boolean
$type string
return boolean

isTypeAdd() public method

A convenience function to check if this batch type is an ADD action.
public isTypeAdd ( ) : boolean
return boolean

isTypeRemove() public method

A convenience function to check if this batch type is a REMOVE action.
public isTypeRemove ( ) : boolean
return boolean

isTypeRemoveAll() public method

A convenience function to check if this batch type is a REMOVE_ALL action.
public isTypeRemoveAll ( ) : boolean
return boolean

isTypeReplace() public method

A convenience function to check if this batch type is a REPLACE action.
public isTypeReplace ( ) : boolean
return boolean

resolve() protected method

Allows for an anonymous function to produce the final value.
protected resolve ( array $values ) : array
$values array
return array

setAttribute() public method

Set the attribute for this batch.
public setAttribute ( string $attribute )
$attribute string

setModType() public method

Set the modtype for this batch.
public setModType ( integer $modtype )
$modtype integer

setValues() public method

Set the values for this batch.
public setValues ( $values )
$values

toArray() public method

Get the array representation of this batch action.
public toArray ( ) : array
return array

Property Details

$attribute protected property

The attribute name the batch action will modify.
protected $attribute

$modtype protected property

The batch modification type to perform.
protected $modtype

$values protected property

The values for the batch action.
protected $values