Docs For Class RecordTag

Description

Stores the mapping between a RecordTag and the specific versions of values within a Record that were created when the Record was tagged. A tag can be thought of like a CVS tag, where each file in CVS is like a specific value in a record. Each value has its own number of versions, and a RecordTag can remember all the versions that were active at any given time.

version: $Id: Tag.class.php,v 1.10 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/Tag.class.php (line 16)

Variable Summary

mixed $_date

mixed $_loaded

mixed $_mappings

mixed $_myID

mixed $_recordID

Method Summary

RecordTag RecordTag (mixed $recordID, mixed $date, [mixed $id = null])

ref getDate ()

int getID ()

int getMapping (string $id, int $index)

int getRecordID ()

bool haveMappings (string $id)

bool load ()

void populate (array $arrayOfRows)

Variables

mixed $_date (line 20)

mixed $_loaded (line 24)

mixed $_mappings (line 22)

mixed $_myID (line 18)

mixed $_recordID (line 19)

Methods

Constructor RecordTag (line 26)

RecordTag RecordTag (mixed $recordID, mixed $date, [mixed $id = null])

getDate (line 60)

Returns the DateAndTime timestamp of this tag.

return: object
access: public

ref getDate ()

getID (line 96)

Returns our ID.

int getID ()

getMapping (line 71)

Returns the specific version of a value that was active when this tag was created.

return: The version ID.
access: public

int getMapping (string $id, int $index)

string $id: The field id to look for.
int $index: The specific index within that label to look for.

getRecordID (line 90)

Returns the ID of the Record for which this RecordTag was created.

access: public

int getRecordID ()

haveMappings (line 81)

Checks whether a mapping for this $id was defined when the tag was created.

access: public

bool haveMappings (string $id)

string $id

load (line 103)

Loads the tag mapping data from the database, if it hasn't done so already.

access: public

bool load ()

populate (line 40)

Takes an array of database rows and populates the local mapping arrays based on those rows.

access: public

void populate (array $arrayOfRows)

array $arrayOfRows