The log decorator for folder lists from Kolab storage.
Copyright 2010-2012 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.
Methods summary
public
|
#
__construct( Horde_Kolab_Storage_List $list, mixed $logger )
Constructor.
Parameters
- $list
- The original list handler.
- $logger
- <p>The log handler. This instance
must provide the debug()
and info() methods.</p>
|
public
Horde_Kolab_Storage_Driver
|
#
getDriver( )
Return the list driver.
Returns
Implementation of
|
public
string
|
#
getId( )
Return the ID of the underlying connection.
Return the ID of the underlying connection.
Returns
string The connection ID.
Implementation of
|
public
array
|
#
getIdParameters( )
Return the connection parameters.
Return the connection parameters.
Returns
array The connection parameters.
Implementation of
|
public
null
|
#
createFolder( string $folder, string $type = null )
Create a new folder.
Parameters
- $folder
- The path of the folder to create.
- $type
- An optional type for the folder.
Returns
null
Implementation of
|
public
null
|
#
deleteFolder( string $folder )
Delete a folder.
Parameters
- $folder
- The path of the folder to delete.
Returns
null
Implementation of
|
public
null
|
#
renameFolder( string $old, string $new )
Rename a folder.
Parameters
- $old
- The old path of the folder.
- $new
- The new path of the folder.
Returns
null
Implementation of
|
public
Horde_Kolab_Storage_Folder
|
#
getFolder( string $folder )
Returns a representation for the requested folder.
Returns a representation for the requested folder.
Parameters
- $folder
- The path of the folder to return.
Returns
Implementation of
|
public
null
|
#
setDefault( string $folder )
Mark the specified folder as the default folder of this type.
Mark the specified folder as the default folder of this type.
Parameters
- $folder
- The path of the folder to mark as default.
Returns
null
Implementation of
|
public
array
|
#
listFolders( )
Returns the list of folders visible to the current user.
Returns the list of folders visible to the current user.
Returns
array The list of folders, represented as a list of strings.
Implementation of
|
public
array
|
#
listFolderTypes( )
Returns the folder type annotation as associative array.
Returns the folder type annotation as associative array.
Returns
array The list folder types with the folder names as key and the
folder type as values.
Implementation of
|
public
Horde_Kolab_Storage_Folder_Namespace
|
#
getNamespace( )
Returns the namespace for the list.
Returns the namespace for the list.
Returns
Implementation of
|
public
string
|
#
getStamp( )
Return the last sync stamp.
Return the last sync stamp.
Returns
string The stamp.
Implementation of
|
public
null
|
#
synchronize( array $params = array() )
Synchronize the list information with the information from the backend.
Synchronize the list information with the information from the backend.
Parameters
- $params
- Additional parameters.
Returns
null
Implementation of
|
public
null
|
#
registerQuery( string $name, Horde_Kolab_Storage_Query $query )
Register a query to be updated if the underlying data changes.
Register a query to be updated if the underlying data changes.
Parameters
- $name
- The query name.
- $query
- The query to register.
Returns
null
Implementation of
|
public
Horde_Kolab_Storage_Query
|
#
getQuery( string $name = null )
Return a registered query.
Return a registered query.
Parameters
Returns
Throws
Implementation of
|