Documentation

Horde_Dav_Storage_Sql extends Horde_Dav_Storage_Base
in package

Implements an SQL based storage backend.

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

Tags
author

Jan Schneider jan@horde.org

category

Horde

copyright

2013-2017 Horde LLC

license

http://www.horde.org/licenses/bsd BSD

Table of Contents

$_db  : Horde_Db_Adapter
Handle for the current database connection.
__construct()  : mixed
Constructor.
addCollectionMap()  : mixed
Adds a collection ID map to the backend storage.
addObjectMap()  : mixed
Adds an object ID map to the backend storage.
deleteExternalCollectionId()  : mixed
Deletes an ID map from the backend storage.
deleteExternalObjectId()  : mixed
Deletes an ID map from the backend storage.
deleteInternalCollectionId()  : mixed
Deletes an ID map from the backend storage.
deleteInternalObjectId()  : mixed
Deletes an ID map from the backend storage.
getCollectionInterface()  : string
Returns an interface name from a stored collection ID map.
getExternalCollectionId()  : string
Returns an external ID from a stored collection ID map.
getExternalObjectId()  : string
Returns an external ID from a stored object ID map.
getInternalCollectionId()  : string
Returns an internal ID from a stored collection ID map.
getInternalObjectId()  : string
Returns an internal ID from a stored object ID map.

Properties

$_db

Handle for the current database connection.

protected Horde_Db_Adapter $_db

Methods

__construct()

Constructor.

public __construct(mixed $params) : mixed
Parameters
$params : mixed
Return values
mixed

addCollectionMap()

Adds a collection ID map to the backend storage.

public addCollectionMap(string $internal, string $external, string $interface) : mixed
Parameters
$internal : string

An internal collection ID.

$external : string

An external collection ID.

$interface : string

The collection's application.

Tags
throws
Horde_Dav_Exception
Return values
mixed

addObjectMap()

Adds an object ID map to the backend storage.

public addObjectMap(string $internal, string $external, string $collection) : mixed
Parameters
$internal : string

An internal object ID.

$external : string

An external object ID.

$collection : string

The collection of an object.

Tags
throws
Horde_Dav_Exception
Return values
mixed

deleteExternalCollectionId()

Deletes an ID map from the backend storage.

public deleteExternalCollectionId(string $external, string $interface) : mixed
Parameters
$external : string

An external collection ID.

$interface : string

The collection's application.

Tags
throws
Horde_Dav_Exception
Return values
mixed

deleteExternalObjectId()

Deletes an ID map from the backend storage.

public deleteExternalObjectId(string $external, string $collection) : mixed
Parameters
$external : string

An external object ID.

$collection : string

The collection of an object.

Tags
throws
Horde_Dav_Exception
Return values
mixed

deleteInternalCollectionId()

Deletes an ID map from the backend storage.

public deleteInternalCollectionId(string $internal, string $interface) : mixed
Parameters
$internal : string

An internal collection ID.

$interface : string

The collection's application.

Tags
throws
Horde_Dav_Exception
Return values
mixed

deleteInternalObjectId()

Deletes an ID map from the backend storage.

public deleteInternalObjectId(string $internal, string $collection) : mixed
Parameters
$internal : string

An internal object ID.

$collection : string

The collection of an object.

Tags
throws
Horde_Dav_Exception
Return values
mixed

getCollectionInterface()

Returns an interface name from a stored collection ID map.

public getCollectionInterface(string $external) : string
Parameters
$external : string

An external collection ID.

Tags
throws
Horde_Dav_Exception
Return values
string

The collection's application.

getExternalCollectionId()

Returns an external ID from a stored collection ID map.

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

An internal collection ID.

$interface : string

The collection's application.

Tags
throws
Horde_Dav_Exception
Return values
string

The collection's external ID.

getExternalObjectId()

Returns an external ID from a stored object ID map.

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

An internal object ID.

$collection : string

The collection of an object.

Tags
throws
Horde_Dav_Exception
Return values
string

The object's external ID or null.

getInternalCollectionId()

Returns an internal ID from a stored collection ID map.

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

An external collection ID.

$interface : string

The collection's application.

Tags
throws
Horde_Dav_Exception
Return values
string

The collection's internal ID or null.

getInternalObjectId()

Returns an internal ID from a stored object ID map.

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

An external object ID.

$collection : string

The collection of an object.

Tags
throws
Horde_Dav_Exception
Return values
string

The object's internal ID or null.

Search results