2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * Bulk activity completion manager class
20 * @package core_completion
21 * @category completion
22 * @copyright 2017 Adrian Greeve
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 namespace core_completion
;
34 defined('MOODLE_INTERNAL') ||
die;
37 * Bulk activity completion manager class
39 * @package core_completion
40 * @category completion
41 * @copyright 2017 Adrian Greeve
42 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
47 * @var int $courseid the course id.
52 * manager constructor.
53 * @param int $courseid the course id.
55 public function __construct($courseid) {
56 $this->courseid
= $courseid;
60 * Gets the data (context) to be used with the bulkactivitycompletion template.
62 * @return stdClass data for use with the bulkactivitycompletion template.
64 public function get_activities_and_headings() {
66 $moduleinfo = get_fast_modinfo($this->courseid
);
67 $sections = $moduleinfo->get_sections();
69 $data->courseid
= $this->courseid
;
70 $data->sesskey
= sesskey();
71 $data->helpicon
= $OUTPUT->help_icon('bulkcompletiontracking', 'core_completion');
73 foreach ($sections as $sectionnumber => $section) {
74 $sectioninfo = $moduleinfo->get_section_info($sectionnumber);
76 $sectionobject = new stdClass();
77 $sectionobject->sectionnumber
= $sectionnumber;
78 $sectionobject->name
= get_section_name($this->courseid
, $sectioninfo);
79 $sectionobject->activities
= $this->get_activities($section, true);
80 $data->sections
[] = $sectionobject;
86 * Gets the data (context) to be used with the activityinstance template
88 * @param array $cmids list of course module ids
89 * @param bool $withcompletiondetails include completion details
92 public function get_activities($cmids, $withcompletiondetails = false) {
93 $moduleinfo = get_fast_modinfo($this->courseid
);
95 foreach ($cmids as $cmid) {
96 $mod = $moduleinfo->get_cm($cmid);
97 if (!$mod->uservisible
) {
100 $moduleobject = new stdClass();
101 $moduleobject->cmid
= $cmid;
102 $moduleobject->modname
= $mod->get_formatted_name();
103 $moduleobject->icon
= $mod->get_icon_url()->out();
104 $moduleobject->url
= $mod->url
;
105 $moduleobject->canmanage
= $withcompletiondetails && self
::can_edit_bulk_completion($this->courseid
, $mod);
107 // Get activity completion information.
108 if ($moduleobject->canmanage
) {
109 $moduleobject->completionstatus
= $this->get_completion_detail($mod);
111 $moduleobject->completionstatus
= ['icon' => null, 'string' => null];
113 if (self
::can_edit_bulk_completion($this->courseid
, $mod)) {
114 $activities[] = $moduleobject;
122 * Get completion information on the selected module or module type
124 * @param cm_info|stdClass $mod either instance of cm_info (with 'customcompletionrules' in customdata) or
125 * object with fields ->completion, ->completionview, ->completionexpected, ->completionusegrade
126 * and ->customdata['customcompletionrules']
129 private function get_completion_detail($mod) {
132 switch ($mod->completion
) {
133 case COMPLETION_TRACKING_NONE
:
134 $strings['string'] = get_string('none');
137 case COMPLETION_TRACKING_MANUAL
:
138 $strings['string'] = get_string('manual', 'completion');
139 $strings['icon'] = $OUTPUT->pix_icon('i/completion-manual-y', get_string('completion_manual', 'completion'));
142 case COMPLETION_TRACKING_AUTOMATIC
:
143 $strings['string'] = get_string('withconditions', 'completion');
144 $strings['icon'] = $OUTPUT->pix_icon('i/completion-auto-y', get_string('completion_automatic', 'completion'));
148 $strings['string'] = get_string('none');
152 // Get the descriptions for all the active completion rules for the module.
153 if ($ruledescriptions = $this->get_completion_active_rule_descriptions($mod)) {
154 foreach ($ruledescriptions as $ruledescription) {
155 $strings['string'] .= \html_writer
::empty_tag('br') . $ruledescription;
162 * Get the descriptions for all active conditional completion rules for the current module.
164 * @param cm_info|stdClass $moduledata either instance of cm_info (with 'customcompletionrules' in customdata) or
165 * object with fields ->completion, ->completionview, ->completionexpected, ->completionusegrade
166 * and ->customdata['customcompletionrules']
167 * @return array $activeruledescriptions an array of strings describing the active completion rules.
169 protected function get_completion_active_rule_descriptions($moduledata) {
170 $activeruledescriptions = [];
172 if ($moduledata->completion
== COMPLETION_TRACKING_AUTOMATIC
) {
173 // Generate the description strings for the core conditional completion rules (if set).
174 if (!empty($moduledata->completionview
)) {
175 $activeruledescriptions[] = get_string('completionview_desc', 'completion');
177 if ($moduledata instanceof cm_info
&& !is_null($moduledata->completiongradeitemnumber
) ||
178 ($moduledata instanceof stdClass
&& !empty($moduledata->completionusegrade
))) {
179 $activeruledescriptions[] = get_string('completionusegrade_desc', 'completion');
182 // Now, ask the module to provide descriptions for its custom conditional completion rules.
183 if ($customruledescriptions = component_callback($moduledata->modname
,
184 'get_completion_active_rule_descriptions', [$moduledata])) {
185 $activeruledescriptions = array_merge($activeruledescriptions, $customruledescriptions);
189 if ($moduledata->completion
!= COMPLETION_TRACKING_NONE
) {
190 if (!empty($moduledata->completionexpected
)) {
191 $activeruledescriptions[] = get_string('completionexpecteddesc', 'completion',
192 userdate($moduledata->completionexpected
));
196 return $activeruledescriptions;
200 * Gets the course modules for the current course.
202 * @return stdClass $data containing the modules
204 public function get_activities_and_resources() {
205 global $DB, $OUTPUT, $CFG;
206 require_once($CFG->dirroot
.'/course/lib.php');
208 // Get enabled activities and resources.
209 $modules = $DB->get_records('modules', ['visible' => 1], 'name ASC');
210 $data = new stdClass();
211 $data->courseid
= $this->courseid
;
212 $data->sesskey
= sesskey();
213 $data->helpicon
= $OUTPUT->help_icon('bulkcompletiontracking', 'core_completion');
214 // Add icon information.
215 $data->modules
= array_values($modules);
216 $coursecontext = context_course
::instance($this->courseid
);
217 $canmanage = has_capability('moodle/course:manageactivities', $coursecontext);
218 $course = get_course($this->courseid
);
219 foreach ($data->modules
as $module) {
220 $module->icon
= $OUTPUT->image_url('icon', $module->name
)->out();
221 $module->formattedname
= format_string(get_string('modulenameplural', 'mod_' . $module->name
),
222 true, ['context' => $coursecontext]);
223 $module->canmanage
= $canmanage && course_allowed_module($course, $module->name
);
224 $defaults = self
::get_default_completion($course, $module, false);
225 $defaults->modname
= $module->name
;
226 $module->completionstatus
= $this->get_completion_detail($defaults);
233 * Checks if current user can edit activity completion
235 * @param int|stdClass $courseorid
236 * @param \cm_info|null $cm if specified capability for a given coursemodule will be check,
237 * if not specified capability to edit at least one activity is checked.
239 public static function can_edit_bulk_completion($courseorid, $cm = null) {
241 return $cm->uservisible
&& has_capability('moodle/course:manageactivities', $cm->context
);
243 $coursecontext = context_course
::instance(is_object($courseorid) ?
$courseorid->id
: $courseorid);
244 if (has_capability('moodle/course:manageactivities', $coursecontext)) {
247 $modinfo = get_fast_modinfo($courseorid);
248 foreach ($modinfo->cms
as $mod) {
249 if ($mod->uservisible
&& has_capability('moodle/course:manageactivities', $mod->context
)) {
257 * Gets the available completion tabs for the current course and user.
259 * @param stdClass|int $courseorid the course object or id.
260 * @return tabobject[]
262 public static function get_available_completion_tabs($courseorid) {
265 $courseid = is_object($courseorid) ?
$courseorid->id
: $courseorid;
266 $coursecontext = context_course
::instance($courseid);
268 if (has_capability('moodle/course:update', $coursecontext)) {
269 $tabs[] = new tabobject(
271 new moodle_url('/course/completion.php', ['id' => $courseid]),
272 new lang_string('coursecompletion', 'completion')
276 if (has_capability('moodle/course:manageactivities', $coursecontext)) {
277 $tabs[] = new tabobject(
279 new moodle_url('/course/defaultcompletion.php', ['id' => $courseid]),
280 new lang_string('defaultcompletion', 'completion')
284 if (self
::can_edit_bulk_completion($courseorid)) {
285 $tabs[] = new tabobject(
287 new moodle_url('/course/bulkcompletion.php', ['id' => $courseid]),
288 new lang_string('bulkactivitycompletion', 'completion')
296 * Applies completion from the bulk edit form to all selected modules
298 * @param stdClass $data data received from the core_completion_bulkedit_form
299 * @param bool $updateinstances if we need to update the instance tables of the module (i.e. 'assign', 'forum', etc.) -
300 * if no module-specific completion rules were added to the form, update of the module table is not needed.
302 public function apply_completion($data, $updateinstances) {
305 $modinfo = get_fast_modinfo($this->courseid
);
307 $cmids = $data->cmid
;
309 $data = (array)$data;
310 unset($data['id']); // This is a course id, we don't want to confuse it with cmid or instance id.
311 unset($data['cmid']);
312 unset($data['submitbutton']);
314 foreach ($cmids as $cmid) {
315 $cm = $modinfo->get_cm($cmid);
316 if (self
::can_edit_bulk_completion($this->courseid
, $cm) && $this->apply_completion_cm($cm, $data, $updateinstances)) {
318 if ($cm->completion
!= COMPLETION_TRACKING_MANUAL ||
$data['completion'] != COMPLETION_TRACKING_MANUAL
) {
319 // If completion was changed we will need to reset it's state. Exception is when completion was and remains as manual.
320 $needreset[] = $cm->id
;
323 // Update completion calendar events.
324 $completionexpected = ($data['completionexpected']) ?
$data['completionexpected'] : null;
325 \core_completion\api
::update_completion_date_event($cm->id
, $cm->modname
, $cm->instance
, $completionexpected);
328 // Now that modules are fully updated, also update completion data if required.
329 // This will wipe all user completion data and recalculate it.
330 rebuild_course_cache($this->courseid
, true);
331 $modinfo = get_fast_modinfo($this->courseid
);
332 $completion = new \
completion_info($modinfo->get_course());
333 foreach ($needreset as $cmid) {
334 $completion->reset_all_state($modinfo->get_cm($cmid));
337 // And notify the user of the result.
338 \core\notification
::add(get_string('activitycompletionupdated', 'core_completion'), \core\notification
::SUCCESS
);
343 * Applies new completion rules to one course module
345 * @param \cm_info $cm
347 * @param bool $updateinstance if we need to update the instance table of the module (i.e. 'assign', 'forum', etc.) -
348 * if no module-specific completion rules were added to the form, update of the module table is not needed.
349 * @return bool if module was updated
351 protected function apply_completion_cm(\cm_info
$cm, $data, $updateinstance) {
354 $defaults = ['completion' => COMPLETION_DISABLED
, 'completionview' => COMPLETION_VIEW_NOT_REQUIRED
,
355 'completionexpected' => 0, 'completiongradeitemnumber' => null];
357 $data +
= ['completion' => $cm->completion
,
358 'completionexpected' => $cm->completionexpected
,
359 'completionview' => $cm->completionview
];
361 if ($cm->completion
== $data['completion'] && $cm->completion
== COMPLETION_TRACKING_NONE
) {
362 // If old and new completion are both "none" - no changes are needed.
366 if ($cm->completion
== $data['completion'] && $cm->completion
== COMPLETION_TRACKING_NONE
&&
367 $cm->completionexpected
== $data['completionexpected']) {
368 // If old and new completion are both "manual" and completion expected date is not changed - no changes are needed.
372 if (array_key_exists('completionusegrade', $data)) {
373 // Convert the 'use grade' checkbox into a grade-item number: 0 if checked, null if not.
374 $data['completiongradeitemnumber'] = !empty($data['completionusegrade']) ?
0 : null;
375 unset($data['completionusegrade']);
377 $data['completiongradeitemnumber'] = $cm->completiongradeitemnumber
;
380 // Update module instance table.
381 if ($updateinstance) {
382 $moddata = ['id' => $cm->instance
, 'timemodified' => time()] +
array_diff_key($data, $defaults);
383 $DB->update_record($cm->modname
, $moddata);
386 // Update course modules table.
387 $cmdata = ['id' => $cm->id
, 'timemodified' => time()] +
array_intersect_key($data, $defaults);
388 $DB->update_record('course_modules', $cmdata);
390 \core\event\course_module_updated
::create_from_cm($cm, $cm->context
)->trigger();
392 // We need to reset completion data for this activity.
398 * Saves default completion from edit form to all selected module types
400 * @param stdClass $data data received from the core_completion_bulkedit_form
401 * @param bool $updatecustomrules if we need to update the custom rules of the module -
402 * if no module-specific completion rules were added to the form, update of the module table is not needed.
404 public function apply_default_completion($data, $updatecustomrules) {
407 $courseid = $data->id
;
408 $coursecontext = context_course
::instance($courseid);
409 if (!$modids = $data->modids
) {
413 'completion' => COMPLETION_DISABLED
,
414 'completionview' => COMPLETION_VIEW_NOT_REQUIRED
,
415 'completionexpected' => 0,
416 'completionusegrade' => 0
419 $data = (array)$data;
421 if ($updatecustomrules) {
422 $customdata = array_diff_key($data, $defaults);
423 $data['customrules'] = $customdata ?
json_encode($customdata) : null;
424 $defaults['customrules'] = null;
426 $data = array_intersect_key($data, $defaults);
428 // Get names of the affected modules.
429 list($modidssql, $params) = $DB->get_in_or_equal($modids);
431 $modules = $DB->get_records_select_menu('modules', 'id ' . $modidssql . ' and visible = ?', $params, '', 'id, name');
433 // Get an associative array of [module_id => course_completion_defaults_id].
434 list($in, $params) = $DB->get_in_or_equal($modids);
435 $params[] = $courseid;
436 $defaultsids = $DB->get_records_select_menu('course_completion_defaults', 'module ' . $in . ' and course = ?', $params, '',
439 foreach ($modids as $modid) {
440 if (!array_key_exists($modid, $modules)) {
443 if (isset($defaultsids[$modid])) {
444 $DB->update_record('course_completion_defaults', $data +
['id' => $defaultsids[$modid]]);
446 $defaultsids[$modid] = $DB->insert_record('course_completion_defaults', $data +
['course' => $courseid,
447 'module' => $modid]);
450 \core\event\completion_defaults_updated
::create([
451 'objectid' => $defaultsids[$modid],
452 'context' => $coursecontext,
453 'other' => ['modulename' => $modules[$modid]],
458 \core\notification
::add(get_string('defaultcompletionupdated', 'completion'), \core\notification
::SUCCESS
);
462 * Returns default completion rules for given module type in the given course
464 * @param stdClass $course
465 * @param stdClass $module
466 * @param bool $flatten if true all module custom completion rules become properties of the same object,
467 * otherwise they can be found as array in ->customdata['customcompletionrules']
470 public static function get_default_completion($course, $module, $flatten = true) {
472 if ($data = $DB->get_record('course_completion_defaults', ['course' => $course->id
, 'module' => $module->id
],
473 'completion, completionview, completionexpected, completionusegrade, customrules')) {
474 if ($data->customrules
&& ($customrules = @json_decode
($data->customrules
, true))) {
476 foreach ($customrules as $key => $value) {
477 $data->$key = $value;
480 $data->customdata
['customcompletionrules'] = $customrules;
483 unset($data->customrules
);
485 $data = new stdClass();
486 $data->completion
= COMPLETION_TRACKING_NONE
;
487 if ($CFG->completiondefault
) {
488 $completion = new \
completion_info(get_fast_modinfo($course->id
)->get_course());
489 if ($completion->is_enabled() && plugin_supports('mod', $module->name
, FEATURE_MODEDIT_DEFAULT_COMPLETION
, true)) {
490 $data->completion
= COMPLETION_TRACKING_MANUAL
;
491 $data->completionview
= 1;