Docs For Class StorableRecordSet

Description

The StorableRecordSet allows you to store a RecordSet in the database.

version: $Id: StorableRecordSet.class.php,v 1.12 2007/09/04 20:25:32 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

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

RecordSet
   |
   --StorableRecordSet

Variable Summary

mixed $_fetchedIDs

mixed $_fetchMode

mixed $_myID

mixed $_storedRecordIDs

Method Summary

StorableRecordSet StorableRecordSet (mixed $id)

void addRecordID (integer $id)

void commit ([boolean $ignoreMandatory = false])

int getID ()

ref getRecordByID (int $id)

array getRecordIDs ()

void loadRecords ([optional $mode = RECORD_CURRENT], [optional $limitResults = null])

void removeRecord (ref $record)

void removeRecordByID (int $id)

boolean revertToDate (ref $date)

void takeRow (ref $row)

Variables

mixed $_fetchedIDs (line 17)

mixed $_fetchMode (line 19)

mixed $_myID (line 20)

mixed $_storedRecordIDs (line 18)

Inherited Variables

Inherited from RecordSet

RecordSet::$_dirty
RecordSet::$_records

Methods

Constructor StorableRecordSet (line 22)

StorableRecordSet StorableRecordSet (mixed $id)

addRecordID (line 168)

Adds the given ID to our list of Records.

void addRecordID (integer $id)

integer $id

commit (line 120)

Attempts to commit our Records to the database and update our mapping.

void commit ([boolean $ignoreMandatory = false])

boolean $ignoreMandatory: optional $ignoreMandatory If true, doesn't fail if mandatory fields don't have values.

getID (line 78)

Returns our ID.

access: public

int getID ()

getRecordByID (line 195)

Returns a Record by ID.

return: object
access: public

ref getRecordByID (int $id)

int $id

getRecordIDs (line 69)

Returns an array of Record IDs that we know about.

array getRecordIDs ()

Redefinition of:

RecordSet::getRecordIDs(): Returns an array of Record IDs that we know about.

loadRecords (line 50)

Fetches all the Records that we know about.

Use RecordSet::getRecords() to get the fetched records.

void loadRecords ([optional $mode = RECORD_CURRENT], [optional $limitResults = null])

optional $mode: int $mode Defaults to RECORD_CURRENT. Specifies the fetch mode. Must be one of the RECORD_* constants.
optional $limitResults: mixed $limitResults NOT IMPLEMENTED.

removeRecord (line 89)

Removes the given record from the set.

access: public

void removeRecord (ref $record)

ref $record: object $record A Record object.

Redefinition of:

RecordSet::removeRecord(): Removes the given record from the set.

removeRecordByID (line 183)

Remove a record by ID.

access: public

void removeRecordByID (int $id)

int $id

revertToDate (line 218)

Returns all of the Records within this Set to the state they were in on the given date.

access: public

boolean revertToDate (ref $date)

ref $date: object $date A DateAndTime object.

Redefinition of:

RecordSet::revertToDate(): Returns all of the Records within this Set to the state they were in on the given date.

takeRow (line 37)

Takes an associative array of columns from a database query and populates internal variables.

void takeRow (ref $row)

ref $row: array $row

Inherited Methods

Inherited From RecordSet

RecordSet::RecordSet()
RecordSet::add()
RecordSet::addRecord()
RecordSet::addRecords()
RecordSet::contains()
RecordSet::getMergedTagDates()
RecordSet::getRecordIDs()
RecordSet::getRecords()
RecordSet::getRecordsByLabel()
RecordSet::getRecordsByType()
RecordSet::numRecords()
RecordSet::removeRecord()
RecordSet::revertToDate()