Anupama Sarjoshi
48520cfc6a
This change ensures that course completion percentage calculations include only completion activities visible to the user on the course home page. Hidden or unavailable activities, and those in hidden sections, are no longer included in the calculation.
85 lines
2.8 KiB
PHP
85 lines
2.8 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Contains class used to return completion progress information.
|
|
*
|
|
* @package core_completion
|
|
* @copyright 2017 Mark Nelson <markn@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core_completion;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
require_once($CFG->libdir . '/completionlib.php');
|
|
|
|
/**
|
|
* Class used to return completion progress information.
|
|
*
|
|
* @package core_completion
|
|
* @copyright 2017 Mark Nelson <markn@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class progress {
|
|
|
|
/**
|
|
* Returns the course percentage completed by a certain user, returns null if no completion data is available.
|
|
*
|
|
* @param \stdClass $course Moodle course object
|
|
* @param int $userid The id of the user, 0 for the current user
|
|
* @return null|float The percentage, or null if completion is not supported in the course,
|
|
* or there are no activities that support completion.
|
|
*/
|
|
public static function get_course_progress_percentage($course, $userid = 0) {
|
|
global $USER;
|
|
|
|
// Make sure we continue with a valid userid.
|
|
if (empty($userid)) {
|
|
$userid = $USER->id;
|
|
}
|
|
|
|
$completion = new \completion_info($course);
|
|
|
|
// First, let's make sure completion is enabled.
|
|
if (!$completion->is_enabled()) {
|
|
return null;
|
|
}
|
|
|
|
if (!$completion->is_tracked_user($userid)) {
|
|
return null;
|
|
}
|
|
|
|
// Before we check how many modules have been completed see if the course has.
|
|
if ($completion->is_course_complete($userid)) {
|
|
return 100;
|
|
}
|
|
|
|
// Get the number of modules that support completion.
|
|
$modules = $completion->get_user_activities_with_completion($userid);
|
|
$count = count($modules);
|
|
if (!$count) {
|
|
return null;
|
|
}
|
|
|
|
// Get the number of modules that have been completed.
|
|
$totalcompleted = $completion->count_modules_completed($userid, array_keys($modules));
|
|
|
|
return ($totalcompleted / $count) * 100;
|
|
}
|
|
}
|