PHP Interface LdapTools\Hydrator\HydratorInterface

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

Public Methods

Method Description
getLdapObjectSchema ( ) : array Get the LdapObjectSchema that has been set.
getSelectedAttributes ( ) : array Get the attributes that were selected for in the query.
hydrateAllFromLdap ( array $entries ) : mixed Hydrates an array of LDAP entries.
hydrateFromLdap ( array $entry ) : mixed Hydrates a single LDAP entry.
hydrateToLdap ( mixed $object ) : array Hydrates an array representing a LDAP object so it can be sent back to LDAP.
setLdapConnection ( LdapTools\Connection\LdapConnectionInterface $connection = null ) Set the LDAP connection for the context of this hydration.
setLdapObjectSchema ( LdapObjectSchema $schema = null ) Set the LdapObjectSchema object needed for attribute/value conversion.
setOperationType ( integer $type ) Set the LDAP operation type that is requesting this hydration.
setSelectedAttributes ( array $attributes ) If this query is based off a LdapObjectSchema then include the attributes as they were named in the select statement. How they were named in the select statement is how they will be passed back. This also means that any converters applied to the mapped name, but not to the LDAP attribute name, will not be applied.

Method Details

getLdapObjectSchema() public method

Get the LdapObjectSchema that has been set.
public getLdapObjectSchema ( ) : array
return array An array of LdapObjectSchema objects.

getSelectedAttributes() public method

Get the attributes that were selected for in the query.
public getSelectedAttributes ( ) : array
return array

hydrateAllFromLdap() public method

Hydrates an array of LDAP entries.
public hydrateAllFromLdap ( array $entries ) : mixed
$entries array
return mixed

hydrateFromLdap() public method

Hydrates a single LDAP entry.
public hydrateFromLdap ( array $entry ) : mixed
$entry array
return mixed

hydrateToLdap() public method

Hydrates an array representing a LDAP object so it can be sent back to LDAP.
public hydrateToLdap ( mixed $object ) : array
$object mixed
return array

setLdapConnection() public method

Set the LDAP connection for the context of this hydration.
public setLdapConnection ( LdapTools\Connection\LdapConnectionInterface $connection = null )
$connection LdapTools\Connection\LdapConnectionInterface

setLdapObjectSchema() public method

Set the LdapObjectSchema object needed for attribute/value conversion.
public setLdapObjectSchema ( LdapObjectSchema $schema = null )
$schema LdapTools\Schema\LdapObjectSchema

setOperationType() public method

Set the LDAP operation type that is requesting this hydration.
public setOperationType ( integer $type )
$type integer

setSelectedAttributes() public method

If this query is based off a LdapObjectSchema then include the attributes as they were named in the select statement. How they were named in the select statement is how they will be passed back. This also means that any converters applied to the mapped name, but not to the LDAP attribute name, will not be applied.
public setSelectedAttributes ( array $attributes )
$attributes array