Docs For Class RecordTagManager

Description

Handles the creation and retrieval of RecordTags to/from the database. See RecordTag for a more detailed explanation of the role of tags.

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

Method Summary

void checkForEmptyTags (ref $record)

void deleteRecordTags (int $id)

ref fetchTagDescriptors (int $id)

ref fetchTags (int $id)

void pruneTag (ref $tag)

void pruneTags (ref $record)

int tagRecord (ref $record, [optional $date = null])

Methods

checkForEmptyTags (line 153)

Checks to see if any of our RecordTags are empty, and if so, deletes them.

void checkForEmptyTags (ref $record)

ref $record: object $record The Record to check.

deleteRecordTags (line 282)

Deletes all tags stored in the database for Record id $id.

access: public

void deleteRecordTags (int $id)

int $id

fetchTagDescriptors (line 188)

Returns an array of RecordTags without having loaded all of the mapping data. Useful for just checking what tags are available and what dates they were created on.

return: array
access: public

ref fetchTagDescriptors (int $id)

int $id: The ID of the Record to look for.

fetchTags (line 224)

Fetches all of the RecordTags available for Record ID $id with all mapping data loaded.

return: array
access: public

ref fetchTags (int $id)

int $id: The Record ID.

pruneTag (line 126)

Removes specific tag from the database.

void pruneTag (ref $tag)

ref $tag: object $tag A RecordTag object.

pruneTags (line 83)

Removes from the Database all tags associated with $record.

void pruneTags (ref $record)

ref $record: object $record A Record object.

tagRecord (line 26)

Takes a Record and an optional date and creates a RecordTag in the database based on the current active versions of values within the Record.

return: The new tag's ID in the database.
access: public

int tagRecord (ref $record, [optional $date = null])

ref $record: object $record The Record to be tagged.
optional $date: object $date An optional DateAndTime object to attach to the tag instead of the current date/time.