See Release Notes
Long Term Support Release
<?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/>. /** * Course completion status for a particular user/course * * @package core_completion * @category completion * @copyright 2009 Catalyst IT Ltd * @author Aaron Barnes <aaronb@catalyst.net.nz> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); require_once($CFG->dirroot.'/completion/data_object.php'); /** * Course completion status for a particular user/course * * @package core_completion * @category completion * @copyright 2009 Catalyst IT Ltd * @author Aaron Barnes <aaronb@catalyst.net.nz> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class completion_completion extends data_object { /* @var string $table Database table name that stores completion information */ public $table = 'course_completions'; /* @var array $required_fields Array of required table fields, must start with 'id'. */ public $required_fields = array('id', 'userid', 'course', 'timeenrolled', 'timestarted', 'timecompleted', 'reaggregate'); /* @var int $userid User ID */ public $userid; /* @var int $course Course ID */ public $course; /* @var int Time of course enrolment {@link completion_completion::mark_enrolled()} */ public $timeenrolled; /** * Time the user started their course completion {@link completion_completion::mark_inprogress()} * @var int */ public $timestarted; /* @var int Timestamp of course completion {@link completion_completion::mark_complete()} */ public $timecompleted; /* @var int Flag to trigger cron aggregation (timestamp) */ public $reaggregate; /** * Finds and returns a data_object instance based on params. * * @param array $params associative arrays varname = >value * @return data_object instance of data_object or false if none found. */ public static function fetch($params) { $cache = cache::make('core', 'coursecompletion'); $key = $params['userid'] . '_' . $params['course']; if ($hit = $cache->get($key)) { return $hit['value']; } $tocache = self::fetch_helper('course_completions', __CLASS__, $params); $cache->set($key, ['value' => $tocache]); return $tocache; } /** * Return status of this completion * * @return bool */ public function is_complete() { return (bool) $this->timecompleted; } /** * Mark this user as started (or enrolled) in this course * * If the user is already marked as started, no change will occur * * @param integer $timeenrolled Time enrolled (optional)> * @return int|null id of completion record on successful update.*/ public function mark_enrolled($timeenrolled = null) { if ($this->timeenrolled === null) { if ($timeenrolled === null) { $timeenrolled = time(); } $this->timeenrolled = $timeenrolled; } return $this->_save(); } /** * Mark this user as inprogress in this course * * If the user is already marked as inprogress, the time will not be changed * * @param integer $timestarted Time started (optional)> * @return int|null id of completion record on successful update.*/ public function mark_inprogress($timestarted = null) { $timenow = time(); // Set reaggregate flag $this->reaggregate = $timenow; if (!$this->timestarted) { if (!$timestarted) { $timestarted = $timenow; } $this->timestarted = $timestarted; } return $this->_save(); } /** * Mark this user complete in this course * * This generally happens when the required completion criteria * in the course are complete. * * @param integer $timecomplete Time completed (optional)< * @return void> * @return int|null id of completion record on successful update.*/ public function mark_complete($timecomplete = null) { global $USER; // Never change a completion time. if ($this->timecompleted) {< return;> return null;} // Use current time if nothing supplied. if (!$timecomplete) { $timecomplete = time(); } // Set time complete. $this->timecompleted = $timecomplete;<// Save record. if ($result = $this->_save()) { $data = $this->get_record_data(); \core\event\course_completed::create_from_completion($data)->trigger(); }> // Notify user. return $result; > $course = get_course($data->course); } > $messagesubject = get_string('coursecompleted', 'completion'); > $a = [ /** > 'coursename' => get_course_display_name_for_list($course), * Save course completion status > 'courselink' => (string) new moodle_url('/course/view.php', array('id' => $course->id)), * > ]; * This method creates a course_completions record if none exists > $messagebody = get_string('coursecompletedmessage', 'completion', $a); * @access private > $messageplaintext = html_to_text($messagebody); * @return bool > */ > $eventdata = new \core\message\message(); private function _save() { > $eventdata->courseid = $course->id; if ($this->timeenrolled === null) { > $eventdata->component = 'moodle'; $this->timeenrolled = 0; > $eventdata->name = 'coursecompleted'; } > $eventdata->userfrom = core_user::get_noreply_user(); > $eventdata->userto = $data->userid; $result = false; > $eventdata->notification = 1; // Save record > $eventdata->subject = $messagesubject; if ($this->id) { > $eventdata->fullmessage = $messageplaintext; $result = $this->update(); > $eventdata->fullmessageformat = FORMAT_HTML; } else { > $eventdata->fullmessagehtml = $messagebody; // Make sure reaggregate field is not null > $eventdata->smallmessage = $messageplaintext; if (!$this->reaggregate) { > $this->reaggregate = 0; > if ($courseimage = \core_course\external\course_summary_exporter::get_course_image($course)) { } > $eventdata->customdata = [ > 'notificationpictureurl' => $courseimage, // Make sure timestarted is not null > ]; if (!$this->timestarted) { > } $this->timestarted = 0; > message_send($eventdata); } >< * @return bool> * @return int|null id of completion record on successful update.< $result = false;< if ($this->id) { < $result = $this->update();> if (isset($this->id)) { > $success = $this->update();< $result = $this->insert();> $success = $this->insert();< if ($result) {> if ($success) {$cache = cache::make('core', 'coursecompletion'); $data = $this->get_record_data(); $key = $data->userid . '_' . $data->course; $cache->set($key, ['value' => $data]);> return $this->id;}< return $result;> return null;} }