Overview

Packages

  • Kolab
    • Server

Classes

  • Horde_Kolab_Server_Composite
  • Horde_Kolab_Server_Connection_File
  • Horde_Kolab_Server_Connection_Mock
  • Horde_Kolab_Server_Connection_Mock_Ldap
  • Horde_Kolab_Server_Connection_Mock_Search
  • Horde_Kolab_Server_Connection_Simpleldap
  • Horde_Kolab_Server_Connection_Splittedldap
  • Horde_Kolab_Server_Decorator_Clean
  • Horde_Kolab_Server_Decorator_Count
  • Horde_Kolab_Server_Decorator_Log
  • Horde_Kolab_Server_Decorator_Map
  • Horde_Kolab_Server_Exception
  • Horde_Kolab_Server_Exception_Bindfailed
  • Horde_Kolab_Server_Exception_Novalue
  • Horde_Kolab_Server_Factory
  • Horde_Kolab_Server_Ldap
  • Horde_Kolab_Server_Ldap_Changes
  • Horde_Kolab_Server_Ldap_Filtered
  • Horde_Kolab_Server_Ldap_Standard
  • Horde_Kolab_Server_List_Base
  • Horde_Kolab_Server_Object_Attribute_Base
  • Horde_Kolab_Server_Object_Attribute_Createtimestamp
  • Horde_Kolab_Server_Object_Attribute_Createtimestampdate
  • Horde_Kolab_Server_Object_Attribute_Decorator
  • Horde_Kolab_Server_Object_Attribute_Default
  • Horde_Kolab_Server_Object_Attribute_Empty
  • Horde_Kolab_Server_Object_Attribute_External
  • Horde_Kolab_Server_Object_Attribute_Field
  • Horde_Kolab_Server_Object_Attribute_Firstnamelastname
  • Horde_Kolab_Server_Object_Attribute_Guid
  • Horde_Kolab_Server_Object_Attribute_Id
  • Horde_Kolab_Server_Object_Attribute_Internal
  • Horde_Kolab_Server_Object_Attribute_Locked
  • Horde_Kolab_Server_Object_Attribute_Modifytimestamp
  • Horde_Kolab_Server_Object_Attribute_Modifytimestampdate
  • Horde_Kolab_Server_Object_Attribute_Objectclass
  • Horde_Kolab_Server_Object_Attribute_Openldapaci
  • Horde_Kolab_Server_Object_Attribute_Required
  • Horde_Kolab_Server_Object_Attribute_Single
  • Horde_Kolab_Server_Object_Attribute_Value
  • Horde_Kolab_Server_Object_Attribute_Writelock
  • Horde_Kolab_Server_Object_Base
  • Horde_Kolab_Server_Object_Factory
  • Horde_Kolab_Server_Object_Groupofnames
  • Horde_Kolab_Server_Object_Hash
  • Horde_Kolab_Server_Object_Inetorgperson
  • Horde_Kolab_Server_Object_Kolab
  • Horde_Kolab_Server_Object_Kolab_Address
  • Horde_Kolab_Server_Object_Kolab_Administrator
  • Horde_Kolab_Server_Object_Kolab_Adminrole
  • Horde_Kolab_Server_Object_Kolab_Distlist
  • Horde_Kolab_Server_Object_Kolab_Domainmaintainer
  • Horde_Kolab_Server_Object_Kolab_Maintainer
  • Horde_Kolab_Server_Object_Kolab_User
  • Horde_Kolab_Server_Object_Kolabgermanbankarrangement
  • Horde_Kolab_Server_Object_Kolabgroupofnames
  • Horde_Kolab_Server_Object_Kolabinetorgperson
  • Horde_Kolab_Server_Object_Kolabpop3account
  • Horde_Kolab_Server_Object_Kolabsharedfolder
  • Horde_Kolab_Server_Object_Mcached
  • Horde_Kolab_Server_Object_Organizationalperson
  • Horde_Kolab_Server_Object_Person
  • Horde_Kolab_Server_Object_Top
  • Horde_Kolab_Server_Objects_Base
  • Horde_Kolab_Server_Query_Element_And
  • Horde_Kolab_Server_Query_Element_Approx
  • Horde_Kolab_Server_Query_Element_Begins
  • Horde_Kolab_Server_Query_Element_Contains
  • Horde_Kolab_Server_Query_Element_Ends
  • Horde_Kolab_Server_Query_Element_Equals
  • Horde_Kolab_Server_Query_Element_Greater
  • Horde_Kolab_Server_Query_Element_Group
  • Horde_Kolab_Server_Query_Element_Less
  • Horde_Kolab_Server_Query_Element_Mapped
  • Horde_Kolab_Server_Query_Element_Not
  • Horde_Kolab_Server_Query_Element_Or
  • Horde_Kolab_Server_Query_Element_Single
  • Horde_Kolab_Server_Query_Ldap
  • Horde_Kolab_Server_Result_Ldap
  • Horde_Kolab_Server_Schema_Base
  • Horde_Kolab_Server_Schema_Decorator_Cache
  • Horde_Kolab_Server_Search_Base
  • Horde_Kolab_Server_Search_Operation_Addressesforuidormail
  • Horde_Kolab_Server_Search_Operation_Attributes
  • Horde_Kolab_Server_Search_Operation_Base
  • Horde_Kolab_Server_Search_Operation_Children
  • Horde_Kolab_Server_Search_Operation_Constraint_Single
  • Horde_Kolab_Server_Search_Operation_Constraint_Strict
  • Horde_Kolab_Server_Search_Operation_Groupsformember
  • Horde_Kolab_Server_Search_Operation_Guid
  • Horde_Kolab_Server_Search_Operation_Guidforalias
  • Horde_Kolab_Server_Search_Operation_Guidforcn
  • Horde_Kolab_Server_Search_Operation_Guidforkolabusers
  • Horde_Kolab_Server_Search_Operation_Guidformail
  • Horde_Kolab_Server_Search_Operation_Guidformailoralias
  • Horde_Kolab_Server_Search_Operation_Guidforuid
  • Horde_Kolab_Server_Search_Operation_Guidforuidormail
  • Horde_Kolab_Server_Search_Operation_Guidforuidormailoralias
  • Horde_Kolab_Server_Search_Operation_Mailforuidormail
  • Horde_Kolab_Server_Search_Operation_Restrictgroups
  • Horde_Kolab_Server_Search_Operation_Restrictkolab
  • Horde_Kolab_Server_Structure_Attribute_Double
  • Horde_Kolab_Server_Structure_Attribute_Value
  • Horde_Kolab_Server_Structure_Base
  • Horde_Kolab_Server_Structure_Kolab
  • Horde_Kolab_Server_Structure_Ldap

