1: <?php
2: /**
3: * The interface of the share information query.
4: *
5: * PHP version 5
6: *
7: * @category Kolab
8: * @package Kolab_Storage
9: * @author Gunnar Wrobel <wrobel@pardus.de>
10: * @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
11: * @link http://pear.horde.org/index.php?package=Kolab_Storage
12: */
13:
14: /**
15: * The interface of the share information query.
16: *
17: * Copyright 2011-2012 Horde LLC (http://www.horde.org/)
18: *
19: * See the enclosed file COPYING for license information (LGPL). If you
20: * did not receive this file, see http://www.horde.org/licenses/lgpl21.
21: *
22: * @category Kolab
23: * @package Kolab_Storage
24: * @author Gunnar Wrobel <wrobel@pardus.de>
25: * @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
26: * @link http://pear.horde.org/index.php?package=Kolab_Storage
27: */
28: interface Horde_Kolab_Storage_List_Query_Share
29: extends Horde_Kolab_Storage_List_Query
30: {
31: /**
32: * Returns the share description.
33: *
34: * @param string $folder The folder name.
35: *
36: * @return string The folder/share description.
37: */
38: public function getDescription($folder);
39:
40: /**
41: * Returns the share parameters.
42: *
43: * @param string $folder The folder name.
44: *
45: * @return string The folder/share parameters.
46: */
47: public function getParameters($folder);
48:
49: /**
50: * Returns the share description.
51: *
52: * @param string $folder The folder name.
53: * @param string $description The share description.
54: *
55: * @return string The folder/share description.
56: */
57: public function setDescription($folder, $description);
58:
59: /**
60: * Returns the share parameters.
61: *
62: * @param string $folder The folder name.
63: * @param array $parameters The share parameters.
64: *
65: * @return string The folder/share parameters.
66: */
67: public function setParameters($folder, array $parameters);
68: }