Merge pull request #42 from bfh/codingstyle

Respect latest Moodle coding guidelines.
bfh · Jul 13, 2024 · 7f91ea5 · 7f91ea5
2 parents 0bf38a7 + 8ccd145
commit 7f91ea5
Show file tree

Hide file tree

Showing 57 changed files with 275 additions and 263 deletions.
diff --git a/classes/api.php b/classes/api.php
@@ -137,10 +137,10 @@ public static function get_instance_by_categoryid($categoryid) {
     /**
      * Check whether only active users in course should be shown.
      *
-     * @param context_module $context context the verbal feedback belongs to.
+     * @param ?context_module $context context the verbal feedback belongs to.
      * @return bool true if only active users should be shown.
      */
-    public static function show_only_active_users(context_module $context = null) {
+    public static function show_only_active_users(?context_module $context = null) {
         global $CFG;
 
         $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);

diff --git a/classes/helper.php b/classes/helper.php
@@ -128,19 +128,19 @@ public static function prepare_items_view($categories) {
 
     /**
      * Wrapper for the Yaml::parseFile() function.
-     * @param string $someYaml
+     *
+     * @param string $someyaml
      * @param int|null $options
      * @param int|null $debug
      * @return array|\Dallgoot\Yaml\Types\YamlObject|\Dallgoot\Yaml\YamlObject|null
      * @throws Exception
      */
-    public static function parseYamlFile(string $someYaml, ?int $options = null, ?int $debug = null)
-    {
+    public static function parseyamlfile(string $someyaml, ?int $options = null, ?int $debug = null) {
         if (version_compare(PHP_VERSION, '8.1.14') >= 0) {
-            require_once implode(DIRECTORY_SEPARATOR, [dirname(__FILE__), 'vendor', '81x', 'autoload.php']);
-            return \Dallgoot\Yaml\Yaml::parseFile($someYaml, $options, $debug);
+            require_once(implode(DIRECTORY_SEPARATOR, [dirname(__FILE__), 'vendor', '81x', 'autoload.php']));
+            return \Dallgoot\Yaml\Yaml::parseFile($someyaml, $options, $debug);
         }
-        require_once implode(DIRECTORY_SEPARATOR, [dirname(__FILE__), 'vendor', '74x', 'autoload.php']);
-        return \Dallgoot\Yaml::parseFile($someYaml, $options, $debug);
+        require_once(implode(DIRECTORY_SEPARATOR, [dirname(__FILE__), 'vendor', '74x', 'autoload.php']));
+        return \Dallgoot\Yaml::parseFile($someyaml, $options, $debug);
     }
 }
diff --git a/classes/model/instance.php b/classes/model/instance.php
@@ -162,7 +162,7 @@ public function __construct(int $course, int $id = 0, string $name = "", string
     public static function from_template(int $course, template $template, int $id = 0, string $name = "", string $intro = "",
         int $introformat = 0, int $gradecat = 0, int $grade = 0, float $gradepass = 0,
         int $status = instance_status::NOT_READY, int $timeopen = 0, int $timeclose = 0, int $timemodified = 0,
-        int $releasetype = instance_release_type::NONE, int $released = 0) : instance {
+        int $releasetype = instance_release_type::NONE, int $released = 0): instance {
 
         $instance = new instance($course, $id, $name, $intro, $introformat, $grade, $gradecat, $gradepass,
             $status, $timeopen, $timeclose, $timemodified, $releasetype, $released);
@@ -181,7 +181,7 @@ public static function from_template(int $course, template $template, int $id =
      *
      * @return int The id.
      */
-    public function get_id() : int {
+    public function get_id(): int {
         return $this->id;
     }
 
@@ -199,7 +199,7 @@ public function set_id(int $id) {
      *
      * @return int|null The template id.
      */
-    public function get_template_id() : ?int {
+    public function get_template_id(): ?int {
         return $this->templateid;
     }
 
@@ -217,7 +217,7 @@ public function set_template_id(?int $templateid) {
      *
      * @return int The course id.
      */
-    public function get_course() : int {
+    public function get_course(): int {
         return $this->course;
     }
 
@@ -235,7 +235,7 @@ public function set_course(int $course) {
      *
      * @return string The instance name.
      */
-    public function get_name() : string {
+    public function get_name(): string {
         return $this->name;
     }
 
@@ -253,7 +253,7 @@ public function set_name(string $name) {
      *
      * @return string The intro.
      */
-    public function get_intro() : string {
+    public function get_intro(): string {
         return $this->intro;
     }
 
@@ -271,7 +271,7 @@ public function set_intro(string $intro) {
      *
      * @return int The introformat.
      */
-    public function get_introformat() : int {
+    public function get_introformat(): int {
         return $this->introformat;
     }
 
@@ -289,7 +289,7 @@ public function set_introformat(int $introformat) {
      *
      * @return int The max grade.
      */
-    public function get_grade() : int {
+    public function get_grade(): int {
         global $DB;
         return $DB->get_field('verbalfeedback', 'grade', ['id' => $this->id]);
     }
@@ -308,7 +308,7 @@ public function set_grade(int $grade) {
      *
      * @return int The grade category.
      */
-    public function get_gradecat() : int {
+    public function get_gradecat(): int {
         return $this->gradecat;
     }
 
@@ -326,7 +326,7 @@ public function set_gradecat(int $gradecat) {
      *
      * @return float The pass grade.
      */
-    public function get_gradepass() : float {
+    public function get_gradepass(): float {
         return $this->gradepass;
     }
 
@@ -344,7 +344,7 @@ public function set_gradepass(float $gradepass) {
      *
      * @return int The grade scale.
      */
-    public function get_gradescale() : int {
+    public function get_gradescale(): int {
         return $this->gradescale;
     }
 
@@ -362,7 +362,7 @@ public function set_gradescale(int $gradescale) {
      *
      * @return int The instance status.
      */
-    public function get_status() : int {
+    public function get_status(): int {
         return $this->status;
     }
 
@@ -380,7 +380,7 @@ public function set_status(int $status) {
      *
      * @return int The opening time.
      */
-    public function get_timeopen() : int {
+    public function get_timeopen(): int {
         return $this->timeopen;
     }
 
@@ -398,7 +398,7 @@ public function set_timeopen(int $timeopen) {
      *
      * @return int The closing time.
      */
-    public function get_timeclose() : int {
+    public function get_timeclose(): int {
         return $this->timeclose;
     }
 
@@ -416,7 +416,7 @@ public function set_timeclose(int $timeclose) {
      *
      * @return int The time of the last modification.
      */
-    public function get_timemodified() : int {
+    public function get_timemodified(): int {
         return $this->timemodified;
     }
 
@@ -439,7 +439,7 @@ public function set_timemodified(int $timemodified) {
      *
      * @return int The releasetype property value.
      */
-    public function get_release_type() : int {
+    public function get_release_type(): int {
         return $this->releasetype;
     }
 
@@ -462,7 +462,7 @@ public function set_release_type(int $releasetype) {
      *
      * @return int The released property value.
      */
-    public function get_released() : int {
+    public function get_released(): int {
         return $this->released;
     }
 
@@ -480,7 +480,7 @@ public function set_released(int $released) {
      *
      * @return array<int, instance_category> The categories.
      */
-    public function get_categories() : array {
+    public function get_categories(): array {
         return $this->categories;
     }
 

diff --git a/classes/model/instance_category.php b/classes/model/instance_category.php
@@ -68,7 +68,7 @@ public function __construct(int $id = 0, ?int $paramtemplatecategoryid = null, i
      * @param parametrized_template_category $paramtemplatecategory The parametrized template category id
      * @return instance_category
      */
-    public static function from_template(parametrized_template_category $paramtemplatecategory) : instance_category {
+    public static function from_template(parametrized_template_category $paramtemplatecategory): instance_category {
         $instancecategory = new instance_category();
         $instancecategory->set_parametrized_template_category_id($paramtemplatecategory->get_id());
         $instancecategory->set_position($paramtemplatecategory->get_position());
@@ -107,7 +107,7 @@ public function set_id(int $id) {
      *
      * @return int
      */
-    public function get_id() : int {
+    public function get_id(): int {
         return $this->id;
     }
 
@@ -125,7 +125,7 @@ public function set_parametrized_template_category_id(?int $paramtemplatecategor
      *
      * @return int|null The parametrized template category id
      */
-    public function get_parametrized_template_category_id() : ?int {
+    public function get_parametrized_template_category_id(): ?int {
         return $this->paramtemplatecategoryid;
     }
 
@@ -143,7 +143,7 @@ public function set_position(int $position) {
      *
      * @return int The template category position
      */
-    public function get_position() : int {
+    public function get_position(): int {
         return $this->position;
     }
 
@@ -161,7 +161,7 @@ public function set_weight(float $weight) {
      *
      * @return float The category weight
      */
-    public function get_weight() : float {
+    public function get_weight(): float {
         return $this->weight;
     }
 
@@ -170,7 +170,7 @@ public function get_weight() : float {
      *
      * @return array<int, localized_string> The localized instance category headers.
      */
-    public function get_headers() : array {
+    public function get_headers(): array {
         return $this->localizedheaders;
     }
 
@@ -180,7 +180,7 @@ public function get_headers() : array {
      * @param string $languagestr The given language string
      * @return \mod_verbalfeedback\model\localized_string
      */
-    public function get_header(string $languagestr) : localized_string {
+    public function get_header(string $languagestr): localized_string {
         $langrepo = new language_repository();
 
         // Select the language string matching the current language.
@@ -207,7 +207,7 @@ public function add_header(localized_string $header) {
      *
      * @return array<int, instance_criterion> The criteria
      */
-    public function get_criteria() : array {
+    public function get_criteria(): array {
         return $this->instancecriteria;
     }
 

diff --git a/classes/model/instance_criterion.php b/classes/model/instance_criterion.php
@@ -124,7 +124,7 @@ public function set_id(int $id) {
      *
      * @return int
      */
-    public function get_id() : int {
+    public function get_id(): int {
         return $this->id;
     }
 
@@ -142,7 +142,7 @@ public function set_parametrized_template_criterion_id(?int $parametrizedtemplat
      *
      * @return int|null
      */
-    public function get_parametrized_template_criterion_id() : ?int {
+    public function get_parametrized_template_criterion_id(): ?int {
         return $this->parametrizedtemplatecriterionid;
     }
 
@@ -160,7 +160,7 @@ public function set_position(int $position) {
      *
      * @return int The instance criterion position
      */
-    public function get_position() : int {
+    public function get_position(): int {
         return $this->position;
     }
 
@@ -178,7 +178,7 @@ public function set_weight(float $weight) {
      *
      * @return float
      */
-    public function get_weight() : float {
+    public function get_weight(): float {
         return $this->weight;
     }
 
@@ -187,7 +187,7 @@ public function get_weight() : float {
      *
      * @return array<int, localized_string> The localized strings.
      */
-    public function get_descriptions() : array {
+    public function get_descriptions(): array {
         return $this->descriptions;
     }
 
@@ -197,7 +197,7 @@ public function get_descriptions() : array {
      * @param string $languagestr The given language string
      * @return \mod_verbalfeedback\model\localized_string|null
      */
-    public function get_description(string $languagestr) : ?localized_string {
+    public function get_description(string $languagestr): ?localized_string {
         $languagerepository = new language_repository();
 
         // Select the language string matching the current language.
@@ -242,7 +242,7 @@ public function add_subrating(subrating $subrating) {
      *
      * @return array
      */
-    public function get_subratings() : array {
+    public function get_subratings(): array {
         return $this->subratings;
     }
 }
diff --git a/classes/model/language.php b/classes/model/language.php
@@ -46,9 +46,9 @@ public function __construct(?int $id = null, string $language = '') {
     /**
      * Sets the id.
      *
-     * @param int|null $id The id.
+     * @param ?int|null $id The id.
      */
-    public function set_id(int $id = null) {
+    public function set_id(?int $id = null) {
         $this->id = $id;
     }
 
@@ -57,7 +57,7 @@ public function set_id(int $id = null) {
      *
      * @return int The id.
      */
-    public function get_id() : ?int {
+    public function get_id(): ?int {
         return $this->id;
     }
 
@@ -75,7 +75,7 @@ public function set_language(string $language) {
      *
      * @return string The language
      */
-    public function get_language() : string {
+    public function get_language(): string {
         return $this->language;
     }
 }
diff --git a/classes/model/localized_string.php b/classes/model/localized_string.php
@@ -61,7 +61,7 @@ public function set_id(int $id) {
      *
      * @return int The id.
      */
-    public function get_id() : int {
+    public function get_id(): int {
         return $this->id;
     }
 
@@ -79,7 +79,7 @@ public function set_language_id(int $languageid) {
      *
      * @return language The language.
      */
-    public function get_language_id() : int {
+    public function get_language_id(): int {
         return $this->languageid;
     }
 
@@ -97,7 +97,7 @@ public function set_string(string $string) {
      *
      * @return string The string.
      */
-    public function get_string() : string {
+    public function get_string(): string {
         return $this->string;
     }
 }