DEF-2237: Adding WS

.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
       matrix:
         include:
           - php: '8.1'
-            moodle-branch: 'master'
+            moodle-branch: 'main'
             database: 'pgsql'
           - php: '8.0'
             moodle-branch: 'MOODLE_403_STABLE'

bitbucket-pipelines.yml

@@ -0,0 +1,99 @@
+---
+image:
+  name: '271411534863.dkr.ecr.us-east-2.amazonaws.com/moodleusdev:latest'
+  aws:
+    access-key: "$AWS_ACCESS_KEY"
+    secret-key: "$AWS_SECRET_KEY"
+definitions:
+  installscript: &baseInst
+    echo "Checking out Moodle\n" ;
+    moodle-plugin-ci install --branch='MOODLE_401_STABLE' ;
+  steps:
+    - step: &base
+        name: 'Moodle 4.1, PHP 7.4 and MariaDB 10.6'
+        caches:
+          - npm
+          - composer
+          - docker
+        services:
+          - mariadb
+          - docker
+  services:
+    mariadb:
+      image: mariadb:10.6
+      variables:
+        MARIADB_ALLOW_EMPTY_ROOT_PASSWORD: 'yes'
+  caches:
+    npm: $HOME/.npm
+pipelines:
+  default:
+    - parallel:
+        steps:
+          - step:
+              <<: *base
+              name: PHP Lint
+              script:
+                - *baseInst
+                - moodle-plugin-ci phplint
+          - step:
+              <<: *base
+              name: PHP Copy detector
+              script:
+                - *baseInst
+                - moodle-plugin-ci phpcpd
+          - step:
+              <<: *base
+              name: PHP Mess detector
+              script:
+                - *baseInst
+                - moodle-plugin-ci phpmd
+          - step:
+              <<: *base
+              name: PHP Code checker
+              script:
+                - *baseInst
+                - moodle-plugin-ci codechecker
+          - step:
+              <<: *base
+              name: PHP Validate
+              script:
+                - *baseInst
+                - moodle-plugin-ci validate
+          - step:
+              <<: *base
+              name: PHP Savepoints
+              script:
+                - *baseInst
+                - moodle-plugin-ci savepoints
+          - step:
+              <<: *base
+              name: PHP Mustache
+              script:
+                - *baseInst
+                - moodle-plugin-ci mustache
+          - step:
+              <<: *base
+              name: PHP Grunt
+              script:
+                - *baseInst
+                - moodle-plugin-ci grunt
+          - step:
+              <<: *base
+              name: PHP Doc
+              script:
+                - *baseInst
+                - moodle-plugin-ci phpdoc
+          - step:
+              <<: *base
+              name: PHPUnit
+              script:
+                - *baseInst
+                - moodle-plugin-ci phpunit
+          # Commented out Behat because there are no Behat tests in this project yet.
+          # - step:
+          #     <<: *base
+          #     name: Behat
+          #     script:
+          #       - *baseInst
+          #       - preset-start-behat
+          #       - moodle-plugin-ci behat

categoryadd_form.php

@@ -39,7 +39,9 @@
  */
 class report_customsql_addcategory_form extends moodleform {
 
-    // Form definition.
+    /**
+     * Define the form.
+     */
     public function definition() {
         global $CFG, $DB;
         $mform = $this->_form;
@@ -65,6 +67,13 @@ public function definition() {
         $this->add_action_buttons(true, $strsubmit);
     }
 
+    /**
+     * Validation.
+     *
+     * @param array $data Form data.
+     * @param array $files Form files.
+     * @return array Array of errors.
+     */
     public function validation($data, $files) {
         global $DB;
         $errors = parent::validation($data, $files);

classes/event/query_deleted.php

@@ -32,20 +32,39 @@
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class query_deleted extends \core\event\base {
+
+    /**
+     * Event constructor.
+     */
     protected function init() {
         $this->data['crud'] = 'd';
         $this->data['edulevel'] = self::LEVEL_OTHER;
         $this->data['objecttable'] = 'report_customsql_queries';
     }
 
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
     public static function get_name() {
         return get_string('query_deleted', 'report_customsql');
     }
 
+    /**
+     * Returns description of the query deleted event.
+     *
+     * @return string
+     */
     public function get_description() {
         return "User {$this->userid} has deleted the SQL query with id {$this->objectid}.";
     }
 
+    /**
+     * Returns relevant URL.
+     *
+     * @return \moodle_url
+     */
     public function get_url() {
         return new \moodle_url('/report/customsql/index.php');
     }

classes/event/query_edited.php

@@ -32,20 +32,39 @@
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class query_edited extends \core\event\base {
+
+    /**
+     * Event constructor.
+     */
     protected function init() {
         $this->data['crud'] = 'u';
         $this->data['edulevel'] = self::LEVEL_OTHER;
         $this->data['objecttable'] = 'report_customsql_queries';
     }
 
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
     public static function get_name() {
         return get_string('query_edited', 'report_customsql');
     }
 
+    /**
+     * Returns description of the query edited event.
+     *
+     * @return string
+     */
     public function get_description() {
         return "User {$this->userid} has edited the SQL query with id {$this->objectid}.";
     }
 
+    /**
+     * Returns url to view the query.
+     *
+     * @return string
+     */
     public function get_url() {
         return new \moodle_url('/report/customsql/view.php', ['id' => $this->objectid]);
     }

classes/event/query_viewed.php

@@ -32,20 +32,39 @@
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class query_viewed extends \core\event\base {
+
+    /**
+     * Event constructor.
+     */
     protected function init() {
         $this->data['crud'] = 'r';
         $this->data['edulevel'] = self::LEVEL_OTHER;
         $this->data['objecttable'] = 'report_customsql_queries';
     }
 
+    /**
+     * Returns localised general event name.
+     *
+     * @return string
+     */
     public static function get_name() {
         return get_string('query_viewed', 'report_customsql');
     }
 
+    /**
+     * Returns description of the query viewed event.
+     *
+     * @return string
+     */
     public function get_description() {
         return "User {$this->userid} has viewed the SQL query with id {$this->objectid}.";
     }
 
+    /**
+     * Returns relevant URL.
+     *
+     * @return \moodle_url
+     */
     public function get_url() {
         return new \moodle_url('/report/customsql/view.php', ['id' => $this->objectid]);
     }