PHP Trait LdapTools\AttributeConverter\AttributeConverterTrait

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

Protected Properties

Property Type Description
$aggregateValues Whether to aggregate multiple attributes assigned to this converter that all map to one attribute.
$attribute The attribute name for the current conversion.
$batch The batch object for the conversion.
$connection LdapTools\Connection\LdapConnectionInterface
$dn string | null
$isMultiValuedConverter Whether the values should be passed one by one to the converter or as an array of the values.
$lastValue When the converter aggregates multiple attributes into a single one, this is the last value set.
$options Any options that may be recognized by the converter.
$type The operation type for this conversion process.

Public Methods

Method Description
getAttribute ( ) : string
getBatch ( ) : Batch
getDn ( ) : string
getIsMultiValuedConverter ( ) : boolean
getLastValue ( ) : mixed
getLdapConnection ( ) : LdapTools\Connection\LdapConnectionInterface | null
getOperationType ( ) : integer
getOptions ( ) : array
getShouldAggregateValues ( ) : boolean
isBatchSupported ( Batch $batch ) : boolean
setAttribute ( $attribute )
setAttributeName ( string $attribute )
setBatch ( Batch $batch )
setDn ( string $dn )
setIsMultiValuedConverter ( $isMultiValuedConverter )
setLastValue ( $value )
setLdapConnection ( LdapTools\Connection\LdapConnectionInterface $connection = null ) Sets the current LdapConnection for access by the converter.
setOperationType ( integer $type )
setOptions ( array $options )
setShouldAggregateValues ( $aggregateValues )

Method Details

getAttribute() public method

public getAttribute ( ) : string
return string

getBatch() public method

public getBatch ( ) : Batch
return LdapTools\BatchModify\Batch

getDn() public method

public getDn ( ) : string
return string

getIsMultiValuedConverter() public method

public getIsMultiValuedConverter ( ) : boolean
return boolean

getLastValue() public method

public getLastValue ( ) : mixed
return mixed

getLdapConnection() public method

public getLdapConnection ( ) : LdapTools\Connection\LdapConnectionInterface | null
return LdapTools\Connection\LdapConnectionInterface | null

getOperationType() public method

public getOperationType ( ) : integer
return integer

getOptions() public method

public getOptions ( ) : array
return array

getShouldAggregateValues() public method

public getShouldAggregateValues ( ) : boolean
return boolean

isBatchSupported() public method

public isBatchSupported ( Batch $batch ) : boolean
$batch LdapTools\BatchModify\Batch
return boolean

setAttribute() public method

public setAttribute ( $attribute )

setAttributeName() public method

public setAttributeName ( string $attribute )
$attribute string

setBatch() public method

public setBatch ( Batch $batch )
$batch LdapTools\BatchModify\Batch

setDn() public method

public setDn ( string $dn )
$dn string

setIsMultiValuedConverter() public method

public setIsMultiValuedConverter ( $isMultiValuedConverter )

setLastValue() public method

public setLastValue ( $value )

setLdapConnection() public method

Sets the current LdapConnection for access by the converter.
public setLdapConnection ( LdapTools\Connection\LdapConnectionInterface $connection = null )
$connection LdapTools\Connection\LdapConnectionInterface

setOperationType() public method

public setOperationType ( integer $type )
$type integer

setOptions() public method

public setOptions ( array $options )
$options array

setShouldAggregateValues() public method

public setShouldAggregateValues ( $aggregateValues )

Property Details

$aggregateValues protected property

Whether to aggregate multiple attributes assigned to this converter that all map to one attribute.
protected $aggregateValues

$attribute protected property

The attribute name for the current conversion.
protected $attribute

$batch protected property

The batch object for the conversion.
protected $batch

$connection protected property

protected LdapConnectionInterface,LdapTools\Connection $connection
return LdapTools\Connection\LdapConnectionInterface

$dn protected property

protected string|null $dn
return string | null

$isMultiValuedConverter protected property

Whether the values should be passed one by one to the converter or as an array of the values.
protected $isMultiValuedConverter

$lastValue protected property

When the converter aggregates multiple attributes into a single one, this is the last value set.
protected $lastValue

$options protected property

Any options that may be recognized by the converter.
protected $options

$type protected property

The operation type for this conversion process.
protected $type