Merge pull request maths#1338 from maths/code-tidy

Code tidy
Mat-Ge · Dec 18, 2024 · a71e1ed · a71e1ed
2 parents 7ad0204 + 64d326c
commit a71e1ed
Show file tree

Hide file tree

Showing 398 changed files with 6,856 additions and 2,532 deletions.
diff --git a/adminui/answertests.php b/adminui/answertests.php
@@ -21,6 +21,7 @@
  * correctly, and second it serves to document the expected behaviour of answer
  * tests, which is useful for learning how they work.
  *
+ * @package    qtype_stack
  * @copyright  2012 University of Birmingham
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/cascacheview.php b/adminui/cascacheview.php
@@ -18,6 +18,7 @@
  * This script lets the user see the latest commands stored to CAS
  * cache as pretty printted presentations. This exists for debugging.
  *
+ * @package    qtype_stack
  * @copyright  2019 Aalto University
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/caschat.php b/adminui/caschat.php
@@ -19,6 +19,7 @@
  * This can be useful for learning about the CAS syntax, and also for testing
  * that maxima is working correctly.
  *
+ * @package    qtype_stack
  * @copyright  2012 University of Birmingham
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/compiledquestion.php b/adminui/compiledquestion.php
@@ -20,6 +20,7 @@
  *
  * This is for developers.
  *
+ * @package    qtype_stack
  * @copyright  2022 Aalto University
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/dependencies.php b/adminui/dependencies.php
@@ -22,6 +22,7 @@
  * the whole logic in a fast way. Thus this does not work for questions
  * that have not been compiled.
  *
+ * @package    qtype_stack
  * @copyright  2022 Aalto University
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/equivdemo.php b/adminui/equivdemo.php
@@ -15,6 +15,8 @@
 // along with Stack.  If not, see <http://www.gnu.org/licenses/>.
 
 /**
+ * Add description here!
+ * @package    qtype_stack
  * @copyright  2016 University of Edinburgh
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/healthcheck.php b/adminui/healthcheck.php
@@ -19,6 +19,7 @@
  * all the parts are working properly, including the conection to the CAS,
  * graph plotting, and equation rendering.
  *
+ * @package    qtype_stack
  * @copyright  2012 University of Birmingham
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/replacedollars.php b/adminui/replacedollars.php
@@ -22,6 +22,7 @@
  * from this script can overload your web browser. In that case, there
  * is an un-documented feature. Add preview=0 at the end of the URL.
  *
+ * @package    qtype_stack
  * @copyright  2012 the Open University
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/replacedollarsindex.php b/adminui/replacedollarsindex.php
@@ -17,6 +17,7 @@
 /**
  * This script lets the user create or edit question tests for a question.
  *
+ * @package    qtype_stack
  * @copyright  2012 the Open University
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/studentinputs.php b/adminui/studentinputs.php
@@ -17,6 +17,7 @@
 /**
  * This script runs attempts to "validate" a list of potential answer strings from students and verifies the results.
  *
+ * @package    qtype_stack
  * @copyright  2012 University of Birmingham
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/subscripts.php b/adminui/subscripts.php
@@ -21,6 +21,7 @@
  * correctly, and second it serves to document the expected behaviour of answer
  * tests, which is useful for learning how they work.
  *
+ * @package    qtype_stack
  * @copyright  2012 University of Birmingham
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */

diff --git a/adminui/todo.php b/adminui/todo.php
@@ -18,6 +18,7 @@
  * This page lets the user find all questions in a course in which they are a techer
  * which have a [[todo]] block.  The questions are sorted by any tags they might have.
  *
+ * @package    qtype_stack
  * @copyright  2024 University of Edinburgh
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
@@ -81,7 +82,7 @@
                     $dashurl = html_writer::link(new moodle_url($questiontestsurl,
                         ['questionid' => $qid]), $qname). ' ' .
                         $OUTPUT->action_icon($preurl, new pix_icon('t/preview', get_string('preview')));
