\SeedDMS_Core_Object

Class to represent a generic object in the document management system

This is the base class for generic objects in SeedDMS.

Summary

Methods
Properties
Constants
SeedDMS_Core_Object()
setDMS()
getID()
getAttributes()
getAttributeValue()
setAttributeValue()
removeAttribute()
$_dms
No constants found
No protected methods found
$_id
$_attributes
N/A
No private methods found
No private properties found
N/A

Properties

$_dms

$_dms : object

Type

object — back reference to document management system

$_id

$_id : integer

Type

integer — unique id of object

$_attributes

$_attributes : array

Type

array — list of attributes

Methods

SeedDMS_Core_Object()

SeedDMS_Core_Object( $id)

Parameters

$id

setDMS()

setDMS( $dms)

Parameters

$dms

getID()

getID()

getAttributes()

getAttributes() : array

Returns all attributes set for the object

Returns

array —

list of objects of class SeedDMS_Core_Attribute

getAttributeValue()

getAttributeValue( $attrdef) : array|string

Returns an attribute of the object for the given attribute definition

Parameters

$attrdef

Returns

array|string —

value of attritbute or false. The value is an array if the attribute is defined as multi value

setAttributeValue()

setAttributeValue(object $attrdef, array|\sting $value) : boolean

Set an attribute of the object for the given attribute definition

Parameters

object $attrdef

definition of attribute

array|\sting $value

value of attribute, for multiple values this must be an array

Returns

boolean —

true if operation was successful, otherwise false

removeAttribute()

removeAttribute( $attrdef) : boolean

Remove an attribute of the object for the given attribute definition

Parameters

$attrdef

Returns

boolean —

true if operation was successful, otherwise false