PHP Interface LdapTools\AttributeConverter\AttributeConverterInterface

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

Public Methods

Method Description
fromLdap ( $value ) : mixed Modify the value coming from LDAP so it's easier to work with.
getAttribute ( ) : string Get the name of the attribute being converted.
getBatch ( ) : Batch Get the batch object.
getDn ( ) : string Get the DN of the object with the specific value being converted.
getIsMultiValuedConverter ( ) : boolean Get whether this converter should the full array of attributes passed to it rather than one at a time.
getLastValue ( ) : mixed Get the last value as the result of the value conversion.
getOperationType ( ) : integer Get the LDAP operation type.
getOptions ( ) : array Gets the options that may be recognized by the converter.
getShouldAggregateValues ( ) : boolean Get whether or not this converter should aggregate multiple attributes into one value.
isBatchSupported ( Batch $batch ) : boolean Return whether this batch is a supported type for the converter.
setAttribute ( string $attribute ) Set the name of the attribute being converted.
setBatch ( Batch $batch ) Set the batch object.
setDn ( string $dn ) Set the DN of the object with the specific value being converted.
setIsMultiValuedConverter ( boolean $isMultiValuedConverter ) Set whether this converter should the full array of attributes passed to it rather than one at a time.
setLastValue ( mixed $value ) Set the last value in the case of an aggregate value.
setLdapConnection ( LdapTools\Connection\LdapConnectionInterface $connection ) Sets the current LDAP Connection for use by the converter.
setOperationType ( $type ) Set the LDAP operation type.
setOptions ( array $options ) Sets options that may be recognized by the converter.
setShouldAggregateValues ( boolean $aggregateValues ) Set whether or not this converter should aggregate multiple attributes into one value.
toLdap ( $value ) : mixed Modify the value so it can be understood by LDAP when it gets sent back.

Method Details

fromLdap() public method

Modify the value coming from LDAP so it's easier to work with.
public fromLdap ( $value ) : mixed
$value
return mixed

getAttribute() public method

Get the name of the attribute being converted.
public getAttribute ( ) : string
return string

getBatch() public method

Get the batch object.
public getBatch ( ) : Batch
return LdapTools\BatchModify\Batch

getDn() public method

Get the DN of the object with the specific value being converted.
public getDn ( ) : string
return string

getIsMultiValuedConverter() public method

Get whether this converter should the full array of attributes passed to it rather than one at a time.
public getIsMultiValuedConverter ( ) : boolean
return boolean

getLastValue() public method

Get the last value as the result of the value conversion.
public getLastValue ( ) : mixed
return mixed

getOperationType() public method

Get the LDAP operation type.
public getOperationType ( ) : integer
return integer

getOptions() public method

Gets the options that may be recognized by the converter.
public getOptions ( ) : array
return array

getShouldAggregateValues() public method

Get whether or not this converter should aggregate multiple attributes into one value.
public getShouldAggregateValues ( ) : boolean
return boolean

isBatchSupported() public method

Return whether this batch is a supported type for the converter.
public isBatchSupported ( Batch $batch ) : boolean
$batch LdapTools\BatchModify\Batch
return boolean

setAttribute() public method

Set the name of the attribute being converted.
public setAttribute ( string $attribute )
$attribute string

setBatch() public method

Set the batch object.
public setBatch ( Batch $batch )
$batch LdapTools\BatchModify\Batch

setDn() public method

Set the DN of the object with the specific value being converted.
public setDn ( string $dn )
$dn string

setIsMultiValuedConverter() public method

Set whether this converter should the full array of attributes passed to it rather than one at a time.
public setIsMultiValuedConverter ( boolean $isMultiValuedConverter )
$isMultiValuedConverter boolean

setLastValue() public method

Set the last value in the case of an aggregate value.
public setLastValue ( mixed $value )
$value mixed

setLdapConnection() public method

Sets the current LDAP Connection for use by the converter.
public setLdapConnection ( LdapTools\Connection\LdapConnectionInterface $connection )
$connection LdapTools\Connection\LdapConnectionInterface

setOperationType() public method

Set the LDAP operation type.
public setOperationType ( $type )
$type

setOptions() public method

Sets options that may be recognized by the converter.
public setOptions ( array $options )
$options array

setShouldAggregateValues() public method

Set whether or not this converter should aggregate multiple attributes into one value.
public setShouldAggregateValues ( boolean $aggregateValues )
$aggregateValues boolean

toLdap() public method

Modify the value so it can be understood by LDAP when it gets sent back.
public toLdap ( $value ) : mixed
$value
return mixed