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

Class Horde_Kolab_Server_Object_Hash

Provides array access to Kolab objects.

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.

Horde_Kolab_Server_Object_Hash implements Horde_Kolab_Server_Object_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/Object/Hash.php
Methods summary
public
# __construct( Horde_Kolab_Server_Object_Interface $object )

Initialize the Kolab Object. Provide either the GUID

Initialize the Kolab Object. Provide either the GUID

Parameters

$object
The represented object.
public string
# getGuid( )

Get the GUID of this object

Get the GUID of this object

Returns

string
the GUID of this object

Implementation of

Horde_Kolab_Server_Object_Interface::getGuid()
public array
# getExternalAttributes( )

Get the external attributes supported by this object.

Get the external attributes supported by this object.

Returns

array

The external attributes supported by this object. This is an association of attribute names and attribute handler class names.

Implementation of

Horde_Kolab_Server_Object_Interface::getExternalAttributes()
public array
# getInternalAttributes( )

Get the internal attributes supported by this object.

Get the internal attributes supported by this object.

Returns

array
The internal attributes supported by this object.

Implementation of

Horde_Kolab_Server_Object_Interface::getInternalAttributes()
public null
# exists( )

Does the object exist?

Does the object exist?

Returns

null

Implementation of

Horde_Kolab_Server_Object_Interface::exists()
public array
# readInternal( )

Read the object into the cache

Read the object into the cache

Returns

array
The read data.

Implementation of

Horde_Kolab_Server_Object_Interface::readInternal()
public array
# getInternal( array $attributes )

Get the specified internal attributes.

Get the specified internal attributes.

Parameters

$attributes
The internal attribute.

Returns

array
The value(s) of these attribute

Implementation of

Horde_Kolab_Server_Object_Interface::getInternal()
public mixed
# getExternal( string $attr )

Get the specified attribute of this object.

Get the specified attribute of this object.

Parameters

$attr
The attribute to read.

Returns

mixed
The value of this attribute.

Implementation of

Horde_Kolab_Server_Object_Interface::getExternal()
public mixed
# getSingle( string $attr )

Get the specified attribute of this object and ensure that only a single value is being returned.

Get the specified attribute of this object and ensure that only a single value is being returned.

Parameters

$attr
The attribute to read.

Returns

mixed
The value of this attribute.
public array|PEAR_Error
# toHash( array $attrs = array(), boolean $single = true )

Convert the object attributes to a hash.

Convert the object attributes to a hash.

Parameters

$attrs
The attributes to return.
$single
Should only a single attribute be returned?

Returns

array|PEAR_Error
The hash representing this object.
public null
# save( array $info )

Saves object information. This may either create a new entry or modify an existing entry.

Saves object information. This may either create a new entry or modify an existing entry.

Please note that fields with multiple allowed values require the callee to provide the full set of values for the field. Any old values that are not resubmitted will be considered to be deleted.

Parameters

$info
The information about the object.

Returns

null

Throws

Horde_Kolab_Server_Exception
If saving the data failed.

Implementation of

Horde_Kolab_Server_Object_Interface::save()
public null
# delete( )

Delete this object.

Delete this object.

Returns

null

Throws

Horde_Kolab_Server_Exception
If deleting the object failed.

Implementation of

Horde_Kolab_Server_Object_Interface::delete()
public string
# generateId( array & $info )

Generates an ID for the given information.

Generates an ID for the given information.

Parameters

$info
$info The data of the object.

Returns

string
The ID.

Implementation of

Horde_Kolab_Server_Object_Interface::generateId()
public NULL.
# prepareObjectInformation( array & $info )

Distill the server side object information to save.

Distill the server side object information to save.

Parameters

$info
$info The information about the object.

Returns

NULL.

Throws

Horde_Kolab_Server_Exception
If the given information contains errors.

Implementation of

Horde_Kolab_Server_Object_Interface::prepareObjectInformation()
public array
# getActions( )

Returns the set of actions supported by this object type.

Returns the set of actions supported by this object type.

Returns

array
An array of supported actions.

Implementation of

Horde_Kolab_Server_Object_Interface::getActions()
API documentation generated by ApiGen