. /** * Block for displayed logged in user's course completion status * * @package moodlecore * @copyright 2009 Catalyst IT Ltd * @author Aaron Barnes * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->libdir.'/completionlib.php'); /** * Course completion status * Displays overall, and individual criteria status for logged in user */ class block_completionstatus extends block_base { public function init() { $this->title = get_string('completionstatus', 'block_completionstatus'); } public function get_content() { global $USER, $CFG, $DB, $COURSE; // If content is cached if ($this->content !== NULL) { return $this->content; } // Create empty content $this->content = new stdClass; // Can edit settings? $can_edit = has_capability('moodle/course:update', get_context_instance(CONTEXT_COURSE, $this->page->course->id)); // Get course completion data $info = new completion_info($this->page->course); // Don't display if completion isn't enabled! if (!completion_info::is_enabled_for_site()) { if ($can_edit) { $this->content->text = get_string('completionnotenabledforsite', 'completion'); } return $this->content; } else if (!$info->is_enabled()) { if ($can_edit) { $this->content->text = get_string('completionnotenabledforcourse', 'completion'); } return $this->content; } // Load criteria to display $completions = $info->get_completions($USER->id); // Check if this course has any criteria if (empty($completions)) { if ($can_edit) { $this->content->text = get_string('nocriteriaset', 'completion'); } return $this->content; } // Check this user is enroled if (!$info->is_tracked_user($USER->id)) { // If not enrolled, but are can view the report: if (has_capability('coursereport/completion:view', get_context_instance(CONTEXT_COURSE, $COURSE->id))) { $this->content->text = ''.get_string('viewcoursereport', 'completion').''; return $this->content; } // Otherwise, show error $this->content->text = get_string('notenroled', 'completion'); return $this->content; } // Generate markup for criteria statuses $shtml = ''; // For aggregating activity completion $activities = array(); $activities_complete = 0; // For aggregating course prerequisites $prerequisites = array(); $prerequisites_complete = 0; // Flag to set if current completion data is inconsistent with // what is stored in the database $pending_update = false; // Loop through course criteria foreach ($completions as $completion) { $criteria = $completion->get_criteria(); $complete = $completion->is_complete(); if (!$pending_update && $criteria->is_pending($completion)) { $pending_update = true; } // Activities are a special case, so cache them and leave them till last if ($criteria->criteriatype == COMPLETION_CRITERIA_TYPE_ACTIVITY) { $activities[$criteria->moduleinstance] = $complete; if ($complete) { $activities_complete++; } continue; } // Prerequisites are also a special case, so cache them and leave them till last if ($criteria->criteriatype == COMPLETION_CRITERIA_TYPE_COURSE) { $prerequisites[$criteria->courseinstance] = $complete; if ($complete) { $prerequisites_complete++; } continue; } $shtml .= ''; $shtml .= $criteria->get_title(); $shtml .= ''; $shtml .= $completion->get_status(); $shtml .= ''; } // Aggregate activities if (!empty($activities)) { $shtml .= ''; $shtml .= get_string('activitiescompleted', 'completion'); $shtml .= ''; $a = new stdClass(); $a->first = $activities_complete; $a->second = count($activities); $shtml .= get_string('firstofsecond', 'block_completionstatus', $a); $shtml .= ''; } // Aggregate prerequisites if (!empty($prerequisites)) { $phtml = ''; $phtml .= get_string('prerequisitescompleted', 'completion'); $phtml .= ''; $a = new stdClass(); $a->first = $prerequisites_complete; $a->second = count($prerequisites); $phtml .= get_string('firstofsecond', 'block_completionstatus', $a); $phtml .= ''; $shtml = $phtml . $shtml; } // Display completion status $this->content->text = ''; $this->content->text .= ''; $this->content->text .= ''; $this->content->text .= ''; $this->content->text .= $shtml.'

'.get_string('status').': '; // Is course complete? $coursecomplete = $info->is_course_complete($USER->id); // Load course completion $params = array( 'userid' => $USER->id, 'course' => $COURSE->id ); $ccompletion = new completion_completion($params); // Has this user completed any criteria? $criteriacomplete = $info->count_course_user_data($USER->id); if ($pending_update) { $this->content->text .= ''.get_string('pending', 'completion').''; } else if ($coursecomplete) { $this->content->text .= get_string('complete'); } else if (!$criteriacomplete && !$ccompletion->timestarted) { $this->content->text .= ''.get_string('notyetstarted', 'completion').''; } else { $this->content->text .= ''.get_string('inprogress','completion').''; } $this->content->text .= '
'; // Get overall aggregation method $overall = $info->get_aggregation_method(); if ($overall == COMPLETION_AGGREGATION_ALL) { $this->content->text .= get_string('criteriarequiredall', 'completion'); } else { $this->content->text .= get_string('criteriarequiredany', 'completion'); } $this->content->text .= ':
'.get_string('requiredcriteria', 'completion').'	'.get_string('status').'

'; // Display link to detailed view $this->content->footer = '
'.get_string('moredetails', 'completion').''; return $this->content; } }