API Documentation
\

\Horde_Kolab_Storage_List_Query_Share_Base

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.

Summary

Methods
Properties
Constants
getDescription()
getParameters()
setDescription()
setParameters()
__construct()
No public properties found
ANNOTATION_DESCRIPTION
ANNOTATION_SHARE_PARAMETERS
No protected methods found
No protected properties found
N/A
No private methods found
$_driver
N/A

Constants

ANNOTATION_DESCRIPTION

ANNOTATION_DESCRIPTION

The folder description

ANNOTATION_SHARE_PARAMETERS

ANNOTATION_SHARE_PARAMETERS

Properties

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) : NULL

Set the share description.

Parameters

string $folder

The folder name.
string $description

The share description.

Returns

NULL

setParameters()

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

Set the share parameters.

Parameters

string $folder

The folder name.
array $parameters

The share parameters.

Returns

string —

The encoded share parameters.

__construct()

__construct(\Horde_Kolab_Storage_Driver  $driver)

Constructor.

Parameters

\Horde_Kolab_Storage_Driver $driver

The driver to access the backend.