Docs For Class RecordFieldData

Description

Holds information about a specific version of a value index of a field in a Record. Information held includes: Date created/modified, active/not active (ie, deleted), and the actual value object (usually a Primitive).

author: Gabe Schine
version: $Id: RecordFieldData.class.php,v 1.26 2007/09/04 20:25:31 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/dataManager/record/RecordFieldData.class.php (line 15)

Variable Summary

mixed $_active

mixed $_dataID

mixed $_date

mixed $_myID

mixed $_parent

mixed $_primitive

mixed $_prune

mixed $_recast

mixed $_update

Method Summary

RecordFieldData RecordFieldData (mixed $parent, [mixed $active = false])

void cancelPrune ()

bool commit ()

bool getActiveFlag ()

ref getDate ()

int getID ()

ref getPrimitive ()

bool isActive ()

void populate (ref $row)

void prune ()

void recastAsStorable ()

ref replicate (ref $parent)

void setActiveFlag (bool $active)

void setDate (ref $date)

void setValueFromPrimitive (ref $object)

void takeValueFromPrimitive (ref $object)

void update ()

bool willPrune ()

Variables

mixed $_active = false (line 22)

mixed $_dataID (line 18)

mixed $_date = null (line 20)

mixed $_myID (line 17)

mixed $_parent = null (line 24)

mixed $_primitive = null (line 21)

mixed $_prune = false (line 27)

mixed $_recast = false (line 28)

mixed $_update = false (line 26)

Methods

Constructor RecordFieldData (line 30)

RecordFieldData RecordFieldData (mixed $parent, [mixed $active = false])

cancelPrune (line 143)

Unflags us for deletion from the DB.

access: public

void cancelPrune ()

commit (line 172)

Commits any changes that have been made to the database. If neither update() nor prune() have been called, even if changes have been made, they will not be reflected in the database.

access: public

bool commit ()

getActiveFlag (line 82)

Returns the current active flag.

access: public

bool getActiveFlag ()

getDate (line 318)

Returns the created/modified timestamp of this specific version.

return: object A DateAndTime object.
access: public

ref getDate ()

getID (line 339)

Returns our ID in the database.

access: public

int getID ()

getPrimitive (line 309)

Returns the current value object contained locally.

return: object A Primitive.
access: public

ref getPrimitive ()

isActive (line 92)

Returns the current active flag.

access: public

bool isActive ()

populate (line 101)

Takes a single database row and sets local data (like the modified timestamp, etc) variables based on that row.

access: public

void populate (ref $row)

ref $row: array $row The associative database row.

prune (line 131)

Flags us for deletion from the DB.

access: public

void prune ()

recastAsStorable (line 152)

Re-casts our internal Primitive data object as a StorablePrimitive of the same data type.

access: public

void recastAsStorable ()

replicate (line 43)

Returns an exact data-specific replica of the current object.

return: object
access: public

ref replicate (ref $parent)

ref $parent: object $parent The new parent object to use instead of our parent.

setActiveFlag (line 68)

Changes the active flag of this RecordFieldData to $active.

access: public

void setActiveFlag (bool $active)

bool $active

setDate (line 328)

Sets the date reflected within our local variables to $date.

access: public

void setDate (ref $date)

ref $date: object A DateAndTime object.

setValueFromPrimitive (line 299)

Sets the local valueObject to be a reference to $object.

access: public

void setValueFromPrimitive (ref $object)

ref $object: object $object A new Primitive object.

takeValueFromPrimitive (line 289)

Takes a Primitive object and hands it to our local value object so that it can set its own value based on $object.

access: public

void takeValueFromPrimitive (ref $object)

ref $object: object $object

update (line 60)

Flags this RecordFieldData to be updated to the database upon commit().

access: public

void update ()

willPrune (line 278)

Returns if this ValueVersion object is flagged to delete itself from the DB upon commit().

access: public

bool willPrune ()