Class: aiccItem

Source Location: /main/newscorm/aiccItem.class.php

Class Overview

learnpathItem
   |
   --aiccItem

lp_item defines items belonging to a learnpath. Each item has a name, a score, a use time and additional

Variables

Methods

Inherited Variables

Class: learnpathItem

learnpathItem::$attempt_id
learnpathItem::$children
learnpathItem::$condition
learnpathItem::$current_data
learnpathItem::$current_score
learnpathItem::$current_start_time
learnpathItem::$current_stop_time
learnpathItem::$db_id
learnpathItem::$db_item_view_id
learnpathItem::$description
learnpathItem::$file
learnpathItem::$interactions
learnpathItem::$interactions_count
learnpathItem::$launch_data
learnpathItem::$lesson_location
learnpathItem::$level
learnpathItem::$lp_id
learnpathItem::$mastery_score
learnpathItem::$max_score
learnpathItem::$max_time_allowed
learnpathItem::$min_score
learnpathItem::$name
learnpathItem::$next
learnpathItem::$objectives
learnpathItem::$objectives_count
learnpathItem::$parent
learnpathItem::$path
learnpathItem::$possible_status
learnpathItem::$prereqs
learnpathItem::$prereq_alert
learnpathItem::$prereq_string
learnpathItem::$prevent_reinit
learnpathItem::$previous
learnpathItem::$ref
learnpathItem::$save_on_close
learnpathItem::$status
learnpathItem::$type
learnpathItem::$view_id

Inherited Methods

Class: learnpathItem

learnpathItem::learnpathItem(): Class constructor. Prepares the learnpath_item for later launch
learnpathItem::add_child(): Adds a child to the current item
learnpathItem::add_interaction(): Adds an interaction to the current item
learnpathItem::add_objective(): Adds an objective to the current item
learnpathItem::close(): Closes/stops the item viewing. Finalises runtime values. If required, save to DB.
learnpathItem::delete(): Deletes all traces of this item in the database
learnpathItem::drop_child(): Drops a child from the children array
learnpathItem::get_attempt_id(): Gets the current attempt_id for this user on this item
learnpathItem::get_children(): Gets a list of the item's children
learnpathItem::get_core_exit(): Gets the core_exit value from the database
learnpathItem::get_credit(): Gets the credit information (rather scorm-stuff) based on current status and reinit
learnpathItem::get_current_start_time(): Gets the current start time property
learnpathItem::get_description(): Gets the item's description
learnpathItem::get_file_path(): Gets the file path from the course's root directory, no matter what tool it is from.
learnpathItem::get_id(): Gets the DB ID
learnpathItem::get_interactions_count(): Gets the current count of interactions recorded in the database
learnpathItem::get_launch_data(): Gets the launch_data field found in imsmanifests (this is SCORM- or AICC-related, really)
learnpathItem::get_lesson_location(): Gets the lesson location
learnpathItem::get_lesson_mode(): Gets the lesson_mode (scorm feature, but might be used by aicc as well as dokeos paths)
learnpathItem::get_level(): Gets the depth level
learnpathItem::get_mastery_score(): Gets the mastery score
learnpathItem::get_max(): Gets the maximum (score)
learnpathItem::get_max_time_allowed(): Gets the maximum time allowed for this user in this attempt on this item
learnpathItem::get_min(): Gets the minimum (score)
learnpathItem::get_objectives_count(): Gets the current count of objectives recorded in the database
learnpathItem::get_parent(): Gets the parent ID
learnpathItem::get_path(): Gets the path attribute.
learnpathItem::get_prereq_string(): Gets the prerequisites string
learnpathItem::get_prevent_reinit(): Gets the prevent_reinit attribute value (and sets it if not set already)
learnpathItem::get_ref(): Gets the item's reference column
learnpathItem::get_resources_from_source(): Gets the list of included resources as a list of absolute or relative paths of resources included in the current item. This allows for a better SCORM export.
learnpathItem::get_score(): Gets the score
learnpathItem::get_scorm_time(): Gets the total time spent on this item view so far
learnpathItem::get_status(): Gets the item status
learnpathItem::get_suspend_data(): Gets the suspend data
learnpathItem::get_title(): Returns the item's title
learnpathItem::get_total_time(): Returns the total time used to see that item
learnpathItem::get_type(): Gets the item type
learnpathItem::get_view_count(): Gets the view count for this item
learnpathItem::is_done(): Tells if an item is done ('completed','passed','succeeded') or not
learnpathItem::is_restart_allowed(): Tells if a restart is allowed (take it from $this->prevent_reinit and $this->status)
learnpathItem::open(): Opens/launches the item. Initialises runtime values.
learnpathItem::output(): Outputs the item contents
learnpathItem::parse_HTML_attributes(): Parses the HTML attributes given as string.
learnpathItem::parse_prereq(): Parses the prerequisites string with the AICC logic language
learnpathItem::restart(): Reinits all local values as the learnpath is restarted
learnpathItem::save(): Saves data in the database
learnpathItem::set_attempt_id(): Sets the number of attempt_id to a given value
learnpathItem::set_core_exit(): Sets the core_exit value to the one given
learnpathItem::set_description(): Sets the item's description
learnpathItem::set_lesson_location(): Sets the lesson_location value
learnpathItem::set_level(): Sets the item's depth level in the LP tree (0 is at root)
learnpathItem::set_lp_view(): Sets the lp_view id this item view is registered to
learnpathItem::set_max_score(): Sets the maximum score for this item
learnpathItem::set_path(): Sets the path
learnpathItem::set_prevent_reinit(): Sets the prevent_reinit attribute. This is based on the LP value and is set at creation time for each learnpathItem. It is a (bad?) way of avoiding a reference to the LP when saving an item.
learnpathItem::set_score(): Sets the score value. If the mastery_score is set and the score reaches it, then set the status to 'passed'.
learnpathItem::set_status(): Sets the status for this item
learnpathItem::set_time(): Sets the item viewing time in a usable form, given that SCORM packages often give it as 00:00:00.0000
learnpathItem::set_title(): Sets the item's title
learnpathItem::set_type(): Sets the item's type
learnpathItem::status_is(): Checks if the current status is part of the list of status given
learnpathItem::update_time(): Updates the time info according to the given session_time
learnpathItem::write_objectives_to_db(): Write objectives to DB. This method is separate from write_to_db() because otherwise
learnpathItem::write_to_db(): Writes the current data to the database

