M4.2: External APIs: update to use new base classes

This commit adds back the commit 0a47d77
and 7e67d5e

Author: AnupamaSarjoshi

classes/external/get_users.php

@@ -16,10 +16,12 @@
 
 namespace report_customsql\external;
 
-defined('MOODLE_INTERNAL') || die();
-
-global $CFG;
-require_once($CFG->libdir . '/externallib.php');
+use core_external\external_api;
+use core_external\external_description;
+use core_external\external_function_parameters;
+use core_external\external_multiple_structure;
+use core_external\external_single_structure;
+use core_external\external_value;
 
 /**
  * Web service used by form autocomplete to get a list of users with a given capability.
@@ -28,16 +30,16 @@
  * @copyright 2020 The Open University
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class get_users extends \external_api {
+class get_users extends external_api {
     /**
      * Parameter declaration.
      *
-     * @return \external_function_parameters Parameters
+     * @return external_function_parameters Parameters
      */
-    public static function execute_parameters(): \external_function_parameters {
-        return new \external_function_parameters([
-            'query' => new \external_value(PARAM_RAW, 'Contents of the search box.'),
-            'capability' => new \external_value(PARAM_CAPABILITY, 'Return only users with this capability in the system context.'),
+    public static function execute_parameters(): external_function_parameters {
+        return new external_function_parameters([
+            'query' => new external_value(PARAM_RAW, 'Contents of the search box.'),
+            'capability' => new external_value(PARAM_CAPABILITY, 'Return only users with this capability in the system context.'),
         ]);
     }
 
@@ -136,16 +138,16 @@ public static function prepare_result_object(\stdClass $user, array $extrafields
     /**
      * Returns type for declaration.
      *
-     * @return \external_description Result type
+     * @return external_description Result type
      */
-    public static function execute_returns(): \external_description {
-        return new \external_multiple_structure(
-            new \external_single_structure([
-                'id' => new \external_value(PARAM_INT, 'User id.'),
-                'fullname' => new \external_value(PARAM_RAW, 'User full name.'),
-                'identity' => new \external_value(PARAM_RAW, 'Additional user identifying info.'),
-                'hasidentity' => new \external_value(PARAM_BOOL, 'Whether identity is non-blank.'),
-                'profileimageurlsmall' => new \external_value(PARAM_RAW, 'URL of the user profile image.'),
+    public static function execute_returns(): external_description {
+        return new external_multiple_structure(
+            new external_single_structure([
+                'id' => new external_value(PARAM_INT, 'User id.'),
+                'fullname' => new external_value(PARAM_RAW, 'User full name.'),
+                'identity' => new external_value(PARAM_RAW, 'Additional user identifying info.'),
+                'hasidentity' => new external_value(PARAM_BOOL, 'Whether identity is non-blank.'),
+                'profileimageurlsmall' => new external_value(PARAM_RAW, 'URL of the user profile image.'),
             ]));
     }
 }

tests/external/external_get_users_test.php

@@ -16,6 +16,8 @@
 
 namespace report_customsql\external;
 
+use core_external\external_api;
+
 defined('MOODLE_INTERNAL') || die();
 
 global $CFG;
@@ -79,7 +81,7 @@ public function test_get_users_site_config(): void {
         [$admin] = $this->setup_users();
 
         $result = get_users::execute('', 'moodle/site:config');
-        $result = \external_api::clean_returnvalue(get_users::execute_returns(), $result);
+        $result = external_api::clean_returnvalue(get_users::execute_returns(), $result);
 
         $this->assertEquals([
             [
@@ -99,7 +101,7 @@ public function test_get_users_site_viewreports(): void {
         [$admin, $manager] = $this->setup_users();
 
         $result = get_users::execute('', 'moodle/site:viewreports');
-        $result = \external_api::clean_returnvalue(get_users::execute_returns(), $result);
+        $result = external_api::clean_returnvalue(get_users::execute_returns(), $result);
 
         $this->assertEquals([
             [
@@ -126,7 +128,7 @@ public function test_get_users_customsql_view(): void {
         [$admin, $manager, $coursecreateor] = $this->setup_users();
 
         $result = get_users::execute('', 'report/customsql:view');
-        $result = \external_api::clean_returnvalue(get_users::execute_returns(), $result);
+        $result = external_api::clean_returnvalue(get_users::execute_returns(), $result);
 
         $this->assertEquals([
             [
@@ -162,7 +164,7 @@ public function test_get_users_serch_without_admins(): void {
         [, $manager] = $this->setup_users();
 
         $result = get_users::execute('Man', 'report/customsql:view');
-        $result = \external_api::clean_returnvalue(get_users::execute_returns(), $result);
+        $result = external_api::clean_returnvalue(get_users::execute_returns(), $result);
 
         $this->assertEquals([
                 [
@@ -182,7 +184,7 @@ public function test_get_users_serch_with_admin(): void {
         [$admin] = $this->setup_users();
 
         $result = get_users::execute('n U', 'report/customsql:view');
-        $result = \external_api::clean_returnvalue(get_users::execute_returns(), $result);
+        $result = external_api::clean_returnvalue(get_users::execute_returns(), $result);
 
         $this->assertEquals([
             [