diff --git a/.upgradenotes/MDL-82775-2024082908150378.yml b/.upgradenotes/MDL-82775-2024082908150378.yml new file mode 100644 index 00000000000..a40950f8665 --- /dev/null +++ b/.upgradenotes/MDL-82775-2024082908150378.yml @@ -0,0 +1,7 @@ +issueNumber: MDL-82775 +notes: + mod_h5pactivity: + - message: >- + The external function get_user_attempts now returns the total number of + attempts. + type: changed diff --git a/mod/h5pactivity/classes/external/get_user_attempts.php b/mod/h5pactivity/classes/external/get_user_attempts.php index e10163af3ac..bd5fe29b9ab 100644 --- a/mod/h5pactivity/classes/external/get_user_attempts.php +++ b/mod/h5pactivity/classes/external/get_user_attempts.php @@ -149,6 +149,7 @@ class get_user_attempts extends external_api { $result = (object)[ 'activityid' => $instance->id, 'usersattempts' => $usersattempts, + 'totalattempts' => $manager->count_attempts(), 'warnings' => $warnings, ]; @@ -255,6 +256,7 @@ class get_user_attempts extends external_api { 'usersattempts' => new external_multiple_structure( self::get_user_attempts_returns(), 'The complete users attempts list' ), + 'totalattempts' => new external_value(PARAM_INT, 'Total number of attempts'), 'warnings' => new external_warnings(), ], 'Activity attempts data'); } diff --git a/mod/h5pactivity/tests/external/get_user_attempts_test.php b/mod/h5pactivity/tests/external/get_user_attempts_test.php index 2f0a344d7cb..985f89b48eb 100644 --- a/mod/h5pactivity/tests/external/get_user_attempts_test.php +++ b/mod/h5pactivity/tests/external/get_user_attempts_test.php @@ -80,6 +80,7 @@ class get_user_attempts_test extends externallib_advanced_testcase { $generator = $this->getDataGenerator()->get_plugin_generator('mod_h5pactivity'); $attemptcount = 1; + $totalattempts = 0; foreach ($users as $key => $user) { if (($key == 'noattempts') || ($key == 'noenrolled') || ($key == 'editingteacher')) { $countattempts[$user->id] = 0; @@ -87,6 +88,7 @@ class get_user_attempts_test extends externallib_advanced_testcase { $params = ['cmid' => $cm->id, 'userid' => $user->id]; for ($i = 1; $i <= $attemptcount; $i++) { $generator->create_content($activity, $params); + $totalattempts++; } $countattempts[$user->id] = $attemptcount; $attemptcount++; @@ -107,6 +109,7 @@ class get_user_attempts_test extends externallib_advanced_testcase { $result ); + $this->assertEquals($totalattempts, $result['totalattempts']); $this->assertCount(count($warnings), $result['warnings']); // Teacher is excluded. $this->assertCount(count($resultusers), $result['usersattempts']);