Merge pull request #195 from learnweb/fix-codestyles

Fix codestyle and pin moodle-plugin-ci version

.github/workflows/moodle-ci.yml

@@ -50,7 +50,7 @@ jobs:
 
       - name: Initialise moodle-plugin-ci
         run: |
-          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4
+          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci 4.5.4
           echo $(cd ci/bin; pwd) >> $GITHUB_PATH
           echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
           sudo locale-gen en_AU.UTF-8
@@ -173,7 +173,7 @@ jobs:
 
       - name: Initialise moodle-plugin-ci
         run: |
-          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4
+          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci 4.5.4
           echo $(cd ci/bin; pwd) >> $GITHUB_PATH
           echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
           sudo locale-gen en_AU.UTF-8

classes/capabilities.php

@@ -94,11 +94,11 @@ public static function has(string $capability, context $context, $userid = null)
 
         $key = "$userid:$context->id:$capability";
 
-        if (!isset($cache[$key])) {
-            $cache[$key] = has_capability($capability, $context, $userid);
+        if (!isset(self::$cache[$key])) {
+            self::$cache[$key] = has_capability($capability, $context, $userid);
         }
 
-        return $cache[$key];
+        return self::$cache[$key];
     }
 
 }

classes/output/moodleoverflow_email.php

