PHP Класс Horde_Kolab_Server_Object_Hash, horde

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.
Автор: Gunnar Wrobel ([email protected])
Наследование: implements Horde_Kolab_Server_Object_Interface
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__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.

Описание методов

__construct() публичный Метод

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() публичный Метод

Delete this object.
public delete ( ) : null
Результат null

exists() публичный Метод

Does the object exist?
public exists ( ) : null
Результат null

generateId() публичный Метод

Generates an ID for the given information.
public generateId ( array &$info ) : string
$info array
Результат string The ID.

getActions() публичный Метод

Returns the set of actions supported by this object type.
public getActions ( ) : array
Результат array An array of supported actions.

getExternal() публичный Метод

Get the specified attribute of this object.
public getExternal ( string $attr ) : mixed
$attr string The attribute to read.
Результат mixed The value of this attribute.

getExternalAttributes() публичный Метод

Get the external attributes supported by this object.
public getExternalAttributes ( ) : array
Результат array The external attributes supported by this object. This is an association of attribute names and attribute handler class names.

getGuid() публичный Метод

Get the GUID of this object
public getGuid ( ) : string
Результат string the GUID of this object

getInternal() публичный Метод

Get the specified internal attributes.
public getInternal ( array $attributes ) : array
$attributes array The internal attribute.
Результат array The value(s) of these attribute

getInternalAttributes() публичный Метод

Get the internal attributes supported by this object.
public getInternalAttributes ( ) : array
Результат array The internal attributes supported by this object.

getSingle() публичный Метод

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.
Результат mixed The value of this attribute.

prepareObjectInformation() публичный Метод

Distill the server side object information to save.
public prepareObjectInformation ( array &$info ) : NULL.
$info array
Результат NULL.

readInternal() публичный Метод

Read the object into the cache
public readInternal ( ) : array
Результат array The read data.

save() публичный Метод

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.
Результат null

toHash() публичный Метод

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?
Результат array | PEAR_Error The hash representing this object.