/usr/share/php/Horde/Kolab/Server/Structure/Interface.php is in php-horde-kolab-server 2.0.2-2.
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 | <?php
/**
* A simple structural handler for a tree of objects.
*
* 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
*/
/**
* The interface definition for the handlers dealing with the Kolab Server
* object tree structure.
*
* Copyright 2009-2013 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_Structure_Interface
{
/**
* Finds object data matching a given set of criteria.
*
* @param Horde_Kolab_Server_Query_Element $criteria The criteria for the search.
* @param array $params Additional search parameters.
*
* @return Horde_Kolab_Server_Result The result object.
*
* @throws Horde_Kolab_Server_Exception
*/
public function find(
Horde_Kolab_Server_Query_Element_Interface $criteria,
array $params = array()
);
/**
* Finds all object data below a parent matching a given set of criteria.
*
* @param Horde_Kolab_Server_Query_Element $criteria The criteria for the search.
* @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(
Horde_Kolab_Server_Query_Element_Interface $criteria,
$parent,
array $params = array()
);
/**
* Set the composite server reference for this object.
*
* @param Horde_Kolab_Server_Composite $composite A link to the composite
* server handler.
*
* @return NULL
*/
public function setComposite(
Horde_Kolab_Server_Composite $composite
);
/**
* Returns the set of objects supported by this structure.
*
* @return array An array of supported objects.
*/
public function getSupportedObjects();
/**
* Returns the set of search operations supported by this object type.
*
* @return array An array of supported search operations.
*/
public function getSearchOperations();
/**
* Maps the external attribute name to its internal counterpart.
*
* @param string $external The external attribute name.
*
* @return string The internal attribute name.
*/
public function mapExternalToInternalAttribute($external);
/**
* Return the external attributes supported by the given object class.
*
* @param Horde_Kolab_Server_Object $object Determine the external
* attributes for this class.
*
* @return array The supported attributes.
*
* @throws Horde_Kolab_Server_Exception If the schema analysis fails.
*/
public function getExternalAttributes($object);
/**
* Return the internal attributes supported by the given object class.
*
* @param Horde_Kolab_Server_Object $object Determine the internal
* attributes for this class.
*
* @return array The supported attributes.
*
* @throws Horde_Kolab_Server_Exception If the schema analysis fails.
*/
public function getInternalAttributes($object);
public function getExternalAttribute(
$name,
Horde_Kolab_Server_Object_Interface $object
);
/**
* Determine the type of an object by its tree position and other
* parameters.
*
* @param string $guid The GUID of the object to examine.
*
* @return string The class name of the corresponding object type.
*
* @throws Horde_Kolab_Server_Exception If the object type is unknown.
*/
public function determineType($guid);
/**
* Generates a UID for the given information.
*
* @param string $type The class name of the object to create.
* @param string $id The id of the object.
* @param array $info Any additional information about the object to create.
*
* @return string The GUID.
*
* @throws Horde_Kolab_Server_Exception If the given type is unknown.
*/
public function generateServerGuid($type, $id, array $info);
}
|