Linting: linting code

Wunderbyte-GmbH · Dec 20, 2023 · c0ec75b · c0ec75b
1 parent bf748bd
commit c0ec75b
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/classes/helper/user_path_relation.php b/classes/helper/user_path_relation.php
@@ -114,7 +114,7 @@ public function get_user_path_relation($learningpathid, $userid) {
      * Get active user path relation.
      *
      * @param object $userpath
-     * @param array $nodes
+     * @return object
      *
      */
     public function revision_user_path_relation($userpath) {

diff --git a/classes/learning_paths.php b/classes/learning_paths.php
@@ -239,7 +239,7 @@ public static function get_learning_user_relations($data) {
     /**
      * Get user path relation.
      *
-     * @param string $json
+     * @param object $relationnodes
      * @return array
      */
     public static function getnodeprogress($relationnodes) {
@@ -261,7 +261,7 @@ public static function getnodeprogress($relationnodes) {
             }
         }
 
-        // Filter paths ending with childCondition null
+        // Filter paths ending with childCondition null.
         $filteredpaths = array_filter($paths, function ($path) use ($pathnodes) {
             $lastnode = self::findNodeById(end($path), $pathnodes);
             return isset($lastnode['childCourse']) && empty($lastnode['childCourse']);
@@ -285,6 +285,15 @@ public static function getnodeprogress($relationnodes) {
         ];
     }
 
+    /**
+     * Find a paths in learning path.
+     *
+     * @param array $node
+     * @param array $currentpath
+     * @param array $paths
+     * @param array $nodes
+     * @return array
+     */
     public static function findpaths($node, $currentpath, &$paths, $nodes) {
         $currentpath[] = $node['id'];
 
@@ -301,6 +310,13 @@ public static function findpaths($node, $currentpath, &$paths, $nodes) {
         }
     }
 
+    /**
+     * Find a node by its id.
+     *
+     * @param int $id
+     * @param array $nodes
+     * @return array
+     */
     public static function findnodebyid($id, $nodes) {
         global $data;
         foreach ($nodes as $node) {

diff --git a/classes/relation_update.php b/classes/relation_update.php
@@ -98,7 +98,7 @@ public static function updated_single($event) {
      * Observer for course completed
      *
      * @param array $completionnodepaths
-     * @param string $key
+     * @return array
      */
     public static function getcompletionnode($completionnodepaths) {
         // TODO sort the valid completion paths.
@@ -115,6 +115,7 @@ public static function getcompletionnode($completionnodepaths) {
      * @param array $haystack
      * @param array $needle
      * @param string $key
+     * @return array
      */
     public static function searchnestedarray($haystack, $needle, $key) {
         foreach ($haystack as $item) {