@@ -73,13 +73,13 @@ class moodleoverflow_email implements \renderable, \templatable {
     /**
      * Whether the user can reply to this post.
      *
-     * @var boolean $canreply
+     * @var bool $canreply
      */
     protected $canreply = false;
 
     /**
      * Whether to override forum display when displaying usernames.
-     * @var boolean $viewfullnames
+     * @var bool $viewfullnames
      */
     protected $viewfullnames = false;
 

classes/privacy/data_export_helper.php

@@ -13,6 +13,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
 /**
  * Privacy Subsystem implementation for mod_moodleoverflow.
  *

classes/privacy/provider.php

@@ -50,7 +50,7 @@ class provider implements
      *
      * @return collection the updated collection of metadata items.
      */
-    public static function get_metadata(collection $collection) : collection {
+    public static function get_metadata(collection $collection): collection {
         $collection->add_database_table('moodleoverflow_discussions',
             [
                 'name' => 'privacy:metadata:moodleoverflow_discussions:name',
@@ -135,7 +135,7 @@ public static function get_metadata(collection $collection) : collection {
      *
      * @return contextlist $contextlist The list of contexts used in this plugin.
      */
-    public static function get_contexts_for_userid(int $userid) : contextlist {
+    public static function get_contexts_for_userid(int $userid): contextlist {
         // Fetch all Moodleoverflow discussions, moodleoverflow posts, ratings, tracking settings and subscriptions.
         $sql = "SELECT c.id
                 FROM {context} c

grade.php

@@ -21,6 +21,7 @@
  * @copyright 2017 Kennet Winter <[email protected]>
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
+
 require_once(__DIR__ . "/../../config.php");
 require_login();
 $id = required_param('id', PARAM_INT);

tests/behat/behat_mod_moodleoverflow.php

@@ -159,6 +159,7 @@ protected function find_moodleoverflow_discussion_card(string $discussiontitle):
             $discussiontitle . '"]]');
     }
 
+    // phpcs:disable moodle.Files.LineLength.TooLong
     /**
      * Checks that an element and selector type exists in another element and selector type on the current page.
      *
@@ -171,6 +172,7 @@ protected function find_moodleoverflow_discussion_card(string $discussiontitle):
      * @param string $discussiontitle The discussion title
      */
     public function should_exist_in_the_moodleoverflow_discussion_card($element, $selectortype, $discussiontitle) {
+        // phpcs:enable
         // Get the container node.
         $containernode = $this->find_moodleoverflow_discussion_card($discussiontitle);
 
@@ -182,6 +184,7 @@ public function should_exist_in_the_moodleoverflow_discussion_card($element, $se
         $this->find($selectortype, $element, $exception, $containernode);
     }
 
+    // phpcs:disable moodle.Files.LineLength.TooLong
     /**
      * Click on the element of the specified type which is located inside the second element.
      *
@@ -191,6 +194,7 @@ public function should_exist_in_the_moodleoverflow_discussion_card($element, $se
      * @param string $discussiontitle The discussion title
      */
     public function i_click_on_in_the_moodleoverflow_discussion_card($element, $selectortype, $discussiontitle) {
+        // phpcs:enable
         // Get the container node.
         $containernode = $this->find_moodleoverflow_discussion_card($discussiontitle);
 
@@ -204,6 +208,7 @@ public function i_click_on_in_the_moodleoverflow_discussion_card($element, $sele
         $node->click();
     }
 
+    // phpcs:disable moodle.Files.LineLength.TooLong
     /**
      * Checks that an element and selector type does not exist in another element and selector type on the current page.
      *
@@ -216,6 +221,7 @@ public function i_click_on_in_the_moodleoverflow_discussion_card($element, $sele
      * @param string $discussiontitle The discussion title
      */
     public function should_not_exist_in_the_moodleoverflow_discussion_card($element, $selectortype, $discussiontitle) {
+        // phpcs:enable
         // Get the container node.
         $containernode = $this->find_moodleoverflow_discussion_card($discussiontitle);
 

tests/dailymail_test.php

@@ -38,8 +38,9 @@
  * @package   mod_moodleoverflow
  * @copyright 2023 Tamaro Walter
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers \mod_moodleoverflow\task\send_daily_mail::execute
  */
-class dailymail_test extends \advanced_testcase {
+final class dailymail_test extends \advanced_testcase {
 
     /** @var \stdClass collection of messages */
     private $sink;
@@ -138,7 +139,6 @@ private function helper_run_send_mails() {
 
     /**
      * Test if the task send_daily_mail sends a mail to the user.
-     * @covers \send_daily_mail::execute
      */
     public function test_mail_delivery(): void {
         // Create user with maildigest = on.
@@ -154,7 +154,6 @@ public function test_mail_delivery(): void {
 
     /**
      * Test if the task send_daily_mail does not sends email from posts that are not in the course of the user.
-     * @return void
      */
     public function test_delivery_not_enrolled(): void {
         // Create user with maildigest = on.
@@ -201,7 +200,6 @@ public function test_delivery_not_enrolled(): void {
 
     /**
      * Test if the content of the mail matches the supposed content.
-     * @covers \send_daily_mail::execute
      */
     public function test_content_of_mail_delivery(): void {
 
@@ -236,7 +234,6 @@ public function test_content_of_mail_delivery(): void {
 
     /**
      * Test if the task does not send a mail when maildigest = 0
-     * @covers \send_daily_mail::execute
      */
     public function test_mail_not_send(): void {
         // Creat user with daily_mail = off.
@@ -252,7 +249,6 @@ public function test_mail_not_send(): void {
 
     /**
      * Test if database is updated after sending a mail
-     * @covers \send_daily_mail::execute
      */
     public function test_records_removed(): void {
         global $DB;

tests/locallib_test.php

@@ -36,7 +36,7 @@
  * @copyright 2017 Kennet Winter <[email protected]>
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class locallib_test extends advanced_testcase {
+final class locallib_test extends advanced_testcase {
 
     public function setUp(): void {
         \mod_moodleoverflow\subscriptions::reset_moodleoverflow_cache();

tests/post_test.php

@@ -33,7 +33,7 @@
  * @copyright 2023 Tamaro Walter
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class post_test extends \advanced_testcase {
+final class post_test extends \advanced_testcase {
 
     /** @var \stdClass test course */
     private $course;

tests/privacy_provider_test.php

@@ -13,6 +13,7 @@
 //
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
 /**
  * Tests for the moodleoverflow implementation of the Privacy Provider API.
  *
@@ -41,7 +42,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @covers \provider
  */
-class privacy_provider_test extends \core_privacy\tests\provider_testcase {
+final class privacy_provider_test extends \core_privacy\tests\provider_testcase {
     /**
      * @var \mod_moodleoverflow_generator Plugin generator
      */
@@ -587,7 +588,7 @@ public function test_post_attachment_inclusion(): void {
     /**
      * Ensure that all user data is deleted from a context.
      */
-    public function test_all_users_deleted_from_context() {
+    public function test_all_users_deleted_from_context(): void {
         global $DB;
         $fs = get_file_storage();
         $course = $this->getDataGenerator()->create_course();
@@ -724,7 +725,7 @@ public function test_all_users_deleted_from_context() {
     /**
      * Ensure that all user data is deleted for a specific context.
      */
-    public function test_delete_data_for_user() {
+    public function test_delete_data_for_user(): void {
         global $DB;
         $fs = get_file_storage();
         $course = $this->getDataGenerator()->create_course();
@@ -937,7 +938,7 @@ protected function create_and_enrol_users($course, $count) {
     /**
      * Ensure that user data for specific users is deleted from a specified context.
      */
-    public function test_delete_data_for_users() {
+    public function test_delete_data_for_users(): void {
         global $DB;
 
         $fs = get_file_storage();

tests/ratings_test.php

@@ -37,7 +37,7 @@
  * @copyright 2023 Tamaro Walter
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class ratings_test extends \advanced_testcase {
+final class ratings_test extends \advanced_testcase {
     /** @var \stdClass test course */
     private $course;
 

tests/readtracking_test.php

@@ -38,7 +38,7 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @covers \readtracking
  */
-class readtracking_test extends advanced_testcase {
+final class readtracking_test extends advanced_testcase {
 
     /**
      * Test the logic in the moodleoverflow_can_track_moodleoverflows() function.

tests/review_test.php

@@ -39,8 +39,10 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  *
  * @group mod_moodleoverflow
+ * @covers \mod_moodleoverflow_external::review_approve_post
+ * @covers \mod_moodleoverflow_external::review_reject_post
  */
-class review_test extends \advanced_testcase {
+final class review_test extends \advanced_testcase {
 
     /** @var \mod_moodleoverflow_generator $generator */
     private $generator;

tests/subscriptions_test.php

@@ -38,7 +38,7 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  * @covers \subscriptions
  */
-class subscriptions_test extends advanced_testcase {
+final class subscriptions_test extends advanced_testcase {
 
     /**
      * Test setUp.
@@ -1360,7 +1360,7 @@ public function test_moodleoverflow_subscribe_toggle_as_other_repeat_subscriptio
      *
      * @return array
      */
-    public function is_subscribable_moodleoverflows() {
+    public static function is_subscribable_moodleoverflows() {
         return [
             [
                 'forcesubscribe' => MOODLEOVERFLOW_DISALLOWSUBSCRIBE,
@@ -1382,9 +1382,9 @@ public function is_subscribable_moodleoverflows() {
      *
      * @return array
      */
-    public function is_subscribable_provider(): array {
+    public static function is_subscribable_provider(): array {
         $data = [];
-        foreach ($this->is_subscribable_moodleoverflows() as $moodleoverflow) {
+        foreach (self::is_subscribable_moodleoverflows() as $moodleoverflow) {
             $data[] = [$moodleoverflow];
         }
 
@@ -1440,7 +1440,7 @@ public function test_is_subscribable_is_guest($options): void {
      * Returns subscription obtions.
      * @return array
      */
-    public function is_subscribable_loggedin_provider(): array {
+    public static function is_subscribable_loggedin_provider(): array {
         return [
             [
                 ['forcesubscribe' => MOODLEOVERFLOW_DISALLOWSUBSCRIBE],

tests/userstats_test.php

@@ -39,7 +39,7 @@
  *
  * @covers \userstats_table
  */
-class userstats_test extends \advanced_testcase {
+final class userstats_test extends \advanced_testcase {
 
     /** @var \stdClass test course */
     private $course;