Overview

Packages

  • Kolab
    • Storage

Classes

  • Horde_Kolab_Storage_Base
  • Horde_Kolab_Storage_Cache
  • Horde_Kolab_Storage_Cache_Data
  • Horde_Kolab_Storage_Cache_List
  • Horde_Kolab_Storage_Cached
  • Horde_Kolab_Storage_Data_Base
  • Horde_Kolab_Storage_Data_Cached
  • Horde_Kolab_Storage_Data_Decorator_Log
  • Horde_Kolab_Storage_Data_Format_Mime
  • Horde_Kolab_Storage_Data_Modifiable
  • Horde_Kolab_Storage_Data_Old
  • Horde_Kolab_Storage_Data_Parser_Structure
  • Horde_Kolab_Storage_Data_Query_History_Base
  • Horde_Kolab_Storage_Data_Query_History_Cache
  • Horde_Kolab_Storage_Data_Query_Preferences_Base
  • Horde_Kolab_Storage_Data_Query_Preferences_Cache
  • Horde_Kolab_Storage_Decorator_Synchronization
  • Horde_Kolab_Storage_Driver_Base
  • Horde_Kolab_Storage_Driver_Cclient
  • Horde_Kolab_Storage_Driver_Decorator_Base
  • Horde_Kolab_Storage_Driver_Decorator_Log
  • Horde_Kolab_Storage_Driver_Decorator_Timer
  • Horde_Kolab_Storage_Driver_Imap
  • Horde_Kolab_Storage_Driver_Mock
  • Horde_Kolab_Storage_Driver_Mock_Data
  • Horde_Kolab_Storage_Driver_Pear
  • Horde_Kolab_Storage_Driver_Rcube
  • Horde_Kolab_Storage_Exception
  • Horde_Kolab_Storage_Exception_Pear
  • Horde_Kolab_Storage_Factory
  • Horde_Kolab_Storage_Folder_Base
  • Horde_Kolab_Storage_Folder_Decorator_Base
  • Horde_Kolab_Storage_Folder_Decorator_Trigger
  • Horde_Kolab_Storage_Folder_Namespace
  • Horde_Kolab_Storage_Folder_Namespace_Config
  • Horde_Kolab_Storage_Folder_Namespace_Element
  • Horde_Kolab_Storage_Folder_Namespace_Element_Other
  • Horde_Kolab_Storage_Folder_Namespace_Element_Personal
  • Horde_Kolab_Storage_Folder_Namespace_Element_Shared
  • Horde_Kolab_Storage_Folder_Namespace_Element_SharedWithPrefix
  • Horde_Kolab_Storage_Folder_Namespace_Fixed
  • Horde_Kolab_Storage_Folder_Namespace_Imap
  • Horde_Kolab_Storage_Folder_Stamp_Uids
  • Horde_Kolab_Storage_Folder_Type
  • Horde_Kolab_Storage_List_Base
  • Horde_Kolab_Storage_List_Decorator_Cache
  • Horde_Kolab_Storage_List_Decorator_Log
  • Horde_Kolab_Storage_List_Query_Acl_Base
  • Horde_Kolab_Storage_List_Query_Acl_Cache
  • Horde_Kolab_Storage_List_Query_ActiveSync_Base
  • Horde_Kolab_Storage_List_Query_ActiveSync_Cache
  • Horde_Kolab_Storage_List_Query_List_Base
  • Horde_Kolab_Storage_List_Query_List_Cache
  • Horde_Kolab_Storage_List_Query_Share_Base
  • Horde_Kolab_Storage_List_Query_Share_Cache
  • Horde_Kolab_Storage_QuerySet_Base
  • Horde_Kolab_Storage_QuerySet_Cached
  • Horde_Kolab_Storage_QuerySet_Uncached
  • Horde_Kolab_Storage_Synchronization
  • Horde_Kolab_Storage_Translation
  • Horde_Kolab_Storage_Uncached

Interfaces

  • Horde_Kolab_Storage
  • Horde_Kolab_Storage_Data
  • Horde_Kolab_Storage_Data_Format
  • Horde_Kolab_Storage_Data_Parser
  • Horde_Kolab_Storage_Data_Query
  • Horde_Kolab_Storage_Data_Query_History
  • Horde_Kolab_Storage_Data_Query_Preferences
  • Horde_Kolab_Storage_Driver
  • Horde_Kolab_Storage_Folder
  • Horde_Kolab_Storage_Folder_Stamp
  • Horde_Kolab_Storage_List
  • Horde_Kolab_Storage_List_Query
  • Horde_Kolab_Storage_List_Query_Acl
  • Horde_Kolab_Storage_List_Query_ActiveSync
  • Horde_Kolab_Storage_List_Query_List
  • Horde_Kolab_Storage_List_Query_Share
  • Horde_Kolab_Storage_Queriable
  • Horde_Kolab_Storage_Query
  • Horde_Kolab_Storage_QuerySet
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Kolab_Storage_List_Query_List_Base

