API Documentation
\

\Horde_Dav_Storage_Base

Base class for storage backends.

This is not for DAV content storage, but for metadata storage.

Summary

Methods
Properties
Constants
addObjectMap()
addCollectionMap()
getInternalObjectId()
getExternalObjectId()
getInternalCollectionId()
getExternalCollectionId()
getCollectionInterface()
deleteInternalObjectId()
deleteExternalObjectId()
deleteInternalCollectionId()
deleteExternalCollectionId()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

addObjectMap()

addObjectMap(string  $internal, string  $external, string  $collection)

Adds an object ID map to the backend storage.

Parameters

string $internal

An internal object ID.
string $external

An external object ID.
string $collection

The collection of an object.

Throws

\Horde_Dav_Exception

addCollectionMap()

addCollectionMap(string  $internal, string  $external, string  $interface)

Adds a collection ID map to the backend storage.

Parameters

string $internal

An internal collection ID.
string $external

An external collection ID.
string $interface

The collection's application.

Throws

\Horde_Dav_Exception

getInternalObjectId()

getInternalObjectId(string  $external, string  $collection) : string

Returns an internal ID from a stored object ID map.

Parameters

string $external

An external object ID.
string $collection

The collection of an object.

Throws

\Horde_Dav_Exception

Returns

string —

The object's internal ID or null.

getExternalObjectId()

getExternalObjectId(string  $internal, string  $collection) : string

Returns an external ID from a stored object ID map.

Parameters

string $internal

An internal object ID.
string $collection

The collection of an object.

Throws

\Horde_Dav_Exception

Returns

string —

The object's external ID or null.

getInternalCollectionId()

getInternalCollectionId(string  $external, string  $interface) : string

Returns an internal ID from a stored collection ID map.

Parameters

string $external

An external collection ID.
string $interface

The collection's application.

Throws

\Horde_Dav_Exception

Returns

string —

The collection's internal ID or null.

getExternalCollectionId()

getExternalCollectionId(string  $internal, string  $interface) : string

Returns an external ID from a stored collection ID map.

Parameters

string $internal

An internal collection ID.
string $interface

The collection's application.

Throws

\Horde_Dav_Exception

Returns

string —

The collection's external ID.

getCollectionInterface()

getCollectionInterface(string  $external) : string

Returns an interface name from a stored collection ID map.

Parameters

string $external

An external collection ID.

Throws

\Horde_Dav_Exception

Returns

string —

The collection's application.

deleteInternalObjectId()

deleteInternalObjectId(string  $internal, string  $collection)

Deletes an ID map from the backend storage.

Parameters

string $internal

An internal object ID.
string $collection

The collection of an object.

Throws

\Horde_Dav_Exception

deleteExternalObjectId()

deleteExternalObjectId(string  $external, string  $collection)

Deletes an ID map from the backend storage.

Parameters

string $external

An external object ID.
string $collection

The collection of an object.

Throws

\Horde_Dav_Exception

deleteInternalCollectionId()

deleteInternalCollectionId(string  $internal, string  $interface)

Deletes an ID map from the backend storage.

Parameters

string $internal

An internal collection ID.
string $interface

The collection's application.

Throws

\Horde_Dav_Exception

deleteExternalCollectionId()

deleteExternalCollectionId(string  $external, string  $interface)

Deletes an ID map from the backend storage.

Parameters

string $external

An external collection ID.
string $interface

The collection's application.

Throws

\Horde_Dav_Exception