From d6eb54bc2351670cfea87c00bd7bf22f68383455 Mon Sep 17 00:00:00 2001 From: Alexander Bias Date: Sun, 18 Aug 2024 10:10:32 +0200 Subject: [PATCH] Make codechecker happy again --- classes/privacy/provider.php | 4 ++-- lang/en/block_cohortspecifichtml.php | 29 +++++++++---------------- lib.php | 2 +- tests/block_cohortspecifichtml_test.php | 5 +++-- tests/privacy/privacy_test.php | 16 +++++++------- 5 files changed, 24 insertions(+), 32 deletions(-) diff --git a/classes/privacy/provider.php b/classes/privacy/provider.php index d0cc3dc..cc4ea87 100644 --- a/classes/privacy/provider.php +++ b/classes/privacy/provider.php @@ -51,7 +51,7 @@ class provider implements \core_privacy\local\metadata\provider, * @param collection $collection The initialised collection to add items to. * @return collection A listing of user data stored through this system. */ - public static function get_metadata(collection $collection) : collection { + public static function get_metadata(collection $collection): collection { $collection->link_subsystem('block', 'privacy:metadata:block'); return $collection; @@ -63,7 +63,7 @@ public static function get_metadata(collection $collection) : collection { * @param int $userid The user to search. * @return contextlist $contextlist The contextlist containing the list of contexts used in this plugin. */ - public static function get_contexts_for_userid(int $userid) : \core_privacy\local\request\contextlist { + public static function get_contexts_for_userid(int $userid): \core_privacy\local\request\contextlist { // This block doesn't know who information is stored against unless it // is at the user context. $contextlist = new \core_privacy\local\request\contextlist(); diff --git a/lang/en/block_cohortspecifichtml.php b/lang/en/block_cohortspecifichtml.php index 0ecc093..3ad244c 100644 --- a/lang/en/block_cohortspecifichtml.php +++ b/lang/en/block_cohortspecifichtml.php @@ -22,34 +22,25 @@ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ - -$string['pluginname'] = 'Text (on cohorts)'; - -// Capabilities. +$string['cohortselection'] = 'Show to cohorts'; +$string['cohortselection_help'] = 'The block will be only shown to the members of at least one selected cohort. This means that if you selected, for example, two cohorts and a user is only member of one of them, the block will be displayed to him as he is part of at least one selected cohort. This is equivalent to an OR connection.'; $string['cohortspecifichtml:addinstance'] = 'Add a new Text (on cohorts) block'; $string['cohortspecifichtml:myaddinstance'] = 'Add a new Text (on cohorts) block to Dashboard'; $string['cohortspecifichtml:viewalways'] = 'Always view the block'; - -// Settings. -$string['newhtmlcohortblock'] = 'New Text (on cohorts)'; -$string['cohortselection'] = 'Show to cohorts'; -$string['cohortselection_help'] = 'The block will be only shown to the members of at least one selected cohort. This means that if you selected, for example, two cohorts and a user is only member of one of them, the block will be displayed to him as he is part of at least one selected cohort. This is equivalent to an OR connection.'; -$string['nocohorts'] = 'No cohorts are defined yet. Without any cohorts the block will not be visible to anybody, even if you have entered content above.
-Cohorts can be managed in the site administration.'; $string['invertcohortselection'] = 'Invert the selection (hide it for the selected cohorts)'; $string['invertcohortselection_help'] = 'With this setting you can invert your selection. This means that the block will not be shown to members of the selected cohort but to everyone else.
Examples: '; +$string['newhtmlcohortblock'] = 'New Text (on cohorts)'; +$string['nocohorts'] = 'No cohorts are defined yet. Without any cohorts the block will not be visible to anybody, even if you have entered content above.
+Cohorts can be managed in the site administration.'; +$string['notvisibletoall'] = '
This block is not visible to any user.'; +$string['notvisibletocohorts'] = '
Not visible to cohorts:'; +$string['pluginname'] = 'Text (on cohorts)'; +$string['privacy:metadata:block'] = 'The Text (on cohorts) block stores all of its data within the block subsystem.'; $string['resetcohortselection'] = 'Reset selection'; $string['resetcohortselection_help'] = 'If you enable and save this setting, the selection you made will be reset. This means that no cohorts are selected. Unfortunately, this workaround is needed, because unselecting all cohorts would not result in any change as an empty result is passed to the server.
If you open the block configuration again this setting is reset and won\'t be shown as there is nothing that could be reset anymore.'; - -// Badges / Information. -$string['notvisibletocohorts'] = '
Not visible to cohorts:'; -$string['notvisibletoall'] = '
This block is not visible to any user.'; $string['unrestricted'] = 'Unrestricted'; -$string['visibletocohorts'] = '
Only visible to cohorts:'; $string['visibletoall'] = '
This block is visible to all users.'; - -// Privacy. -$string['privacy:metadata:block'] = 'The Text (on cohorts) block stores all of its data within the block subsystem.'; +$string['visibletocohorts'] = '
Only visible to cohorts:'; diff --git a/lib.php b/lib.php index d0e6e30..a948468 100644 --- a/lib.php +++ b/lib.php @@ -134,7 +134,7 @@ function block_cohortspecifichtml_global_db_replace($search, $replace) { * @param array $args The path (the part after the filearea and before the filename). * @return array The itemid and the filepath inside the $args path, for the defined filearea. */ -function block_cohortspecifichtml_get_path_from_pluginfile(string $filearea, array $args) : array { +function block_cohortspecifichtml_get_path_from_pluginfile(string $filearea, array $args): array { // This block never has an itemid (the number represents the revision but it's not stored in database). array_shift($args); diff --git a/tests/block_cohortspecifichtml_test.php b/tests/block_cohortspecifichtml_test.php index baa0076..ca39209 100644 --- a/tests/block_cohortspecifichtml_test.php +++ b/tests/block_cohortspecifichtml_test.php @@ -22,15 +22,16 @@ * @package block_cohortspecifichtml * @copyright 2023 Alexander Bias * based on code from 2022 Open LMS (https://www.openlms.net/) Petr Skoda + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @coversDefaultClass \block_cohortspecifichtml */ -class block_cohortspecifichtml_test extends \advanced_testcase { +final class block_cohortspecifichtml_test extends \advanced_testcase { /** * Tests instance files copying. * @covers ::instance_copy */ - public function test_instance_copy() { + public function test_instance_copy(): void { global $USER; $this->resetAfterTest(); diff --git a/tests/privacy/privacy_test.php b/tests/privacy/privacy_test.php index fe3d4b9..8a2050c 100644 --- a/tests/privacy/privacy_test.php +++ b/tests/privacy/privacy_test.php @@ -36,7 +36,7 @@ * based on code from 2018 Andrew Nicols * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -class privacy_test extends \core_privacy\tests\provider_testcase { +final class privacy_test extends \core_privacy\tests\provider_testcase { /** * Get the list of standard format options for comparison. * @@ -166,7 +166,7 @@ protected function construct_course_page(\stdClass $course) { * It is adopted from block_html and does not have a coverage tag there either. Thus, we set coversNothing. * @coversNothing */ - public function test_user_block() { + public function test_user_block(): void { $this->resetAfterTest(); $title = 'Example title'; @@ -213,7 +213,7 @@ public function test_user_block() { * It is adopted from block_html and does not have a coverage tag there either. Thus, we set coversNothing. * @coversNothing */ - public function test_user_block_unconfigured() { + public function test_user_block_unconfigured(): void { global $DB; $this->resetAfterTest(); @@ -253,7 +253,7 @@ public function test_user_block_unconfigured() { * It is adopted from block_html and does not have a coverage tag there either. Thus, we set coversNothing. * @coversNothing */ - public function test_user_multiple_blocks_exported() { + public function test_user_multiple_blocks_exported(): void { $this->resetAfterTest(); $title = 'Example title'; @@ -301,7 +301,7 @@ public function test_user_multiple_blocks_exported() { * It is adopted from block_html and does not have a coverage tag there either. Thus, we set coversNothing. * @coversNothing */ - public function test_course_blocks_not_exported() { + public function test_course_blocks_not_exported(): void { $this->resetAfterTest(); $title = 'Example title'; @@ -330,7 +330,7 @@ public function test_course_blocks_not_exported() { * It is adopted from block_html and does not have a coverage tag there either. Thus, we set coversNothing. * @coversNothing */ - public function test_mixed_multiple_blocks_exported() { + public function test_mixed_multiple_blocks_exported(): void { $this->resetAfterTest(); $title = 'Example title'; @@ -372,7 +372,7 @@ public function test_mixed_multiple_blocks_exported() { * It is adopted from block_html and does not have a coverage tag there either. Thus, we set coversNothing. * @coversNothing */ - public function test_get_users_in_context() { + public function test_get_users_in_context(): void { $this->resetAfterTest(); $component = 'block_cohortspecifichtml'; @@ -419,7 +419,7 @@ public function test_get_users_in_context() { * It is adopted from block_html and does not have a coverage tag there either. Thus, we set coversNothing. * @coversNothing */ - public function test_delete_data_for_users() { + public function test_delete_data_for_users(): void { $this->resetAfterTest(); $component = 'block_cohortspecifichtml';