\Horde_Kolab_Server_Structure_Base

An abstract class definiing methods to deal with an 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.

Summary

Methods
Properties
Constants
find()
findBelow()
setComposite()
getComposite()
getExternalAttributes()
getInternalAttributes()
getInternalAttributesForExternal()
No public properties found
MAX_HIERARCHY
No protected methods found
No protected properties found
N/A
No private methods found
$_composite
N/A

Constants

MAX_HIERARCHY

MAX_HIERARCHY

Maximum accepted level for the object class hierarchy

Properties

Methods

find()

find(\Horde_Kolab_Server_Query_Element  $criteria, array  $params = array()) : \Horde_Kolab_Server_Result

Finds object data matching a given set of criteria.

Parameters

\Horde_Kolab_Server_Query_Element $criteria

The criteria for the search.

array $params

Additional search parameters.

Throws

\Horde_Kolab_Server_Exception

Returns

\Horde_Kolab_Server_Result —

The result object.

findBelow()

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.

Parameters

\Horde_Kolab_Server_Query_Element $criteria

The criteria for the search.

string $parent

The parent to search below.

array $params

Additional search parameters.

Throws

\Horde_Kolab_Server_Exception

Returns

\Horde_Kolab_Server_Result —

The result object.

setComposite()

setComposite(\Horde_Kolab_Server_Composite  $composite) : NULL

Set the composite server reference for this object.

Parameters

\Horde_Kolab_Server_Composite $composite

A link to the composite server handler.

Returns

NULL

getComposite()

getComposite() : \Horde_Kolab_Server_Composite

Get the composite server reference for this object.

Returns

\Horde_Kolab_Server_Composite

A link to the composite server handler.

getExternalAttributes()

getExternalAttributes(string  $class) : array

Return the attributes supported by the given object class.

Parameters

string $class

Determine the attributes for this class.

Throws

\Horde_Kolab_Server_Exception

If the schema analysis fails.

Returns

array —

The supported attributes.

getInternalAttributes()

getInternalAttributes(  $class) : array

Return the internal attributes supported by the given object class.

Parameters

$class

Returns

array —

The supported attributes.

getInternalAttributesForExternal()

getInternalAttributesForExternal(  $class,   $external) 

Parameters

$class
$external