• Home
  • Horde_Kolab_Server_Decorator_Clean

PHP Class Horde_Kolab_Server_Decorator_Clean, horde

Copyright 2008-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
See link: http://pear.horde.org/index.php?package=Kolab_Server
Author: Gunnar Wrobel ([email protected])
Inheritance: implements Horde_Kolab_Server_Interface
Datei anzeigen Open project: horde/horde

Public Methods

Method Description
__construct ( Horde_Kolab_Server_Interface $server ) Constructor.
__destruct ( ) Destructor.
add ( Horde_Kolab_Server_Object_Interface $object, array $data ) : null Add new object data.
cleanup ( ) Cleanup the server.
connectGuid ( string $guid = null, string $pass = null ) : NULL. Connect to the server.
delete ( string $guid ) : null Delete an object.
find ( string $query, array $params = [] ) : Horde_Kolab_Server_Result Finds object data matching a given set of criteria.
findBelow ( string $query, string $parent, array $params = [] ) : Horde_Kolab_Server_Result 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.
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.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Server_Interface $server )
$server Horde_Kolab_Server_Interface The base server connection.

__destruct() public method

Destructor.
public __destruct ( )

add() public method

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

cleanup() public method

Cleanup the server.
public cleanup ( )

connectGuid() public method

Connect to the server.
public connectGuid ( string $guid = null, string $pass = null ) : 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 = [] ) : Horde_Kolab_Server_Result
$query string The LDAP search query
$params array Additional search parameters.
return Horde_Kolab_Server_Result The result object.

findBelow() public method

Finds all object data below a parent matching a given set of criteria.
public findBelow ( string $query, string $parent, array $params = [] ) : Horde_Kolab_Server_Result
$query string The LDAP search query
$parent string The parent to search below.
$params array Additional search parameters.
return Horde_Kolab_Server_Result The result object.

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.

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.
See also: Horde_Kolab_Server::read
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.

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 The object to be modified.
$data array The attributes of the object to be stored.
return null