dokeos-learningpath
[ class tree: dokeos-learningpath ] [ index: dokeos-learningpath ] [ all elements ]

Class: learnpathList

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

Class Overview


This class is only a learning path list container with several practical methods for sorting the list and


Author(s):

Variables

Methods



Class Details

[line 13]
This class is only a learning path list container with several practical methods for sorting the list and

provide links to specific paths




Tags:

uses:  learnpath.class.php - to generate learnpath objects to get in the list
uses:  Database.lib.php - to use the database


[ Top ]


Class Variables

$alpha_list = array()

[line 16]


Type:   mixed


[ Top ]

$course_code =

[line 17]


Type:   mixed


[ Top ]

$list = array()

[line 14]


Type:   mixed


[ Top ]

$refs_active =  false

[line 19]


Type:   mixed


[ Top ]

$ref_list = array()

[line 15]


Type:   mixed


[ Top ]

$user_id =

[line 18]


Type:   mixed


[ Top ]



Class Methods


constructor learnpathList [line 29]

void learnpathList( integer $user_id, [string $course_code = ''])

This method is the constructor for the learnpathList. It gets a list of available learning paths from the database and creates the learnpath objects. This list depends on the user that is connected (only displays) items if he has enough permissions to view them.



Parameters:

integer   $user_id   User ID
string   $course_code   Optional course code (otherwise we use api_get_course_id())

[ Top ]

method get_flat_list [line 101]

array get_flat_list( )

Gets a table of the different learnpaths we have at the moment



Tags:

return:  Learnpath info as [lp_id] => ([lp_type]=> ..., [lp_name]=>...,[lp_desc]=>...,[lp_path]=>...)


[ Top ]

method get_refs [line 89]

array get_refs( )

Gets references to learnpaths for all learnpaths IDs kept in the local list.

This applies a transformation internally on list and ref_list and returns a copy of the refs list




Tags:

return:  List of references to learnpath objects


[ Top ]


Documentation generated on Thu, 12 Jun 2008 13:58:30 -0500 by phpDocumentor 1.4.1