-                    // TODO: add in a direct edit URL.
+                    // TO-DO: add in a direct edit URL.
                     $qtodos[] = ['qid' => $qid,
                                  'qname' => $qname,
                                  'tags' => $tags,

diff --git a/api/config_sample.txt b/api/config_sample.txt
@@ -14,8 +14,12 @@
 // You should have received a copy of the GNU General Public License
 // along with Stack.  If not, see <http://www.gnu.org/licenses/>.
 
-// @copyright  2023 RWTH Aachen
-// @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+/**
+ * Add description here!
+ * @package    qtype_stack
+ * @copyright  2023 RWTH Aachen
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
 
 /**
  * Simulating Moodle global configuration variables.

diff --git a/api/controller/DownloadController.php b/api/controller/DownloadController.php
@@ -14,10 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Stack.  If not, see <http://www.gnu.org/licenses/>.
 
-// This script handles file download from file download blocks.
-//
-// @copyright  2023 RWTH Aachen
-// @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+/**
+ * This script handles file download from file download blocks.
+ *
+ * @package    qtype_stack
+ * @copyright  2023 RWTH Aachen
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
 
 namespace api\controller;
 defined('MOODLE_INTERNAL') || die();
@@ -30,11 +33,9 @@
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
 
+// phpcs:ignore moodle.Commenting.MissingDocblock.Class
 class DownloadController {
-    /**
-     * @throws \stack_exception
-     * @throws \Exception
-     */
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
     public function __invoke(Request $request, Response $response, array $args): Response {
         // TO-DO: Validate.
         $data = $request->getParsedBody();

diff --git a/api/controller/GradingController.php b/api/controller/GradingController.php
@@ -14,10 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Stack.  If not, see <http://www.gnu.org/licenses/>.
 
-// This script handles the various deploy/undeploy actions from questiontestrun.php.
-//
-// @copyright  2023 RWTH Aachen
-// @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+/**
+ * This script handles the various deploy/undeploy actions from questiontestrun.php.
+ *
+ * @package    qtype_stack
+ * @copyright  2023 RWTH Aachen
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
 
 namespace api\controller;
 defined('MOODLE_INTERNAL') || die();
@@ -35,11 +38,9 @@
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
 
+// phpcs:ignore moodle.Commenting.MissingDocblock.Class
 class GradingController {
-    /**
-     * @throws \stack_exception
-     * @throws \Exception
-     */
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
     public function __invoke(Request $request, Response $response, array $args): Response {
         // TO-DO: Validate.
         $data = $request->getParsedBody();
@@ -156,6 +157,7 @@ public function __invoke(Request $request, Response $response, array $args): Res
         return $response->withHeader('Content-Type', 'application/json');
     }
 
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
     private function standard_prt_feedback(\qtype_stack_question $question, \prt_evaluatable $result, $feedbackstyle) {
         $class = '';
         if ($result->get_score() < 0.000001) {

diff --git a/api/controller/RenderController.php b/api/controller/RenderController.php
@@ -14,10 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Stack.  If not, see <http://www.gnu.org/licenses/>.
 
-// This script handles the various deploy/undeploy actions from questiontestrun.php.
-//
-// @copyright  2023 RWTH Aachen
-// @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+/**
+ * This script handles the various deploy/undeploy actions from questiontestrun.php.
+ *
+ * @package    qtype_stack
+ * @copyright  2023 RWTH Aachen
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
 
 namespace api\controller;
 defined('MOODLE_INTERNAL') || die();
@@ -36,11 +39,9 @@
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
 
+// phpcs:ignore moodle.Commenting.MissingDocblock.Class
 class RenderController {
-    /**
-     * @throws \stack_exception
-     * @throws \Exception
-     */
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
     public function __invoke(Request $request, Response $response, array $args): Response {
         // TO-DO: Validate.
         $data = $request->getParsedBody();

diff --git a/api/controller/TestController.php b/api/controller/TestController.php
@@ -14,10 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Stack.  If not, see <http://www.gnu.org/licenses/>.
 
-// This script handles the running of question tests for a supplied question
-//
-// @copyright  2024 University of Edinburgh
-// @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+/**
+ * This script handles the running of question tests for a supplied question
+ *
+ * @package    qtype_stack
+ * @copyright  2024 University of Edinburgh
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
 
 namespace api\controller;
 defined('MOODLE_INTERNAL') || die();
@@ -40,10 +43,7 @@
  * leaving display for the front end.
  */
 class TestController {
-    /**
-     * @throws \stack_exception
-     * @throws \Exception
-     */
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
     public function __invoke(Request $request, Response $response, array $args): Response {
         // TO-DO: Validate.
         $data = $request->getParsedBody();

diff --git a/api/controller/ValidationController.php b/api/controller/ValidationController.php
@@ -14,10 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Stack.  If not, see <http://www.gnu.org/licenses/>.
 
-// This script handles the various deploy/undeploy actions from questiontestrun.php.
-//
-// @copyright  2023 RWTH Aachen
-// @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+/**
+ * This script handles the various deploy/undeploy actions from questiontestrun.php.
+ *
+ * @package    qtype_stack
+ * @copyright  2023 RWTH Aachen
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
 
 namespace api\controller;
 defined('MOODLE_INTERNAL') || die();
@@ -33,11 +36,9 @@
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as Request;
 
+// phpcs:ignore moodle.Commenting.MissingDocblock.Class
 class ValidationController {
-    /**
-     * @throws \stack_exception
-     * @throws \Exception
-     */
+    // phpcs:ignore moodle.Commenting.MissingDocblock.Function
     public function __invoke(Request $request, Response $response, array $args): Response {
         // TO-DO: Validate.
         $data = $request->getParsedBody();

diff --git a/api/dtos/StackGradingResponse.php b/api/dtos/StackGradingResponse.php
@@ -14,13 +14,17 @@
 // You should have received a copy of the GNU General Public License
 // along with Stack.  If not, see <http://www.gnu.org/licenses/>.
 
-// This script handles the various deploy/undeploy actions from questiontestrun.php.
-//
-// @copyright  2023 RWTH Aachen
-// @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+/**
+ * This script handles the various deploy/undeploy actions from questiontestrun.php.
+ *
+ * @package    qtype_stack
+ * @copyright  2023 RWTH Aachen
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
 
 namespace api\dtos;
 
+// phpcs:ignore moodle.Commenting.MissingDocblock.Class
 class StackGradingResponse {
     /** @var bool */
     public $isgradable;
@@ -34,9 +38,10 @@ class StackGradingResponse {
     public $specificfeedback;
     /** @var array */
     public $prts;
+    // phpcs:ignore moodle.Commenting.VariableComment.Missing
     public $gradingassets;
-     /** @var string */
-     public $responsesummary;
+    /** @var string */
+    public $responsesummary;
     /** @var array */
     public $iframes;
 

diff --git a/api/dtos/StackRenderResponse.php b/api/dtos/StackRenderResponse.php
@@ -14,21 +14,26 @@
 // You should have received a copy of the GNU General Public License
 // along with Stack.  If not, see <http://www.gnu.org/licenses/>.
 
-// This script handles the various deploy/undeploy actions from questiontestrun.php.
-//
-// @copyright  2023 RWTH Aachen
-// @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+/**
+ * This script handles the various deploy/undeploy actions from questiontestrun.php.
+ *
+ * @package    qtype_stack
+ * @copyright  2023 RWTH Aachen
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
 
 namespace api\dtos;
 defined('MOODLE_INTERNAL') || die();
 
+// phpcs:ignore moodle.Commenting.MissingDocblock.Class
 class StackRenderResponse {
     /** @var string */
     public $questionrender;
     /** @var string */
     public $questionsamplesolutiontext;
     /** @var StackRenderInput[]  */
     public $questioninputs;
+    // phpcs:ignore moodle.Commenting.VariableComment.Missing
     public $questionassets;
     /** @var int */
     public $questionseed;
@@ -38,9 +43,11 @@ class StackRenderResponse {
     public $iframes;
 }
 
+// phpcs:ignore moodle.Commenting.MissingDocblock.Class
 class StackRenderInput {
     /** @var int */
     public $validationtype;
+    // phpcs:ignore moodle.Commenting.VariableComment.Missing
     public $samplesolution;
     /** @var string */
     public $samplesolutionrender;

diff --git a/api/dtos/StackTestResponse.php b/api/dtos/StackTestResponse.php
@@ -17,12 +17,14 @@
 /**
  * Response to a question test request
  *
+ * @package    qtype_stack
  * @copyright  2024 Uuniversity of Edinburgh
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  */
 
 namespace api\dtos;
 
+// phpcs:ignore moodle.Commenting.MissingDocblock.Class
 class StackTestResponse {
     /** @var string */
     public $name = '';