first commit

enrol/manual/classes/enrol_users_form.php

@@ -0,0 +1,162 @@
+<?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/>.
+
+/**
+ * Enrol users form.
+ *
+ * Simple form to search for users and add them using a manual enrolment to this course.
+ *
+ * @package enrol_manual
+ * @copyright 2016 Damyon Wiese
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir.'/formslib.php');
+
+class enrol_manual_enrol_users_form extends moodleform {
+
+    /**
+     * Form definition.
+     * @return void
+     */
+    public function definition() {
+        global $PAGE, $DB, $CFG;
+
+
+        require_once($CFG->dirroot . '/enrol/locallib.php');
+
+        $context = $this->_customdata->context;
+
+        // Get the course and enrolment instance.
+        $coursecontext = $context->get_course_context();
+        $course = $DB->get_record('course', ['id' => $coursecontext->instanceid]);
+        $manager = new course_enrolment_manager($PAGE, $course);
+
+        $instance = null;
+        foreach ($manager->get_enrolment_instances() as $tempinstance) {
+            if ($tempinstance->enrol == 'manual') {
+                if ($instance === null) {
+                    $instance = $tempinstance;
+                    break;
+                }
+            }
+        }
+
+        $mform = $this->_form;
+        $mform->setDisableShortforms();
+        $mform->disable_form_change_checker();
+        $periodmenu = enrol_get_period_list();
+        // Work out the apropriate default settings.
+        $defaultperiod = $instance->enrolperiod;
+        if ($instance->enrolperiod > 0 && !isset($periodmenu[$instance->enrolperiod])) {
+            $periodmenu[$instance->enrolperiod] = format_time($instance->enrolperiod);
+        }
+        if (empty($extendbase)) {
+            if (!$extendbase = get_config('enrol_manual', 'enrolstart')) {
+                // Default to now if there is no system setting.
+                $extendbase = 4;
+            }
+        }
+
+        // Build the list of options for the starting from dropdown.
+        $now = time();
+        $today = make_timestamp(date('Y', $now), date('m', $now), date('d', $now), 0, 0, 0);
+        $dateformat = get_string('strftimedatefullshort');
+
+        // Enrolment start.
+        $basemenu = array();
+        if ($course->startdate > 0) {
+            $basemenu[2] = get_string('coursestart') . ' (' . userdate($course->startdate, $dateformat) . ')';
+        }
+        $basemenu[3] = get_string('today') . ' (' . userdate($today, $dateformat) . ')';
+        $basemenu[4] = get_string('now', 'enrol_manual') . ' (' . userdate($now, get_string('strftimedatetimeshort')) . ')';
+
+        $mform->addElement('header', 'main', get_string('enrolmentoptions', 'enrol'));
+        $options = array(
+            'ajax' => 'enrol_manual/form-potential-user-selector',
+            'multiple' => true,
+            'courseid' => $course->id,
+            'enrolid' => $instance->id,
+            'perpage' => $CFG->maxusersperpage,
+            'userfields' => implode(',', \core_user\fields::get_identity_fields($context, true))
+        );
+        $mform->addElement('autocomplete', 'userlist', get_string('selectusers', 'enrol_manual'), array(), $options);
+
+        // Confirm the user can search for cohorts before displaying select.
+        if (has_capability('moodle/cohort:manage', $context) || has_capability('moodle/cohort:view', $context)) {
+            // Check to ensure there is at least one visible cohort before displaying the select box.
+            // Ideally it would be better to call external_api::call_external_function('core_cohort_search_cohorts')
+            // (which is used to populate the select box) instead of duplicating logic but there is an issue with globals
+            // being borked (in this case $PAGE) when combining the usage of fragments and call_external_function().
+            require_once($CFG->dirroot . '/cohort/lib.php');
+            $availablecohorts = cohort_get_cohorts($context->id, 0, 1, '');
+            $availablecohorts = $availablecohorts['cohorts'];
+            if (!($context instanceof context_system)) {
+                $availablecohorts = array_merge($availablecohorts,
+                    cohort_get_available_cohorts($context, COHORT_ALL, 0, 1, ''));
+            }
+            if (!empty($availablecohorts)) {
+                $options = ['contextid' => $context->id, 'multiple' => true];
+                $mform->addElement('cohort', 'cohortlist', get_string('selectcohorts', 'enrol_manual'), $options);
+            }
+        }
+
+        $roles = get_assignable_roles($context, ROLENAME_BOTH);
+        $mform->addElement('select', 'roletoassign', get_string('assignrole', 'enrol_manual'), $roles);
+        $mform->setDefault('roletoassign', $instance->roleid);
+
+        $mform->addAdvancedStatusElement('main');
+
+        $mform->addElement('checkbox', 'recovergrades', get_string('recovergrades', 'enrol'));
+        $mform->setAdvanced('recovergrades');
+        $mform->setDefault('recovergrades', $CFG->recovergradesdefault);
+        $mform->addElement('select', 'startdate', get_string('startingfrom'), $basemenu);
+        $mform->setDefault('startdate', $extendbase);
+        $mform->setAdvanced('startdate');
+        $mform->addElement('select', 'duration', get_string('enrolperiod', 'enrol'), $periodmenu);
+        $mform->setDefault('duration', $defaultperiod);
+        $mform->setAdvanced('duration');
+        $mform->disabledIf('duration', 'timeend[enabled]', 'checked', 1);
+        $mform->addElement('date_time_selector', 'timeend', get_string('enroltimeend', 'enrol'), ['optional' => true]);
+        $mform->setAdvanced('timeend');
+        $mform->addElement('hidden', 'id', $course->id);
+        $mform->setType('id', PARAM_INT);
+        $mform->addElement('hidden', 'action', 'enrol');
+        $mform->setType('action', PARAM_ALPHA);
+        $mform->addElement('hidden', 'enrolid', $instance->id);
+        $mform->setType('enrolid', PARAM_INT);
+    }
+
+    /**
+     * Validate the submitted form data.
+     *
+     * @param array $data array of ("fieldname"=>value) of submitted data
+     * @param array $files array of uploaded files "element_name"=>tmp_file_path
+     * @return array of "element_name"=>"error_description" if there are errors,
+     *         or an empty array if everything is OK (true allowed for backwards compatibility too).
+     */
+    public function validation($data, $files) {
+        $errors = parent::validation($data, $files);
+        if (!empty($data['startdate']) && !empty($data['timeend'])) {
+            if ($data['startdate'] >= $data['timeend']) {
+                $errors['timeend'] = get_string('enroltimeendinvalid', 'enrol');
+            }
+        }
+        return $errors;
+    }
+}

