Horde_Kolab_Storage_List_Query_Share_Base
extends Horde_Kolab_Storage_List_Query_Share
in package
Handles a 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
Table of Contents
- ANNOTATION_DESCRIPTION = '/shared/comment'
- The folder description
- ANNOTATION_SHARE_PARAMETERS = '/shared/vendor/horde/share-params'
- $_driver : Horde_Kolab_Storage_Driver
- The driver for accessing the Kolab storage system.
- __construct() : mixed
- Constructor.
- getDescription() : string
- Returns the share description.
- getParameters() : string
- Returns the share parameters.
- setDescription() : null
- Set the share description.
- setParameters() : string
- Set the share parameters.
Constants
ANNOTATION_DESCRIPTION
The folder description
public
mixed
ANNOTATION_DESCRIPTION
= '/shared/comment'
ANNOTATION_SHARE_PARAMETERS
public
mixed
ANNOTATION_SHARE_PARAMETERS
= '/shared/vendor/horde/share-params'
Tags
Properties
$_driver
The driver for accessing the Kolab storage system.
private
Horde_Kolab_Storage_Driver
$_driver
Methods
__construct()
Constructor.
public
__construct(Horde_Kolab_Storage_Driver $driver) : mixed
Parameters
- $driver : Horde_Kolab_Storage_Driver
-
The driver to access the backend.
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()
Set the share description.
public
setDescription(string $folder, string $description) : null
Parameters
- $folder : string
-
The folder name.
- $description : string
-
The share description.
Return values
null —setParameters()
Set 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 encoded share parameters.