Interface Horde_Kolab_Server_Object_Interface

Interface describing Kolab objects stored in the server database.

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_Object_Base, Horde_Kolab_Server_Object_Hash, Horde_Kolab_Server_Object_Mcached

Indirect known implementers

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/Interface.php

Methods summary
`public string`	# `getGuid( )` Get the GUID of this object Get the GUID of this object Returns `string` the GUID of this object
`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 a list of abbreviated attribute class names.
`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.
`public boolean`	# `exists( )` Does the object exist? Does the object exist? Returns `boolean` True if the object exists, false otherwise.
`public array`	# `readInternal( )` Read the object into the cache Read the object into the cache Returns `array` The read data.
`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
`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.
`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.
`public null`	# `delete( )` Delete this object. Delete this object. Returns `null` Throws `Horde_Kolab_Server_Exception` If deleting the object failed.
`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.
`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.
`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.

Packages

Classes

Interfaces

Interface Horde_Kolab_Server_Object_Interface

Direct known implementers

Indirect known implementers

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

Parameters

Returns

Throws

Returns