Ad-hoc database queries: publish report_customsql M4.5/M5.0 version #948807

Author: Mahmoud Kassaei

.github/workflows/ci.yml

@@ -8,8 +8,11 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - php: '8.3'
+          - php: '8.4'
             moodle-branch: 'main'
+            database: 'mariadb'
+          - php: '8.4'
+            moodle-branch: 'MOODLE_501_STABLE'
             database: 'pgsql'
           - php: '8.3'
             moodle-branch: 'MOODLE_500_STABLE'
@@ -23,7 +26,7 @@ jobs:
 
     services:
       postgres:
-        image: postgres:14
+        image: postgres:16
         env:
           POSTGRES_USER: 'postgres'
           POSTGRES_HOST_AUTH_METHOD: 'trust'
@@ -36,7 +39,7 @@ jobs:
           - 5432:5432
 
       mariadb:
-        image: mariadb:10
+        image: mariadb:10.11
         env:
           MYSQL_USER: 'root'
           MYSQL_ALLOW_EMPTY_PASSWORD: "true"
@@ -79,10 +82,6 @@ jobs:
         if: ${{ always() }}
         run: moodle-plugin-ci phplint
 
-      - name: PHP Copy/Paste Detector
-        if: ${{ always() }}
-        run: moodle-plugin-ci phpcpd
-
       - name: PHP Mess Detector
         if: ${{ always() }}
         run: moodle-plugin-ci phpmd

addcategory.php

@@ -47,8 +47,12 @@
     $queryparams['categoryid'] = $id;
     $isadding = false;
     // Editing an existing category.
