WebSVN – Moodle – Diff – /course/externallib.php

                 // reset $sectioncontents
                 $sectionvalues = array();
                 $sectionvalues['id'] = $section->id;
+                $sectionvalues['name'] = get_section_name($course, $section);
+                // Temporary hack to be able to hide the subsections in certain app versions.
+                if (!empty($section->component) && \core_useragent::is_moodle_app()) {
+                    $sectionvalues['name'] = html_writer::span($sectionvalues['name'], 'course-' . $section->component);
                 $sectionvalues['name'] = get_section_name($course, $section);
                 $sectionvalues['visible'] = $section->visible;
                 $options = (object) array('noclean' => true);
                 $sectionvalues['hiddenbynumsections'] = $section->section > $coursenumsections ? 1 : 0;
                 $sectionvalues['uservisible'] = $section->uservisible;
                 if (!empty($section->availableinfo)) {
                     $sectionvalues['availabilityinfo'] = \core_availability\info::format_info($section->availableinfo, $course);
+                }
+                $sectionvalues['component'] = $section->component;
+                $sectionvalues['itemid'] = $section->itemid;
                 $sectioncontents = array();
                     'section' => new external_value(PARAM_INT, 'Section number inside the course', VALUE_OPTIONAL),
                     'hiddenbynumsections' => new external_value(PARAM_INT, 'Whether is a section hidden in the course format',
                                                                 VALUE_OPTIONAL),
                     'uservisible' => new external_value(PARAM_BOOL, 'Is the section visible for the user?', VALUE_OPTIONAL),
                     'availabilityinfo' => new external_value(PARAM_RAW, 'Availability information.', VALUE_OPTIONAL),
+                    'component' => new external_value(PARAM_COMPONENT, 'The delegate component of this section if any.',
+                        VALUE_OPTIONAL),
+                    'itemid' => new external_value(PARAM_INT,
+                        'The optional item id delegate component can use to identify its instance.', VALUE_OPTIONAL),
                     'modules' => new external_multiple_structure(
                             new external_single_structure(
                                 array(
                                     'id' => new external_value(PARAM_INT, 'activity id'),
                                     'url' => new external_value(PARAM_URL, 'activity url', VALUE_OPTIONAL),
                                     'largest size of file that can be uploaded into the course',
                                     VALUE_DEFAULT, $courseconfig->maxbytes),
                             'showreports' => new external_value(PARAM_INT,
                                     'are activity report shown (yes = 1, no =0)', VALUE_DEFAULT,
                                     $courseconfig->showreports),
-                            'visible' => new external_value(PARAM_INT,
+                            'visible' => new external_value(
+                                PARAM_INT,
-                                    '1: available to student, 0:not available', VALUE_OPTIONAL),
+                                '1: available to student, 0: not available',
+                                VALUE_DEFAULT,
+                                $courseconfig->visible,
+                            ),
                             'hiddensections' => new external_value(PARAM_INT,
                                     '(deprecated, use courseformatoptions) How the hidden sections in the course are displayed to students',
                                     VALUE_OPTIONAL),
                             'groupmode' => new external_value(PARAM_INT, 'no group, separate, visible',
                                     VALUE_DEFAULT, $courseconfig->groupmode),
         require_once($CFG->libdir . '/completionlib.php');
         $params = self::validate_parameters(self::create_courses_parameters(),
+                        array('courses' => $courses));
-                        array('courses' => $courses));
+        $courseconfig = get_config('moodlecourse');
         $availablethemes = core_component::get_plugin_list('theme');
                 throw new moodle_exception('errorinvalidparam', 'webservice', '', 'fullname');
             } else if (trim($course['shortname']) === '') {
                 throw new moodle_exception('errorinvalidparam', 'webservice', '', 'shortname');
+            }
+            // Make sure start/end date are correctly set.
+            if (!array_key_exists('startdate', $course)) {
+                $course['startdate'] = usergetmidnight(time());
+            }
+            if (!array_key_exists('enddate', $course) && $courseconfig->courseenddateenabled) {
+                $course['enddate'] = $course['startdate'] + $courseconfig->courseduration;
+            }
             // Make sure lang is valid
             if (array_key_exists('lang', $course)) {
                 if (empty($availablelangs[$course['lang']])) {
                     throw new moodle_exception('errorinvalidparam', 'webservice', '', 'lang');
                         $course['theme'] = $course['forcetheme'];
+                    }
+                }
+            }
+            $course['showactivitydates'] = $courseconfig->showactivitydates;
             //force visibility if ws user doesn't have the permission to set it
             $category = $DB->get_record('course_categories', array('id' => $course['categoryid']));
             if (!has_capability('moodle/course:visibility', $context)) {
                 $course['visible'] = $category->visible;
+            }
             //set default value for completion
