/usr/share/php/Horde/Kolab/Server/Interface.php is in php-horde-kolab-server 2.0.5-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | <?php
/**
* A library for accessing the Kolab user database.
*
* PHP version 5
*
* @category Kolab
* @package Kolab_Server
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Server
*/
/**
* This class defines the interface of a generic Kolab user database.
*
* Copyright 2008-2016 Horde LLC (http://www.horde.org/)
*
* See the enclosed file COPYING for license information (LGPL). If you
* did not receive this file, see http://www.horde.org/licenses/lgpl21.
*
* @category Kolab
* @package Kolab_Server
* @author Gunnar Wrobel <wrobel@pardus.de>
* @license http://www.horde.org/licenses/lgpl21 LGPL 2.1
* @link http://pear.horde.org/index.php?package=Kolab_Server
*/
interface Horde_Kolab_Server_Interface
{
/**
* Connect to the server.
*
* @param string $guid The global unique id of the user.
* @param string $pass The password.
*
* @return NULL.
*
* @throws Horde_Kolab_Server_Exception If the connection failed.
*/
public function connectGuid($guid = '', $pass = '');
/**
* Get the current GUID
*
* @return string The GUID of the currently connected user.
*/
public function getGuid();
/**
* Get the base GUID of this server
*
* @return string The base GUID of this server.
*/
public function getBaseGuid();
/**
* Low level access to reading object data.
*
* This function provides direct access to the Server data.
*
* Usually you should use
*
* <code>
* $object = $server->fetch('a server uid');
* $variable = $object['attribute']
* </code>
*
* to access object attributes. This is slower but takes special object
* handling into account (e.g. custom attribute parsing).
*
* @param string $guid The object to retrieve.
*
* @return array An array of attributes.
*
* @throws Horde_Kolab_Server_Exception
*/
public function read($guid);
/**
* Low level access to reading some object attributes.
*
* @param string $guid The object to retrieve.
* @param string $attrs Restrict to these attributes.
*
* @return array An array of attributes.
*
* @throws Horde_Kolab_Server_Exception
*
* @see Horde_Kolab_Server::read
*/
public function readAttributes($guid, array $attrs);
/**
* Finds object data matching a given set of criteria.
*
* @param string $query The LDAP search query
* @param array $params Additional search parameters.
*
* @return Horde_Kolab_Server_Result The result object.
*
* @throws Horde_Kolab_Server_Exception
*/
public function find($query, array $params = array());
/**
* Finds all object data below a parent matching a given set of criteria.
*
* @param string $query The LDAP search query
* @param string $parent The parent to search below.
* @param array $params Additional search parameters.
*
* @return Horde_Kolab_Server_Result The result object.
*
* @throws Horde_Kolab_Server_Exception
*/
public function findBelow($query, $parent, array $params = array());
/**
* Modify existing object data.
*
* @param Horde_Kolab_Server_Object $object The object to be modified.
* @param array $data The attributes of the object
* to be stored.
*
* @return NULL
*
* @throws Horde_Kolab_Server_Exception
*/
public function save(
Horde_Kolab_Server_Object_Interface $object,
array $data
);
/**
* Add new object data.
*
* @param Horde_Kolab_Server_Object $object The object to be added.
* @param array $data The attributes of the object
* to be added.
*
* @return NULL
*
* @throws Horde_Kolab_Server_Exception
*/
public function add(
Horde_Kolab_Server_Object_Interface $object,
array $data
);
/**
* Delete an object.
*
* @param string $guid The GUID of the object to be deleted.
*
* @return NULL
*
* @throws Horde_Kolab_Server_Exception
*/
public function delete($guid);
/**
* Rename an object.
*
* @param string $guid The GUID of the object to be renamed.
* @param string $new The new GUID of the object.
*
* @return NULL
*
* @throws Horde_Kolab_Server_Exception
*/
public function rename($guid, $new);
/**
* Return the database schema description.
*
* @return array The schema.
*
* @throws Horde_Kolab_Server_Exception If retrieval of the schema failed.
*/
public function getSchema();
/**
* Get the parent GUID of this object.
*
* @param string $guid The GUID of the child.
*
* @return string the parent GUID of this object.
*/
public function getParentGuid($guid);
}
|