Linting: Linting conditions

classes/course_completion/conditions/course_completed.php

@@ -14,29 +14,27 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
-
-namespace local_adele\course_completion\conditions;
-
-use local_adele\course_completion\course_completion;
-
 /**
- * Manually checked Course.
+ * Base class for a single booking option availability condition.
  *
- * @package mod_booking
- * @copyright 2022 Wunderbyte GmbH
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * All bo condition types must extend this class.
+ *
+ * @package     local_adele
+ * @author      Jacob Viertel
+ * @copyright  2023 Wunderbyte GmbH
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+namespace local_adele\course_completion\conditions;
+
+use local_adele\course_completion\course_completion;
 
 defined('MOODLE_INTERNAL') || die();
 
 require_once($CFG->dirroot . '/local/adele/lib.php');
 
 /**
- * Base class for a single bo availability condition.
- *
- * All bo condition types must extend this class.
- *
+ * Class for a single learning path course condition.
  *
  * @package     local_adele
  * @author      Jacob Viertel
@@ -47,6 +45,7 @@ class course_completed implements course_completion {
 
     /** @var int $id Standard Conditions have hardcoded ids. */
     public $id = COURSES_COND_MANUALLY;
+    /** @var string $type of the redered condition in frontend. */
     public $type = 'info_text';
     /**
      * Obtains a string describing this restriction (whether or not

classes/course_completion/conditions/manually.php

@@ -14,29 +14,28 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * Base class for a single booking option availability condition.
+ *
+ * All bo condition types must extend this class.
+ *
+ * @package     local_adele
+ * @author      Jacob Viertel
+ * @copyright  2023 Wunderbyte GmbH
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
 
 namespace local_adele\course_completion\conditions;
 
 use local_adele\course_completion\course_completion;
 
-/**
- * Manually checked Course.
- *
- * @package mod_booking
- * @copyright 2022 Wunderbyte GmbH
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
- */
-
 
 defined('MOODLE_INTERNAL') || die();
 
 require_once($CFG->dirroot . '/local/adele/lib.php');
 
 /**
- * Base class for a single bo availability condition.
- *
- * All bo condition types must extend this class.
- *
+ * Class for a single learning path course condition.
  *
  * @package     local_adele
  * @author      Jacob Viertel
@@ -47,6 +46,7 @@ class manually implements course_completion {
 
     /** @var int $id Standard Conditions have hardcoded ids. */
     public $id = COURSES_COND_MANUALLY;
+    /** @var string $type of the redered condition in frontend. */
     public $type = 'checkbox';
     /**
      * Obtains a string describing this restriction (whether or not

classes/course_completion/conditions/timed.php

@@ -19,9 +19,10 @@
  *
  * All bo condition types must extend this class.
  *
- * @package mod_booking
- * @copyright 2022 Wunderbyte GmbH
- * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @package     local_adele
+ * @author      Jacob Viertel
+ * @copyright  2023 Wunderbyte GmbH
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
  namespace local_adele\course_completion\conditions;
@@ -33,10 +34,7 @@
 require_once($CFG->dirroot . '/local/adele/lib.php');
 
 /**
- * Class for a single bo availability condition.
- *
- * This returns true or false based on the standard booking times
- * OR a custom time passed on via the availability json
+ * Class for a single learning path course condition.
  *
  * @package     local_adele
  * @author      Jacob Viertel
@@ -47,6 +45,7 @@ class timed implements course_completion {
 
     /** @var int $id Standard Conditions have hardcoded ids. */
     public $id = COURSES_COND_TIMED;
+    /** @var string $type of the redered condition in frontend. */
     public $type = 'date';
 
     /**
@@ -59,10 +58,6 @@ class timed implements course_completion {
      * (when displaying all information about the activity) and 'student' cases
      * (when displaying only conditions they don't meet).
      *
-     * @param bool $full Set true if this is the 'full information' view
-     * @param booking_option_settings $settings Item we're checking
-     * @param int $userid User ID to check availability for
-     * @param bool $not Set true if we are inverting the condition
      * @return array availability and Information string (for admin) about all restrictions on
      *   this item
      */

classes/course_completion/course_completion.php

@@ -14,10 +14,25 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+/**
+ * Base class for a single booking option availability condition.
+ *
+ * All bo condition types must extend this class.
+ *
+ * @package     local_adele
+ * @author      Jacob Viertel
+ * @copyright  2023 Wunderbyte GmbH
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
 namespace local_adele\course_completion;
 
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/local/adele/lib.php');
+
 /**
- * Validate if the string does excist.
+ * Interface for a learning path course conditions.
  *
  * @package     local_adele
  * @author      Jacob Viertel

classes/course_completion/course_info.php

@@ -49,10 +49,6 @@ public function __construct() {
     /**
      * Returns conditions depending on the conditions param.
      *
-     * @param int $condparam conditions parameter
-     *  0 ... all conditions (default)
-     *  1 ... hardcoded conditions only
-     *  2 ... customizable conditions only
      * @return array
      */
     public static function get_conditions(): array {