Class Horde_Kolab_Server_Decorator_Map

A server delegation that maps object attributes.

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Horde_Kolab_Server_Decorator_Map implements Horde_Kolab_Server_Interface

Package: Kolab\Server
Category: Kolab
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_Server
Located at Horde/Kolab/Server/Decorator/Map.php

Methods summary
`public`	# `__construct( Horde_Kolab_Server_Interface $server, array $mapping )` Constructor. Constructor. Parameters `$server` The base server connection. `$mapping` The attribute mapping.
`public NULL.`	# `connect( string $user = null, string $pass = 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. 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. Parameters `$user` The user name. `$pass` The password. Returns `NULL.` Throws `Horde_Kolab_Server_Exception` If the connection failed.
`public NULL.`	# `connectGuid( string $guid = '', string $pass = '' )` Connect to the server. Connect to the server. Parameters `$guid` The global unique id of the user. `$pass` The password. Returns `NULL.` Throws `Horde_Kolab_Server_Exception` If the connection failed. Implementation of `Horde_Kolab_Server_Interface::connectGuid()`
`public string`	# `getGuid( )` Get the current GUID Get the current GUID Returns `string` The GUID of the connected user. Implementation of `Horde_Kolab_Server_Interface::getGuid()`
`public string`	# `getBaseGuid( )` Get the base GUID of this server Get the base GUID of this server Returns `string` The base GUID of this server. Implementation of `Horde_Kolab_Server_Interface::getBaseGuid()`
`public array`	# `read( string $guid, array $attrs = array() )` Low level access to reading object data. Low level access to reading object data. Parameters `$guid` The object to retrieve. `$attrs` Restrict to these attributes. Returns `array` An array of attributes. Throws `Horde_Kolab_Server_Exception` If the search operation hit an error or returned no result. Implementation of `Horde_Kolab_Server_Interface::read()`
`public array`	# `readAttributes( string $guid, array $attrs )` Low level access to reading some object attributes. Low level access to reading some object attributes. Parameters `$guid` The object to retrieve. `$attrs` Restrict to these attributes. Returns `array` An array of attributes. Throws `Horde_Kolab_Server_Exception` See Horde_Kolab_Server::read Implementation of `Horde_Kolab_Server_Interface::readAttributes()`
`public array`	# `find( string $query, array $params = array() )` Finds object data matching a given set of criteria. Finds object data matching a given set of criteria. Parameters `$query` The LDAP search query `$params` Additional search parameters. Returns `array` The result array. Throws `Horde_Kolab_Server_Exception` Implementation of `Horde_Kolab_Server_Interface::find()`
`public array`	# `findBelow( string $query, string $parent, array $params = array() )` Finds all object data below a parent matching a given set of criteria. Finds all object data below a parent matching a given set of criteria. Parameters `$query` The LDAP search query `$parent` The parent to search below. `$params` Additional search parameters. Returns `array` The result array. Throws `Horde_Kolab_Server_Exception` Implementation of `Horde_Kolab_Server_Interface::findBelow()`
`public null`	# `save( Horde_Kolab_Server_Object_Interface $object, array $data )` Modify existing object data. Modify existing object data. Parameters `$object` $guid The GUID of the object to be added. `$data` The attributes of the object to be added. Returns `null` Throws `Horde_Kolab_Server_Exception` Implementation of `Horde_Kolab_Server_Interface::save()`
`public null`	# `add( Horde_Kolab_Server_Object_Interface $object, array $data )` Add new object data. Add new object data. Parameters `$object` $guid The GUID of the object to be added. `$data` The attributes of the object to be added. Returns `null` Throws `Horde_Kolab_Server_Exception` Implementation of `Horde_Kolab_Server_Interface::add()`
`public null`	# `delete( string $guid )` Delete an object. Delete an object. Parameters `$guid` The GUID of the object to be deleted. Returns `null` Throws `Horde_Kolab_Server_Exception` Implementation of `Horde_Kolab_Server_Interface::delete()`
`public null`	# `rename( string $guid, string $new )` Rename an object. Rename an object. Parameters `$guid` The GUID of the object to be renamed. `$new` The new GUID of the object. Returns `null` Throws `Horde_Kolab_Server_Exception` Implementation of `Horde_Kolab_Server_Interface::rename()`
`public Horde_Ldap_Schema`	# `getSchema( )` Return the ldap schema. Return the ldap schema. Returns `Horde_Ldap_Schema` The LDAP schema. Throws `Horde_Kolab_Server_Exception` If retrieval of the schema failed. Implementation of `Horde_Kolab_Server_Interface::getSchema()`
`public The`	# `mapField( array $field )` Map a single attribute key defined within this library into its real world counterpart. Map a single attribute key defined within this library into its real world counterpart. Parameters `$field` The attribute name. Returns `The` real name of this attribute on the server we connect to.
`public string`	# `getParentGuid( string $guid )` Get the parent GUID of this object. Get the parent GUID of this object. Parameters `$guid` The GUID of the child. Returns `string` the parent GUID of this object. Implementation of `Horde_Kolab_Server_Interface::getParentGuid()`

Packages

Classes

Interfaces

Class Horde_Kolab_Server_Decorator_Map

Parameters

Parameters

Returns

Throws

Parameters

Returns

Throws

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

See

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Returns

Throws

Implementation of

Parameters

Returns

Parameters

Returns

Implementation of