Class used to return completion progress information. More...

Static Public Member Functions
static	get_course_progress_percentage ($course, $userid=0)
	Returns the course percentage completed by a certain user, returns null if no completion data is available. More...

Detailed Description

Class used to return completion progress information.

Member Function Documentation

static core_completion\progress::get_course_progress_percentage	(	$course,
		$userid = `0`
	)

static

Returns the course percentage completed by a certain user, returns null if no completion data is available.

Parameters

stdClass	$course	Moodle course object
int	$userid	The id of the user, 0 for the current user

Return values

null|float The percentage, or null if completion is not supported in the course, or there are no activities that support completion.

The documentation for this class was generated from the following file: