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/>.
19 * Course completion critieria aggregation
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
28 defined('MOODLE_INTERNAL') ||
die();
29 require_once($CFG->libdir
.'/completion/data_object.php');
32 * Course completion critieria aggregation
34 * @package core_completion
35 * @category completion
36 * @copyright 2009 Catalyst IT Ltd
37 * @author Aaron Barnes <aaronb@catalyst.net.nz>
38 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40 class completion_aggregation
extends data_object
{
42 /* @var string Database table name that stores completion aggregation information */
43 public $table = 'course_completion_aggr_methd';
46 * Array of required table fields, must start with 'id'.
47 * Defaults to id, course, criteriatype, method, value
50 public $required_fields = array('id', 'course', 'criteriatype', 'method', 'value');
52 /* @var int Course id */
55 /* @var int Criteria type this aggregation method applies to, or NULL for overall course aggregation */
58 /* @var int Aggregation method (COMPLETION_AGGREGATION_* constant)*/
61 /* @var mixed Method value */
66 * Finds and returns a data_object instance based on params.
68 * @param array $params associative arrays varname=>value
69 * @return data_object instance of data_object or false if none found.
71 public static function fetch($params) {
72 return self
::fetch_helper('course_completion_aggr_methd', __CLASS__
, $params);
77 * Finds and returns all data_object instances based on params.
79 * @param array $params associative arrays varname=>value
80 * @return array array of data_object insatnces or false if none found.
82 public static function fetch_all($params) {}
85 * Set the aggregation method
87 * @param int $method One of COMPLETION_AGGREGATION_ALL or COMPLETION_AGGREGATION_ANY
89 public function setMethod($method) {
91 COMPLETION_AGGREGATION_ALL
,
92 COMPLETION_AGGREGATION_ANY
,
95 if (in_array($method, $methods)) {
96 $this->method
= $method;
98 $this->method
= COMPLETION_AGGREGATION_ALL
;