PHP Class Horde_Kolab_Storage_List_Tools, horde

Copyright 2012-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Mostra file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Cache $cache, Horde_Log_Logger $logger, array $params = [] ) Constructor.
getId ( ) : string Return the ID of the underlying connection.
getListManipulation ( ) Return the handler for list manipulations.
getListSynchronization ( ) Return the handler for list synchronizations.
getNamespace ( ) : Horde_Kolab_Storage_Folder_Namespace Return the namespace handler for the underlying connection.
getQuery ( string $type = null ) Return a query object.

Private Methods

Method Description
_prepareAclQuery ( array $params = null ) Prepare the ACL query.
_prepareListCache ( ) Setup the list cache.
_prepareListQuery ( array $params = null ) Prepare the general list query.
_prepareManipulationHandler ( ) Setup for the manipulation handler.
_prepareQueries ( ) Setup the queries.
_prepareShareQuery ( array $params = null ) Prepare the query for shares.
_prepareSynchronizationHandler ( ) Setup for the synchronization handler.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Kolab_Storage_Driver $driver, Horde_Kolab_Storage_Cache $cache, Horde_Log_Logger $logger, array $params = [] )
$driver Horde_Kolab_Storage_Driver The backend driver.
$cache Horde_Kolab_Storage_Cache The cache.
$logger Horde_Log_Logger A logger.
$params array

getId() public method

Return the ID of the underlying connection.
public getId ( ) : string
return string The connection ID.

getListManipulation() public method

Return the handler for list manipulations.
public getListManipulation ( )

getListSynchronization() public method

Return the handler for list synchronizations.

getNamespace() public method

Return the namespace handler for the underlying connection.
public getNamespace ( ) : Horde_Kolab_Storage_Folder_Namespace
return Horde_Kolab_Storage_Folder_Namespace The namespace handler.

getQuery() public method

Return a query object.
public getQuery ( string $type = null )
$type string The query type that should be returned.