claroline/claroline/inc/lib/courselist.lib.php File Reference

Go to the source code of this file.

Data Structures
class	category_browser
Namespaces
namespace	CLCOURSELIST
Functions
	search_course ($keyword, $userId=null)
	get_user_course_list ($userId, $renew=false)
	get_user_course_list_desactivated ($userId, $renew=false)
	get_locked_course_explanation ($course_id=null)
	get_locked_course_by_key_explanation ($course_id=null)
	build_category_trail ($categoryList, $requiredCode)
	render_course_dt_in_dd_list ($course, $hot=false)
	render_user_course_list_desactivated ()
	render_user_course_list ()
	get_course_access_icon ($accessMode)

---

Function Documentation

build_category_trail	(	$	categoryList,
		$	requiredCode
	)

Definition at line 429 of file courselist.lib.php.

get_course_access_icon

(

$

accessMode

)

Get an icon url according to a course access mode ('public', 'private' or 'platform')

Parameters:

string

$accessMode : label of the access mode for which an icon is asked for

Returns:

string : the url to the icon

Definition at line 736 of file courselist.lib.php.

get_locked_course_by_key_explanation

(

$

course_id = null

)

Return the editable textzone for a course where subscript are locked

Parameters:

string

$course_id

Returns:

string : html content

Definition at line 402 of file courselist.lib.php.

get_locked_course_explanation

(

$

course_id = null

)

return the editable textzone for a course where subscript are denied

Parameters:

string

$course_id

Returns:

string : html content

Definition at line 371 of file courselist.lib.php.

get_user_course_list	(	$	userId,
		$	renew = false
	)

Return the list of course of a user.

Parameters:

	int	$userId valid id of a user
	boolean	$renew whether true, force to read databaseingoring an existing cache.

Returns:

array (list of course) of array (course settings) of the given user.

Todo:

search and merge other instance of this functionality

Definition at line 241 of file courselist.lib.php.

get_user_course_list_desactivated	(	$	userId,
		$	renew = false
	)

Return the list of disabled or unpublished course of a user.

Parameters:

	int	$userId valid id of a user
	boolean	$renew whether true, force to read databaseingoring an existing cache.

Returns:

array (list of course) of array (course settings) of the given user.

Todo:

search and merge other instance of this functionality

Definition at line 306 of file courselist.lib.php.

render_course_dt_in_dd_list	(	$	course,
		$	hot = false
	)

Definition at line 455 of file courselist.lib.php.

render_user_course_list

(

)

Definition at line 621 of file courselist.lib.php.

render_user_course_list_desactivated

(

)

Definition at line 526 of file courselist.lib.php.

search_course	(	$	keyword,
		$	userId = null
	)

Search a specific course based on his course code

Author:

Hugues Peeters <peeters@ipm.ucl.ac.be>

Parameters:

	string	$keyword course code from the cours table
	mixed	$userId null or valid id of a user (default:null)

Returns:

array course parameters

Definition at line 160 of file courselist.lib.php.