The basic list query.

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.

Horde_Kolab_Storage_List_Query_List_Base implements Horde_Kolab_Storage_List_Query_List
Package: Kolab\Storage
Category: Kolab
License: LGPL 2.1
Author: Gunnar Wrobel wrobel@pardus.de
Link: http://pear.horde.org/index.php?package=Kolab_Storage
Located at Horde/Kolab/Storage/List/Query/List/Base.php
Methods summary
public
# __construct( Horde_Kolab_Storage_List $list, array $params )

Constructor.

Constructor.

Parameters

$list
The queriable list.
$params
Additional parameters.
public array
# listTypes( )

Returns the folder types as associative array.

Returns the folder types as associative array.

Returns

array

The list folder types with the folder names as key and the type as values.

Implementation of

Horde_Kolab_Storage_List_Query_List::listTypes()
public array
# listFolderTypeAnnotations( )

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 type handler as values.

Implementation of

Horde_Kolab_Storage_List_Query_List::listFolderTypeAnnotations()
public array
# listByType( string $type )

List all folders of a specific type.

List all folders of a specific type.

Parameters

$type
The folder type the listing should be limited to.

Returns

array
The list of folders.

Implementation of

Horde_Kolab_Storage_List_Query_List::listByType()
public array
# dataByType( string $type )

List basic folder data for the folders of a specific type.

List basic folder data for the folders of a specific type.

Parameters

$type
The folder type the listing should be limited to.

Returns

array
The list of folders.

Implementation of

Horde_Kolab_Storage_List_Query_List::dataByType()
public array
# folderData( string $folder )

List basic folder data for the specified folder.

List basic folder data for the specified folder.

Parameters

$folder
The folder path.

Returns

array
The folder data.

Implementation of

Horde_Kolab_Storage_List_Query_List::folderData()
public array
# listOwners( )

Get the folder owners.

Get the folder owners.

Returns

array

The folder owners with the folder names as key and the owner as values.

Implementation of

Horde_Kolab_Storage_List_Query_List::listOwners()
public array
# listPersonalDefaults( )

Return the list of personal default folders.

Return the list of personal default folders.

Returns

array

An array that associates type (key) with the corresponding default folder name (value).
public array
# listDefaults( )

Return the list of default folders.

Return the list of default folders.

Returns

array

An array with owners as keys and another array as value. The second array associates type (key) with the corresponding default folder (value).

Implementation of

Horde_Kolab_Storage_List_Query_List::listDefaults()
public string|boolean
# getDefault( string $type )

Get the default folder for a certain type.

Get the default folder for a certain type.

Parameters

$type
The type of the share/folder.

Returns

string|boolean
The name of the default folder, false if there is no default.

Implementation of

Horde_Kolab_Storage_List_Query_List::getDefault()
public string|boolean
# getForeignDefault( string $owner, string $type )

Get the default folder for a certain type from a different owner.

Get the default folder for a certain type from a different owner.

Parameters

$owner
The folder owner.
$type
The type of the share/folder.

Returns

string|boolean
The name of the default folder, false if there is no default.

Implementation of

Horde_Kolab_Storage_List_Query_List::getForeignDefault()
public null
# createFolder( string $folder, string $type = null )

Create a new folder.

Create a new folder.

Parameters

$folder
The path of the folder to create.
$type
An optional type for the folder.

Returns

null

Implementation of

Horde_Kolab_Storage_List_Query::createFolder()
public null
# deleteFolder( string $folder )

Delete a folder.

Delete a folder.

Parameters

$folder
The path of the folder to delete.

Returns

null

Implementation of

Horde_Kolab_Storage_List_Query::deleteFolder()
public null
# renameFolder( string $old, string $new )

Rename a folder.

Rename a folder.

Parameters

$old
The old path of the folder.
$new
The new path of the folder.

Returns

null

Implementation of

Horde_Kolab_Storage_List_Query::renameFolder()
public string
# getStamp( )

Return the last sync stamp.

Return the last sync stamp.

Returns

string
The stamp.

Implementation of

Horde_Kolab_Storage_List_Query::getStamp()
public null
# synchronize( array $params = array() )

Synchronize the query data with the information from the backend.

Synchronize the query data with the information from the backend.

Parameters

$params
Additional parameters.

Returns

null

Implementation of

Horde_Kolab_Storage_Query::synchronize()
API documentation generated by ApiGen