API Documentation
\

\Horde_Kolab_Storage_List_Query_List_Cache

The cached list query.

Copyright 2010-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
listTypes()
dataByType()
folderData()
listByType()
listOwners()
listDefaults()
getDefault()
getForeignDefault()
getStamp()
__construct()
setDefault()
listPersonalDefaults()
updateAfterCreateFolder()
updateAfterDeleteFolder()
updateAfterRenameFolder()
getDuplicateDefaults()
synchronize()
No public properties found
ANNOTATION_FOLDER_TYPE
TYPES
BY_TYPE
FOLDERS
OWNERS
PERSONAL_DEFAULTS
DEFAULTS
No protected methods found
No protected properties found
N/A
_initQuery()
$_sync
$_list_cache
N/A

Constants

ANNOTATION_FOLDER_TYPE

ANNOTATION_FOLDER_TYPE

The folder type annotation

TYPES

TYPES

The list of folder types

BY_TYPE

BY_TYPE

The folder list sorted by type

FOLDERS

FOLDERS

The list of folder data

OWNERS

OWNERS

The folder owner list

PERSONAL_DEFAULTS

PERSONAL_DEFAULTS

The default folder list for the current user

DEFAULTS

DEFAULTS

The default folder list

Properties

Methods

listTypes()

listTypes() : 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.

dataByType()

dataByType(string  $type) : array

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

Parameters

string $type

The folder type the listing should be limited to.

Returns

array —

The list of folders.

folderData()

folderData(string  $folder) : array

List basic folder data for the specified folder.

Parameters

string $folder

The folder path.

Returns

array —

The folder data.

listByType()

listByType(string  $type) : array

List all folders of a specific type.

Parameters

string $type

The folder type the listing should be limited to.

Returns

array —

The list of folders.

listOwners()

listOwners() : array

Get the folder owners.

Returns

array —

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

listDefaults()

listDefaults() : array

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).

getDefault()

getDefault(string  $type) : string|boolean

Get the default folder for a certain type.

Parameters

string $type

The type of the share/folder.

Returns

string|boolean —

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

getForeignDefault()

getForeignDefault(string  $owner, string  $type) : string|boolean

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

Parameters

string $owner

The folder owner.
string $type

The type of the share/folder.

Returns

string|boolean —

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

getStamp()

getStamp() : string

Return the last sync stamp.

Returns

string —

The stamp.

setDefault()

setDefault(string  $folder)

Set the specified folder as default for its current type.

Parameters

string $folder

The folder name.

listPersonalDefaults()

listPersonalDefaults() : array

Return the list of personal default folders.

Returns

array —

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

updateAfterCreateFolder()

updateAfterCreateFolder(string  $folder, string  $type = null) : NULL

Update the listener after creating a new folder.

Parameters

string $folder

The path of the folder that has been created.
string $type

An optional type for the folder.

Returns

NULL

updateAfterDeleteFolder()

updateAfterDeleteFolder(string  $folder) : NULL

Update the listener after deleting folder.

Parameters

string $folder

The path of the folder that has been deleted.

Returns

NULL

updateAfterRenameFolder()

updateAfterRenameFolder(string  $old, string  $new) : NULL

Update the listener after renaming a folder.

Parameters

string $old

The old path of the folder.
string $new

The new path of the folder.

Returns

NULL

getDuplicateDefaults()

getDuplicateDefaults() : array

Return any default folder duplicates.

Returns

array —

The list of duplicate default folders accessible to the current user.

synchronize()

synchronize()

Synchronize the listener.

_initQuery()

_initQuery(string  $query) : NULL

Ensure we have the query data.

Parameters

string $query

The query data required.

Returns

NULL