Skip to content

Commit a3cc26f

Browse files
andrewnicolsandrewnicols
committed
MDL-76583 core: Update uses of external_* classes
1 parent 3e19209 commit a3cc26f

File tree

382 files changed

+4052
-4428
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

382 files changed

+4052
-4428
lines changed

‎admin/tool/analytics/classes/external.php

+5-9
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,11 @@
2424

2525
namespace tool_analytics;
2626

27-
defined('MOODLE_INTERNAL') || die();
28-
29-
require_once("$CFG->libdir/externallib.php");
30-
31-
use external_api;
32-
use external_function_parameters;
33-
use external_value;
34-
use external_single_structure;
35-
use external_multiple_structure;
27+
use core_external\external_api;
28+
use core_external\external_function_parameters;
29+
use core_external\external_value;
30+
use core_external\external_single_structure;
31+
use core_external\external_multiple_structure;
3632

3733
/**
3834
* This is the external API for this component.

‎admin/tool/behat/classes/external/get_entity_generator.php

+19-11
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,22 @@
2525

2626
namespace tool_behat\external;
2727

28+
use core_external\external_api;
29+
use core_external\external_function_parameters;
30+
use core_external\external_multiple_structure;
31+
use core_external\external_single_structure;
32+
use core_external\external_value;
33+
2834
defined('MOODLE_INTERNAL') || die();
2935

30-
require_once($CFG->libdir . '/externallib.php');
36+
// Ensure we can load Behat and Facebook namespaces in behat libraries.
37+
require_once($CFG->dirroot . '/vendor/autoload.php');
38+
require_once($CFG->libdir . '/tests/behat/behat_data_generators.php');
3139

3240
/**
3341
* External function for getting properties of entity generators.
3442
*/
35-
class get_entity_generator extends \external_api {
43+
class get_entity_generator extends external_api {
3644

3745
/**
3846
* Define parameters for external function.
@@ -42,11 +50,11 @@ class get_entity_generator extends \external_api {
4250
* behat_data_generators::parse_entity_type, which validates the format of the parameter and throws an exception if it is not
4351
* correct.
4452
*
45-
* @return \external_function_parameters
53+
* @return external_function_parameters
4654
*/
47-
public static function execute_parameters(): \external_function_parameters {
48-
return new \external_function_parameters([
49-
'entitytype' => new \external_value(PARAM_RAW, 'Entity type that can be created by a generator.'),
55+
public static function execute_parameters(): external_function_parameters {
56+
return new external_function_parameters([
57+
'entitytype' => new external_value(PARAM_RAW, 'Entity type that can be created by a generator.'),
5058
]);
5159
}
5260

@@ -78,12 +86,12 @@ public static function execute(string $entitytype): array {
7886
*
7987
* Return required fields
8088
*
81-
* @return \external_single_structure
89+
* @return external_single_structure
8290
*/
83-
public static function execute_returns(): \external_single_structure {
84-
return new \external_single_structure([
85-
'required' => new \external_multiple_structure(
86-
new \external_value(PARAM_TEXT, 'Required field'),
91+
public static function execute_returns(): external_single_structure {
92+
return new external_single_structure([
93+
'required' => new external_multiple_structure(
94+
new external_value(PARAM_TEXT, 'Required field'),
8795
'Required fields',
8896
VALUE_OPTIONAL
8997
),

‎admin/tool/dataprivacy/classes/external.php

+16-22
Original file line numberDiff line numberDiff line change
@@ -21,30 +21,24 @@
2121
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
2222
*/
2323
namespace tool_dataprivacy;
24+
2425
defined('MOODLE_INTERNAL') || die();
2526

26-
require_once("$CFG->libdir/externallib.php");
2727
require_once($CFG->dirroot . '/' . $CFG->admin . '/tool/dataprivacy/lib.php');
2828

29-
use coding_exception;
3029
use context_helper;
3130
use context_system;
3231
use context_user;
33-
use core\invalid_persistent_exception;
3432
use core\notification;
3533
use core_user;
36-
use dml_exception;
37-
use external_api;
38-
use external_description;
39-
use external_function_parameters;
40-
use external_multiple_structure;
41-
use external_single_structure;
42-
use external_value;
43-
use external_warnings;
44-
use invalid_parameter_exception;
34+
use core_external\external_api;
35+
use core_external\external_function_parameters;
36+
use core_external\external_multiple_structure;
37+
use core_external\external_single_structure;
38+
use core_external\external_value;
39+
use core_external\external_warnings;
4540
use moodle_exception;
4641
use required_capability_exception;
47-
use restricted_context_exception;
4842
use tool_dataprivacy\external\category_exporter;
4943
use tool_dataprivacy\external\data_request_exporter;
5044
use tool_dataprivacy\external\purpose_exporter;
@@ -136,7 +130,7 @@ public static function cancel_data_request($requestid) {
136130
* Parameter description for cancel_data_request().
137131
*
138132
* @since Moodle 3.5
139-
* @return external_description
133+
* @return \core_external\external_description
140134
*/
141135
public static function cancel_data_request_returns() {
142136
return new external_single_structure([
@@ -228,7 +222,7 @@ public static function contact_dpo($message) {
228222
* Parameter description for contact_dpo().
229223
*
230224
* @since Moodle 3.5
231-
* @return external_description
225+
* @return \core_external\external_description
232226
*/
233227
public static function contact_dpo_returns() {
234228
return new external_single_structure([
@@ -293,7 +287,7 @@ public static function mark_complete($requestid) {
293287
* Parameter description for mark_complete().
294288
*
295289
* @since Moodle 3.5.2
296-
* @return external_description
290+
* @return \core_external\external_description
297291
*/
298292
public static function mark_complete_returns() {
299293
return new external_single_structure([
@@ -355,7 +349,7 @@ public static function get_data_request($requestid) {
355349
* Parameter description for get_data_request().
356350
*
357351
* @since Moodle 3.5
358-
* @return external_description
352+
* @return \core_external\external_description
359353
*/
360354
public static function get_data_request_returns() {
361355
return new external_single_structure([
@@ -427,7 +421,7 @@ public static function approve_data_request($requestid) {
427421
* Parameter description for approve_data_request().
428422
*
429423
* @since Moodle 3.5
430-
* @return external_description
424+
* @return \core_external\external_description
431425
*/
432426
public static function approve_data_request_returns() {
433427
return new external_single_structure([
@@ -506,7 +500,7 @@ public static function bulk_approve_data_requests($requestids) {
506500
* Parameter description for bulk_approve_data_requests().
507501
*
508502
* @since Moodle 3.5
509-
* @return external_description
503+
* @return \core_external\external_description
510504
*/
511505
public static function bulk_approve_data_requests_returns() {
512506
return new external_single_structure([
@@ -578,7 +572,7 @@ public static function deny_data_request($requestid) {
578572
* Parameter description for deny_data_request().
579573
*
580574
* @since Moodle 3.5
581-
* @return external_description
575+
* @return \core_external\external_description
582576
*/
583577
public static function deny_data_request_returns() {
584578
return new external_single_structure([
@@ -657,7 +651,7 @@ public static function bulk_deny_data_requests($requestids) {
657651
* Parameter description for bulk_deny_data_requests().
658652
*
659653
* @since Moodle 3.5
660-
* @return external_description
654+
* @return \core_external\external_description
661655
*/
662656
public static function bulk_deny_data_requests_returns() {
663657
return new external_single_structure([
@@ -740,7 +734,7 @@ public static function get_users($query) {
740734
* Parameter description for get_users().
741735
*
742736
* @since Moodle 3.5
743-
* @return external_description
737+
* @return \core_external\external_description
744738
* @throws coding_exception
745739
*/
746740
public static function get_users_returns() {

‎admin/tool/dataprivacy/classes/external/data_request_exporter.php

-3
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,9 @@
2424
namespace tool_dataprivacy\external;
2525
defined('MOODLE_INTERNAL') || die();
2626

27-
use coding_exception;
2827
use core\external\persistent_exporter;
2928
use core_user;
3029
use core_user\external\user_summary_exporter;
31-
use dml_exception;
32-
use moodle_exception;
3330
use renderer_base;
3431
use tool_dataprivacy\api;
3532
use tool_dataprivacy\data_request;

‎admin/tool/dataprivacy/classes/external/purpose_exporter.php

-2
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@
2424
namespace tool_dataprivacy\external;
2525
defined('MOODLE_INTERNAL') || die();
2626

27-
use coding_exception;
2827
use core\external\persistent_exporter;
29-
use Exception;
3028
use renderer_base;
3129
use tool_dataprivacy\context_instance;
3230
use tool_dataprivacy\purpose;

‎admin/tool/dataprivacy/tests/external/external_test.php

+19-18
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424

2525
namespace tool_dataprivacy\external;
2626

27+
use core_external\external_api;
2728
use externallib_advanced_testcase;
2829
use tool_dataprivacy\api;
2930
use tool_dataprivacy\context_instance;
@@ -123,7 +124,7 @@ public function test_approve_data_request() {
123124
$this->setAdminUser();
124125
api::update_request_status($datarequest->get('id'), api::DATAREQUEST_STATUS_AWAITING_APPROVAL);
125126
$result = external::approve_data_request($datarequest->get('id'));
126-
$return = (object) \external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
127+
$return = (object) external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
127128
$this->assertTrue($return->result);
128129
$this->assertEmpty($return->warnings);
129130
}
@@ -139,7 +140,7 @@ public function test_approve_data_request_non_existent() {
139140

140141
$result = external::approve_data_request(1);
141142

142-
$return = (object) \external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
143+
$return = (object) external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
143144
$this->assertFalse($return->result);
144145
$this->assertCount(1, $return->warnings);
145146
$warning = reset($return->warnings);
@@ -165,7 +166,7 @@ public function test_cancel_data_request_other_user() {
165166
$this->setUser($otheruser);
166167

167168
$result = external::cancel_data_request($datarequest->get('id'));
168-
$return = (object) \external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
169+
$return = (object) external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
169170
$this->assertFalse($return->result);
170171
$this->assertCount(1, $return->warnings);
171172
$warning = reset($return->warnings);
@@ -194,7 +195,7 @@ public function test_cancel_data_request_other_user_as_requester() {
194195
$datarequest = api::create_data_request($otheruser->id, api::DATAREQUEST_TYPE_EXPORT, $comment);
195196

196197
$result = external::cancel_data_request($datarequest->get('id'));
197-
$return = (object) \external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
198+
$return = (object) external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
198199
$this->assertTrue($return->result);
199200
$this->assertEmpty($return->warnings);
200201
}
@@ -250,7 +251,7 @@ public function test_cancel_data_request_other_user_as_child() {
250251
$datarequest = api::create_data_request($otheruser->id, api::DATAREQUEST_TYPE_EXPORT, $comment);
251252

252253
$result = external::cancel_data_request($datarequest->get('id'));
253-
$return = (object) \external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
254+
$return = (object) external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
254255
$this->assertTrue($return->result);
255256
$this->assertEmpty($return->warnings);
256257
}
@@ -273,7 +274,7 @@ public function test_cancel_data_request() {
273274
$this->setUser($requester);
274275
$result = external::cancel_data_request($datarequest->get('id'));
275276

276-
$return = (object) \external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
277+
$return = (object) external_api::clean_returnvalue(external::approve_data_request_returns(), $result);
277278
$this->assertTrue($return->result);
278279
$this->assertEmpty($return->warnings);
279280
}
@@ -290,7 +291,7 @@ public function test_contact_dpo() {
290291
$this->setUser($user);
291292
$message = 'Hello world!';
292293
$result = external::contact_dpo($message);
293-
$return = (object) \external_api::clean_returnvalue(external::contact_dpo_returns(), $result);
294+
$return = (object) external_api::clean_returnvalue(external::contact_dpo_returns(), $result);
294295
$this->assertTrue($return->result);
295296
$this->assertEmpty($return->warnings);
296297
}
@@ -385,7 +386,7 @@ public function test_deny_data_request() {
385386
$this->setAdminUser();
386387
api::update_request_status($datarequest->get('id'), api::DATAREQUEST_STATUS_AWAITING_APPROVAL);
387388
$result = external::approve_data_request($datarequest->get('id'));
388-
$return = (object) \external_api::clean_returnvalue(external::deny_data_request_returns(), $result);
389+
$return = (object) external_api::clean_returnvalue(external::deny_data_request_returns(), $result);
389390
$this->assertTrue($return->result);
390391
$this->assertEmpty($return->warnings);
391392
}
@@ -400,7 +401,7 @@ public function test_deny_data_request_non_existent() {
400401
$this->setAdminUser();
401402
$result = external::deny_data_request(1);
402403

403-
$return = (object) \external_api::clean_returnvalue(external::deny_data_request_returns(), $result);
404+
$return = (object) external_api::clean_returnvalue(external::deny_data_request_returns(), $result);
404405
$this->assertFalse($return->result);
405406
$this->assertCount(1, $return->warnings);
406407
$warning = reset($return->warnings);
@@ -462,7 +463,7 @@ public function test_get_data_request() {
462463
$this->setAdminUser();
463464
$result = external::get_data_request($datarequest->get('id'));
464465

465-
$return = (object) \external_api::clean_returnvalue(external::get_data_request_returns(), $result);
466+
$return = (object) external_api::clean_returnvalue(external::get_data_request_returns(), $result);
466467
$this->assertEquals(api::DATAREQUEST_TYPE_EXPORT, $return->result['type']);
467468
$this->assertEquals('sample comment', $return->result['comments']);
468469
$this->assertEquals($requester->id, $return->result['userid']);
@@ -542,7 +543,7 @@ public function test_set_context_defaults($modulelevel, $override) {
542543
$result = external::set_context_defaults(CONTEXT_MODULE, $categoryid, $purposeid, $modulename, $override);
543544

544545
// Extract the result.
545-
$return = \external_api::clean_returnvalue(external::set_context_defaults_returns(), $result);
546+
$return = external_api::clean_returnvalue(external::set_context_defaults_returns(), $result);
546547
$this->assertTrue($return['result']);
547548

548549
// Check the assignment context instance.
@@ -626,7 +627,7 @@ public function test_get_category_options($includeinherit, $includenotset) {
626627
$result = external::get_category_options($includeinherit, $includenotset);
627628

628629
// Extract the options.
629-
$return = (object) \external_api::clean_returnvalue(external::get_category_options_returns(), $result);
630+
$return = (object) external_api::clean_returnvalue(external::get_category_options_returns(), $result);
630631
$options = $return->options;
631632

632633
// Make sure everything checks out.
@@ -690,7 +691,7 @@ public function test_get_purpose_options($includeinherit, $includenotset) {
690691
$result = external::get_purpose_options($includeinherit, $includenotset);
691692

692693
// Extract the options.
693-
$return = (object) \external_api::clean_returnvalue(external::get_purpose_options_returns(), $result);
694+
$return = (object) external_api::clean_returnvalue(external::get_purpose_options_returns(), $result);
694695
$options = $return->options;
695696

696697
// Make sure everything checks out.
@@ -749,7 +750,7 @@ public function test_get_activity_options($inheritcategory, $inheritpurpose, $no
749750
$result = external::get_activity_options($nodefaults);
750751

751752
// Extract the options.
752-
$return = (object) \external_api::clean_returnvalue(external::get_activity_options_returns(), $result);
753+
$return = (object) external_api::clean_returnvalue(external::get_activity_options_returns(), $result);
753754
$options = $return->options;
754755

755756
// Make sure the options list is not empty.
@@ -792,7 +793,7 @@ public function test_bulk_approve_data_requests() {
792793
api::update_request_status($requestid2, api::DATAREQUEST_STATUS_AWAITING_APPROVAL);
793794
$result = external::bulk_approve_data_requests([$requestid1, $requestid2]);
794795

795-
$return = (object) \external_api::clean_returnvalue(external::bulk_approve_data_requests_returns(), $result);
796+
$return = (object) external_api::clean_returnvalue(external::bulk_approve_data_requests_returns(), $result);
796797
$this->assertTrue($return->result);
797798
$this->assertEmpty($return->warnings);
798799
}
@@ -807,7 +808,7 @@ public function test_bulk_approve_data_requests_non_existent() {
807808

808809
$result = external::bulk_approve_data_requests([42]);
809810

810-
$return = (object) \external_api::clean_returnvalue(external::bulk_approve_data_requests_returns(), $result);
811+
$return = (object) external_api::clean_returnvalue(external::bulk_approve_data_requests_returns(), $result);
811812
$this->assertFalse($return->result);
812813
$this->assertCount(1, $return->warnings);
813814
$warning = reset($return->warnings);
@@ -895,7 +896,7 @@ public function test_bulk_deny_data_requests() {
895896
api::update_request_status($requestid2, api::DATAREQUEST_STATUS_AWAITING_APPROVAL);
896897
$result = external::bulk_deny_data_requests([$requestid1, $requestid2]);
897898

898-
$return = (object) \external_api::clean_returnvalue(external::bulk_approve_data_requests_returns(), $result);
899+
$return = (object) external_api::clean_returnvalue(external::bulk_approve_data_requests_returns(), $result);
899900
$this->assertTrue($return->result);
900901
$this->assertEmpty($return->warnings);
901902
}
@@ -908,7 +909,7 @@ public function test_bulk_deny_data_requests_non_existent() {
908909

909910
$this->setAdminUser();
910911
$result = external::bulk_deny_data_requests([42]);
911-
$return = (object) \external_api::clean_returnvalue(external::bulk_approve_data_requests_returns(), $result);
912+
$return = (object) external_api::clean_returnvalue(external::bulk_approve_data_requests_returns(), $result);
912913

913914
$this->assertFalse($return->result);
914915
$this->assertCount(1, $return->warnings);

0 commit comments

Comments
 (0)