Interfaces

  • Horde_Kolab_Server_Connection_Interface
  • Horde_Kolab_Server_Interface
  • Horde_Kolab_Server_List_Interface
  • Horde_Kolab_Server_Object_Attribute_Interface
  • Horde_Kolab_Server_Object_Interface
  • Horde_Kolab_Server_Object_Searches
  • Horde_Kolab_Server_Objects_Interface
  • Horde_Kolab_Server_Query_Element_Interface
  • Horde_Kolab_Server_Query_Interface
  • Horde_Kolab_Server_Result_Interface
  • Horde_Kolab_Server_Schema_Interface
  • Horde_Kolab_Server_Search_Interface
  • Horde_Kolab_Server_Search_Operation_Interface
  • Horde_Kolab_Server_Structure_Attribute_Interface
  • Horde_Kolab_Server_Structure_Interface
  • Overview
  • Package
  • Class
  • Tree

Interface Horde_Kolab_Server_Interface

This class defines the interface of a generic Kolab user database.

Copyright 2008-2012 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.

Direct known implementers

Horde_Kolab_Server_Decorator_Clean, Horde_Kolab_Server_Decorator_Count, Horde_Kolab_Server_Decorator_Log, Horde_Kolab_Server_Decorator_Map, Horde_Kolab_Server_Ldap

Indirect known implementers

Horde_Kolab_Server_Ldap_Filtered, Horde_Kolab_Server_Ldap_Standard
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/Interface.php
Methods summary
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.
public string
# getGuid( )

Get the current GUID

Get the current GUID

Returns

string
The GUID of the currently connected user.
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.
public array
# read( string $guid )

Low level access to reading object data.

Low level access to reading object data.

This function provides direct access to the Server data.

Usually you should use

$object = $server->fetch('a server uid');
  $variable = $object['attribute']

to access object attributes. This is slower but takes special object handling into account (e.g. custom attribute parsing).

Parameters

$guid
The object to retrieve.

Returns

array
An array of attributes.

Throws

Horde_Kolab_Server_Exception
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
public Horde_Kolab_Server_Result
# 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

Horde_Kolab_Server_Result
The result object.

Throws

Horde_Kolab_Server_Exception
public Horde_Kolab_Server_Result
# 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

Horde_Kolab_Server_Result
The result object.

Throws

Horde_Kolab_Server_Exception
public null
# save( Horde_Kolab_Server_Object_Interface $object, array $data )

Modify existing object data.

Modify existing object data.

Parameters

$object
The object to be modified.
$data
<p>The attributes of the object to be stored.</p>

Returns

null

Throws

Horde_Kolab_Server_Exception
public null
# add( Horde_Kolab_Server_Object_Interface $object, array $data )

Add new object data.

Add new object data.

Parameters

$object
The object to be added.
$data
<p>The attributes of the object to be added.</p>

Returns

null

Throws

Horde_Kolab_Server_Exception
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
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
public array
# getSchema( )

Return the database schema description.

Return the database schema description.

Returns

array
The schema.

Throws

Horde_Kolab_Server_Exception
If retrieval of the schema failed.
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.
API documentation generated by ApiGen