MDL-65276 core: delete orphaned cron.php
[moodle.git] / completion / criteria / completion_criteria.php
CommitLineData
2be4d090 1<?php
2be4d090
MD
2// This file is part of Moodle - http://moodle.org/
3//
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.
8//
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.
13//
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/>.
16
2be4d090
MD
17/**
18 * Course completion criteria
19 *
836375ec
SH
20 * @package core_completion
21 * @category completion
2be4d090 22 * @copyright 2009 Catalyst IT Ltd
836375ec
SH
23 * @author Aaron Barnes <aaronb@catalyst.net.nz>
24 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2be4d090 25 */
836375ec
SH
26
27defined('MOODLE_INTERNAL') || die();
75342343
AB
28require_once($CFG->dirroot.'/completion/data_object.php');
29require_once($CFG->dirroot.'/completion/completion_criteria_completion.php');
2be4d090 30
2be4d090 31/**
836375ec
SH
32 * Self completion criteria type
33 * Criteria type constant, primarily for storing criteria type in the database.
2be4d090
MD
34 */
35define('COMPLETION_CRITERIA_TYPE_SELF', 1);
836375ec
SH
36
37/**
38 * Date completion criteria type
39 * Criteria type constant, primarily for storing criteria type in the database.
40 */
2be4d090 41define('COMPLETION_CRITERIA_TYPE_DATE', 2);
836375ec
SH
42
43/**
44 * Unenrol completion criteria type
45 * Criteria type constant, primarily for storing criteria type in the database.
46 */
2be4d090 47define('COMPLETION_CRITERIA_TYPE_UNENROL', 3);
836375ec
SH
48
49/**
50 * Activity completion criteria type
51 * Criteria type constant, primarily for storing criteria type in the database.
52 */
2be4d090 53define('COMPLETION_CRITERIA_TYPE_ACTIVITY', 4);
836375ec
SH
54
55/**
56 * Duration completion criteria type
57 * Criteria type constant, primarily for storing criteria type in the database.
58 */
2be4d090 59define('COMPLETION_CRITERIA_TYPE_DURATION', 5);
836375ec
SH
60
61/**
62 * Grade completion criteria type
63 * Criteria type constant, primarily for storing criteria type in the database.
64 */
2be4d090 65define('COMPLETION_CRITERIA_TYPE_GRADE', 6);
836375ec
SH
66
67/**
68 * Role completion criteria type
69 * Criteria type constant, primarily for storing criteria type in the database.
70 */
2be4d090 71define('COMPLETION_CRITERIA_TYPE_ROLE', 7);
836375ec
SH
72
73/**
74 * Course completion criteria type
75 * Criteria type constant, primarily for storing criteria type in the database.
76 */
2be4d090
MD
77define('COMPLETION_CRITERIA_TYPE_COURSE', 8);
78
79/**
80 * Criteria type constant to class name mapping
81 */
82global $COMPLETION_CRITERIA_TYPES;
83$COMPLETION_CRITERIA_TYPES = array(
84 COMPLETION_CRITERIA_TYPE_SELF => 'self',
85 COMPLETION_CRITERIA_TYPE_DATE => 'date',
86 COMPLETION_CRITERIA_TYPE_UNENROL => 'unenrol',
87 COMPLETION_CRITERIA_TYPE_ACTIVITY => 'activity',
88 COMPLETION_CRITERIA_TYPE_DURATION => 'duration',
89 COMPLETION_CRITERIA_TYPE_GRADE => 'grade',
90 COMPLETION_CRITERIA_TYPE_ROLE => 'role',
91 COMPLETION_CRITERIA_TYPE_COURSE => 'course',
92);
93
94
95/**
96 * Completion criteria abstract definition
836375ec
SH
97 *
98 * @package core_completion
99 * @category completion
100 * @copyright 2009 Catalyst IT Ltd
101 * @author Aaron Barnes <aaronb@catalyst.net.nz>
102 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2be4d090
MD
103 */
104abstract class completion_criteria extends data_object {
836375ec 105
95dd54ee 106 /* @var string Database table name that stores completion criteria information */
2be4d090
MD
107 public $table = 'course_completion_criteria';
108
109 /**
110 * Array of required table fields, must start with 'id'.
836375ec
SH
111 * Defaults to id, course, criteriatype, module, moduleinstane, courseinstance,
112 * enrolperiod, timeend, gradepass, role
113 * @var array
2be4d090 114 */
fe09ccba 115 public $required_fields = array('id', 'course', 'criteriatype', 'module', 'moduleinstance', 'courseinstance', 'enrolperiod', 'timeend', 'gradepass', 'role');
2be4d090 116
95dd54ee 117 /* @var int Course id */
2be4d090
MD
118 public $course;
119
120 /**
121 * Criteria type
122 * One of the COMPLETION_CRITERIA_TYPE_* constants
836375ec 123 * @var int
2be4d090
MD
124 */
125 public $criteriatype;
126
95dd54ee 127 /* @var string Module type this criteria relates to (for activity criteria) */
2be4d090
MD
128 public $module;
129
95dd54ee 130 /* @var int Course module instance id this criteria relates to (for activity criteria) */
2be4d090
MD
131 public $moduleinstance;
132
133 /**
134 * Period after enrolment completion will be triggered (for period criteria)
836375ec
SH
135 * The value here is the number of days as an int.
136 * @var int
2be4d090
MD
137 */
138 public $enrolperiod;
139
140 /**
141 * Date of course completion (for date criteria)
836375ec
SH
142 * This is a timestamp value
143 * @var int
2be4d090
MD
144 */
145 public $date;
146
95dd54ee 147 /* @var float Passing grade required to complete course (for grade completion) */
2be4d090
MD
148 public $gradepass;
149
95dd54ee 150 /* @var int Role ID that has the ability to mark a user as complete (for role completion) */
2be4d090
MD
151 public $role;
152
153 /**
154 * Finds and returns all data_object instances based on params.
2be4d090
MD
155 *
156 * @param array $params associative arrays varname=>value
157 * @return array array of data_object insatnces or false if none found.
158 */
159 public static function fetch_all($params) {}
160
161 /**
162 * Factory method for creating correct class object
836375ec
SH
163 *
164 * @param array $params associative arrays varname=>value
165 * @return completion_criteria
2be4d090
MD
166 */
167 public static function factory($params) {
168 global $CFG, $COMPLETION_CRITERIA_TYPES;
169
dbfcf440 170 if (!isset($params['criteriatype']) || !isset($COMPLETION_CRITERIA_TYPES[$params['criteriatype']])) {
2149326b 171 print_error('invalidcriteriatype', 'completion');
2be4d090
MD
172 }
173
dbfcf440 174 $class = 'completion_criteria_'.$COMPLETION_CRITERIA_TYPES[$params['criteriatype']];
60829d80 175 require_once($CFG->dirroot.'/completion/criteria/'.$class.'.php');
2be4d090
MD
176
177 return new $class($params, false);
178 }
179
180 /**
181 * Add appropriate form elements to the critieria form
95dd54ee 182 *
836375ec 183 * @param moodleform $mform Moodle forms object
95dd54ee 184 * @param mixed $data optional Any additional data that can be used to set default values in the form
836375ec 185 * @return void
2be4d090
MD
186 */
187 abstract public function config_form_display(&$mform, $data = null);
188
189 /**
190 * Update the criteria information stored in the database
836375ec
SH
191 *
192 * @param array $data Form data
193 * @return void
2be4d090
MD
194 */
195 abstract public function update_config(&$data);
196
197 /**
198 * Review this criteria and decide if the user has completed
836375ec
SH
199 *
200 * @param object $completion The user's completion record
201 * @param boolean $mark Optionally set false to not save changes to database
202 * @return boolean
2be4d090
MD
203 */
204 abstract public function review($completion, $mark = true);
205
206 /**
207 * Return criteria title for display in reports
836375ec
SH
208 *
209 * @return string
2be4d090
MD
210 */
211 abstract public function get_title();
212
213 /**
214 * Return a more detailed criteria title for display in reports
836375ec
SH
215 *
216 * @return string
2be4d090
MD
217 */
218 abstract public function get_title_detailed();
219
220 /**
221 * Return criteria type title for display in reports
836375ec
SH
222 *
223 * @return string
2be4d090
MD
224 */
225 abstract public function get_type_title();
226
227 /**
228 * Return criteria progress details for display in reports
836375ec
SH
229 *
230 * @param completion_completion $completion The user's completion record
231 * @return array
2be4d090
MD
232 */
233 abstract public function get_details($completion);
234
7062e7c6
CB
235 /**
236 * Return pix_icon for display in reports.
237 *
238 * @param string $alt The alt text to use for the icon
239 * @param array $attributes html attributes
240 * @return pix_icon
241 */
242 public function get_icon($alt, array $attributes = null) {
243 global $COMPLETION_CRITERIA_TYPES;
244
245 $criteriatype = $COMPLETION_CRITERIA_TYPES[$this->criteriatype];
246 return new pix_icon('i/'.$criteriatype, $alt, 'moodle', $attributes);
247 }
248
2be4d090
MD
249 /**
250 * Return criteria status text for display in reports
836375ec
SH
251 *
252 * @param completion_completion $completion The user's completion record
253 * @return string
2be4d090
MD
254 */
255 public function get_status($completion) {
256 return $completion->is_complete() ? get_string('yes') : get_string('no');
257 }
258
259 /**
260 * Return true if the criteria's current status is different to what is sorted
261 * in the database, e.g. pending an update
262 *
836375ec 263 * @param completion_completion $completion The user's criteria completion record
2be4d090
MD
264 * @return bool
265 */
266 public function is_pending($completion) {
267 $review = $this->review($completion, false);
268
269 return $review !== $completion->is_complete();
270 }
95dd54ee 271}