Refactoring the plugin and fix ci issues

* Correction 'Error and warnings' phpcs, fix oval btn and validation of behat tests
* Adding github folder and getting rid of .travis.yml
* Fixing pull request commands
* Fix behat test file so it works on moodle 3
* Validating Grunt and PHPDoc tests
* Added status badge to README
* Last try to fix PhpDoc
* Fix PhpDoc
* Fix PhpDoc another time

Author: Martin

.github/workflows/main.yml

@@ -0,0 +1,111 @@
+name: Moodle Plugin CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-22.04
+
+    services:
+      postgres:
+        image: postgres:12
+        env:
+          POSTGRES_USER: 'postgres'
+          POSTGRES_HOST_AUTH_METHOD: 'trust'
+        ports:
+          - 5432:5432
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 3
+      mariadb:
+        image: mariadb:10
+        env:
+          MYSQL_USER: 'root'
+          MYSQL_ALLOW_EMPTY_PASSWORD: "true"
+          MYSQL_CHARACTER_SET_SERVER: "utf8mb4"
+          MYSQL_COLLATION_SERVER: "utf8mb4_unicode_ci"
+
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval 10s --health-timeout 5s --health-retries 3
+
+    strategy:
+      fail-fast: false
+      matrix:
+        php: ['7.4', '8.0']
+        moodle-branch: ['MOODLE_311_STABLE','MOODLE_400_STABLE']
+        database: [pgsql, mariadb]
+
+    steps:
+      - name: Check out repository code
+        uses: actions/checkout@v2
+        with:
+          path: plugin
+
+      - name: Setup PHP ${{ matrix.php }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: ${{ matrix.extensions }}
+          ini-values: max_input_vars=5000
+          # none to use phpdbg fallback. Specify pcov (Moodle 3.10 and up) or xdebug to use them instead.
+          coverage: none
+
+      - name: Initialise moodle-plugin-ci
+        run: |
+          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3
+          echo $(cd ci/bin; pwd) >> $GITHUB_PATH
+          echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
+          sudo locale-gen en_AU.UTF-8
+          echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
+
+      - name: Install moodle-plugin-ci
+        run: |
+          moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
+        env:
+          DB: ${{ matrix.database }}
+          MOODLE_BRANCH: ${{ matrix.moodle-branch }}
+
+      - name: PHP Lint
+        if: ${{ always() }}
+        run: moodle-plugin-ci phplint
+
+      - name: PHP Copy/Paste Detector
+        continue-on-error: true # This step will show errors but will not fail
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpcpd
+
+      - name: PHP Mess Detector
+        continue-on-error: true # This step will show errors but will not fail
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpmd
+
+      - name: Moodle Code Checker
+        if: ${{ always() }}
+        run: moodle-plugin-ci codechecker --max-warnings 0
+
+      - name: Moodle PHPDoc Checker
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpdoc
+
+      - name: Validating
+        if: ${{ always() }}
+        run: moodle-plugin-ci validate
+
+      - name: Check upgrade savepoints
+        if: ${{ always() }}
+        run: moodle-plugin-ci savepoints
+
+      - name: Mustache Lint
+        if: ${{ always() }}
+        run: moodle-plugin-ci mustache
+
+      - name: Grunt
+        if: ${{ always() }}
+        run: moodle-plugin-ci grunt --max-lint-warnings 0
+
+      - name: PHPUnit tests
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpunit --fail-on-warning
+
+      - name: Behat features
+        if: ${{ always() }}
+        run: moodle-plugin-ci behat --profile chrome

.travis.yml

@@ -1,5 +1,7 @@
 # Featured courses #
 
+[![Moodle Plugin CI](https://github.com/martin-call-learning/moodle-block_featured_courses/actions/workflows/main.yml/badge.svg)](https://github.com/martin-call-learning/moodle-block_featured_courses/actions/workflows/main.yml)
+
 [![Build Status](https://travis-ci.org/call-learning/moodle-block-featured_courses.svg?branch=master)](https://travis-ci.org/call-learning/moodle-block-featured_courses)
 
 A block to display of courses from the global list of courses.

README.md

@@ -24,8 +24,6 @@
 
 use block_featured_courses\output\featured_courses;
 
-defined('MOODLE_INTERNAL') || die();
-
 /**
  * Class block_featured_courses
  *
@@ -55,8 +53,9 @@ public function specialization() {
     /**
      * Content for the block
      *
-     * @return \stdClass|string|null
+     * @return stdClass|string|null
      * @throws coding_exception
+     * @throws dml_exception
      */
     public function get_content() {
 
@@ -87,7 +86,7 @@ public function get_content() {
      *
      * @return array
      */
-    public function applicable_formats() {
+    public function applicable_formats(): array {
         return array('all' => true);
     }
 
@@ -96,7 +95,7 @@ public function applicable_formats() {
      *
      * @return bool
      */
-    public function instance_allow_multiple() {
+    public function instance_allow_multiple(): bool {
         return true;
     }
 
@@ -105,7 +104,7 @@ public function instance_allow_multiple() {
      *
      * @return bool
      */
-    public function has_config() {
+    public function has_config(): bool {
         return false;
     }
 }

block_featured_courses.php

@@ -23,10 +23,10 @@
  */
 
 namespace block_featured_courses;
-defined('MOODLE_INTERNAL') || die();
-global $CFG;
 
 use core_course\external\course_summary_exporter;
+use core_course_category;
+use moodle_exception;
 use moodle_url;
 use renderer_base;
 
@@ -45,7 +45,7 @@ class mini_course_summary_exporter extends course_summary_exporter {
      *
      * @return array|array[]
      */
-    public static function define_other_properties() {
+    public static function define_other_properties(): array {
         return array(
             'fullnamedisplay' => array(
                 'type' => PARAM_TEXT,
@@ -65,22 +65,12 @@ public static function define_other_properties() {
         );
     }
 
-    /**
-     * Constructor - saves the persistent object, and the related objects.
-     *
-     * @param mixed $data - Either an stdClass or an array of values.
-     * @param array $related - An optional list of pre-loaded objects related to this object.
-     */
-    public function __construct($data, $related = array()) {
-        \core\external\exporter::__construct($data, $related);
-    }
-
     /**
      * Define related variables
      *
      * @return string[]
      */
-    protected static function define_related() {
+    protected static function define_related(): array {
         // We cache the context so it does not need to be retrieved from the course.
         return array('context' => '\\context');
     }
@@ -90,15 +80,15 @@ protected static function define_related() {
      *
      * @param renderer_base $output
      * @return array
-     * @throws \moodle_exception
+     * @throws moodle_exception
      */
-    protected function get_other_values(renderer_base $output) {
+    protected function get_other_values(renderer_base $output): array {
         global $CFG;
         $courseimage = self::get_course_image($this->data);
         if (!$courseimage) {
             $courseimage = $output->get_generated_image_for_id($this->data->id);
         }
-        $coursecategory = \core_course_category::get($this->data->category, MUST_EXIST, true);
+        $coursecategory = core_course_category::get($this->data->category, MUST_EXIST, true);
         $urlparam = array('id' => $this->data->id);
         $courseurl = new moodle_url('/course/view.php', $urlparam);
         if (!empty($CFG->enablesyllabus) && class_exists('\\local_syllabus\\locallib\utils')) {
@@ -108,9 +98,9 @@ protected function get_other_values(renderer_base $output) {
             'fullnamedisplay' => get_course_display_name_for_list($this->data),
             'viewurl' => $courseurl->out(false),
             'courseimage' => $courseimage,
-            'showshortname' => $CFG->courselistshortnames ? true : false,
+            'showshortname' => (bool) ($CFG->courselistshortnames ?? false),
             'coursecategory' => $coursecategory->name
         );
     }
 
-}
+}

classes/mini_course_summary_exporter.php

@@ -23,11 +23,12 @@
  */
 
 namespace block_featured_courses\output;
-defined('MOODLE_INTERNAL') || die();
 
 use block_featured_courses\mini_course_summary_exporter;
+use coding_exception;
 use context_course;
 use context_helper;
+use dml_exception;
 use renderable;
 use renderer_base;
 use templatable;
@@ -42,23 +43,25 @@
 class featured_courses implements renderable, templatable {
 
     /**
-     * @var array course
+     * The list of the courses. Initialized empty
+     *
+     * @var array $courses
      */
     public $courses = [];
 
     /**
      * featured_courses constructor.
      * Retrieve matchin courses
      *
-     * @param int $coursesid
-     * @throws \coding_exception
-     * @throws \dml_exception
+     * @param array $coursesid
+     * @throws coding_exception
+     * @throws dml_exception
      */
-    public function __construct($coursesid) {
+    public function __construct(array $coursesid) {
         global $DB;
         // First make sure that we have id in the table and not empty strings.
         $realcourseids = [];
-        foreach($coursesid as $cid) {
+        foreach ($coursesid as $cid) {
             if ($cid && is_numeric($cid)) {
                 $realcourseids[] = $cid;
             }
@@ -72,19 +75,17 @@ public function __construct($coursesid) {
      *
      * @param renderer_base $renderer
      * @return array
-     * @throws \coding_exception
+     * @throws coding_exception
      */
-    public function export_for_template(renderer_base $renderer) {
+    public function export_for_template(renderer_base $renderer): array {
         $formattedcourses = array_map(function($course) use ($renderer) {
             context_helper::preload_from_record($course);
             $context = context_course::instance($course->id);
             $exporter = new mini_course_summary_exporter($course, ['context' => $context]);
-            $exported = (array) $exporter->export($renderer);
-            return $exported;
+            return (array) $exporter->export($renderer);
         }, $this->courses);
-        $exportedvalue = [
-            'courses' => array_values((array) $formattedcourses),
+        return [
+            'courses' => array_values($formattedcourses),
         ];
-        return $exportedvalue;
     }
 }

classes/output/featured_courses.php

@@ -23,15 +23,15 @@
  */
 namespace block_featured_courses\privacy;
 
-defined('MOODLE_INTERNAL') || die();
+use core_privacy\local\metadata\null_provider;
 
 /**
  * Privacy Subsystem for block_featured_courses implementing null_provider.
  *
  * @copyright 2020 - CALL Learning - Laurent David <laurent@call-learning>
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class provider implements \core_privacy\local\metadata\null_provider {
+class provider implements null_provider {
 
     /**
      * Get the language string identifier with the component's language