API Documentation
\

\Horde_Kolab_Server_Object_Attribute_Value

The base class representing Kolab object attributes.

Copyright 2008-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
__construct()
getAttribute()
getName()
isEmpty()
value()
consume()
update()
No public properties found
No constants found
No protected methods found
$name
$attribute
N/A
No private methods found
No private properties found
N/A

Properties

$name

$name :

The attribute name.

Type

$attribute

$attribute :

The internal attribute adapter.

Type

Methods

__construct()

__construct(\Horde_Kolab_Server_Structure_Attribute_Interface  $attribute, string  $name)

Constructor

Parameters

\Horde_Kolab_Server_Structure_Attribute_Interface $attribute

The internal attribute adapter.
string $name

The name of this attribute.

getName()

getName() : string

Return the name of this attribute.

Returns

string —

The name of this attribute.

isEmpty()

isEmpty(array  $changes) : string

Return if this attribute is undefined in the given data array.

Parameters

array $changes

The data array to test.

Returns

string —

The name of this object.

value()

value() : array

Return the value of this attribute.

Throws

\Horde_Kolab_Server_Exception

If retrieval of the value failed.

Returns

array —

The value(s) of this attribute.

consume()

consume(array  $changes) : NULL

Indicate that a value will be saved by deleting it from the original data array.

Parameters

array $changes

Returns

NULL

update()

update(array  $changes) : array

Return the new internal state for this attribute.

Parameters

array $changes

The object data that should be updated.

Throws

\Horde_Kolab_Server_Exception

If storing the value failed.

Returns

array —

The resulting internal state.