MDL-34864 improve enrol_category phpdocs
[moodle.git] / enrol / category / lib.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  * Category enrolment plugin.
19  *
20  * @package    enrol_category
21  * @copyright  2010 Petr Skoda {@link http://skodak.org}
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
28 /**
29  * category enrolment plugin implementation.
30  * @author  Petr Skoda
31  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32  */
33 class enrol_category_plugin extends enrol_plugin {
35    /**
36      * Is it possible to delete enrol instance via standard UI?
37      *
38      * @param stdClass $instance
39      * @return bool
40      */
41     public function instance_deleteable($instance) {
42         global $DB;
44         if (!enrol_is_enabled('category')) {
45             return true;
46         }
47         // Allow delete only when no synced users here.
48         return !$DB->record_exists('user_enrolments', array('enrolid'=>$instance->id));
49     }
51     /**
52      * Returns link to page which may be used to add new instance of enrolment plugin in course.
53      * @param int $courseid
54      * @return moodle_url page url
55      */
56     public function get_newinstance_link($courseid) {
57         // Instances are added automatically as necessary.
58         return null;
59     }
61     /**
62      * Called for all enabled enrol plugins that returned true from is_cron_required().
63      * @return void
64      */
65     public function cron() {
66         global $CFG;
68         if (!enrol_is_enabled('category')) {
69             return;
70         }
72         require_once("$CFG->dirroot/enrol/category/locallib.php");
73         enrol_category_sync_full();
74     }
76     /**
77      * Called after updating/inserting course.
78      *
79      * @param bool $inserted true if course just inserted
80      * @param stdClass $course
81      * @param stdClass $data form data
82      * @return void
83      */
84     public function course_updated($inserted, $course, $data) {
85         global $CFG;
87         if (!enrol_is_enabled('category')) {
88             return;
89         }
91         // Sync category enrols.
92         require_once("$CFG->dirroot/enrol/category/locallib.php");
93         enrol_category_sync_course($course);
94     }
95 }