The interface definition for the handlers dealing with the Kolab Server object tree structure.
Copyright 2009-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.
find(\Horde_Kolab_Server_Query_Element $criteria, array $params = array()) : \Horde_Kolab_Server_Result
Finds object data matching a given set of criteria.
| \Horde_Kolab_Server_Query_Element | $criteria | The criteria for the search. |
| array | $params | Additional search parameters. |
The result object.
findBelow(\Horde_Kolab_Server_Query_Element $criteria, string $parent, array $params = array()) : \Horde_Kolab_Server_Result
Finds all object data below a parent matching a given set of criteria.
| \Horde_Kolab_Server_Query_Element | $criteria | The criteria for the search. |
| string | $parent | The parent to search below. |
| array | $params | Additional search parameters. |
The result object.
setComposite(\Horde_Kolab_Server_Composite $composite) : NULL
Set the composite server reference for this object.
| \Horde_Kolab_Server_Composite | $composite | A link to the composite server handler. |
getExternalAttributes(\Horde_Kolab_Server_Object $object) : array
Return the external attributes supported by the given object class.
| \Horde_Kolab_Server_Object | $object | Determine the external attributes for this class. |
If the schema analysis fails.
The supported attributes.
getInternalAttributes(\Horde_Kolab_Server_Object $object) : array
Return the internal attributes supported by the given object class.
| \Horde_Kolab_Server_Object | $object | Determine the internal attributes for this class. |
If the schema analysis fails.
The supported attributes.
getExternalAttribute( $name, \Horde_Kolab_Server_Object_Interface $object)
| $name | ||
| \Horde_Kolab_Server_Object_Interface | $object |
determineType(string $guid) : string
Determine the type of an object by its tree position and other parameters.
| string | $guid | The GUID of the object to examine. |
If the object type is unknown.
The class name of the corresponding object type.
generateServerGuid(string $type, string $id, array $info) : string
Generates a UID for the given information.
| string | $type | The class name of the object to create. |
| string | $id | The id of the object. |
| array | $info | Any additional information about the object to create. |
If the given type is unknown.
The GUID.