Merge pull request #4 from KrisBax/wip918773

Update for plugin for release

Author: mkassaei

.github/workflows/ci.yml

@@ -8,16 +8,22 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - php: '7.4'
-            moodle-branch: 'master'
+          - php: '8.3'
+            moodle-branch: 'main'
             database: 'pgsql'
-          - php: '7.4'
-            moodle-branch: 'MOODLE_311_STABLE'
+          - php: '8.3'
+            moodle-branch: 'MOODLE_500_STABLE'
+            database: 'mariadb'
+          - php: '8.2'
+            moodle-branch: 'MOODLE_405_STABLE'
+            database: 'pgsql'
+          - php: '8.2'
+            moodle-branch: 'MOODLE_404_STABLE'
             database: 'mariadb'
 
     services:
       postgres:
-        image: postgres
+        image: postgres:15
         env:
           POSTGRES_USER: 'postgres'
           POSTGRES_HOST_AUTH_METHOD: 'trust'
@@ -30,77 +36,85 @@ jobs:
           - 5432:5432
 
       mariadb:
-        image: 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
 
     steps:
-      - name: Checkout
+      - name: Check out repository code
         uses: actions/checkout@v2
         with:
           path: plugin
 
-      - name: Setup PHP
+      - name: Setup PHP ${{ matrix.php }}
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
-          extensions: mbstring, pgsql, mysqli
+          extensions: ${{ matrix.extensions }}
+          ini-values: max_input_vars=5000
+          coverage: none
 
-      - name: Deploy moodle-plugin-ci
+      - name: Initialise moodle-plugin-ci
         run: |
-          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^3
+          composer create-project -n --no-dev --prefer-dist moodlehq/moodle-plugin-ci ci ^4
           # Add dirs to $PATH
           echo $(cd ci/bin; pwd) >> $GITHUB_PATH
           echo $(cd ci/vendor/bin; pwd) >> $GITHUB_PATH
-          # PHPUnit depends on en_AU.UTF-8 locale
           sudo locale-gen en_AU.UTF-8
+          echo "NVM_DIR=$HOME/.nvm" >> $GITHUB_ENV
 
       - name: Install Moodle
         run: moodle-plugin-ci install --plugin ./plugin --db-host=127.0.0.1
         env:
           DB: ${{ matrix.database }}
           MOODLE_BRANCH: ${{ matrix.moodle-branch }}
 
-      - name: phplint
+      - name: PHP Lint
         if: ${{ always() }}
         run: moodle-plugin-ci phplint
 
-      - name: phpcpd
+      - name: PHP Copy/Paste Detector
         if: ${{ always() }}
         run: moodle-plugin-ci phpcpd
 
-      - name: phpmd
+      - name: PHP Mess Detector
         if: ${{ always() }}
         run: moodle-plugin-ci phpmd
 
-      - name: codechecker
+      - name: Moodle Code Checker
         if: ${{ always() }}
-        run: moodle-plugin-ci codechecker
+        run: moodle-plugin-ci codechecker --max-warnings 0
 
-      - name: validate
+      - name: Moodle PHPDoc Checker
+        if: ${{ always() }}
+        run: moodle-plugin-ci phpdoc
+
+      - name: Validating
         if: ${{ always() }}
         run: moodle-plugin-ci validate
 
-      - name: savepoints
+      - name: Check upgrade savepoints
         if: ${{ always() }}
         run: moodle-plugin-ci savepoints
 
-      - name: mustache
+      - name: Mustache Lint
+        continue-on-error: true # We are getting a false positive due to MDLSITE-6744 so ignore.
         if: ${{ always() }}
         run: moodle-plugin-ci mustache
 
-      - name: grunt
-        if: ${{ always() }}
-        run: moodle-plugin-ci grunt
+      - name: Grunt
+        run: moodle-plugin-ci grunt --max-lint-warnings 4
 
-      - name: phpunit
+      - name: PHPUnit tests
         if: ${{ always() }}
-        run: moodle-plugin-ci phpunit
+        run: moodle-plugin-ci phpunit --fail-on-warning
 
