enrol/cohort/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/>.
  16
  17 /**
  18  * Cohort enrolment plugin.
  19  *
  20  * @package    enrol
  21  * @subpackage cohort
  22  * @copyright  2010 Petr Skoda {@link http://skodak.org}
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 /**
  29  * Cohort 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_cohort_plugin extends enrol_plugin {
  34     /**
  35      * Returns localised name of enrol instance
  36      *
  37      * @param object $instance (null is accepted too)
  38      * @return string
  39      */
  40     public function get_instance_name($instance) {
  41         global $DB;
  42
  43         if (empty($instance)) {
  44             $enrol = $this->get_name();
  45             return get_string('pluginname', 'enrol_'.$enrol);
  46
  47         } else if (empty($instance->name)) {
  48             $enrol = $this->get_name();
  49             if ($role = $DB->get_record('role', array('id'=>$instance->roleid))) {
  50                 $role = role_get_name($role, get_context_instance(CONTEXT_COURSE, $instance->courseid));
  51                 return get_string('pluginname', 'enrol_'.$enrol) . ' (' . format_string($DB->get_field('cohort', 'name', array('id'=>$instance->customint1))) . ' - ' . $role .')';
  52             } else {
  53                 return get_string('pluginname', 'enrol_'.$enrol) . ' (' . format_string($DB->get_field('cohort', 'name', array('id'=>$instance->customint1))) . ')';
  54             }
  55
  56         } else {
  57             return format_string($instance->name);
  58         }
  59     }
  60
  61     /**
  62      * Returns link to page which may be used to add new instance of enrolment plugin in course.
  63      * @param int $courseid
  64      * @return moodle_url page url
  65      */
  66     public function get_newinstance_link($courseid) {
  67         if (!$this->can_add_new_instances($courseid)) {
  68             return NULL;
  69         }
  70         // multiple instances supported - multiple parent courses linked
  71         return new moodle_url('/enrol/cohort/addinstance.php', array('id'=>$courseid));
  72     }
  73
  74     /**
  75      * Given a courseid this function returns true if the user is able to enrol or configure cohorts
  76      * AND there are cohorts that the user can view.
  77      *
  78      * @param int $courseid
  79      * @return bool
  80      */
  81     protected function can_add_new_instances($courseid) {
  82         global $DB;
  83
  84         $coursecontext = get_context_instance(CONTEXT_COURSE, $courseid);
  85         if (!has_capability('moodle/course:enrolconfig', $coursecontext) or !has_capability('enrol/cohort:config', $coursecontext)) {
  86             return false;
  87         }
  88         list($sqlparents, $params) = $DB->get_in_or_equal(get_parent_contexts($coursecontext));
  89         $sql = "SELECT id, contextid
  90                   FROM {cohort}
  91                  WHERE contextid $sqlparents
  92               ORDER BY name ASC";
  93         $cohorts = $DB->get_records_sql($sql, $params);
  94         foreach ($cohorts as $c) {
  95             $context = get_context_instance_by_id($c->contextid);
  96             if (has_capability('moodle/cohort:view', $context)) {
  97                 return true;
  98             }
  99         }
 100         return false;
 101     }
 102
 103
 104     /**
 105      * Called for all enabled enrol plugins that returned true from is_cron_required().
 106      * @return void
 107      */
 108     public function cron() {
 109         global $CFG;
 110
 111         require_once("$CFG->dirroot/enrol/cohort/locallib.php");
 112         enrol_cohort_sync();
 113     }
 114
 115     /**
 116      * Called after updating/inserting course.
 117      *
 118      * @param bool $inserted true if course just inserted
 119      * @param object $course
 120      * @param object $data form data
 121      * @return void
 122      */
 123     public function course_updated($inserted, $course, $data) {
 124         // It turns out there is no need for cohorts to deal with this hook, see MDL-34870.
 125     }
 126
 127     /**
 128      * Update instance status
 129      *
 130      * @param stdClass $instance
 131      * @param int $newstatus ENROL_INSTANCE_ENABLED, ENROL_INSTANCE_DISABLED
 132      * @return void
 133      */
 134     public function update_status($instance, $newstatus) {
 135         global $CFG;
 136
 137         parent::update_status($instance, $newstatus);
 138
 139         require_once("$CFG->dirroot/enrol/cohort/locallib.php");
 140         enrol_cohort_sync($instance->courseid);
 141     }
 142
 143     /**
 144      * Does this plugin allow manual unenrolment of a specific user?
 145      * Yes, but only if user suspended...
 146      *
 147      * @param stdClass $instance course enrol instance
 148      * @param stdClass $ue record from user_enrolments table
 149      *
 150      * @return bool - true means user with 'enrol/xxx:unenrol' may unenrol this user, false means nobody may touch this user enrolment
 151      */
 152     public function allow_unenrol_user(stdClass $instance, stdClass $ue) {
 153         if ($ue->status == ENROL_USER_SUSPENDED) {
 154             return true;
 155         }
 156
 157         return false;
 158     }
 159
 160     /**
 161      * Gets an array of the user enrolment actions
 162      *
 163      * @param course_enrolment_manager $manager
 164      * @param stdClass $ue A user enrolment object
 165      * @return array An array of user_enrolment_actions
 166      */
 167     public function get_user_enrolment_actions(course_enrolment_manager $manager, $ue) {
 168         $actions = array();
 169         $context = $manager->get_context();
 170         $instance = $ue->enrolmentinstance;
 171         $params = $manager->get_moodlepage()->url->params();
 172         $params['ue'] = $ue->id;
 173         if ($this->allow_unenrol_user($instance, $ue) && has_capability('enrol/cohort:unenrol', $context)) {
 174             $url = new moodle_url('/enrol/unenroluser.php', $params);
 175             $actions[] = new user_enrolment_action(new pix_icon('t/delete', ''), get_string('unenrol', 'enrol'), $url, array('class'=>'unenrollink', 'rel'=>$ue->id));
 176         }
 177         return $actions;
 178     }
 179
 180     /**
 181      * Returns a button to enrol a cohort or its users through the manual enrolment plugin.
 182      *
 183      * This function also adds a quickenrolment JS ui to the page so that users can be enrolled
 184      * via AJAX.
 185      *
 186      * @param course_enrolment_manager $manager
 187      * @return enrol_user_button
 188      */
 189     public function get_manual_enrol_button(course_enrolment_manager $manager) {
 190         $course = $manager->get_course();
 191         if (!$this->can_add_new_instances($course->id)) {
 192             return false;
 193         }
 194
 195         $cohorturl = new moodle_url('/enrol/cohort/addinstance.php', array('id' => $course->id));
 196         $button = new enrol_user_button($cohorturl, get_string('enrolcohort', 'enrol'), 'get');
 197         $button->class .= ' enrol_cohort_plugin';
 198
 199         $button->strings_for_js(array(
 200             'enrol',
 201             'synced',
 202             'enrolcohort',
 203             'enrolcohortusers',
 204             ), 'enrol');
 205         $button->strings_for_js(array(
 206             'ajaxmore',
 207             'cohortsearch',
 208             ), 'enrol_cohort');
 209         $button->strings_for_js('assignroles', 'role');
 210         $button->strings_for_js('cohort', 'cohort');
 211         $button->strings_for_js('users', 'moodle');
 212
 213         // No point showing this at all if the user cant manually enrol users
 214         $hasmanualinstance = has_capability('enrol/manual:enrol', $manager->get_context()) && $manager->has_instance('manual');
 215
 216         $modules = array('moodle-enrol_cohort-quickenrolment', 'moodle-enrol_cohort-quickenrolment-skin');
 217         $function = 'M.enrol_cohort.quickenrolment.init';
 218         $arguments = array(
 219             'courseid'        => $course->id,
 220             'ajaxurl'         => '/enrol/cohort/ajax.php',
 221             'url'             => $manager->get_moodlepage()->url->out(false),
 222             'manualEnrolment' => $hasmanualinstance);
 223         $button->require_yui_module($modules, $function, array($arguments));
 224
 225         return $button;
 226     }
 227 }
 228
 229