MDL-82342 core_course: deprecate old course edit webservices

Both core_course_edit_section and core_course_edit_module are not needed anymore. All course edit actions are now executed as state actions from core_courseformat_update_course.
ferranrecio · Nov 4, 2024 · c7e7ae1 · c7e7ae1
1 parent 3a1f137
commit c7e7ae1
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 8 deletions.
diff --git a/.upgradenotes/MDL-82342-2024110403441284.yml b/.upgradenotes/MDL-82342-2024110403441284.yml
@@ -0,0 +1,8 @@
+issueNumber: MDL-82342
+notes:
+  core_course:
+    - message: >-
+        The core_course_edit_module and core_course_edit_section external
+        functions are now deprecated. Use core_courseformat_update_course
+        instead
+      type: deprecated
diff --git a/course/externallib.php b/course/externallib.php
@@ -3621,10 +3621,20 @@ 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()
      *
-     * @since Moodle 3.3
+     * @deprecated since 5.0
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @return external_function_parameters
      */
     public static function edit_module_parameters() {
@@ -3647,7 +3657,8 @@ public static function edit_module_parameters() {
      *
      * 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
@@ -3753,7 +3764,8 @@ public static function edit_module($action, $id, $sectionreturn = null) {
     /**
      * Return structure for edit_module()
      *
-     * @since Moodle 3.3
+     * @deprecated since 5.0
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @return \core_external\external_description
      */
     public static function edit_module_returns() {
@@ -3826,10 +3838,20 @@ 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()
      *
-     * @since Moodle 3.3
+     * @deprecated since 5.0
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @return external_function_parameters
      */
     public static function edit_section_parameters() {
@@ -3844,7 +3866,8 @@ public static function edit_section_parameters() {
     /**
      * Performs one of the edit section actions
      *
-     * @since Moodle 3.3
+     * @deprecated since 5.0
+     * @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
@@ -3874,7 +3897,8 @@ public static function edit_section($action, $id, $sectionreturn) {
     /**
      * Return structure for edit_section()
      *
-     * @since Moodle 3.3
+     * @deprecated since 5.0
+     * @todo Remove this method in Moodle 6.0 (MDL-83530).
      * @return \core_external\external_description
      */
     public static function edit_section_returns() {

diff --git a/lib/db/services.php b/lib/db/services.php
@@ -610,15 +610,19 @@
         'classname'   => 'core_course_external',
         'methodname'  => 'edit_module',
         'classpath'   => 'course/externallib.php',
-        'description' => 'Performs an action on course module (change visibility, duplicate, delete, etc.)',
+        'description' => '** DEPRECATED ** Please do not call this function any more (will be removed in Moodle 6.0).'
+            .' Performs an action on course module (change visibility, duplicate, delete, etc.)'
+            .' Use core_courseformat_update_course instead.',
         'type'        => 'write',
         'ajax'        => true,
     ),
     'core_course_edit_section' => array(
         'classname'   => 'core_course_external',
         'methodname'  => 'edit_section',
         'classpath'   => 'course/externallib.php',
-        'description' => 'Performs an action on course section (change visibility, set marker, delete)',
+        'description' => '** DEPRECATED ** Please do not call this function any more (will be removed in Moodle 6.0).'
+            .'Performs an action on course section (change visibility, set marker, delete)'
+            .' Use core_courseformat_update_course instead.',
         'type'        => 'write',
         'ajax'        => true,
     ),