-      - name: behat
+      - name: Behat features
         if: ${{ always() }}
         run: moodle-plugin-ci behat --profile chrome

changes.md

@@ -1,5 +1,13 @@
 # Change log for the Edit ID numbers report
 
+## Changes in 2.7
+
+* This version is compatible with Moodle 5.0.
+* Fixed code checker issues.
+* Updated behat tests to work with Moodle 4.4.
+* Log events: removed legacy logging methods for compatibility with Moodle 4.2.
+
+
 ## Changes in 2.6
 
 * This version works with Moodle 4.0.

classes/event/report_viewed.php

@@ -23,8 +23,6 @@
 
 namespace report_editidnumber\event;
 
-defined('MOODLE_INTERNAL') || die();
-
 /**
  *
  * @package    report_editdates
@@ -72,30 +70,10 @@ public static function get_name() {
      * @return \moodle_url
      */
     public function get_url() {
-        $params = array('id' => $this->courseid);
+        $params = ['id' => $this->courseid];
         if ($this->other['activitytype']) {
             $params['activitytype'] = $this->other['activitytype'];
         }
         return new \moodle_url('/report/editidnumber/index.php', $params);
     }
-
-    public static function get_legacy_eventname() {
-        return 'report id number';
-    }
-
-    /**
-     * Return the legacy event log data.
-     *
-     * @return array|null
-     */
-    protected function get_legacy_logdata() {
-        return array(
-                $this->courseid,
-                "course",
-                "report id number",
-                "report/editidnumber/index.php?id={$this->courseid}",
-                $this->contextinstanceid
-        );
-    }
-
 }

classes/privacy/provider.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 report_editidnumber.
  *
@@ -21,7 +22,7 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 namespace report_editidnumber\privacy;
-defined('MOODLE_INTERNAL') || die();
+
 /**
  * Privacy Subsystem for report_editidnumber implementing null_provider.
  *
@@ -33,9 +34,9 @@ class provider implements \core_privacy\local\metadata\null_provider {
      * Get the language string identifier with the component's language
      * file to explain why this plugin stores no data.
      *
-     * @return  string
+     * @return string
      */
-    public static function get_reason() : string {
+    public static function get_reason(): string {
         return 'privacy:metadata';
     }
 }

db/access.php

@@ -25,15 +25,15 @@
 defined('MOODLE_INTERNAL') || die;
 
 
-$capabilities = array(
-    'report/editidnumber:view' => array(
+$capabilities = [
+    'report/editidnumber:view' => [
         'riskbitmask' => RISK_PERSONAL,
         'captype' => 'read',
         'contextlevel' => CONTEXT_COURSE,
-        'archetypes' => array(
+        'archetypes' => [
             'editingteacher' => CAP_ALLOW,
-            'manager' => CAP_ALLOW
-        ),
+            'manager' => CAP_ALLOW,
+        ],
         'clonepermissionsfrom' => 'moodle/site:viewreports',
-    ),
-);
+    ],
+];

db/install.php

