Refactoring

Author: sebastsg

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +1,20 @@
 ---
 name: Bug report
-about: Create a report to help us improve
+about: Create a report to help us improve CAPQUiz
 title: ''
 labels: bug
 assignees: ''
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+Description:
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+Reproduction steps:
+1. Log in as instructor / student
+2. ...
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
+Additional information:
+- Operating system:
+- Web browser:
+- Screenshots:

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,20 +1,20 @@
 ---
 name: Feature request
-about: Suggest an idea for this project
+about: Suggest a new feature for CAPQuiz
 title: ''
 labels: enhancement
 assignees: ''
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+Background:
+- Example: I'm always frustrated when ...
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+Suggested solution:
+- Example: Add button to do X thing on page Y
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+Alternatives considered:
+- Example: Change default value for setting X
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+Additional information:
+- Example: This mockup illustrates button placement

.github/workflows/main.yml

@@ -4,11 +4,11 @@ on: [push, pull_request]
 
 jobs:
   test:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
 
     services:
       postgres:
-        image: postgres:13
+        image: postgres:15
         env:
           POSTGRES_USER: 'postgres'
           POSTGRES_HOST_AUTH_METHOD: 'trust'
@@ -31,14 +31,14 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - php: '8.0'
-            moodle-branch: 'MOODLE_403_STABLE'
+          - php: '8.2'
+            moodle-branch: 'MOODLE_405_STABLE'
             database: 'pgsql'
-          - php: '8.1'
-            moodle-branch: 'MOODLE_404_STABLE'
+          - php: '8.2'
+            moodle-branch: 'MOODLE_500_STABLE'
             database: 'pgsql'
-          - php: '8.1'
-            moodle-branch: 'MOODLE_404_STABLE'
+          - php: '8.2'
+            moodle-branch: 'MOODLE_500_STABLE'
             database: 'mariadb'
 
     steps:

.github/workflows/moodle-ci.yml

@@ -47,7 +47,7 @@ class capquiz_admin_page_manage_capquiz_plugins extends admin_externalpage {
      */
     public function __construct(string $subtype) {
         $this->subtype = $subtype;
-        $url = new moodle_url('/mod/capquiz/adminmanageplugins.php', ['subtype' => $subtype]);
+        $url = new \core\url('/mod/capquiz/adminmanageplugins.php', ['subtype' => $subtype]);
         parent::__construct('manage' . $subtype . 'plugins', get_string('manage' . $subtype . 'plugins', 'capquiz'), $url);
     }
 
@@ -70,7 +70,7 @@ public function search($query): array {
             }
         }
         if ($found) {
-            $result = new stdClass();
+            $result = new \stdClass();
             $result->page = $this;
             $result->settings = [];
             return [$this->name => $result];
@@ -80,7 +80,6 @@ public function search($query): array {
     }
 }
 
-
 /**
  * Class that handles the display and configuration of the list of capquiz plugins.
  *
@@ -91,8 +90,8 @@ public function search($query): array {
  */
 class capquiz_plugin_manager {
 
-    /** @var moodle_url the url of the manage capquiz plugin page */
-    private moodle_url $pageurl;
+    /** @var \core\url the url of the manage capquiz plugin page */
+    private \core\url $pageurl;
 
     /** @var string report */
     private string $subtype;
@@ -106,7 +105,7 @@ class capquiz_plugin_manager {
      * @param string $subtype
      */
     public function __construct(string $subtype) {
-        $this->pageurl = new moodle_url('/mod/capquiz/adminmanageplugins.php', ['subtype' => $subtype]);
+        $this->pageurl = new \core\url('/mod/capquiz/adminmanageplugins.php', ['subtype' => $subtype]);
         $this->subtype = $subtype;
     }
 
@@ -139,8 +138,7 @@ public function execute(string $action = 'view', ?string $plugin = null): void {
      */
     private function check_permissions(): void {
         require_login();
-        $systemcontext = context_system::instance();
-        require_capability('moodle/site:config', $systemcontext);
+        require_capability('moodle/site:config', \core\context\system::instance());
     }
 
     /**
@@ -219,7 +217,7 @@ public function move_plugin(string $plugintomove, string $dir): string {
      * @return array The list of plugins
      */
     public function get_sorted_plugins_list(): array {
-        $names = core_component::get_plugin_list($this->subtype);
+        $names = \core\component::get_plugin_list($this->subtype);
         $result = [];
         foreach ($names as $name => $path) {
             $idx = get_config($this->subtype . '_' . $name, 'sortorder');
@@ -244,7 +242,7 @@ private function view_plugins_table(): void {
 
         // Set up the table.
         $this->view_header();
-        $table = new flexible_table($this->subtype . 'pluginsadminttable');
+        $table = new \core_table\flexible_table($this->subtype . 'pluginsadminttable');
         $table->define_baseurl($this->pageurl);
         $table->define_columns(['pluginname', 'version', 'hideshow', 'order', 'settings', 'uninstall']);
         $table->define_headers([get_string($this->subtype . 'type', 'capquiz'),
@@ -286,8 +284,8 @@ private function view_plugins_table(): void {
 
             $exists = file_exists($CFG->dirroot . '/mod/capquiz/' . $shortsubtype . '/' . $plugin . '/settings.php');
             if ($row[1] !== '' && $exists) {
-                $url = new moodle_url('/admin/settings.php', ['section' => $this->subtype . '_' . $plugin]);
-                $row[] = html_writer::link($url, get_string('settings'));
+                $url = new \core\url('/admin/settings.php', ['section' => $this->subtype . '_' . $plugin]);
+                $row[] = \core\output\html_writer::link($url, get_string('settings'));
             } else {
                 $row[] = ' ';
             }
@@ -324,14 +322,14 @@ private function view_header(): void {
     private function format_icon_link(string $action, string $plugin, string $icon, string $alt): string {
         global $OUTPUT;
         if ($action === 'delete') {
-            $url = core_plugin_manager::instance()->get_uninstall_url($this->subtype . '_' . $plugin, 'manage');
+            $url = \core\plugin_manager::instance()->get_uninstall_url($this->subtype . '_' . $plugin, 'manage');
             if (!$url) {
                 return ' ';
             }
-            return html_writer::link($url, get_string('uninstallplugin', 'core_admin'));
+            return \core\output\html_writer::link($url, get_string('uninstallplugin', 'core_admin'));
         }
-        $url = new moodle_url($this->pageurl, ['action' => $action, 'plugin' => $plugin, 'sesskey' => sesskey()]);
-        $icon = new pix_icon($icon, $alt, 'moodle', ['title' => $alt]);
+        $url = new \core\url($this->pageurl, ['action' => $action, 'plugin' => $plugin, 'sesskey' => sesskey()]);
+        $icon = new \core\output\pix_icon($icon, $alt, 'moodle', ['title' => $alt]);
         return $OUTPUT->action_icon($url, $icon, null, ['title' => $alt]) . ' ';
     }
 

TODO

@@ -25,6 +25,8 @@
 
 require_once("../../config.php");
 
+global $CFG, $PAGE;
+
 require_login();
 
 require_once($CFG->dirroot . '/mod/capquiz/adminlib.php');
@@ -37,7 +39,7 @@
     require_sesskey();
 }
 
-$PAGE->set_context(context_system::instance());
+$PAGE->set_context(\core\context\system::instance());
 
 $pluginmanager = new capquiz_plugin_manager($subtype);
 $pluginmanager->execute($action, $plugin);