Docs For Class RecordSet

Description

The RecordSet class holds a list of IDs and their Records in a specific record set.

version: $Id: RecordSet.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/RecordSet.class.php (line 13)

Direct descendents

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

Variable Summary

mixed $_dirty

mixed $_records

Method Summary

RecordSet RecordSet ()

void add (ref $record)

void addRecord (ref $record)

void addRecords (ref $records)

boolean contains (ref $record)

array getMergedTagDates ()

array getRecordIDs ()

ref getRecords ()

ref getRecordsByLabel (string $label)

ref getRecordsByType (string $id)

int numRecords ()

void removeRecord (ref $record)

boolean revertToDate (ref $date)

Variables

mixed $_dirty (line 17)

mixed $_records (line 15)

Methods

Constructor RecordSet (line 19)

RecordSet RecordSet ()

add (line 153)

Adds the given Record to our list.

void add (ref $record)

ref $record: object $record

addRecord (line 165)

This is a synonym for RecordSet::add().

access: public

void addRecord (ref $record)

ref $record: object $record

addRecords (line 31)

Adds the records in the passed array to our set.

access: public

void addRecords (ref $records)

ref $records: array $records An array of Record objects.

contains (line 65)

Returns if this set contains the passed Record

access: public

boolean contains (ref $record)

ref $record: object $record

getMergedTagDates (line 175)

Returns an array of merged tag-dates (as DateAndTime objects) which can be used to setup our Records as they were on a specific date.

access: public

array getMergedTagDates ()

getRecordIDs (line 107)

Returns an array of Record IDs that we know about.

array getRecordIDs ()

Redefined in descendants as:

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

getRecords (line 54)

Returns an array of records.

return: array
access: public

ref getRecords ()

getRecordsByLabel (line 143)

Returns an array of records based on a label assigned previously. NOTE: this is a proposed method and has not been implemented.

return: array
access: public

ref getRecordsByLabel (string $label)

string $label: The string label of the Records to return.

getRecordsByType (line 123)

Returns an array of Records of the passed Schema Type.

return: array
access: public

ref getRecordsByType (string $id)

string $id: A type/ID string linked with a Schema.

numRecords (line 44)

Returns the number of records in this set.

access: public

int numRecords ()

removeRecord (line 84)

Removes the given record from the set.

access: public

void removeRecord (ref $record)

ref $record: object $record A Record object.

Redefined in descendants as:

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

revertToDate (line 202)

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.

Redefined in descendants as:

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