API Documentation
\

\Horde_Kolab_Server_Object_Attribute_Field

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()
No public properties found
No constants found
quote()
unquote()
getField()
setField()
$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.

quote()

quote(string  $string) : string

Quote field separators within a LDAP value.

Parameters

string $string

The string that should be quoted.

Returns

string —

The quoted string.

unquote()

unquote(string  $string) : string

Unquote a LDAP value.

Parameters

string $string

The string that should be unquoted.

Returns

string —

The unquoted string.

getField()

getField(string  $basekey, string  $field, string  $separator = '$', integer  $max_count = null) : mixed

Get a derived attribute value by returning a given position in a delimited string.

Parameters

string $basekey

Name of the attribute that holds the delimited string.
string $field

The position of the field to retrieve.
string $separator

The field separator.
integer $max_count

The maximal number of fields.

Returns

mixed —

The value of the attribute.

setField()

setField(string  $key, array  $attributes, array  $info, string  $separator = '$', boolean  $unset = true) : \NULL.

Set a collapsed attribute value.

Parameters

string $key

The attribute to collapse into.
array $attributes

The attributes to collapse.
array $info

The information currently working on.
string $separator

Separate the fields using this character.
boolean $unset

Unset the base values.

Returns

\NULL.