API Documentation
\

\Horde_Kolab_Server_Schema_Base

This class handles the db schema.

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
Properties
Constants
setComposite()
getObjectclassSchema()
getAttributeSchema()
getExternalAttributes()
shutdown()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$_composite
N/A

Properties

Methods

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

getObjectclassSchema()

getObjectclassSchema(string  $objectclass) : array

Return the schema for the given objectClass.

Parameters

string $objectclass

Fetch the schema for this objectClass.

Throws

\Horde_Kolab_Server_Exception

If retrieval of the schema failed.

Returns

array —

The schema for the given objectClass.

getAttributeSchema()

getAttributeSchema(string  $attribute) : array

Return the schema for the given attribute.

Parameters

string $attribute

Fetch the schema for this attribute.

Throws

\Horde_Kolab_Server_Exception

If retrieval of the schema failed.

Returns

array —

The schema for the given attribute.

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.

shutdown()

shutdown() : \Horde_Kolab_Server

Stores the attribute definitions in the cache.

Returns

\Horde_Kolab_Server —

The concrete Horde_Kolab_Server reference.