PHP Class Adldap\Objects\BatchModification

Show file Open project: adldap2/adldap2 Class Usage Examples

Protected Properties

Property Type Description
$attribute integer | string The attribute of the modification.
$original null The original value of the attribute before modification.
$type integer The modtype integer of the batch modification.
$values array The values of the modification.

Public Methods

Method Description
__construct ( null | string $attribute = null, null | integer $type = null, array $values = [] ) Constructor.
build ( ) : BatchModification Builds the type of modification automatically based on the current and original values.
get ( ) : array | null Returns the built batch modification array.
getAttribute ( ) : string Returns the attribute of the modification.
getOriginal ( ) : mixed Returns the original value of the attribute before modification.
getType ( ) : integer Returns the type of the modification.
getValues ( ) : array Returns the values of the modification.
setAttribute ( string $attribute ) : BatchModification Sets the attribute of the modification.
setOriginal ( null $original = null ) Sets the original value of the attribute before modification.
setType ( integer $type ) : BatchModification Sets the type of the modification.
setValues ( array $values = [] ) : BatchModification Sets the values of the modification.

Method Details

__construct() public method

Constructor.
public __construct ( null | string $attribute = null, null | integer $type = null, array $values = [] )
$attribute null | string
$type null | integer
$values array

build() public method

Builds the type of modification automatically based on the current and original values.
public build ( ) : BatchModification
return BatchModification

get() public method

Returns the built batch modification array.
public get ( ) : array | null
return array | null

getAttribute() public method

Returns the attribute of the modification.
public getAttribute ( ) : string
return string

getOriginal() public method

Returns the original value of the attribute before modification.
public getOriginal ( ) : mixed
return mixed

getType() public method

Returns the type of the modification.
public getType ( ) : integer
return integer

getValues() public method

Returns the values of the modification.
public getValues ( ) : array
return array

setAttribute() public method

Sets the attribute of the modification.
public setAttribute ( string $attribute ) : BatchModification
$attribute string
return BatchModification

setOriginal() public method

Sets the original value of the attribute before modification.
public setOriginal ( null $original = null )
$original null

setType() public method

Sets the type of the modification.
public setType ( integer $type ) : BatchModification
$type integer
return BatchModification

setValues() public method

Sets the values of the modification.
public setValues ( array $values = [] ) : BatchModification
$values array
return BatchModification

Property Details

$attribute protected property

The attribute of the modification.
protected int|string $attribute
return integer | string

$original protected property

The original value of the attribute before modification.
protected null $original
return null

$type protected property

The modtype integer of the batch modification.
protected int $type
return integer

$values protected property

The values of the modification.
protected array $values
return array