WebSVN – Moodle – Diff – /enrol/self/lib.php

  * @package    enrol_self
  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
+use core\output\single_button;
+use core_enrol\output\enrol_page;
 /**
  * Self enrolment plugin implementation.
  * @author Petr Skoda
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
         return true;
+    }
+    /**
+     * Returns edit icons for the page with list of instances.
+     *
+     * @param stdClass $instance
+     * @return array
+     */
+    public function get_action_icons(stdClass $instance): array {
+        global $OUTPUT;
+        $context = context_course::instance($instance->courseid);
+        $icons = [];
+        if (has_any_capability(['enrol/self:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+            $linkparams = [
+                'courseid' => $instance->courseid,
+                'id' => $instance->id,
+                'type' => $instance->enrol,
+            ];
+            $editlink = new moodle_url('/enrol/editinstance.php', $linkparams);
+            $icon = new pix_icon('t/edit', get_string('edit'), 'core', ['class' => 'iconsmall']);
+            $icons[] = $OUTPUT->action_icon($editlink, $icon);
+        }
+        return $icons;
+    }
     /**
      * Self enrol user to course
+     *
-     * @param stdClass $instance enrolment instance
-     * @param stdClass $data data needed for enrolment.
+     * @param stdClass $instance enrolment instance
-     * @return bool|array true if enroled else eddor code and messege
+     * @param stdClass $data data needed for enrolment.
      */
     public function enrol_self(stdClass $instance, $data = null) {
+                }
+            }
+        }
+    }
-    /**
-     * Creates course enrol form, checks if form submitted
-     * and enrols user if necessary. It can also redirect.
-     *
-     * @param stdClass $instance
-     * @return string html text, usually a form in a text box
-     */
+    #[\Override]
     public function enrol_page_hook(stdClass $instance) {
+        global $CFG, $OUTPUT, $USER, $PAGE;
+        $buttonurl = null;
+        $buttontext = '';
-        global $CFG, $OUTPUT, $USER;
+        $buttonattrs = [];
         $body = '';
-        require_once("$CFG->dirroot/enrol/self/locallib.php");
+        $title = $this->get_instance_name($instance);
-        $enrolstatus = $this->can_self_enrol($instance);
+        $enrolstatus = $this->can_self_enrol($instance);
+        if ($enrolstatus === true) {
+            if ($instance->password) {
+                // Self-enrolment with password. Display a button to open a form in a modal.
-        if (true === $enrolstatus) {
+                $body = get_string('enrolkeyrequired', 'enrol_self');
-            // This user can self enrol using this instance.
+                $buttonurl = $PAGE->url;
+                $buttonattrs = [
-            $form = new enrol_self_enrol_form(null, $instance);
+                    'data-id' => $instance->courseid,
+                    'data-instance' => $instance->id,
+                    'data-form' => enrol_self\form\enrol_form::class,
+                    'data-title' => $title,
+                ];
+                $PAGE->requires->js_call_amd('enrol_self/enrol_page', 'initEnrol', [$instance->id]);
-            $instanceid = optional_param('instance', 0, PARAM_INT);
+            } else {
+                // Self-enrolment without password. Display a button to self enrol. If button is pressed - enrol the user.
-            if ($instance->id == $instanceid) {
+                if (optional_param('action', null, PARAM_TEXT) === 'enrol' && confirm_sesskey()) {
+                    $this->enrol_self($instance, (object)[]);
+                    return '';
                 if ($data = $form->get_data()) {
+                $body = get_string('nopassword', 'enrol_self');
+                $buttonurl = new moodle_url($PAGE->url, ['action' => 'enrol', 'sesskey' => sesskey()]);
+            }
+            $buttontext = get_string('enrolme', 'enrol_self');
+        } else if (isguestuser()) {
+            // User is not logged in. Display a button to login.
+            $buttonurl = new moodle_url(get_login_url());
+            $body = get_string('noguestaccess', 'enrol');
+            $buttontext = get_string('continue');
-                    $this->enrol_self($instance, $data);
+        } else if (!$enrolstatus) {
-                }
-            }
-        } else {
+            // No reason why user can not use this method, do not display anything.
-            // This user can not self enrol using this instance. Using an empty form to keep
-            // the UI consistent with other enrolment plugins that returns a form.
+            return '';
-            $data = new stdClass();
+        } else {
-            $data->header = $this->get_instance_name($instance);
+            $body = $enrolstatus;
-            $data->info = $enrolstatus;
+        }
-            // The can_self_enrol call returns a button to the login page if the user is a
+        $notification = new \core\output\notification($body, 'info', false);
-            // guest, setting the login url to the form if that is the case.
+        $notification->set_extra_classes(['mb-0']);
-            $url = isguestuser() ? get_login_url() : null;
-            $form = new enrol_self_empty_form($url, $data);
+        $enrolpage = new enrol_page(
-        }
+            instance: $instance,
+            header: $title,
+            body: $OUTPUT->render($notification),
-        ob_start();
+            buttons: $buttonurl ?
-        $form->display();
+                [new single_button($buttonurl, $buttontext, 'get', single_button::BUTTON_PRIMARY, $buttonattrs)] :
-        $output = ob_get_clean();
+                []);
-        return $OUTPUT->box($output);
+        return $OUTPUT->render($enrolpage);
+    }
     /**
      * Does this plugin support some way to self enrol?
      * This function doesn't check user capabilities. Use can_self_enrol to check capabilities.
+     *
      * @param stdClass $instance enrolment instance
-     * @return bool - true means "Enrol me in this course" link could be available
+     * @return bool|string - true means "Enrol me in this course" link could be available
      */
     public function is_self_enrol_available(stdClass $instance) {
         global $CFG, $DB, $USER;
      * @see \enrol_plugin::send_course_welcome_message_to_user()
      * @todo MDL-81185 Final deprecation in Moodle 4.8.
      */
     #[\core\attribute\deprecated('enrol_plugin::send_course_welcome_message_to_user', since: '4.4', mdl: 'MDL-4188')]
     protected function email_welcome_message($instance, $user) {
-        \core\deprecation::emit_deprecation_if_present(__FUNCTION__);
+        \core\deprecation::emit_deprecation(__FUNCTION__);
         $this->send_course_welcome_message_to_user(
             instance: $instance,
             userid: $user->id,
             sendoption: $instance->customint4,
             message: $instance->customtext1,
      * @return bool
      */
     public function edit_instance_form($instance, MoodleQuickForm $mform, $context) {
         global $CFG, $DB;
+        }
+        // Course welcome message.
+        if (has_any_capability(['enrol/self:config', 'moodle/course:editcoursewelcomemessage'], $context)) {
+            $mform->addElement('select', 'customint4', get_string('sendcoursewelcomemessage', 'enrol_self'),
+                    enrol_send_welcome_email_options());
+            $mform->addHelpButton('customint4', 'sendcoursewelcomemessage', 'enrol_self');
+            $options = [
+                'cols' => '60',
+                'rows' => '8',
+            ];
+            $mform->addElement('textarea', 'customtext1', get_string('customwelcomemessage', 'core_enrol'), $options);
+            $mform->setDefault('customtext1', get_string('customwelcomemessageplaceholder', 'core_enrol'));
+            $mform->hideIf(
+                elementname: 'customtext1',
+                dependenton: 'customint4',
+                condition: 'eq',
+                value: ENROL_DO_NOT_SEND_EMAIL,
-        );
+            );
-        // Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
+            // Static form elements cannot be hidden by hideIf() so we need to add a dummy group.
-        // See: https://tracker.moodle.org/browse/MDL-66251.
+            // See: https://tracker.moodle.org/browse/MDL-66251.
-        $group[] = $mform->createElement(
+            $group[] = $mform->createElement(
-            'static',
+                'static',
-            'customwelcomemessage_extra_help',
+                'customwelcomemessage_extra_help',
-            null,
+                null,
-            get_string(
+                get_string(
-                identifier: 'customwelcomemessage_help',
+                    identifier: 'customwelcomemessage_help',
-                component: 'core_enrol',
+                    component: 'core_enrol',
-            ),
+                ),
-        );
+            );
-        $mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
+            $mform->addGroup($group, 'group_customwelcomemessage_extra_help', '', ' ', false);
-        $mform->hideIf(
+            $mform->hideIf(
-            elementname: 'group_customwelcomemessage_extra_help',
+                elementname: 'group_customwelcomemessage_extra_help',
-            dependenton: 'customint4',
+                dependenton: 'customint4',
+                condition: 'eq',
-            condition: 'eq',
+                value: ENROL_DO_NOT_SEND_EMAIL,
+            );
-            value: ENROL_DO_NOT_SEND_EMAIL,
+        }
         );
         // Enrolment changes warning.
-        if (enrol_accessing_via_instance($instance)) {
+        if (has_capability('enrol/self:config', $context) && enrol_accessing_via_instance($instance)) {
             $warntext = get_string('instanceeditselfwarningtext', 'core_enrol');
      * Add new instance of enrol plugin.
      * @param object $course
      * @param array $fields instance fields
      * @return int id of new instance, null if can not be created
      */
-    public function add_instance($course, array $fields = null) {
+    public function add_instance($course, ?array $fields = null) {
         // In the form we are representing 2 db columns with one field.
         if (!empty($fields) && !empty($fields['expirynotify'])) {
             if ($fields['expirynotify'] == 2) {
                 $fields['expirynotify'] = 1;
                 $fields['notifyall'] = 1;
+        }
         return $roles;
+    }
-    /**
-     * Get the "from" contact which the email will be sent from.
-     *
-     * @param int $sendoption send email from constant ENROL_SEND_EMAIL_FROM_*
-     * @param $context context where the user will be fetched
-     * @return mixed|stdClass the contact user object.
+    /**
-     * @deprecated since Moodle 4.4
-     * @see \enrol_plugin::get_welcome_message_contact()
-     * @todo MDL-81185 Final deprecation in Moodle 4.8.
+     * @deprecated since Moodle 4.4
      */
-    #[\core\attribute\deprecated('enrol_plugin::get_welcome_message_contact', since: '4.4', mdl: 'MDL-4188')]
+    #[\core\attribute\deprecated('enrol_plugin::get_welcome_message_contact', since: '4.4', mdl: 'MDL-4188', final: true)]
-    public function get_welcome_email_contact($sendoption, $context) {
+    public function get_welcome_email_contact() {
-        \core\deprecation::emit_deprecation_if_present(__FUNCTION__);
-        return $this->get_welcome_message_contact(
-            sendoption: $sendoption,
-            context: $context,
-        );
+        \core\deprecation::emit_deprecation([self::class, __FUNCTION__]);
+    }
     /**
  * Get icon mapping for font-awesome.
  */
 function enrol_self_get_fontawesome_icon_map() {
     return [
         'enrol_self:withkey' => 'fa-key',
-        'enrol_self:withoutkey' => 'fa-sign-in',
+        'enrol_self:withoutkey' => 'fa-solid fa-right-to-bracket',
     ];
+}

Proyectos de Subversion Moodle

(root)/enrol/self/lib.php – Rev 11 → 1441