• Home
  • Horde_Kolab_Server_Structure_Interface

PHP Interface Horde_Kolab_Server_Structure_Interface, horde

Copyright 2009-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.
See link: http://pear.horde.org/index.php?package=Kolab_Server
Author: Gunnar Wrobel ([email protected])
Datei anzeigen Open project: horde/horde Interface Usage Examples

Public Methods

Method Description
determineType ( string $guid ) : string Determine the type of an object by its tree position and other parameters.
find ( Horde_Kolab_Server_Query_Element_Interface $criteria, array $params = [] ) : Horde_Kolab_Server_Result Finds object data matching a given set of criteria.
findBelow ( Horde_Kolab_Server_Query_Element_Interface $criteria, string $parent, array $params = [] ) : Horde_Kolab_Server_Result Finds all object data below a parent matching a given set of criteria.
generateServerGuid ( string $type, string $id, array $info ) : string Generates a UID for the given information.
getExternalAttribute ( $name, Horde_Kolab_Server_Object_Interface $object )
getExternalAttributes ( Horde_Kolab_Server_Object $object ) : array Return the external attributes supported by the given object class.
getInternalAttributes ( Horde_Kolab_Server_Object $object ) : array Return the internal attributes supported by the given object class.
getSearchOperations ( ) : array Returns the set of search operations supported by this object type.
getSupportedObjects ( ) : array Returns the set of objects supported by this structure.
mapExternalToInternalAttribute ( string $external ) : string Maps the external attribute name to its internal counterpart.
setComposite ( Horde_Kolab_Server_Composite $composite ) : null Set the composite server reference for this object.

Method Details

determineType() public method

Determine the type of an object by its tree position and other parameters.
public determineType ( string $guid ) : string
$guid string The GUID of the object to examine.
return string The class name of the corresponding object type.

find() public method

Finds object data matching a given set of criteria.
public find ( Horde_Kolab_Server_Query_Element_Interface $criteria, array $params = [] ) : Horde_Kolab_Server_Result
$criteria Horde_Kolab_Server_Query_Element_Interface The criteria for the search.
$params array Additional search parameters.
return Horde_Kolab_Server_Result The result object.

findBelow() public method

Finds all object data below a parent matching a given set of criteria.
public findBelow ( Horde_Kolab_Server_Query_Element_Interface $criteria, string $parent, array $params = [] ) : Horde_Kolab_Server_Result
$criteria Horde_Kolab_Server_Query_Element_Interface The criteria for the search.
$parent string The parent to search below.
$params array Additional search parameters.
return Horde_Kolab_Server_Result The result object.

generateServerGuid() public method

Generates a UID for the given information.
public generateServerGuid ( string $type, string $id, array $info ) : string
$type string The class name of the object to create.
$id string The id of the object.
$info array Any additional information about the object to create.
return string The GUID.

getExternalAttribute() public method

public getExternalAttribute ( $name, Horde_Kolab_Server_Object_Interface $object )
$object Horde_Kolab_Server_Object_Interface

getExternalAttributes() public method

Return the external attributes supported by the given object class.
public getExternalAttributes ( Horde_Kolab_Server_Object $object ) : array
$object Horde_Kolab_Server_Object Determine the external attributes for this class.
return array The supported attributes.

getInternalAttributes() public method

Return the internal attributes supported by the given object class.
public getInternalAttributes ( Horde_Kolab_Server_Object $object ) : array
$object Horde_Kolab_Server_Object Determine the internal attributes for this class.
return array The supported attributes.

getSearchOperations() public method

Returns the set of search operations supported by this object type.
public getSearchOperations ( ) : array
return array An array of supported search operations.

getSupportedObjects() public method

Returns the set of objects supported by this structure.
public getSupportedObjects ( ) : array
return array An array of supported objects.

mapExternalToInternalAttribute() public method

Maps the external attribute name to its internal counterpart.
public mapExternalToInternalAttribute ( string $external ) : string
$external string The external attribute name.
return string The internal attribute name.

setComposite() public method

Set the composite server reference for this object.
public setComposite ( Horde_Kolab_Server_Composite $composite ) : null
$composite Horde_Kolab_Server_Composite A link to the composite server handler.
return null