Class Details

[line 12]
lp_item defines items belonging to a learnpath. Each item has a name, a score, a use time and additional

information that enables tracking a user's progress in a learning path

[ Top ]

Class Variables

$au_type = ''

[line 26]

Type:

mixed

[ Top ]

$command_line = ''

[line 27]

Type:

mixed

[ Top ]

$core_vendor = ''

[line 24]

Type:

mixed

[ Top ]

$debug = 0

[line 28]

Type:	mixed
Overrides:	Array

[ Top ]

$identifier = ''

[line 13]

Type:

mixed

[ Top ]

$identifierref = ''

[line 14]

Type:

mixed

[ Top ]

$masteryscore = ''

[line 23]

Type:

mixed

[ Top ]

$maxtimeallowed = '00:00:00'

[line 21]

Type:

mixed

[ Top ]

$parameters = ''

[line 15]

Type:

mixed

[ Top ]

$sub_items = array()

[line 17]

Type:

mixed

[ Top ]

$system_vendor = ''

[line 25]

Type:

mixed

[ Top ]

$timelimitaction = ''

[line 22]

Type:

mixed

[ Top ]

$title = ''

[line 16]

Type:	mixed
Overrides:	Array

[ Top ]

Class Methods

constructor aiccItem [line 36]

aiccItem aiccItem(
[string
$type = 'config'], mixed
$params)

Class constructor. Depending of the type of construction called ('db' or 'manifest'), will create a scormItem

object from database records or from the array given as second parameter

Parameters:

string	$type	Type of construction needed ('db' or 'config', default = 'config')
mixed	$params	Depending on the type given, DB id for the lp_item or parameters array

[ Top ]

method get_flat_list [line 99]

void get_flat_list(
array
&$list, integer
&$abs_order, [integer
$rel_order = 1], [integer
$level = 0])

Builds a flat list with the current item and calls itself recursively on all children

Parameters:

array	&$list	Reference to the array to complete with the current item
integer	&$abs_order	Optional absolute order (pointer) of the item in this learning path
integer	$rel_order	Optional relative order of the item at this level
integer	$level	Optional level. If not given, assumes it's level 0

[ Top ]

method save [line 127]

void save(
[boolean
$from_outside = true], [
$prereqs_complete = false])

Save function. Uses the parent save function and adds a layer for AICC.

Overrides learnpathItem::save() (Saves data in the database)

Parameters:

boolean	$from_outside	Save from URL params (1) or from object attributes (0)
	$prereqs_complete

[ Top ]

Documentation generated on Thu, 12 Jun 2008 12:57:14 -0500 by phpDocumentor 1.4.1