-            $courseconfig = get_config('moodlecourse');
+            //set default value for completion
             if (completion_info::is_enabled_for_site()) {
                 if (!array_key_exists('enablecompletion', $course)) {
                     $course['enablecompletion'] = $courseconfig->enablecompletion;
                     id: course id
                     ids: comma separated course ids
                     shortname: course short name
                     idnumber: course id number
                     category: category id the course belongs to
+                    sectionid: section id that belongs to a course
                 ', VALUE_DEFAULT, ''),
                 'value' => new external_value(PARAM_RAW, 'The value to match', VALUE_DEFAULT, '')
+            )
         );
+    }
     /**
      * Get courses matching a specific field (id/s, shortname, idnumber, category)
+     *
      * @param  string $field field name to search, or empty for all courses
             $courses = $DB->get_records('course', null, 'id ASC');
         } else {
             switch ($params['field']) {
                 case 'id':
                 case 'category':
+                case 'sectionid':
                     $value = clean_param($params['value'], PARAM_INT);
                     break;
                 case 'ids':
                     $value = clean_param($params['value'], PARAM_SEQUENCE);
                     break;
                 // Load and validate all courses. This is called because it loads the courses
                 // more efficiently.
                 list ($courses, $warnings) = util::validate_courses($courseids, [],
+                        false, true);
+            } else if ($params['field'] === 'sectionid') {
+                $courseid = $DB->get_field('course_sections', 'course', ['id' => $value]);
-                        false, true);
+                $courses = $courseid ? [$DB->get_record('course', ['id' => $courseid])] : [];
             } else {
                 $courses = $DB->get_records('course', array($params['field'] => $value), 'id ASC');
+            }
     public static function get_updates_since_returns() {
         return self::check_updates_returns();
+    }
+    /**
+     * Mark the edit_module as deprecated.
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
+     * @return bool
+     */
+    public static function edit_module_is_deprecated() {
+        return true;
+    }
     /**
      * Parameters for function edit_module()
      *
+     * @deprecated since 5.0
-     * @since Moodle 3.3
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @return external_function_parameters
      */
     public static function edit_module_parameters() {
         return new external_function_parameters(
      * - two modules html for "duplicate" action
      * - updated module html for everything else
+     *
      * Throws exception if operation is not permitted/possible
+     *
-     * @since Moodle 3.3
+     * @deprecated since 5.0
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @param string $action
      * @param int $id
      * @param null|int $sectionreturn
      * @return string
      */
+    }
     /**
      * Return structure for edit_module()
      *
+     * @deprecated since 5.0
-     * @since Moodle 3.3
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @return \core_external\external_description
      */
     public static function edit_module_returns() {
         return new external_value(PARAM_RAW, 'html to replace the current module with');
+    }
+    /**
+     * Mark the get_module as deprecated.
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
+     * @return bool
+     */
+    public static function get_module_is_deprecated() {
+        return true;
+    }
     /**
      * Parameters for function get_module()
+     *
      * @deprecated since 5.0
-     * @since Moodle 3.3
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @return external_function_parameters
      */
     public static function get_module_parameters() {
+    }
     /**
      * Returns html for displaying one activity module on course page
      *
+     * @deprecated since 5.0
-     * @since Moodle 3.3
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @param int $id
      * @param null|int $sectionreturn
      * @return string
      */
+    }
     /**
      * Return structure for get_module()
      *
+     * @deprecated since 5.0
-     * @since Moodle 3.3
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @return \core_external\external_description
      */
     public static function get_module_returns() {
         return new external_value(PARAM_RAW, 'html to replace the current module with');
+    }
+    /**
+     * Mark the edit_section as deprecated.
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
+     * @return bool
+     */
+    public static function edit_section_is_deprecated() {
+        return true;
+    }
     /**
      * Parameters for function edit_section()
+     *
      * @deprecated since 5.0
-     * @since Moodle 3.3
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @return external_function_parameters
      */
     public static function edit_section_parameters() {
+    }
     /**
      * Performs one of the edit section actions
      *
+     * @deprecated since 5.0
-     * @since Moodle 3.3
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @param string $action
      * @param int $id section id
      * @param int $sectionreturn section to return to
      * @return string
+    }
     /**
      * Return structure for edit_section()
      *
+     * @deprecated since 5.0
-     * @since Moodle 3.3
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @return \core_external\external_description
      */
     public static function edit_section_returns() {
         return new external_value(PARAM_RAW, 'Additional data for javascript (JSON-encoded string)');
      */
     public static function get_enrolled_courses_by_timeline_classification(
         string $classification,
         int $limit = 0,
         int $offset = 0,
-        string $sort = null,
+        ?string $sort = null,
-        string $customfieldname = null,
+        ?string $customfieldname = null,
-        string $customfieldvalue = null,
+        ?string $customfieldvalue = null,
-        string $searchvalue = null,
+        ?string $searchvalue = null,
         array $requiredfields = []
     ) {
         global $CFG, $PAGE, $USER;
         require_once($CFG->dirroot . '/course/lib.php');
      * @param int $offset Skip this number of records from the start of the result set
      * @param string|null $sort SQL string for sorting
      * @return array List of courses
      * @throws  invalid_parameter_exception
      */
-    public static function get_recent_courses(int $userid = 0, int $limit = 0, int $offset = 0, string $sort = null) {
+    public static function get_recent_courses(int $userid = 0, int $limit = 0, int $offset = 0, ?string $sort = null) {
         global $USER, $PAGE;
         if (empty($userid)) {
             $userid = $USER->id;
         $usercontext = context_user::instance($userid);
         self::validate_context($usercontext);
-        if ($userid != $USER->id and !has_capability('moodle/user:viewdetails', $usercontext)) {
+        if ($userid != $USER->id && !has_capability('moodle/user:viewalldetails', $usercontext)) {
+     *
      * @param int $cmid Course Module id from which the users will be obtained
      * @param int $groupid Group id from which the users will be obtained
      * @param bool $onlyactive Whether to return only the active enrolled users or all enrolled users in the course.
      * @return array List of users
-     * @throws invalid_parameter_exception
      */
     public static function get_enrolled_users_by_cmid(int $cmid, int $groupid = 0, bool $onlyactive = false) {
-    global $PAGE;
+        global $PAGE;
         $warnings = [];
+        [
+            'cmid' => $cmid,
+            'groupid' => $groupid,
+            'onlyactive' => $onlyactive,
-        self::validate_parameters(self::get_enrolled_users_by_cmid_parameters(), [
+        ] = self::validate_parameters(self::get_enrolled_users_by_cmid_parameters(), [
-                'cmid' => $cmid,
+            'cmid' => $cmid,
-                'groupid' => $groupid,
+            'groupid' => $groupid,
-                'onlyactive' => $onlyactive,
+            'onlyactive' => $onlyactive,
         ]);
         list($course, $cm) = get_course_and_cm_from_cmid($cmid);
+        $coursecontext = context_course::instance($course->id);
+        self::validate_context($coursecontext);
         $coursecontext = context_course::instance($course->id);
-        self::validate_context($coursecontext);
+        course_require_view_participants($coursecontext);
         $enrolledusers = get_enrolled_users($coursecontext, '', $groupid, 'u.*', null, 0, 0, $onlyactive);
      * @return external_function_parameters
      */
     public static function get_course_content_items_parameters() {
         return new external_function_parameters([
             'courseid' => new external_value(PARAM_INT, 'ID of the course', VALUE_REQUIRED),
+            'sectionnum' => new external_value(PARAM_INT, 'Number of the section', VALUE_DEFAULT),
         ]);
+    }
     /**
      * Given a course ID fetch all accessible modules for that course
+     *
+     * @param int $courseid The course we want to fetch the modules for
-     * @param int $courseid The course we want to fetch the modules for
+     * @param int|null $sectionnum The section we want to fetch the modules for
      * @return array Contains array of modules and their metadata
      */
-    public static function get_course_content_items(int $courseid) {
+    public static function get_course_content_items(int $courseid, ?int $sectionnum = null) {
         global $USER;
+        [
             'courseid' => $courseid,
-            'courseid' => $courseid,
+            'sectionnum' => $sectionnum,
+        ] = self::validate_parameters(self::get_course_content_items_parameters(), [
-        ] = self::validate_parameters(self::get_course_content_items_parameters(), [
+            'courseid' => $courseid,
-            'courseid' => $courseid,
+            'sectionnum' => $sectionnum,
         ]);
+        $coursecontext = context_course::instance($courseid);
+        self::validate_context($coursecontext);
-        $coursecontext = context_course::instance($courseid);
+        $course = get_course($courseid);
-        self::validate_context($coursecontext);
+        // Get section_info object with all delegation information.
-        $course = get_course($courseid);
+        $sectioninfo = get_fast_modinfo($course)->get_section_info($sectionnum);
         $contentitemservice = \core_course\local\factory\content_item_service_factory::get_content_item_service();
         ]);
         $coursecontext = context_course::instance($courseid);
+        self::validate_context($coursecontext);
-        self::validate_context($coursecontext);
+        // The active plugin must be set, and be present on the site.
+        $activeplugin = clean_param(
+            get_config('core', 'activitychooseractivefooter'),
+            PARAM_COMPONENT,
+        );
+        if (
+            $activeplugin !== COURSE_CHOOSER_FOOTER_NONE &&
-        $activeplugin = get_config('core', 'activitychooseractivefooter');
+            !empty($activeplugin) &&
             core_component::get_component_directory($activeplugin) !== null
-        if ($activeplugin !== COURSE_CHOOSER_FOOTER_NONE) {
+        ) {
             $footerdata = component_callback($activeplugin, 'custom_chooser_footer', [$courseid, $sectionid]);
             return [

Proyectos de Subversion Moodle

(root)/course/externallib.php – Rev 1 → 1441