@@ -22,8 +22,13 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
-defined('MOODLE_INTERNAL') || die;
-
+/**
+ * Executes post-installation and migration tasks for the report_editidnumber plugin.
+ *
+ * Handles permission migration and cleanup from previous plugin versions.
+ *
+ * @return void
+ */
 function xmldb_report_editidnumber_install() {
     global $DB;
 
@@ -32,10 +37,10 @@ function xmldb_report_editidnumber_install() {
     // and clone the permissions from moodle/site:viewreports, but if we are upgrading
     // a Moodle that had the old course report plugin installed, then we get rid of the
     // new cloned capabilities, and transfer the old permissions.
-    if ($DB->record_exists('role_capabilities', array('capability' => 'coursereport/editidnumber:view'))) {
-        $DB->delete_records('role_capabilities', array('capability' => 'report/editidnumber:view'));
+    if ($DB->record_exists('role_capabilities', ['capability' => 'coursereport/editidnumber:view'])) {
+        $DB->delete_records('role_capabilities', ['capability' => 'report/editidnumber:view']);
         $DB->set_field('role_capabilities', 'capability', 'report/editidnumber:view',
-                array('capability' => 'coursereport/editidnumber:view'));
+                ['capability' => 'coursereport/editidnumber:view']);
     }
 
     // This is a hack which is needed for cleanup of original coursereport_completion stuff.
@@ -44,6 +49,6 @@ function xmldb_report_editidnumber_install() {
 
     // Update existing block page patterns.
     $DB->set_field('block_instances', 'pagetypepattern', 'report-editidnumber-index',
-            array('pagetypepattern' => 'course-report-editidnumber-index'));
+            ['pagetypepattern' => 'course-report-editidnumber-index']);
 }
 

form.php

@@ -37,6 +37,7 @@
  */
 class report_editidnumber_form extends moodleform {
 
+    #[\Override]
     public function definition() {
         global $CFG, $COURSE, $DB;
         $mform = $this->_form;
@@ -53,7 +54,7 @@ public function definition() {
 
         // Defining array for providing (see above) link from grade items
         // which are associated with course modules.
-        $modgradeitemmap = array();
+        $modgradeitemmap = [];
 
         // Store current activity type.
         $mform->addElement('hidden', 'activitytype', $activitytype);
@@ -103,10 +104,10 @@ public function definition() {
                     $elname = '';
 
                     // Display activity name.
-                    $iconmarkup = html_writer::empty_tag('img', array(
-                            'src' => $cm->get_icon_url(), 'class' => 'activityicon', 'alt' => '' ));
+                    $iconmarkup = html_writer::empty_tag('img', [
+                            'src' => $cm->get_icon_url(), 'class' => 'activityicon', 'alt' => '']);
                     $stractivityname = html_writer::tag('strong' , $iconmarkup . $cm->name,
-                            array('id' => null, 'class' => renderer_base::prepare_classes('main')));
+                            ['id' => null, 'class' => renderer_base::prepare_classes('main')]);
 
                     $elname = 'idnumber[cm]['.$cm->id.']';
                     // Creating element id.
@@ -125,7 +126,7 @@ public function definition() {
 
                     // Element to display ID number.
                     $mform->addElement('text', $elname, get_string('idnumbermod'),
-                             array("id" => $elid), array("id" => $elid));
+                             ["id" => $elid], ["id" => $elid]);
                     $mform->setType($elname, PARAM_RAW);
                     $mform->addHelpButton($elname, 'idnumbermod');
                     if (isset($cm->idnumber)) {
@@ -142,7 +143,7 @@ public function definition() {
         $readonlygrades = !has_capability('moodle/grade:manage', $coursecontext);
 
         // Fetching Gradebook items.
-        $gradeitems = grade_item::fetch_all(array('courseid' => $course->id));
+        $gradeitems = grade_item::fetch_all(['courseid' => $course->id]);
 
         // Course module will be always fetched,
         // so lenghth will always be 1 if no gread item is fetched.
@@ -177,7 +178,7 @@ public function definition() {
                     // In case of itemtype category,
                     // fetching the category fullname from grade_categories table.
                     $gradecategory = $DB->get_record("grade_categories",
-                             array("id" => $gradeitem->iteminstance));
+                             ["id" => $gradeitem->iteminstance]);
                     $mform->addElement('text', $elname, $gradecategory->fullname);
                     $mform->setType($elname, PARAM_RAW);
                     $mform->setDefault($elname, $gradeitem->idnumber);
@@ -203,6 +204,7 @@ public function definition() {
         }
     }
 
+    #[\Override]
     // Perform some extra moodle validation.
     public function validation($data, $files) {
 
@@ -226,7 +228,7 @@ public function validation($data, $files) {
         }
         ksort($data['idnumber']['cm']);
 
-        $errors = array();
+        $errors = [];
         $cmidnumbers = $data['idnumber']['cm']; // Array for course module id numbers.
         if (!empty($cmidnumbers)) {
             $possibleduplicates = $cmidnumbers;