Stilit Wiki

changeField( $record )

Definition : public function changeField( $record )

Returns :

Description
Overloaded method. Make changes to the database structure regarding to changes to this Field.

clear()

Definition : public function clear()

Returns :

Description
Overloaded method, clear out the references to related tablerecords

connect( $value )

Definition : public function connect( $value = false )

Returns :

Description
Connect this relationfield to the opposing sides relation

disconnect()

Definition : public function disconnect()

Returns : boolean false on error, otherwise true

Description
Disconnect this relationfield

getActiveRelation()

Definition : public function &getActiveRelation()

Returns : Relation - the currently active relation

Description
Get a reference to the active relation for this field

getDOM( &$xmlDocument, $isRelation )

Definition : public function getDOM( &$xmlDocument, $isRelation = false )

Returns : DOMElement - XML representation of this field

Description
Get a DOMElement representation of this field

getHead()

Definition : public function getHead()

Returns : String or false on error

Description
Overloaded getHead method returning additional header information

getPlaintext( $save )

Definition : public function getPlaintext( $save = false )

Returns : String

Description
Get the plaintext representation for the related tablerecords descriptor

getRelatedTable()

Definition : public function &getRelatedTable()

Returns : Table

Description
Get a reference to the table on the other side of this relation

getRelation()

Definition : public function &getRelation()

Returns : TableRecord

Description
Get the TableRecord that this relation relates to

getRelations()

Definition : public function &getRelations()

Returns : Array

Description
Get all the relations that relates to this field

getValue( $save )

Definition : public function getValue( $save = false )

Returns : String

Description
Get the value of this field as [idrelation];[value]

setActiveRelation( $identifier )

Definition : public function setActiveRelation( $identifier )

Returns :

Description
Set the active relation for this field

setDOM( $xml )

Definition : public function setDOM( $xml )

Returns :

Description
Overloaded method, sets the contents of this field from the given DOMElement. Sets the active relation.

setSystemValue( $activeRelation )

Definition : public function setSystemValue( $activeRelation )

Returns :

Description
Set the active relation for this relationfield. Makes the setSystemValue set the active relation.

setValue( $value, $init, $depth )

Definition : public function setValue( $value, $init = false, $depth = 0 )

Returns : int - the value after setting

Description
Set the value of this relation. The value to set is the ID field of the related TableRecord. When set the relationdata is voided so it is reloaded on the next reference. Will change the value of the related record if there is a 1-side relation on that side.