PHP Class Horde_Kolab_Server_Decorator_Map, horde

See link: http://pear.horde.org/index.php?package=Kolab_Server

Author: Gunnar Wrobel ([email protected])

Inheritance: implements Horde_Kolab_Server_Interface

Public Methods

Method	Description
__construct ( Horde_Kolab_Server_Interface $server, array $mapping )	Constructor.
add ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null	Add new object data.
connect ( string $user = null, string $pass = null ) : NULL.	Connect to the server. Use this method if the user name you can provide does not match a GUID. In this case it will be required to map this user name first.
connectGuid ( string $guid = '', string $pass = '' ) : NULL.	Connect to the server.
delete ( string $guid ) : null	Delete an object.
find ( string $query, array $params = [] ) : array	Finds object data matching a given set of criteria.
findBelow ( string $query, string $parent, array $params = [] ) : array	Finds all object data below a parent matching a given set of criteria.
getBaseGuid ( ) : string	Get the base GUID of this server
getGuid ( ) : string	Get the current GUID
getParentGuid ( string $guid ) : string	Get the parent GUID of this object.
getSchema ( ) : Horde_Ldap_Schema	Return the ldap schema.
mapField ( array $field ) : The	Map a single attribute key defined within this library into its real world counterpart.
read ( string $guid, array $attrs = [] ) : array	Low level access to reading object data.
readAttributes ( string $guid, array $attrs ) : array	Low level access to reading some object attributes.
rename ( string $guid, string $new ) : null	Rename an object.
save ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null	Modify existing object data.

Protected Methods

Method	Description
mapAttributes ( &$data ) : null	Map attributes defined within this library into their real world counterparts.
mapKeys ( &$keys ) : null	Map attribute keys defined within this library into their real world counterparts.
unmapAttributes ( &$data ) : null	Map attributes defined within this library to their real world counterparts.

Method Details

__construct() public method

Constructor.

public __construct ( Horde_Kolab_Server_Interface $server, array $mapping )
$server	Horde_Kolab_Server_Interface	The base server connection.
$mapping	array	The attribute mapping.

add() public method

Add new object data.

public add ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null
$object	Horde_Kolab_Server_Object_Interface
$data	array	The attributes of the object to be added.
return	null

connect() public method

Connect to the server. Use this method if the user name you can provide does not match a GUID. In this case it will be required to map this user name first.

public connect ( string $user = null, string $pass = null ) : NULL.
$user	string	The user name.
$pass	string	The password.
return	NULL.

connectGuid() public method

Connect to the server.

public connectGuid ( string $guid = '', string $pass = '' ) : NULL.
$guid	string	The global unique id of the user.
$pass	string	The password.
return	NULL.

delete() public method

Delete an object.

public delete ( string $guid ) : null
$guid	string	The GUID of the object to be deleted.
return	null

find() public method

Finds object data matching a given set of criteria.

public find ( string $query, array $params = [] ) : array
$query	string	The LDAP search query
$params	array	Additional search parameters.
return	array	The result array.

findBelow() public method

Finds all object data below a parent matching a given set of criteria.

public findBelow ( string $query, string $parent, array $params = [] ) : array
$query	string	The LDAP search query
$parent	string	The parent to search below.
$params	array	Additional search parameters.
return	array	The result array.

getBaseGuid() public method

Get the base GUID of this server

public getBaseGuid ( ) : string
return	string	The base GUID of this server.

getGuid() public method

Get the current GUID

public getGuid ( ) : string
return	string	The GUID of the connected user.

getParentGuid() public method

Get the parent GUID of this object.

public getParentGuid ( string $guid ) : string
$guid	string	The GUID of the child.
return	string	the parent GUID of this object.

getSchema() public method

Return the ldap schema.

public getSchema ( ) : Horde_Ldap_Schema
return	Horde_Ldap_Schema	The LDAP schema.

mapAttributes() protected method

Map attributes defined within this library into their real world counterparts.

protected mapAttributes ( &$data ) : null
return	null

mapField() public method

Map a single attribute key defined within this library into its real world counterpart.

public mapField ( array $field ) : The
$field	array	The attribute name.
return	The	real name of this attribute on the server we connect to.

mapKeys() protected method

Map attribute keys defined within this library into their real world counterparts.

protected mapKeys ( &$keys ) : null
return	null

read() public method

Low level access to reading object data.

public read ( string $guid, array $attrs = [] ) : array
$guid	string	The object to retrieve.
$attrs	array	Restrict to these attributes.
return	array	An array of attributes.

readAttributes() public method

Low level access to reading some object attributes.

rename() public method

Rename an object.

public rename ( string $guid, string $new ) : null
$guid	string	The GUID of the object to be renamed.
$new	string	The new GUID of the object.
return	null

save() public method

Modify existing object data.

public save ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null
$object	Horde_Kolab_Server_Object_Interface
$data	array	The attributes of the object to be added.
return	null

unmapAttributes() protected method

Map attributes defined within this library to their real world counterparts.

protected unmapAttributes ( &$data ) : null
return	null

public readAttributes ( string $guid, array $attrs ) : array
$guid	string	The object to retrieve.
$attrs	array	Restrict to these attributes.
return	array	An array of attributes.