MDL-10965 tool_generator: use existing course element
[moodle.git] / course / completion_form.php
CommitLineData
2be4d090
MD
1<?php
2
b3b13e99
DM
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
17
18/**
19 * Edit course completion settings - the form definition.
20 *
21 * @package core_completion
22 * @category completion
23 * @copyright 2009 Catalyst IT Ltd
24 * @author Aaron Barnes <aaronb@catalyst.net.nz>
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 */
27
28defined('MOODLE_INTERNAL') || die();
bfebaf64 29
2be4d090 30require_once($CFG->libdir.'/formslib.php');
516c5eca 31require_once($CFG->libdir.'/completionlib.php');
2be4d090 32
b3b13e99
DM
33/**
34 * Defines the course completion settings form.
35 */
2be4d090
MD
36class course_completion_form extends moodleform {
37
b3b13e99
DM
38 /**
39 * Defines the form fields.
40 */
41 public function definition() {
42 global $USER, $CFG, $DB;
2be4d090
MD
43
44 $courseconfig = get_config('moodlecourse');
b3b13e99
DM
45 $mform = $this->_form;
46 $course = $this->_customdata['course'];
2be4d090
MD
47 $completion = new completion_info($course);
48
49 $params = array(
50 'course' => $course->id
51 );
52
b3b13e99 53 // Check if there are existing criteria completions.
2be4d090 54 if ($completion->is_course_locked()) {
807cf3d0 55 $mform->addElement('header', 'completionsettingslocked', get_string('completionsettingslocked', 'completion'));
2be4d090
MD
56 $mform->addElement('static', '', '', get_string('err_settingslocked', 'completion'));
57 $mform->addElement('submit', 'settingsunlock', get_string('unlockcompletiondelete', 'completion'));
58 }
59
b3b13e99 60 // Get array of all available aggregation methods.
2be4d090
MD
61 $aggregation_methods = $completion->get_aggregation_methods();
62
b3b13e99 63 // Overall criteria aggregation.
6e5a473c
DM
64 $mform->addElement('header', 'overallcriteria', get_string('general', 'core_form'));
65 // Map aggregation methods to context-sensitive human readable dropdown menu.
66 $overallaggregationmenu = array();
67 foreach ($aggregation_methods as $methodcode => $methodname) {
68 if ($methodcode === COMPLETION_AGGREGATION_ALL) {
69 $overallaggregationmenu[COMPLETION_AGGREGATION_ALL] = get_string('overallaggregation_all', 'core_completion');
70 } else if ($methodcode === COMPLETION_AGGREGATION_ANY) {
71 $overallaggregationmenu[COMPLETION_AGGREGATION_ANY] = get_string('overallaggregation_any', 'core_completion');
72 } else {
73 $overallaggregationmenu[$methodcode] = $methodname;
74 }
75 }
76 $mform->addElement('select', 'overall_aggregation', get_string('overallaggregation', 'core_completion'), $overallaggregationmenu);
2be4d090
MD
77 $mform->setDefault('overall_aggregation', $completion->get_aggregation_method());
78
6e5a473c
DM
79 // Activity completion criteria
80 $label = get_string('coursecompletioncondition', 'core_completion', get_string('activitiescompleted', 'core_completion'));
81 $mform->addElement('header', 'activitiescompleted', $label);
82 // Get the list of currently specified conditions and expand the section if some are found.
83 $current = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_ACTIVITY);
84 if (!empty($current)) {
85 $mform->setExpanded('activitiescompleted');
86 }
87
88 $activities = $completion->get_activities();
89 if (!empty($activities)) {
90
6ae9dbc2 91 if (!$completion->is_course_locked()) {
92 $this->add_checkbox_controller(1, null, null, 0);
93 }
6e5a473c
DM
94 foreach ($activities as $activity) {
95 $params_a = array('moduleinstance' => $activity->id);
96 $criteria = new completion_criteria_activity(array_merge($params, $params_a));
97 $criteria->config_form_display($mform, $activity);
98 }
99 $mform->addElement('static', 'criteria_role_note', '', get_string('activitiescompletednote', 'core_completion'));
100
101 if (count($activities) > 1) {
102 // Map aggregation methods to context-sensitive human readable dropdown menu.
103 $activityaggregationmenu = array();
104 foreach ($aggregation_methods as $methodcode => $methodname) {
105 if ($methodcode === COMPLETION_AGGREGATION_ALL) {
106 $activityaggregationmenu[COMPLETION_AGGREGATION_ALL] = get_string('activityaggregation_all', 'core_completion');
107 } else if ($methodcode === COMPLETION_AGGREGATION_ANY) {
108 $activityaggregationmenu[COMPLETION_AGGREGATION_ANY] = get_string('activityaggregation_any', 'core_completion');
109 } else {
110 $activityaggregationmenu[$methodcode] = $methodname;
111 }
112 }
113 $mform->addElement('select', 'activity_aggregation', get_string('activityaggregation', 'core_completion'), $activityaggregationmenu);
114 $mform->setDefault('activity_aggregation', $completion->get_aggregation_method(COMPLETION_CRITERIA_TYPE_ACTIVITY));
115 }
116
117 } else {
118 $mform->addElement('static', 'noactivities', '', get_string('err_noactivities', 'completion'));
119 }
120
b3b13e99 121 // Course prerequisite completion criteria.
6e5a473c
DM
122 $label = get_string('coursecompletioncondition', 'core_completion', get_string('dependenciescompleted', 'core_completion'));
123 $mform->addElement('header', 'courseprerequisites', $label);
124 // Get the list of currently specified conditions and expand the section if some are found.
125 $current = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_COURSE);
126 if (!empty($current)) {
127 $mform->setExpanded('courseprerequisites');
128 }
2be4d090 129
b3b13e99
DM
130 // Get applicable courses (prerequisites).
131 $courses = $DB->get_records_sql("
132 SELECT DISTINCT c.id, c.category, c.fullname, cc.id AS selected
133 FROM {course} c
134 LEFT JOIN {course_completion_criteria} cc ON cc.courseinstance = c.id AND cc.course = {$course->id}
135 INNER JOIN {course_completion_criteria} ccc ON ccc.course = c.id
136 WHERE c.enablecompletion = ".COMPLETION_ENABLED."
137 AND c.id <> {$course->id}");
2be4d090
MD
138
139 if (!empty($courses)) {
b3b13e99 140 // Get category list.
442f12f8 141 $list = core_course_category::make_categories_list();
2be4d090 142
b3b13e99 143 // Get course list for select box.
2be4d090
MD
144 $selectbox = array();
145 $selected = array();
146 foreach ($courses as $c) {
b3b13e99
DM
147 $selectbox[$c->id] = $list[$c->category] . ' / ' . format_string($c->fullname, true,
148 array('context' => context_course::instance($c->id)));
2be4d090 149
b3b13e99 150 // If already selected ...
2be4d090
MD
151 if ($c->selected) {
152 $selected[] = $c->id;
153 }
154 }
155
b3b13e99
DM
156 // Show multiselect box.
157 $mform->addElement('select', 'criteria_course', get_string('coursesavailable', 'completion'), $selectbox,
158 array('multiple' => 'multiple', 'size' => 6));
2be4d090 159
b3b13e99 160 // Select current criteria.
2be4d090
MD
161 $mform->setDefault('criteria_course', $selected);
162
b3b13e99 163 // Explain list.
2be4d090
MD
164 $mform->addElement('static', 'criteria_courses_explaination', '', get_string('coursesavailableexplaination', 'completion'));
165
6e5a473c
DM
166 if (count($courses) > 1) {
167 // Map aggregation methods to context-sensitive human readable dropdown menu.
168 $courseaggregationmenu = array();
169 foreach ($aggregation_methods as $methodcode => $methodname) {
170 if ($methodcode === COMPLETION_AGGREGATION_ALL) {
171 $courseaggregationmenu[COMPLETION_AGGREGATION_ALL] = get_string('courseaggregation_all', 'core_completion');
172 } else if ($methodcode === COMPLETION_AGGREGATION_ANY) {
173 $courseaggregationmenu[COMPLETION_AGGREGATION_ANY] = get_string('courseaggregation_any', 'core_completion');
174 } else {
175 $courseaggregationmenu[$methodcode] = $methodname;
176 }
177 }
178 $mform->addElement('select', 'course_aggregation', get_string('courseaggregation', 'core_completion'), $courseaggregationmenu);
179 $mform->setDefault('course_aggregation', $completion->get_aggregation_method(COMPLETION_CRITERIA_TYPE_COURSE));
2be4d090
MD
180 }
181
2be4d090 182 } else {
6e5a473c 183 $mform->addElement('static', 'nocourses', '', get_string('err_nocourses', 'completion'));
2be4d090
MD
184 }
185
186 // Completion on date
6e5a473c
DM
187 $label = get_string('coursecompletioncondition', 'core_completion', get_string('completionondate', 'core_completion'));
188 $mform->addElement('header', 'date', $label);
189 // Expand the condition section if it is currently enabled.
190 $current = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_DATE);
191 if (!empty($current)) {
192 $mform->setExpanded('date');
193 }
2be4d090
MD
194 $criteria = new completion_criteria_date($params);
195 $criteria->config_form_display($mform);
196
197 // Completion after enrolment duration
6e5a473c
DM
198 $label = get_string('coursecompletioncondition', 'core_completion', get_string('enrolmentduration', 'core_completion'));
199 $mform->addElement('header', 'duration', $label);
200 // Expand the condition section if it is currently enabled.
201 $current = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_DURATION);
202 if (!empty($current)) {
203 $mform->setExpanded('duration');
204 }
2be4d090
MD
205 $criteria = new completion_criteria_duration($params);
206 $criteria->config_form_display($mform);
207
6e5a473c
DM
208 // Completion on unenrolment
209 $label = get_string('coursecompletioncondition', 'core_completion', get_string('unenrolment', 'core_completion'));
210 $mform->addElement('header', 'unenrolment', $label);
211 // Expand the condition section if it is currently enabled.
212 $current = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_UNENROL);
213 if (!empty($current)) {
214 $mform->setExpanded('unenrolment');
215 }
216 $criteria = new completion_criteria_unenrol($params);
217 $criteria->config_form_display($mform);
2be4d090 218
6e5a473c
DM
219 // Completion on course grade
220 $label = get_string('coursecompletioncondition', 'core_completion', get_string('coursegrade', 'core_completion'));
221 $mform->addElement('header', 'grade', $label);
222 // Expand the condition section if it is currently enabled.
223 $current = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_GRADE);
224 if (!empty($current)) {
225 $mform->setExpanded('grade');
226 }
2be4d090 227 $course_grade = $DB->get_field('grade_items', 'gradepass', array('courseid' => $course->id, 'itemtype' => 'course'));
08f19f48
AB
228 if (!$course_grade) {
229 $course_grade = '0.00000';
230 }
2be4d090
MD
231 $criteria = new completion_criteria_grade($params);
232 $criteria->config_form_display($mform, $course_grade);
233
6e5a473c
DM
234 // Manual self completion
235 $label = get_string('coursecompletioncondition', 'core_completion', get_string('manualselfcompletion', 'core_completion'));
236 $mform->addElement('header', 'manualselfcompletion', $label);
237 // Expand the condition section if it is currently enabled.
238 $current = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_SELF);
239 if (!empty($current)) {
240 $mform->setExpanded('manualselfcompletion');
241 }
242 $criteria = new completion_criteria_self($params);
2be4d090 243 $criteria->config_form_display($mform);
6e5a473c
DM
244 $mform->addElement('static', 'criteria_self_note', '', get_string('manualselfcompletionnote', 'core_completion'));
245
246 // Role completion criteria
247 $label = get_string('coursecompletioncondition', 'core_completion', get_string('manualcompletionby', 'core_completion'));
248 $mform->addElement('header', 'roles', $label);
249 // Expand the condition section if it is currently enabled.
250 $current = $completion->get_criteria(COMPLETION_CRITERIA_TYPE_ROLE);
251 if (!empty($current)) {
252 $mform->setExpanded('roles');
253 }
254 $roles = get_roles_with_capability('moodle/course:markcomplete', CAP_ALLOW, context_course::instance($course->id, IGNORE_MISSING));
255
256 if (!empty($roles)) {
257 foreach ($roles as $role) {
258 $params_a = array('role' => $role->id);
259 $criteria = new completion_criteria_role(array_merge($params, $params_a));
260 $criteria->config_form_display($mform, $role);
261 }
262 $mform->addElement('static', 'criteria_role_note', '', get_string('manualcompletionbynote', 'core_completion'));
263 // Map aggregation methods to context-sensitive human readable dropdown menu.
264 $roleaggregationmenu = array();
265 foreach ($aggregation_methods as $methodcode => $methodname) {
266 if ($methodcode === COMPLETION_AGGREGATION_ALL) {
267 $roleaggregationmenu[COMPLETION_AGGREGATION_ALL] = get_string('roleaggregation_all', 'core_completion');
268 } else if ($methodcode === COMPLETION_AGGREGATION_ANY) {
269 $roleaggregationmenu[COMPLETION_AGGREGATION_ANY] = get_string('roleaggregation_any', 'core_completion');
270 } else {
271 $roleaggregationmenu[$methodcode] = $methodname;
272 }
273 }
274 $mform->addElement('select', 'role_aggregation', get_string('roleaggregation', 'core_completion'), $roleaggregationmenu);
275 $mform->setDefault('role_aggregation', $completion->get_aggregation_method(COMPLETION_CRITERIA_TYPE_ROLE));
276
277 } else {
278 $mform->addElement('static', 'noroles', '', get_string('err_noroles', 'completion'));
279 }
2be4d090 280
b3b13e99 281 // Add common action buttons.
2be4d090 282 $this->add_action_buttons();
b3b13e99
DM
283
284 // Add hidden fields.
2be4d090
MD
285 $mform->addElement('hidden', 'id', $course->id);
286 $mform->setType('id', PARAM_INT);
287
b3b13e99 288 // If the criteria are locked, freeze values and submit button.
2be4d090
MD
289 if ($completion->is_course_locked()) {
290 $except = array('settingsunlock');
291 $mform->hardFreezeAllVisibleExcept($except);
292 $mform->addElement('cancel');
293 }
294 }
2be4d090 295}