Docs For Class TaggedItem

Class TaggedItem

Description

<##>

version: $Id: TaggedItem.class.php,v 1.4 2007/09/13 16:04:16 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College
since: 11/2/06

Located in /harmoni/core/Tagging/TaggedItem.class.php (line 23)

Direct descendents

Class	Description
HarmoniNodeTaggedItem	<##>
UrlTaggedItem	<##>

Method Summary

void deleteTagsByAgent (object Id $agentId)

object forDatabaseRow (array $row)

object forId (mixed $id, string $system, [mixed $class = 'TaggedItem'])

integer getDatabaseId ()

integer getDatabaseIndex ()

string getDescription ()

string getDisplayName ()

mixed getId ()

string getIdString ()

object TagIterator getNonUserTags ([string $sortBy = TAG_SORT_ALFA], integer $max)

string getSystem ()

object TagIterator getTags ([string $sortBy = TAG_SORT_ALFA], integer $max)

object TagIterator getTagsByAgent (object Id $agentId, [string $sortBy = TAG_SORT_ALFA], integer $max)

object TagIterator getTagsNotByAgent (object Id $agentId, [string $sortBy = TAG_SORT_ALFA], integer $max)

string getThumbnailUrl ()

string getUrl ()

object TagIterator getUserTags ([string $sortBy = TAG_SORT_ALFA], integer $max)

Methods

deleteTagsByAgent (line 135)

Delete the tags for this item created by a given agent

since: 11/27/06
access: public

void deleteTagsByAgent (object Id $agentId)

object Id $agentId

forDatabaseRow (line 53)

Create an Item for a database row

since: 11/6/06
access: public

object forDatabaseRow (array $row)

array $row

forId (line 34)

Constructor

since: 11/2/06
access: public

object forId (mixed $id, string $system, [mixed $class = 'TaggedItem'])

string $system: The system an Id is accessed through
mixed $id: object or string $id

Redefined in descendants as:

HarmoniNodeTaggedItem::forId() : Constructor
UrlTaggedItem::forId() : Constructor

getDatabaseId (line 201)

Insert [if needed] into the item table and return the database id of this item

since: 11/6/06
access: public

integer getDatabaseId ()

getDatabaseIndex (line 283)

Answer the database index

since: 11/6/06
access: public

integer getDatabaseIndex ()

getDescription (line 261)

Answer the description of this item

since: 11/3/06
access: public

string getDescription ()

Redefined in descendants as:

HarmoniNodeTaggedItem::getDescription() : Answer the description of this item
UrlTaggedItem::getDescription() : Answer the description of this item

getDisplayName (line 250)

Answer the display name for this item

since: 11/3/06
access: public

string getDisplayName ()

Redefined in descendants as:

HarmoniNodeTaggedItem::getDisplayName() : Answer the display name for this item
UrlTaggedItem::getDisplayName() : Answer the display name for this item

getId (line 68)

Answer the id that was given to this object

return: object or string
since: 11/3/06
access: public

mixed getId ()

getIdString (line 79)

Answer the string version of the id given to this object

since: 11/3/06
access: public

string getIdString ()

getNonUserTags (line 187)

Answer the tags for this item not created by the current user

since: 11/1/06
access: public

object TagIterator getNonUserTags ([string $sortBy = TAG_SORT_ALFA], integer $max)

string $sortBy: Return tags in alphanumeric order or by frequency of usage.
integer $max: The maximum number of tags to return. The least frequently used tags will be dropped first. If $max is 0, all tags will be returned.

getSystem (line 90)

Answer the name of the system this item is stored in

since: 11/3/06
access: public

string getSystem ()

getTags (line 104)

Answer the tags for this item

since: 11/1/06
access: public

object TagIterator getTags ([string $sortBy = TAG_SORT_ALFA], integer $max)

string $sortBy: Return tags in alphanumeric order or by frequency of usage.
integer $max: The maximum number of tags to return. The least frequently used tags will be dropped first. If $max is 0, all tags will be returned.

getTagsByAgent (line 121)

Answer the tags for this item created by a given agent

since: 11/1/06
access: public

object TagIterator getTagsByAgent (object Id $agentId, [string $sortBy = TAG_SORT_ALFA], integer $max)

object Id $agentId
string $sortBy: Return tags in alphanumeric order or by frequency of usage.
integer $max: The maximum number of tags to return. The least frequently used tags will be dropped first. If $max is 0, all tags will be returned.

getTagsNotByAgent (line 171)

Answer the tags for this item created by a given agent

since: 11/1/06
access: public

object TagIterator getTagsNotByAgent (object Id $agentId, [string $sortBy = TAG_SORT_ALFA], integer $max)

object Id $agentId
string $sortBy: Return tags in alphanumeric order or by frequency of usage.
integer $max: The maximum number of tags to return. The least frequently used tags will be dropped first. If $max is 0, all tags will be returned.

getThumbnailUrl (line 272)

Answer the thumbnail url of this item

since: 11/3/06
access: public

string getThumbnailUrl ()

Redefined in descendants as:

HarmoniNodeTaggedItem::getThumbnailUrl() : Answer the thumbnail url of this item
UrlTaggedItem::getThumbnailUrl() : Answer the thumbnail url of this item

getUrl (line 239)

Answer the url to this item

since: 11/3/06
access: public

string getUrl ()

Redefined in descendants as:

HarmoniNodeTaggedItem::getUrl() : Answer the url to this item
UrlTaggedItem::getUrl() : Answer the url to this item

getUserTags (line 154)

Answer the tags for this item created by the current user

since: 11/1/06
access: public

object TagIterator getUserTags ([string $sortBy = TAG_SORT_ALFA], integer $max)

string $sortBy: Return tags in alphanumeric order or by frequency of usage.
integer $max: The maximum number of tags to return. The least frequently used tags will be dropped first. If $max is 0, all tags will be returned.

Documentation generated on Wed, 19 Sep 2007 10:27:10 -0400 by phpDocumentor 1.3.0RC3