Tag API before 3.1

Revision as of 09:24, 23 January 2012 by Gerard Caulfield (talk | contribs) (Overview)

Jump to: navigation, search

Moodle 2.0


WORK IN PROGRESS: I've currently just created a template, so please ignore this page until this wip notices has been removed. However, you are free to help in the construction of this page by improving it. Please review the edit history if you would like to contact the user who put up this notice. If this article has not been edited by that user in a while, please remove this template.


Objectives

The goals of Tag API:

  • example goal


Tag API overview

Tag API provides following functionalities:

  1. example functionality

Tag API Usage

Title for the example goes here

Description of the example:

shortexamplecode();

Title for the second example goes here

Description of the example:

shortexamplecode();

Tag API overview

The Tag API has been implemented in lib/moodlelib.php.

examplefunction()

Example function description.

Tag API database tables

Tag

This table holds all of the tags which are currently available in the system.

Field Type Default Info
id int(10) auto-incrementing The unique ID for this Tag.
userid int(10) The user that the Tag belongs to
name varchar(255) null
rawname varchar(255)
tagtype varchar(255) NULL null
description text NULL
descriptionformat tinyint(2) unsigned 0
flag smallint(4) 0
timemodified bigint(10)

Tag_Instance

This table is use to record the instances of each tag's use. It has a many to one relationship with the tag table shown above.

Field Type Default Info
id int(10) auto-incrementing The unique ID for this Tag.
tagid int(10) The user that the Tag belongs to
itemtype varchar(255) null
itemid int(10)
tiuserid int(10) 0  ???The userid of the user which owns the tag instance???
ordering int(10)
timemodified int(10) 0

Tag_Correlation

This table only exists for performance reasons

Field Type Default Info
id int(10) auto-incrementing The unique ID for this tag correlation.
tagid int(10) The the id of the tag
correlatedtags text

See also