Low level caching for the Kolab object.
Copyright 2008-2012 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.
Methods summary
public
|
#
__construct( Horde_Kolab_Server_Object $object )
Initialize the Kolab Object. Provide either the GUID
Initialize the Kolab Object. Provide either the GUID
Parameters
- $object
- $composite The link to the Kolab server.
|
public
string
|
#
getGuid( )
Get the GUID of this object
Get the GUID of this object
Returns
string
the GUID of this object
Implementation of
|
public
array
|
#
getExternalAttributes( )
Get the external attributes supported by this object.
Get the external attributes supported by this object.
Returns
arrayThe external attributes supported by this object. This is a
list of abbreviated attribute class names.
Implementation of
|
public
array
|
#
getInternalAttributes( )
Get the internal attributes supported by this object.
Get the internal attributes supported by this object.
Returns
arrayThe internal attributes supported by this object. This is
an association of internal attribute names an the correspodning attribute
class names.
Implementation of
|
public
null
|
#
setInternalData( array $data )
Set the internal data of this object.
Set the internal data of this object.
Parameters
- $data
- A data array for the object.
Returns
null
|
public
null
|
#
exists( )
Does the object exist?
Returns
null
Implementation of
|
public
array
|
#
readInternal( )
Read the object data.
Returns
array
The read data.
Implementation of
|
public
array
|
#
getInternal( array $attributes )
Get the specified internal attributes.
Get the specified internal attributes.
Parameters
- $attributes
- The internal attribute.
Returns
array
The value(s) of these attribute
Implementation of
|
public
mixed
|
#
getExternal( string $attr )
Get the specified attribute of this object.
Get the specified attribute of this object.
Parameters
- $attr
- The attribute to read.
Returns
mixed
The value of this attribute.
Implementation of
|
public
mixed
|
#
getSingle( string $attr )
Get the specified attribute of this object and ensure that only a single
value is being returned.
Get the specified attribute of this object and ensure that only a single
value is being returned.
Parameters
- $attr
- The attribute to read.
Returns
mixed
The value of this attribute.
|
public
array|PEAR_Error
|
#
toHash( array $attrs = array(), boolean $single = true )
Convert the object attributes to a hash.
Convert the object attributes to a hash.
Parameters
- $attrs
- The attributes to return.
- $single
- Should only a single attribute be returned?
Returns
array|PEAR_Error
The hash representing this object.
|
public
null
|
#
save( array $info )
Saves object information. This may either create a new entry or modify an
existing entry.
Saves object information. This may either create a new entry or modify an
existing entry.
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.
Parameters
- $info
- The information about the object.
Returns
null
Throws
Implementation of
|
public
null
|
#
delete( )
Delete this object.
Returns
null
Throws
Implementation of
|
public
string
|
#
generateId( array & $info )
Generates an ID for the given information.
Generates an ID for the given information.
Parameters
- $info
- $info The data of the object.
Returns
string
The ID.
Implementation of
|
public
NULL.
|
#
prepareObjectInformation( array & $info )
Distill the server side object information to save.
Distill the server side object information to save.
Parameters
- $info
- $info The information about the object.
Returns
NULL.
Throws
Implementation of
|
public
array
|
#
getActions( )
Returns the set of actions supported by this object type.
Returns the set of actions supported by this object type.
Returns
array
An array of supported actions.
Implementation of
|