PHP Class Horde_Kolab_Server_Object_Hash, horde

See link: http://pear.horde.org/index.php?package=Kolab_Server

Author: Gunnar Wrobel ([email protected])

Inheritance: implements Horde_Kolab_Server_Object_Interface

Mostra file Open project: horde/horde Class Usage Examples

Public Methods

Method	Description
__construct ( Horde_Kolab_Server_Object_Interface $object )	Initialize the Kolab Object. Provide either the GUID
delete ( ) : null	Delete this object.
exists ( ) : null	Does the object exist?
generateId ( array &$info ) : string	Generates an ID for the given information.
getActions ( ) : array	Returns the set of actions supported by this object type.
getExternal ( string $attr ) : mixed	Get the specified attribute of this object.
getExternalAttributes ( ) : array	Get the external attributes supported by this object.
getGuid ( ) : string	Get the GUID of this object
getInternal ( array $attributes ) : array	Get the specified internal attributes.
getInternalAttributes ( ) : array	Get the internal attributes supported by this object.
getSingle ( string $attr ) : mixed	Get the specified attribute of this object and ensure that only a single value is being returned.
prepareObjectInformation ( array &$info ) : NULL.	Distill the server side object information to save.
readInternal ( ) : array	Read the object into the cache
save ( array $info ) : null	Saves object information. This may either create a new entry or modify an existing entry.
toHash ( array $attrs = [], boolean $single = true ) : array \| PEAR_Error	Convert the object attributes to a hash.

Method Details

__construct() public method

Initialize the Kolab Object. Provide either the GUID

public __construct ( Horde_Kolab_Server_Object_Interface $object )
$object	Horde_Kolab_Server_Object_Interface	The represented object.

delete() public method

Delete this object.

public delete ( ) : null
return	null

exists() public method

Does the object exist?

public exists ( ) : null
return	null

generateId() public method

Generates an ID for the given information.

public generateId ( array &$info ) : string
$info	array
return	string	The ID.

getActions() public method

Returns the set of actions supported by this object type.

public getActions ( ) : array
return	array	An array of supported actions.

getExternal() public method

Get the specified attribute of this object.

public getExternal ( string $attr ) : mixed
$attr	string	The attribute to read.
return	mixed	The value of this attribute.

getExternalAttributes() public method

Get the external attributes supported by this object.

public getExternalAttributes ( ) : array
return	array	The external attributes supported by this object. This is an association of attribute names and attribute handler class names.

getGuid() public method

Get the GUID of this object

public getGuid ( ) : string
return	string	the GUID of this object

getInternal() public method

Get the specified internal attributes.

public getInternal ( array $attributes ) : array
$attributes	array	The internal attribute.
return	array	The value(s) of these attribute

getInternalAttributes() public method

Get the internal attributes supported by this object.

public getInternalAttributes ( ) : array
return	array	The internal attributes supported by this object.

getSingle() public method

Get the specified attribute of this object and ensure that only a single value is being returned.

public getSingle ( string $attr ) : mixed
$attr	string	The attribute to read.
return	mixed	The value of this attribute.

prepareObjectInformation() public method

Distill the server side object information to save.

public prepareObjectInformation ( array &$info ) : NULL.
$info	array
return	NULL.

readInternal() public method

Read the object into the cache

public readInternal ( ) : array
return	array	The read data.

save() public method

Please note that fields with multiple allowed values require the callee to provide the full set of values for the field. Any old values that are not resubmitted will be considered to be deleted.

public save ( array $info ) : null
$info	array	The information about the object.
return	null

toHash() public method

Convert the object attributes to a hash.

public toHash ( array $attrs = [], boolean $single = true ) : array \| PEAR_Error
$attrs	array	The attributes to return.
$single	boolean	Should only a single attribute be returned?
return	array \| PEAR_Error	The hash representing this object.