Horde_Kolab_Storage_List_Tools
in package
Manages and provides the toolset available for dealing with the list of Kolab folders.
Tags
Table of Contents
- QUERY_ACL = 'Acl'
- Identifies the ACL query
- QUERY_BASE = 'List'
- Identifies the basic list query
- QUERY_SHARE = 'Share'
- Identifies the share query
- $_cache : Horde_Kolab_Storage_Cache
- The Kolab Storage data cache.
- $_driver : Horde_Kolab_Storage_Driver
- The driver for accessing the Kolab storage system.
- $_list_cache : Horde_Kolab_Storage_List_Cache
- The list specific cache.
- $_logger : Horde_Log_Logger
- A logger.
- $_manipulation : Horde_Kolab_Storage_List_Manipulation
- The handler for list manipulations.
- $_params : array<string|int, mixed>
- Parameters for constructing the various tools.
- $_queries : array<string|int, mixed>
- The queries currently registered.
- $_supported_queries : mixed
- The collection of list queries currently supported
- $_synchronization : Horde_Kolab_Storage_List_Synchronization
- The handler for synchronizing with the backend.
- __construct() : mixed
- Constructor.
- getId() : string
- Return the ID of the underlying connection.
- getListManipulation() : mixed
- Return the handler for list manipulations.
- getListSynchronization() : mixed
- Return the handler for list synchronizations.
- getNamespace() : Horde_Kolab_Storage_Folder_Namespace
- Return the namespace handler for the underlying connection.
- getQuery() : mixed
- Return a query object.
- _prepareAclQuery() : mixed
- Prepare the ACL query.
- _prepareListCache() : mixed
- Setup the list cache.
- _prepareListQuery() : mixed
- Prepare the general list query.
- _prepareManipulationHandler() : mixed
- Setup for the manipulation handler.
- _prepareQueries() : mixed
- Setup the queries.
- _prepareShareQuery() : mixed
- Prepare the query for shares.
- _prepareSynchronizationHandler() : mixed
- Setup for the synchronization handler.
Constants
QUERY_ACL
Identifies the ACL query
public
mixed
QUERY_ACL
= 'Acl'
QUERY_BASE
Identifies the basic list query
public
mixed
QUERY_BASE
= 'List'
QUERY_SHARE
Identifies the share query
public
mixed
QUERY_SHARE
= 'Share'
Properties
$_cache
The Kolab Storage data cache.
private
Horde_Kolab_Storage_Cache
$_cache
$_driver
The driver for accessing the Kolab storage system.
private
Horde_Kolab_Storage_Driver
$_driver
$_list_cache
The list specific cache.
private
Horde_Kolab_Storage_List_Cache
$_list_cache
$_logger
A logger.
private
Horde_Log_Logger
$_logger
$_manipulation
The handler for list manipulations.
private
Horde_Kolab_Storage_List_Manipulation
$_manipulation
$_params
Parameters for constructing the various tools.
private
array<string|int, mixed>
$_params
$_queries
The queries currently registered.
private
array<string|int, mixed>
$_queries
$_supported_queries
The collection of list queries currently supported
private
static mixed
$_supported_queries
= array(self::QUERY_BASE, self::QUERY_ACL, self::QUERY_SHARE)
$_synchronization
The handler for synchronizing with the backend.
private
Horde_Kolab_Storage_List_Synchronization
$_synchronization
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Cache $cache, Horde_Log_Logger $logger[, array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $driver : Horde_Kolab_Storage_Driver
-
The backend driver.
- $cache : Horde_Kolab_Storage_Cache
-
The cache.
- $logger : Horde_Log_Logger
-
A logger.
- $params : array<string|int, mixed> = array()
Return values
mixed —getId()
Return the ID of the underlying connection.
public
getId() : string
Return values
string —The connection ID.
getListManipulation()
Return the handler for list manipulations.
public
getListManipulation() : mixed
Return values
mixed —getListSynchronization()
Return the handler for list synchronizations.
public
getListSynchronization() : mixed
Return values
mixed —getNamespace()
Return the namespace handler for the underlying connection.
public
getNamespace() : Horde_Kolab_Storage_Folder_Namespace
Return values
Horde_Kolab_Storage_Folder_Namespace —The namespace handler.
getQuery()
Return a query object.
public
getQuery([string $type = null ]) : mixed
Parameters
- $type : string = null
-
The query type that should be returned.
Return values
mixed —_prepareAclQuery()
Prepare the ACL query.
private
_prepareAclQuery([array<string|int, mixed> $params = null ]) : mixed
Parameters
- $params : array<string|int, mixed> = null
-
Query specific configuration parameters.
Return values
mixed —_prepareListCache()
Setup the list cache.
private
_prepareListCache() : mixed
Return values
mixed —_prepareListQuery()
Prepare the general list query.
private
_prepareListQuery([array<string|int, mixed> $params = null ]) : mixed
Parameters
- $params : array<string|int, mixed> = null
-
Query specific configuration parameters.
Return values
mixed —_prepareManipulationHandler()
Setup for the manipulation handler.
private
_prepareManipulationHandler() : mixed
Return values
mixed —_prepareQueries()
Setup the queries.
private
_prepareQueries() : mixed
Return values
mixed —_prepareShareQuery()
Prepare the query for shares.
private
_prepareShareQuery([array<string|int, mixed> $params = null ]) : mixed
Parameters
- $params : array<string|int, mixed> = null
-
Query specific configuration parameters.
Return values
mixed —_prepareSynchronizationHandler()
Setup for the synchronization handler.
private
_prepareSynchronizationHandler() : mixed