C:/xampp/htdocs/moodle/lib/completion/completion_criteria.php

Go to the documentation of this file.

<?php


// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.


require_once($CFG->libdir.'/completion/data_object.php');
require_once($CFG->libdir.'/completion/completion_criteria_completion.php');


define('COMPLETION_CRITERIA_TYPE_SELF',         1);
define('COMPLETION_CRITERIA_TYPE_DATE',         2);
define('COMPLETION_CRITERIA_TYPE_UNENROL',      3);
define('COMPLETION_CRITERIA_TYPE_ACTIVITY',     4);
define('COMPLETION_CRITERIA_TYPE_DURATION',     5);
define('COMPLETION_CRITERIA_TYPE_GRADE',        6);
define('COMPLETION_CRITERIA_TYPE_ROLE',         7);
define('COMPLETION_CRITERIA_TYPE_COURSE',       8);

global $COMPLETION_CRITERIA_TYPES;
$COMPLETION_CRITERIA_TYPES = array(
    COMPLETION_CRITERIA_TYPE_SELF       => 'self',
    COMPLETION_CRITERIA_TYPE_DATE       => 'date',
    COMPLETION_CRITERIA_TYPE_UNENROL    => 'unenrol',
    COMPLETION_CRITERIA_TYPE_ACTIVITY   => 'activity',
    COMPLETION_CRITERIA_TYPE_DURATION   => 'duration',
    COMPLETION_CRITERIA_TYPE_GRADE      => 'grade',
    COMPLETION_CRITERIA_TYPE_ROLE       => 'role',
    COMPLETION_CRITERIA_TYPE_COURSE     => 'course',
);


abstract class completion_criteria extends data_object {
    public $table = 'course_completion_criteria';

    public $required_fields = array('id', 'course', 'criteriatype', 'module', 'moduleinstance', 'courseinstance', 'enrolperiod', 'timeend', 'gradepass', 'role');

    public $course;

    public $criteriatype;

    public $module;

    public $moduleinstance;

    public $enrolperiod;

    public $date;

    public $gradepass;

    public $role;

    public static function fetch_all($params) {}

    public static function factory($params) {
        global $CFG, $COMPLETION_CRITERIA_TYPES;

        if (!isset($params->criteriatype) || !isset($COMPLETION_CRITERIA_TYPES[$params->criteriatype])) {
            error('invalidcriteriatype', 'completion');
        }

        $class = 'completion_criteria_'.$COMPLETION_CRITERIA_TYPES[$params->criteriatype];
        require_once($CFG->libdir.'/completion/'.$class.'.php');

        return new $class($params, false);
    }

    abstract public function config_form_display(&$mform, $data = null);

    abstract public function update_config(&$data);

    abstract public function review($completion, $mark = true);

    abstract public function get_title();

    abstract public function get_title_detailed();

    abstract public function get_type_title();

    abstract public function get_details($completion);

    public function get_status($completion) {
        return $completion->is_complete() ? get_string('yes') : get_string('no');
    }

    public function is_pending($completion) {
        $review = $this->review($completion, false);

        return $review !== $completion->is_complete();
    }
}