API Documentation
\

\Horde_Kolab_Server_Object_Interface

Interface describing Kolab objects stored in the server database.

Copyright 2008-2017 Horde LLC (http://www.horde.org/)

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

Summary

Methods
Constants
getGuid()
getExternalAttributes()
getInternalAttributes()
exists()
readInternal()
getInternal()
getExternal()
save()
delete()
generateId()
prepareObjectInformation()
getActions()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getGuid()

getGuid() : string

Get the GUID of this object

Returns

string —

the GUID of this object

getExternalAttributes()

getExternalAttributes() : array

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.

getInternalAttributes()

getInternalAttributes() : array

Get the internal attributes supported by this object.

Returns

array —

The internal attributes supported by this object.

exists()

exists() : boolean

Does the object exist?

Returns

boolean —

True if the object exists, false otherwise.

readInternal()

readInternal() : array

Read the object into the cache

Returns

array —

The read data.

getInternal()

getInternal(array  $attributes) : array

Get the specified internal attributes.

Parameters

array $attributes

The internal attribute.

Returns

array —

The value(s) of these attribute

getExternal()

getExternal(string  $attr) : mixed

Get the specified attribute of this object.

Parameters

string $attr

The attribute to read.

Returns

mixed —

The value of this attribute.

save()

save(array  $info) : NULL

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

array $info

The information about the object.

Throws

\Horde_Kolab_Server_Exception

If saving the data failed.

Returns

NULL

delete()

delete() : NULL

Delete this object.

Throws

\Horde_Kolab_Server_Exception

If deleting the object failed.

Returns

NULL

generateId()

generateId(array  $info) : string

Generates an ID for the given information.

Parameters

array $info

Returns

string —

The ID.

prepareObjectInformation()

prepareObjectInformation(array  $info) : \NULL.

Distill the server side object information to save.

Parameters

array $info

Throws

\Horde_Kolab_Server_Exception

If the given information contains errors.

Returns

\NULL.

getActions()

getActions() : array

Returns the set of actions supported by this object type.

Returns

array —

An array of supported actions.