\SeedDMS_Core_Attribute

Class to represent an attribute in the document management system

Attributes are key/value pairs which can be attachted to documents, folders and document content. The number of attributes is unlimited. Each attribute has a value and is related to an attribute definition, which holds the name and other information about the attribute.

Summary

Methods
Properties
Constants
SeedDMS_Core_Attribute()
setDMS()
getID()
getValue()
setValue()
getAttributeDefinition()
No public properties found
No constants found
No protected methods found
$_id
$_obj
$_attrdef
$_value
$_dms
N/A
No private methods found
No private properties found
N/A

Properties

$_id

$_id : integer

Type

integer — id of attribute

$_obj

$_obj : object

Type

object — SeedDMS_Core_Object folder, document or document content this attribute belongs to

$_attrdef

$_attrdef : object

Type

object — SeedDMS_Core_AttributeDefinition definition of this attribute

$_value

$_value : mixed

Type

mixed — value of this attribute

$_dms

$_dms : object

Type

object — SeedDMS_Core_DMS reference to the dms instance this attribute belongs to

Methods

SeedDMS_Core_Attribute()

SeedDMS_Core_Attribute(integer $id, \SeedDMS_Core_Object $obj, \SeedDMS_Core_AttributeDefinition $attrdef, string $value)

Constructor

Parameters

integer $id

internal id of attribute

\SeedDMS_Core_Object $obj

object this attribute is attached to

\SeedDMS_Core_AttributeDefinition $attrdef

reference to the attribute definition

string $value

value of the attribute

setDMS()

setDMS(\SeedDMS_Core_DMS $dms)

Set reference to dms

Parameters

\SeedDMS_Core_DMS $dms

getID()

getID()

getValue()

getValue()

setValue()

setValue(string $value) : boolean

Set a value of an attribute The attribute is deleted completely if the value is the empty string

Parameters

string $value

value to be set

Returns

boolean —

true if operation was successfull, otherwise false

getAttributeDefinition()

getAttributeDefinition()