WebSVN – Moodle – Diff – /lib/enrollib.php

 define('ENROL_ACTION_UNENROL', 'unenrol');
 /**
  * Returns instances of enrol plugins
  * @param bool $enabled return enabled only
- * @return array of enrol plugins name=>instance
+ * @return enrol_plugin[] array of enrol plugins name=>instance
  */
 function enrol_get_plugins($enabled) {
     global $CFG;
                 $params = array_merge($params, $allowedparams);
+            }
+        }
+    }
-    // Note: we can not use DISTINCT + text fields due to Oracle and MS limitations, that is why
+    // Note: we can not use DISTINCT + text fields due to MS limitations, that is why
     // we have the subselect there.
     $sql = "SELECT $coursefields $ccselect $timeaccessselect
               FROM {course} c
               JOIN ($courseidsql) en ON (en.courseid = c.id)
+ *
  * @param object $course
  * @param array $instances enrol instances of this course, improves performance
  * @return array of pix_icon
  */
-function enrol_get_course_info_icons($course, array $instances = NULL) {
+function enrol_get_course_info_icons($course, ?array $instances = NULL) {
     $icons = array();
     if (is_null($instances)) {
         $instances = enrol_get_instances($course->id, true);
+    }
     $plugins = enrol_get_plugins(true);
     $params = [];
     if ($onlyactive) {
-        $subwhere = "WHERE ue.status = :active AND e.status = :enabled AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
-        $params['now1']    = round(time(), -2); // improves db caching
+        $subwhere = "WHERE ue.status = :active AND e.status = :enabled AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
-        $params['now2']    = $params['now1'];
+        $params['now1']    = $params['now2'] = \core\di::get(\core\clock::class)->time();
         $params['active']  = ENROL_USER_ACTIVE;
         $params['enabled'] = ENROL_INSTANCE_ENABLED;
     } else {
     $coursefields = 'c.' .join(',c.', $fields);
     $ccselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
     $ccjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
     $params['contextlevel'] = CONTEXT_COURSE;
-    //note: we can not use DISTINCT + text fields due to Oracle and MS limitations, that is why we have the subselect there
+    //note: we can not use DISTINCT + text fields due to MS limitations, that is why we have the subselect there
     $sql = "SELECT $coursefields $ccselect
               FROM {course} c
               JOIN (SELECT DISTINCT e.courseid
                       FROM {enrol} e
+    }
     /**
      * Returns localised name of enrol instance
      *
-     * @param object $instance (null is accepted too)
+     * @param stdClass|null $instance (null is accepted too)
      * @return string
      */
     public function get_instance_name($instance) {
         if (empty($instance->name)) {
             return format_string($instance->name, true, array('context'=>$context));
+        }
+    }
+    /**
+     * How this enrolment method should be displayed on the "Enrolment methods" page
+     *
+     * Some plugins may choose to add more information, for example, user role, dates, etc.
+     *
+     * @param stdClass $instance
+     * @return string
+     */
+    public function get_instance_name_for_management_page(stdClass $instance): string {
+        return (string)$this->get_instance_name($instance);
+    }
     /**
      * Returns optional enrolment information icons.
+     *
      * This is used in course list for quick overview of enrolment options.
+     *
         // Dispatch the hook for post enrol user actions.
         $hook = new \core_enrol\hook\after_user_enrolled(
             enrolinstance: $instance,
+            userenrolmentinstance: $ue,
-            userenrolmentinstance: $ue,
+            roleid: $roleid,
         );
         \core\di::get(\core\hook\manager::class)->dispatch($hook);
         // override for most plugins, check if instance already exists in cases only one instance is supported
         return NULL;
+    }
-    /**
-     * @deprecated since Moodle 2.8 MDL-35864 - please use can_delete_instance() instead.
-     */
-    public function instance_deleteable($instance) {
-        throw new coding_exception('Function enrol_plugin::instance_deleteable() is deprecated, use
-                enrol_plugin::can_delete_instance() instead');
-    }
     /**
      * Is it possible to delete enrol instance via standard UI?
+     *
      * @param stdClass  $instance
      * @return bool
      * Add new instance of enrol plugin.
      * @param object $course
      * @param array 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) {
         global $DB;
         if ($course->id == SITEID) {
             throw new coding_exception('Invalid request to add enrol instance to frontpage.');
         // Invalidate all enrol caches.
         $context->mark_dirty();
+    }
-    /**
-     * Update instance members.
-     *
-     * Update communication room membership for an instance action being performed.
-     *
-     * @param int $enrolmentinstanceid ID of the enrolment instance
-     * @param string $action The update action being performed
-     * @param stdClass $course The course object
-     * @return void
+    /**
-     * @deprecated Since Moodle 4.4.0.
-     * @see \core_communication\hook_listener::update_communication_memberships_for_enrol_status_change()
-     * @todo MDL-80491 Final deprecation in Moodle 4.8.
      * @deprecated Since Moodle 4.4.0.
      */
-    public function update_communication(int $enrolmentinstanceid, string $action, stdClass $course): void {
+    #[\core\attribute\deprecated(null, reason: 'Replaced with hooks', since: '4.4', mdl: 'MDL-78551', final: true)]
-        debugging('Use of method update_communication is deprecated. This feature has been moved to
-        core_communication as a part of hooks api implementation so that plugins or core does not need to call this method anymore.
+    public function update_communication(): void {
-        Method update_communication_memberships_for_enrol_status_change method in communication/classes/hook_listener.php
-        now handles all the operations related to this method using hooks callback recorded in lib/db/hooks.php.', DEBUG_DEVELOPER);
-        return;
+        \core\deprecation::emit_deprecation([self::class, __FUNCTION__]);
+    }
     /**
         // Invalidate all enrol caches.
         $context->mark_dirty();
+    }
     /**
+     * Creates a widget to display on the course enrolment page. It can also redirect.
+     *
+     * It is recommended that all plugins use the same template for the consistent output. Example:
-     * Creates course enrol form, checks if form submitted
+     *
+     *     $obj = new \core_enrol\output\enrol_page($instance, ...);
-     * and enrols user if necessary. It can also redirect.
+     *     return $OUTPUT->render($obj);
+     *
      * @param stdClass $instance
-     * @return string html text, usually a form in a text box
+     * @return string|null html to display on the enrolment page
      */
     public function enrol_page_hook(stdClass $instance) {
         return null;
         // Send as the first user assigned as the course contact.
         if ($sendoption === ENROL_SEND_EMAIL_FROM_COURSE_CONTACT) {
             $rusers = [];
             if (!empty($CFG->coursecontact)) {
                 $croles = explode(',', $CFG->coursecontact);
-                [$sort, $sortparams] = users_order_by_sql('u');
+                [$sort] = users_order_by_sql('u');
                 // We only use the first user.
                 $i = 0;
                 do {
                     $userfieldsapi = \core_user\fields::for_name();
                     $allnames = $userfieldsapi->get_sql('u', false, '', '', false)->selects;
-                    $rusers = get_role_users($croles[$i], $context, true, 'u.id,  u.confirmed, u.username, '. $allnames . ',
+                    $rusers = get_role_users($croles[$i], $context, true,
-                    u.email, r.sortorder, ra.id AS raid', 'r.sortorder, ra.id ASC, ' . $sort, null, '', '', '', '', $sortparams);
+                        "u.id, u.confirmed, u.username, {$allnames}, u.email, u.maildisplay, r.sortorder, ra.id AS raid",
+                        "r.sortorder, ra.id ASC, {$sort}");
                     $i++;
                 } while (empty($rusers) && !empty($croles[$i]));
+            }
             if ($rusers) {
                 $contact = array_values($rusers)[0];
+     *
      * @param stdClass $instance Enrol instance.
      * @param int $userid User ID.
      * @param int $sendoption Send email from constant ENROL_SEND_EMAIL_FROM_*
      * @param null|string $message Message to send to the user.
+     * @param int|null $roleid The assigned role ID
      */
     public function send_course_welcome_message_to_user(
         stdClass $instance,
         int $userid,
         int $sendoption,
         ?string $message = '',
+        ?int $roleid = null,
     ): void {
-        global $DB;
+        global $DB, $CFG;
+        require_once($CFG->dirroot . '/course/lib.php');
         $context = context_course::instance($instance->courseid);
         $user = core_user::get_user($userid);
         $course = get_course($instance->courseid);
-        $courserole = $DB->get_field(
+        // Fallback to the instance role ID if parameter not specified.
-            table: 'role',
-            return: 'shortname',
+        $courseroleid = $roleid ?: $instance->roleid;
-            conditions: ['id' => $instance->roleid],
+        $courserole = $DB->get_record('role', ['id' => $courseroleid]);
-        );
         $a = new stdClass();
+        $a->coursename = format_string($course->fullname, true, ['context' => $context, 'escape' => false]);
-        $a->coursename = format_string($course->fullname, true, ['context' => $context, 'escape' => false]);
+        $a->courselink = course_get_url($course)->out();
         $a->profileurl = (new moodle_url(
             url: '/user/view.php',
             params: [
                 'id' => $user->id,
                 'course' => $instance->courseid,
             ],
+        ))->out();
+        $placeholders = \core_user::get_name_placeholders($user);
-        ))->out();
+        foreach ($placeholders as $field => $value) {
+            $a->{$field} = $value;
         $a->fullname = fullname($user);
         if ($message && trim($message) !== '') {
+            $placeholders = [
-            $placeholders = [
+                '{$a->coursename}',
-                '{$a->coursename}',
+                '{$a->courselink}',
                 '{$a->profileurl}',
                 '{$a->fullname}',
                 '{$a->email}',
                 '{$a->firstname}',
                 '{$a->lastname}',
                 '{$a->courserole}',
             ];
+            $values = [
-            $values = [
+                $a->coursename,
-                $a->coursename,
+                $a->courselink,
                 $a->profileurl,
                 fullname($user),
                 $user->email,
                 $user->firstname,
                 $user->lastname,
-                $courserole,
+                role_get_name($courserole, $context),
             ];
             $message = str_replace($placeholders, $values, $message);
             if (strpos($message, '<') === false) {
         $message->fullmessage = $messagetext;
         $message->fullmessageformat = FORMAT_MARKDOWN;
         $message->fullmessagehtml = $messagehtml;
         $message->notification = 1;
         $message->contexturl = $a->profileurl;
-        $message->contexturlname = $course->fullname;
+        $message->contexturlname = $a->coursename;
         message_send($message);
+    }

Proyectos de Subversion Moodle

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