Horde_Kolab_Storage_List_Query_Share_Cache
extends Horde_Kolab_Storage_List_Query_Share
in package
implements
Horde_Kolab_Storage_List_Manipulation_Listener, Horde_Kolab_Storage_List_Synchronization_Listener
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.
Tags
Interfaces, Classes, Traits and Enums
- Horde_Kolab_Storage_List_Manipulation_Listener
- Describes a manipulation listener.
- Horde_Kolab_Storage_List_Synchronization_Listener
- Describes a synchronization listener.
Table of Contents
- DESCRIPTIONS = 'SHARE_DESCRIPTIONS'
- The share description
- PARAMETERS = 'SHARE_PARAMETERS'
- The share parameters
- $_descriptions : array<string|int, mixed>
- The cached share descriptions.
- $_list_cache : Horde_Kolab_Storage_Cache_List
- The list cache.
- $_parameters : array<string|int, mixed>
- The cached share parameters.
- $_query : mixed
- The underlying Share query.
- __construct() : mixed
- Constructor.
- getDescription() : string
- Returns the share description.
- getParameters() : string
- Returns the share parameters.
- setDescription() : string
- Returns the share description.
- setParameters() : string
- Returns the share parameters.
- synchronize() : null
- Synchronize the ACL information with the information from the backend.
- updateAfterCreateFolder() : null
- Update the listener after creating a new folder.
- updateAfterDeleteFolder() : null
- Update the listener after deleting folder.
- updateAfterRenameFolder() : null
- Update the listener after renaming a folder.
Constants
DESCRIPTIONS
The share description
public
mixed
DESCRIPTIONS
= 'SHARE_DESCRIPTIONS'
PARAMETERS
The share parameters
public
mixed
PARAMETERS
= 'SHARE_PARAMETERS'
Properties
$_descriptions
The cached share descriptions.
private
array<string|int, mixed>
$_descriptions
$_list_cache
The list cache.
private
Horde_Kolab_Storage_Cache_List
$_list_cache
$_parameters
The cached share parameters.
private
array<string|int, mixed>
$_parameters
$_query
The underlying Share query.
private
mixed
$_query
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage_List_Query_Share $query, Horde_Kolab_Storage_List_Cache $cache) : mixed
Parameters
- $query : Horde_Kolab_Storage_List_Query_Share
-
The underlying share query.
- $cache : Horde_Kolab_Storage_List_Cache
-
The list cache.
Return values
mixed —getDescription()
Returns the share description.
public
getDescription(string $folder) : string
Parameters
- $folder : string
-
The folder name.
Return values
string —The folder/share description.
getParameters()
Returns the share parameters.
public
getParameters(string $folder) : string
Parameters
- $folder : string
-
The folder name.
Return values
string —The folder/share parameters.
setDescription()
Returns the share description.
public
setDescription(string $folder, string $description) : string
Parameters
- $folder : string
-
The folder name.
- $description : string
-
The share description.
Return values
string —The folder/share description.
setParameters()
Returns the share parameters.
public
setParameters(string $folder, array<string|int, mixed> $parameters) : string
Parameters
- $folder : string
-
The folder name.
- $parameters : array<string|int, mixed>
-
The share parameters.
Return values
string —The folder/share parameters.
synchronize()
Synchronize the ACL information with the information from the backend.
public
synchronize([array<string|int, mixed> $params = array() ]) : null
Parameters
- $params : array<string|int, mixed> = array()
-
Additional parameters.
Return values
null —updateAfterCreateFolder()
Update the listener after creating a new folder.
public
updateAfterCreateFolder(string $folder[, string $type = null ]) : null
Parameters
- $folder : string
-
The path of the folder that has been created.
- $type : string = null
-
An optional type for the folder.
Return values
null —updateAfterDeleteFolder()
Update the listener after deleting folder.
public
updateAfterDeleteFolder(string $folder) : null
Parameters
- $folder : string
-
The path of the folder that has been deleted.
Return values
null —updateAfterRenameFolder()
Update the listener after renaming a folder.
public
updateAfterRenameFolder(string $old, string $new) : null
Parameters
- $old : string
-
The old path of the folder.
- $new : string
-
The new path of the folder.