API Documentation
\

\Horde_Kolab_Storage_List_Query_Share_Cache

Caches share parameters.

Copyright 2011-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
getDescription()
getParameters()
setDescription()
setParameters()
__construct()
updateAfterCreateFolder()
updateAfterDeleteFolder()
updateAfterRenameFolder()
synchronize()
No public properties found
DESCRIPTIONS
PARAMETERS
No protected methods found
No protected properties found
N/A
No private methods found
$_query
$_list_cache
$_descriptions
$_parameters
N/A

Constants

DESCRIPTIONS

DESCRIPTIONS

The share description

PARAMETERS

PARAMETERS

The share parameters

Properties

$_query

$_query :

The underlying Share query.

Type

$_list_cache

$_list_cache : \Horde_Kolab_Storage_Cache_List

The list cache.

Type

\Horde_Kolab_Storage_Cache_List

$_descriptions

$_descriptions : array

The cached share descriptions.

Type

array

$_parameters

$_parameters : array

The cached share parameters.

Type

array

Methods

getDescription()

getDescription(string  $folder) : string

Returns the share description.

Parameters

string $folder

The folder name.

Returns

string —

The folder/share description.

getParameters()

getParameters(string  $folder) : string

Returns the share parameters.

Parameters

string $folder

The folder name.

Returns

string —

The folder/share parameters.

setDescription()

setDescription(string  $folder, string  $description) : string

Returns the share description.

Parameters

string $folder

The folder name.
string $description

The share description.

Returns

string —

The folder/share description.

setParameters()

setParameters(string  $folder, array  $parameters) : string

Returns the share parameters.

Parameters

string $folder

The folder name.
array $parameters

The share parameters.

Returns

string —

The folder/share parameters.

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

synchronize()

synchronize(array  $params = array()) : NULL

Synchronize the ACL information with the information from the backend.

Parameters

array $params

Additional parameters.

Returns

NULL