enrol/manual/classes/privacy/provider.php

@@ -0,0 +1,41 @@
+<?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/>.
+/**
+ * Privacy Subsystem implementation for enrol_manual.
+ *
+ * @package    enrol_manual
+ * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace enrol_manual\privacy;
+defined('MOODLE_INTERNAL') || die();
+/**
+ * Privacy Subsystem for enrol_manual implementing null_provider.
+ *
+ * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider {
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return  string
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}

enrol/manual/classes/task/send_expiry_notifications.php

@@ -0,0 +1,58 @@
+<?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/>.
+
+/**
+ * The send expiry notifications task.
+ *
+ * @package   enrol_manual
+ * @author    Farhan Karmali <farhan6318@gmail.com>
+ * @copyright Farhan Karmali
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace enrol_manual\task;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * The send expiry notifications task.
+ *
+ * @package   enrol_manual
+ * @author    Farhan Karmali <farhan6318@gmail.com>
+ * @copyright Farhan Karmali
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class send_expiry_notifications extends \core\task\scheduled_task {
+
+    /**
+     * Name for this task.
+     *
+     * @return string
+     */
+    public function get_name() {
+        return get_string('sendexpirynotificationstask', 'enrol_manual');
+    }
+
+    /**
+     * Run task for sending expiry notifications.
+     */
+    public function execute() {
+        $enrol = enrol_get_plugin('manual');
+        $trace = new \text_progress_trace();
+        $enrol->send_expiry_notifications($trace);
+    }
+
+}

enrol/manual/classes/task/sync_enrolments.php

@@ -0,0 +1,57 @@
+<?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/>.
+
+/**
+ * Syncing enrolments task.
+ *
+ * @package   enrol_manual
+ * @author    Farhan Karmali <farhan6318@gmail.com>
+ * @copyright Farhan Karmali
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace enrol_manual\task;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Syncing enrolments task.
+ *
+ * @package   enrol_manual
+ * @author    Farhan Karmali <farhan6318@gmail.com>
+ * @copyright Farhan Karmali
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class sync_enrolments extends \core\task\scheduled_task {
+
+    /**
+     * Name for this task.
+     *
+     * @return string
+     */
+    public function get_name() {
+        return get_string('syncenrolmentstask', 'enrol_manual');
+    }
+
+    /**
+     * Run task for syncing enrolments.
+     */
+    public function execute() {
+        $enrol = enrol_get_plugin('manual');
+        $trace = new \text_progress_trace();
+        $enrol->sync($trace);
+    }
+}

enrol/manual/classes/user_enrolment_callbacks.php

@@ -0,0 +1,46 @@
+<?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/>.
+
+namespace enrol_manual;
+
+/**
+ * Hook callbacks to get the enrolment information.
+ *
+ * @package    enrol_manual
+ * @copyright  2024 Huong Nguyen <huongnv13@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class user_enrolment_callbacks {
+
+    /**
+     * Callback for the user_enrolment hook.
+     *
+     * @param \core_enrol\hook\after_user_enrolled $hook
+     */
+    public static function send_course_welcome_message(\core_enrol\hook\after_user_enrolled $hook): void {
+        $instance = $hook->get_enrolinstance();
+        // Send welcome message.
+        if ($instance->enrol == 'manual' && $instance->customint1 && $instance->customint1 !== ENROL_DO_NOT_SEND_EMAIL) {
+            $plugin = enrol_get_plugin($instance->enrol);
+            $plugin->send_course_welcome_message_to_user(
+                instance: $instance,
+                userid: $hook->get_userid(),
+                sendoption: $instance->customint1,
+                message: $instance->customtext1,
+            );
+        }
+    }
+}