-    $category = $DB->get_record('report_customsql_categories',
-            ['id' => $id], '*', MUST_EXIST);
+    $category = $DB->get_record(
+        'report_customsql_categories',
+        ['id' => $id],
+        '*',
+        MUST_EXIST,
+    );
 } else {
     $queryparams['categoryid'] = null;
     $isadding = true;

categoryadd_form.php

@@ -38,7 +38,6 @@
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class report_customsql_addcategory_form extends moodleform {
-
     #[\Override]
     public function definition() {
         global $CFG, $DB;
@@ -74,8 +73,13 @@ public function validation($data, $files) {
             if (!isset($data['id'])) {
                 $data['id'] = 0;// Ensure id to check against.
             }
-            if ($DB->get_record_select('report_customsql_categories',
-                    'name = ? AND id != ?', [$data['name'], $data['id']])) {
+            if (
+                $DB->get_record_select(
+                    'report_customsql_categories',
+                    'name = ? AND id != ?',
+                    [$data['name'], $data['id']],
+                )
+            ) {
                 $errors['name'] = get_string('categoryexists', 'report_customsql');
             }
         }

categorydelete.php

@@ -31,8 +31,12 @@
 $id = required_param('id', PARAM_INT);
 
 // Start the page.
-admin_externalpage_setup('report_customsql', '', ['id' => $id],
-        '/report/customsql/categorydelete.php');
+admin_externalpage_setup(
+    'report_customsql',
+    '',
+    ['id' => $id],
+    '/report/customsql/categorydelete.php',
+);
 $context = context_system::instance();
 require_capability('report/customsql:managecategories', $context);
 
@@ -56,10 +60,25 @@
 }
 
 echo $OUTPUT->header();
-echo $OUTPUT->heading(get_string('deletecategoryareyousure', 'report_customsql'));
-echo html_writer::tag('p', get_string('categorynamex', 'report_customsql', $category->name ));
-echo $OUTPUT->confirm(get_string('deletecategoryyesno', 'report_customsql'),
-             new single_button(report_customsql_url('categorydelete.php',
-                     ['id' => $id, 'confirm' => 1, 'sesskey' => sesskey()]), get_string('yes')),
-                     new single_button(report_customsql_url('index.php'), get_string('no')));
+echo $OUTPUT->heading(
+    get_string('deletecategoryareyousure', 'report_customsql')
+);
+echo html_writer::tag(
+    'p',
+    get_string('categorynamex', 'report_customsql', $category->name),
+);
+echo $OUTPUT->confirm(
+    get_string('deletecategoryyesno', 'report_customsql'),
+    new single_button(
+        report_customsql_url(
+            'categorydelete.php',
+            ['id' => $id,
+                'confirm' => 1,
+                'sesskey' => sesskey(),
+            ]
+        ),
+        get_string('yes')
+    ),
+    new single_button(report_customsql_url('index.php'), get_string('no'))
+);
 echo $OUTPUT->footer();

classes/event/query_deleted.php

@@ -32,7 +32,6 @@
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class query_deleted extends \core\event\base {
-
     #[\Override]
     protected function init() {
         $this->data['crud'] = 'd';

classes/event/query_edited.php

@@ -32,7 +32,6 @@
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class query_edited extends \core\event\base {
-
     #[\Override]
     protected function init() {
         $this->data['crud'] = 'u';

classes/event/query_viewed.php

@@ -32,7 +32,6 @@
  * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class query_viewed extends \core\event\base {
-
     #[\Override]
     protected function init() {
         $this->data['crud'] = 'r';

classes/external/get_users.php

@@ -54,17 +54,29 @@ public static function execute_parameters(): external_function_parameters {
     public static function execute(string $query, string $capability): array {
         global $CFG, $DB;
 
-        [$query, $capability] = array_values(self::validate_parameters(self::execute_parameters(),
-                ['query' => $query, 'capability' => $capability]));
+        [$query, $capability] = array_values(
+            self::validate_parameters(
+                self::execute_parameters(),
+                ['query' => $query, 'capability' => $capability],
+            )
+        );
 
         $context = \context_system::instance();
         self::validate_context($context);
         require_capability('report/customsql:definequeries', $context);
 
         if (class_exists('\core_user\fields')) {
             $extrafields = \core_user\fields::for_identity($context, false)->get_required_fields();
-            $fields = \core_user\fields::for_identity($context,
-                    false)->with_userpic()->get_sql('u', false, '', '', false)->selects;
+            $fields = \core_user\fields::for_identity(
+                $context,
+                false
+            )->with_userpic()->get_sql(
+                'u',
+                false,
+                '',
+                '',
+                false,
+            )->selects;
         } else {
             $extrafields = get_extra_user_fields($context);
             $fields = \user_picture::fields('u', $extrafields);
@@ -148,6 +160,7 @@ public static function execute_returns(): external_description {
                 'identity' => new external_value(PARAM_RAW, 'Additional user identifying info.'),
                 'hasidentity' => new external_value(PARAM_BOOL, 'Whether identity is non-blank.'),
                 'profileimageurlsmall' => new external_value(PARAM_RAW, 'URL of the user profile image.'),
-            ]));
+            ])
+        );
     }
 }

classes/local/category.php

@@ -79,7 +79,7 @@ public function load_queries_data(array $queries): void {
      * @return \stdClass[] All queries of type.
      */
     public static function get_reports_of_a_particular_runtype(array $queries, string $type) {
-        return array_filter($queries, function($query) use ($type) {
+        return array_filter($queries, function ($query) use ($type) {
             return $query->runable == $type;
         }, ARRAY_FILTER_USE_BOTH);
     }
@@ -91,7 +91,7 @@ public static function get_reports_of_a_particular_runtype(array $queries, strin
      * @return \stdClass[] queries the current user is allowed to see.
      */
     public static function filter_reports_by_capability(array $queries) {
-        return array_filter($queries, function($query) {
+        return array_filter($queries, function ($query) {
             return has_capability($query->capability ?? 'moodle/site:config', \context_system::instance());
         }, ARRAY_FILTER_USE_BOTH);
     }

classes/output/category.php

@@ -67,8 +67,16 @@ class category implements renderable, templatable {
      * @param bool $addnewquerybtn Show 'Add new query' button or not.
      * @param moodle_url|null $returnurl Return url.
      */
-    public function __construct(report_category $category, context $context, bool $expandable = false, int $showcat = 0,
-            int $hidecat = 0, bool $showonlythislink = false, bool $addnewquerybtn = true, ?moodle_url $returnurl = null) {
+    public function __construct(
+        report_category $category,
+        context $context,
+        bool $expandable = false,
+        int $showcat = 0,
+        int $hidecat = 0,
+        bool $showonlythislink = false,
+        bool $addnewquerybtn = true,
+        ?moodle_url $returnurl = null
+    ) {
         $this->category = $category;
         $this->context = $context;
         $this->expandable = $expandable;
@@ -108,8 +116,12 @@ public function export_for_template(renderer_base $output) {
         if ($this->addnewquerybtn && has_capability('report/customsql:definequeries', $this->context)) {
             $addnewqueryurl = report_customsql_url('edit.php', ['categoryid' => $this->category->get_id(),
                 'returnurl' => $this->returnurl->out_as_local_url(false)]);
-            $addquerybutton = $output->single_button($addnewqueryurl, get_string('addreport', 'report_customsql'), 'post',
-                                        ['class' => 'mb-1']);
+            $addquerybutton = $output->single_button(
+                $addnewqueryurl,
+                get_string('addreport', 'report_customsql'),
+                'post',
+                ['class' => 'mb-1'],
+            );
         }
 
         return [