mirror of
https://github.com/moodle/moodle.git
synced 2025-01-18 14:03:52 +01:00
257 lines
8.8 KiB
PHP
257 lines
8.8 KiB
PHP
<?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/>.
|
|
|
|
/**
|
|
* Meta course enrolment plugin.
|
|
*
|
|
* @package enrol_meta
|
|
* @copyright 2010 Petr Skoda {@link http://skodak.org}
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* ENROL_META_CREATE_GROUP constant for automatically creating a group for a meta course.
|
|
*/
|
|
define('ENROL_META_CREATE_GROUP', -1);
|
|
|
|
/**
|
|
* Meta course enrolment plugin.
|
|
* @author Petr Skoda
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class enrol_meta_plugin extends enrol_plugin {
|
|
|
|
/**
|
|
* Returns localised name of enrol instance
|
|
*
|
|
* @param stdClass $instance (null is accepted too)
|
|
* @return string
|
|
*/
|
|
public function get_instance_name($instance) {
|
|
global $DB;
|
|
|
|
if (empty($instance)) {
|
|
$enrol = $this->get_name();
|
|
return get_string('pluginname', 'enrol_'.$enrol);
|
|
} else if (empty($instance->name)) {
|
|
$enrol = $this->get_name();
|
|
$course = $DB->get_record('course', array('id'=>$instance->customint1));
|
|
if ($course) {
|
|
$coursename = format_string(get_course_display_name_for_list($course));
|
|
} else {
|
|
// Use course id, if course is deleted.
|
|
$coursename = $instance->customint1;
|
|
}
|
|
return get_string('pluginname', 'enrol_' . $enrol) . ' (' . $coursename . ')';
|
|
} else {
|
|
return format_string($instance->name);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns link to page which may be used to add new instance of enrolment plugin in course.
|
|
* @param int $courseid
|
|
* @return moodle_url page url
|
|
*/
|
|
public function get_newinstance_link($courseid) {
|
|
$context = context_course::instance($courseid, MUST_EXIST);
|
|
if (!has_capability('moodle/course:enrolconfig', $context) or !has_capability('enrol/meta:config', $context)) {
|
|
return NULL;
|
|
}
|
|
// multiple instances supported - multiple parent courses linked
|
|
return new moodle_url('/enrol/meta/addinstance.php', array('id'=>$courseid));
|
|
}
|
|
|
|
/**
|
|
* Does this plugin allow manual unenrolment of a specific user?
|
|
* Yes, but only if user suspended...
|
|
*
|
|
* @param stdClass $instance course enrol instance
|
|
* @param stdClass $ue record from user_enrolments table
|
|
*
|
|
* @return bool - true means user with 'enrol/xxx:unenrol' may unenrol this user, false means nobody may touch this user enrolment
|
|
*/
|
|
public function allow_unenrol_user(stdClass $instance, stdClass $ue) {
|
|
if ($ue->status == ENROL_USER_SUSPENDED) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Gets an array of the user enrolment actions
|
|
*
|
|
* @param course_enrolment_manager $manager
|
|
* @param stdClass $ue A user enrolment object
|
|
* @return array An array of user_enrolment_actions
|
|
*/
|
|
public function get_user_enrolment_actions(course_enrolment_manager $manager, $ue) {
|
|
$actions = array();
|
|
$context = $manager->get_context();
|
|
$instance = $ue->enrolmentinstance;
|
|
$params = $manager->get_moodlepage()->url->params();
|
|
$params['ue'] = $ue->id;
|
|
if ($this->allow_unenrol_user($instance, $ue) && has_capability('enrol/meta:unenrol', $context)) {
|
|
$url = new moodle_url('/enrol/unenroluser.php', $params);
|
|
$actions[] = new user_enrolment_action(new pix_icon('t/delete', ''), get_string('unenrol', 'enrol'), $url, array('class'=>'unenrollink', 'rel'=>$ue->id));
|
|
}
|
|
return $actions;
|
|
}
|
|
|
|
/**
|
|
* Called after updating/inserting course.
|
|
*
|
|
* @param bool $inserted true if course just inserted
|
|
* @param stdClass $course
|
|
* @param stdClass $data form data
|
|
* @return void
|
|
*/
|
|
public function course_updated($inserted, $course, $data) {
|
|
// Meta sync updates are slow, if enrolments get out of sync teacher will have to wait till next cron.
|
|
// We should probably add some sync button to the course enrol methods overview page.
|
|
}
|
|
|
|
/**
|
|
* Update instance status
|
|
*
|
|
* @param stdClass $instance
|
|
* @param int $newstatus ENROL_INSTANCE_ENABLED, ENROL_INSTANCE_DISABLED
|
|
* @return void
|
|
*/
|
|
public function update_status($instance, $newstatus) {
|
|
global $CFG;
|
|
|
|
parent::update_status($instance, $newstatus);
|
|
|
|
require_once("$CFG->dirroot/enrol/meta/locallib.php");
|
|
enrol_meta_sync($instance->courseid);
|
|
}
|
|
|
|
/**
|
|
* Called for all enabled enrol plugins that returned true from is_cron_required().
|
|
* @return void
|
|
*/
|
|
public function cron() {
|
|
global $CFG;
|
|
|
|
require_once("$CFG->dirroot/enrol/meta/locallib.php");
|
|
enrol_meta_sync();
|
|
}
|
|
|
|
/**
|
|
* Is it possible to delete enrol instance via standard UI?
|
|
*
|
|
* @param stdClass $instance
|
|
* @return bool
|
|
*/
|
|
public function can_delete_instance($instance) {
|
|
$context = context_course::instance($instance->courseid);
|
|
return has_capability('enrol/meta:config', $context);
|
|
}
|
|
|
|
/**
|
|
* Is it possible to hide/show enrol instance via standard UI?
|
|
*
|
|
* @param stdClass $instance
|
|
* @return bool
|
|
*/
|
|
public function can_hide_show_instance($instance) {
|
|
$context = context_course::instance($instance->courseid);
|
|
return has_capability('enrol/meta:config', $context);
|
|
}
|
|
|
|
/**
|
|
* Restore instance and map settings.
|
|
*
|
|
* @param restore_enrolments_structure_step $step
|
|
* @param stdClass $data
|
|
* @param stdClass $course
|
|
* @param int $oldid
|
|
*/
|
|
public function restore_instance(restore_enrolments_structure_step $step, stdClass $data, $course, $oldid) {
|
|
global $DB, $CFG;
|
|
|
|
if (!$step->get_task()->is_samesite()) {
|
|
// No meta restore from other sites.
|
|
$step->set_mapping('enrol', $oldid, 0);
|
|
return;
|
|
}
|
|
|
|
if (!empty($data->customint2)) {
|
|
$data->customint2 = $step->get_mappingid('group', $data->customint2);
|
|
}
|
|
|
|
if ($DB->record_exists('course', array('id' => $data->customint1))) {
|
|
$instance = $DB->get_record('enrol', array('roleid' => $data->roleid, 'customint1' => $data->customint1,
|
|
'courseid' => $course->id, 'enrol' => $this->get_name()));
|
|
if ($instance) {
|
|
$instanceid = $instance->id;
|
|
} else {
|
|
$instanceid = $this->add_instance($course, (array)$data);
|
|
}
|
|
$step->set_mapping('enrol', $oldid, $instanceid);
|
|
|
|
require_once("$CFG->dirroot/enrol/meta/locallib.php");
|
|
enrol_meta_sync($data->customint1);
|
|
|
|
} else {
|
|
$step->set_mapping('enrol', $oldid, 0);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Restore user enrolment.
|
|
*
|
|
* @param restore_enrolments_structure_step $step
|
|
* @param stdClass $data
|
|
* @param stdClass $instance
|
|
* @param int $userid
|
|
* @param int $oldinstancestatus
|
|
*/
|
|
public function restore_user_enrolment(restore_enrolments_structure_step $step, $data, $instance, $userid, $oldinstancestatus) {
|
|
global $DB;
|
|
|
|
if ($this->get_config('unenrolaction') != ENROL_EXT_REMOVED_SUSPENDNOROLES) {
|
|
// Enrolments were already synchronised in restore_instance(), we do not want any suspended leftovers.
|
|
return;
|
|
}
|
|
|
|
// ENROL_EXT_REMOVED_SUSPENDNOROLES means all previous enrolments are restored
|
|
// but without roles and suspended.
|
|
|
|
if (!$DB->record_exists('user_enrolments', array('enrolid' => $instance->id, 'userid' => $userid))) {
|
|
$this->enrol_user($instance, $userid, null, $data->timestart, $data->timeend, ENROL_USER_SUSPENDED);
|
|
if ($instance->customint2) {
|
|
groups_add_member($instance->customint2, $userid, 'enrol_meta', $instance->id);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Restore user group membership.
|
|
* @param stdClass $instance
|
|
* @param int $groupid
|
|
* @param int $userid
|
|
*/
|
|
public function restore_group_member($instance, $groupid, $userid) {
|
|
// Nothing to do here, the group members are added in $this->restore_group_restored().
|
|
return;
|
|
}
|
|
}
|