7f448001d20a4ebf11f4d117a8026bdc544bdd4f
[moodle.git] / lib / completion / completion_criteria_completion.php
1 <?php
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/>.
17 /**
18  * Completion data for a specific user, course and critieria
19  *
20  * @package core_completion
21  * @category completion
22  * @copyright 2009 Catalyst IT Ltd
23  * @author Aaron Barnes <aaronb@catalyst.net.nz>
24  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
28 require_once($CFG->libdir.'/completion/data_object.php');
30 /**
31  * Completion data for a specific user, course and critieria
32  *
33  * @package core_completion
34  * @category completion
35  * @copyright 2009 Catalyst IT Ltd
36  * @author Aaron Barnes <aaronb@catalyst.net.nz>
37  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  */
39 class completion_criteria_completion extends data_object {
41     /* @var string Database table that stores completion type criteria */
42     public $table = 'course_completion_crit_compl';
44     /* @var array Array of required table fields, must start with 'id'. */
45     public $required_fields = array('id', 'userid', 'course', 'criteriaid', 'gradefinal', 'rpl', 'deleted', 'unenroled', 'timecompleted');
47     /* @var array Array of unique fields, used in where clauses */
48     public $unique_fields = array('userid', 'course', 'criteriaid');
50     /* @var int User ID */
51     public $userid;
53     /* @var int course ID */
54     public $course;
56     /* @var int The id of the course completion criteria this completion references */
57     public $criteriaid;
59     /* @var float The final grade for the user in the course (if completing a grade criteria) */
60     public $gradefinal;
62     /* @var string Record of prior learning, leave blank if none */
63     public $rpl;
65     /* @var bool Course deleted flag */
66     public $deleted;
68     /* @var int Timestamp of user unenrolment (if completing a unenrol criteria) */
69     public $unenroled;
71     /* @var int Timestamp of course criteria completion {@link completion_criteria_completion::mark_complete()} */
72     public $timecompleted;
74     /* @var completion_criterria Associated criteria object */
75     private $_criteria;
77     /**
78      * Finds and returns a data_object instance based on params.
79      *
80      * @param array $params associative arrays varname=>value
81      * @return data_object instance of data_object or false if none found.
82      */
83     public static function fetch($params) {
84         $params['deleted'] = null;
85         return self::fetch_helper('course_completion_crit_compl', __CLASS__, $params);
86     }
88     /**
89      * Finds and returns all data_object instances based on params.
90      *
91      * @param array $params associative arrays varname=>value
92      * @return array array of data_object insatnces or false if none found.
93      */
94     public static function fetch_all($params) {}
96     /**
97      * Return status of this criteria completion
98      *
99      * @return bool
100      */
101     public function is_complete() {
102         return (bool) $this->timecompleted;
103     }
105     /**
106      * Mark this criteria complete for the associated user
107      *
108      * This method creates a course_completion_crit_compl record
109      */
110     public function mark_complete() {
111         // Create record
112         $this->timecompleted = time();
114         // Save record
115         if ($this->id) {
116             $this->update();
117         } else {
118             $this->insert();
119         }
121         // Mark course completion record as started (if not already)
122         $cc = array(
123             'course'    => $this->course,
124             'userid'    => $this->userid
125         );
126         $ccompletion = new completion_completion($cc);
127         $ccompletion->mark_inprogress($this->timecompleted);
128     }
130     /**
131      * Attach a preloaded criteria object to this object
132      *
133      * @param   $criteria   object  completion_criteria
134      */
135     public function attach_criteria(completion_criteria $criteria) {
136         $this->_criteria = $criteria;
137     }
139     /**
140      * Return the associated criteria with this completion
141      * If nothing attached, load from the db
142      *
143      * @return completion_criteria
144      */
145     public function get_criteria() {
147         if (!$this->_criteria) {
148             global $DB;
150             $params = array(
151                 'id'    => $this->criteriaid
152             );
154             $record = $DB->get_record('course_completion_criteria', $params);
156             $this->attach_criteria(completion_criteria::factory($record));
157         }
159         return $this->_criteria;
160     }
162     /**
163      * Return criteria status text for display in reports {@link completion_criteria::get_status()}
164      *
165      * @return string
166      */
167     public function get_status() {
168         return $this->_criteria->get_status($this);
169     }