Fix psalm issues: Double casting, add phpdoc, fix php warning

public/legacy.php

@@ -17,4 +17,3 @@ require_once __DIR__.'/main/inc/lib/fileDisplay.lib.php';
 require_once __DIR__.'/main/inc/lib/specific_fields_manager.lib.php';
 require_once __DIR__.'/main/forum/forumfunction.inc.php';
 require_once __DIR__.'/main/work/work.lib.php';
-

public/main/exercise/exercise.class.php

@@ -3630,7 +3630,7 @@ class Exercise
         if (ORAL_EXPRESSION == $answerType) {
             $exe_info = Event::get_exercise_results_by_attempt($exeId);
             $exe_info = isset($exe_info[$exeId]) ? $exe_info[$exeId] : null;
-
+            /** @var OralExpression $objQuestionTmp */
             $objQuestionTmp->initFile(
                 api_get_session_id(),
                 isset($exe_info['exe_user_id']) ? $exe_info['exe_user_id'] : api_get_user_id(),
@@ -5058,13 +5058,13 @@ class Exercise
                                 $showTotalScoreAndUserChoicesInLastAttempt
                             );
                         } elseif (HOT_SPOT_ORDER == $answerType) {
-                            ExerciseShowFunctions::display_hotspot_order_answer(
+                            /*ExerciseShowFunctions::display_hotspot_order_answer(
                                 $feedback_type,
                                 $answerId,
                                 $answer,
                                 $studentChoice,
                                 $answerComment
-                            );
+                            );*/
                         } elseif (HOT_SPOT_DELINEATION == $answerType) {
                             $user_answer = $_SESSION['exerciseResultCoordinates'][$questionId];
 
@@ -5422,6 +5422,7 @@ class Exercise
 
                             break;
                         case ORAL_EXPRESSION:
+                            /** @var OralExpression $objQuestionTmp */
                             echo '<tr>
                                 <td valign="top">'.
                                 ExerciseShowFunctions::display_oral_expression_answer(
@@ -5588,13 +5589,13 @@ class Exercise
 
                             break;
                         case HOT_SPOT_ORDER:
-                            ExerciseShowFunctions::display_hotspot_order_answer(
+                            /*ExerciseShowFunctions::display_hotspot_order_answer(
                                 $feedback_type,
                                 $answerId,
                                 $answer,
                                 $studentChoice,
                                 $answerComment
-                            );
+                            );*/
 
                             break;
                         case DRAGGABLE:
@@ -5755,8 +5756,7 @@ class Exercise
                         echo $message;
 
                         $_SESSION['hotspot_delineation_result'][$this->getId()][$questionId][0] = $message;
-                        $_SESSION['hotspot_delineation_result'][$this->selgetIdectId(
-                        )][$questionId][1] = $_SESSION['exerciseResultCoordinates'][$questionId];
+                        $_SESSION['hotspot_delineation_result'][$this->getId()][$questionId][1] = $_SESSION['exerciseResultCoordinates'][$questionId];
                     } else {
                         echo $hotspot_delineation_result[0];
                     }
@@ -9504,7 +9504,7 @@ class Exercise
                         $currentRow['id'] = $exercise->id;
                         $currentRow['url'] = $webPath.'exercise/overview.php?'
                             .api_get_cidreq_params($courseInfo['code'], $sessionId).'&'
-                            ."$mylpid$mylpitemid&exerciseId={$row['id']}";
+                            ."$mylpid$mylpitemid&exerciseId={$exercise->id}";
                         $currentRow['name'] = $currentRow[0];
                     }
                 }

public/main/gradebook/gradebook_flatview.php

@@ -3,7 +3,7 @@
 /* For licensing terms, see /license.txt */
 
 require_once __DIR__.'/../inc/global.inc.php';
-require_once api_get_path(SYS_CODE_PATH).'gradebook/lib/fe/exportgradebook.php';
+require_once __DIR__.'/lib/fe/exportgradebook.php';
 
 $current_course_tool = TOOL_GRADEBOOK;
 
@@ -51,7 +51,7 @@ if ($showlink) {
     $alllinks = $cat[0]->get_links($userId, true);
 }
 
-global $file_type;
+/*global $file_type;
 if (isset($export_flatview_form) && 'pdf' === !$file_type) {
     Display::addFlash(
         Display::return_message(
@@ -60,7 +60,7 @@ if (isset($export_flatview_form) && 'pdf' === !$file_type) {
             false
         )
     );
-}
+}*/
 $category_id = 0;
 if (isset($_GET['selectcat'])) {
     $category_id = (int) $_GET['selectcat'];

public/main/gradebook/gradebook_view_result.php

@@ -3,7 +3,7 @@
 /* For licensing terms, see /license.txt */
 
 require_once __DIR__.'/../inc/global.inc.php';
-require_once api_get_path(SYS_CODE_PATH).'gradebook/lib/fe/exportgradebook.php';
+require_once __DIR__.'/lib/fe/exportgradebook.php';
 
 api_block_anonymous_users();
 $isDrhOfCourse = CourseManager::isUserSubscribedInCourseAsDrh(
@@ -23,9 +23,11 @@ $interbreadcrumb[] = [
 //load the evaluation & category
 $select_eval = (int) $_GET['selecteval'];
 if (empty($select_eval)) {
-    api_not_allowed();
+    api_not_allowed(true);
 }
 
+$_course = api_get_course_info();
+$_user = api_get_user_info();
 $displayscore = ScoreDisplay::instance();
 $eval = Evaluation::load($select_eval);
 $overwritescore = 0;
@@ -360,7 +362,7 @@ if (isset($_GET['export'])) {
         $filename = 'export_results_'.gmdate('Y-m-d_H-i-s');
         $results = Result::load(null, null, $select_eval);
         $data = []; //when file type is csv, add a header to the output file
-        if ('csv' == $file_type) {
+        if ('csv' === $file_type) {
             $alldata[] = [
                 'username',
                 'official_code',
@@ -372,7 +374,7 @@ if (isset($_GET['export'])) {
         }
 
         // export results to pdf file
-        if ('pdf' == $file_type) {
+        if ('pdf' === $file_type) {
             $number_decimals = api_get_setting('gradebook_number_decimals');
             $datagen = new ResultsDataGenerator($eval[0], $allresults);
 

public/main/gradebook/lib/be/abstractlink.class.php

@@ -372,13 +372,11 @@ abstract class AbstractLink implements GradebookItem
     public function add()
     {
         $this->add_linked_data();
-        if (isset($this->type) &&
-            isset($this->ref_id) &&
-            isset($this->user_id) &&
-            isset($this->course_code) &&
-            isset($this->category) &&
-            isset($this->weight) &&
-            isset($this->visible)
+        if (!empty($this->type) &&
+            !empty($this->ref_id) &&
+            !empty($this->user_id) &&
+            !empty($this->course_code) &&
+            !empty($this->category)
         ) {
             $table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
             $sql = "SELECT count(*) count FROM $table

public/main/gradebook/lib/be/evaluation.class.php

@@ -393,7 +393,7 @@ class Evaluation implements GradebookItem
             $sql .= 'null';
         }
         $sql .= ', category_id = ';
-        if (isset($this->category)) {
+        if (!empty($this->category)) {
             $sql .= intval($this->get_category_id());
         } else {
             $sql .= 'null';

public/main/gradebook/lib/fe/catform.class.php

@@ -153,7 +153,7 @@ class CatForm extends FormValidator
         $category_name = $this->category_object->get_name();
 
         // The main course category:
-        if (isset($this->category_object) && 0 == $this->category_object->get_parent_id()) {
+        if (!empty($this->category_object) && 0 == $this->category_object->get_parent_id()) {
             if (empty($category_name)) {
                 $category_name = $course_code;
             }
@@ -219,9 +219,7 @@ class CatForm extends FormValidator
         );
         $this->addRule('name', get_lang('Required field'), 'required');
 
-        if (isset($this->category_object) &&
-            0 == $this->category_object->get_parent_id()
-        ) {
+        if (!empty($this->category_object) && 0 == $this->category_object->get_parent_id()) {
             // we can't change the root category
             $this->freeze('name');
         }

public/main/gradebook/lib/fe/exportgradebook.php

@@ -1,8 +1,6 @@
 <?php
+
 /* For licensing terms, see /license.txt */
-/**
- * Script.
- */
 
 /**
  * Prints an HTML page with a table containing the gradebook data.

public/main/gradebook/lib/flatview_data_generator.class.php

@@ -344,7 +344,7 @@ class FlatViewDataGenerator
             $mainCategoryId = $mainCourseCategory->get_id();
         }
 
-        if (isset($this->category) && !empty($this->category)) {
+        if (!empty($this->category)) {
             $categories = Category::load(
                 null,
                 null,

public/main/inc/lib/SortableTableFromArrayConfig.php

@@ -97,7 +97,7 @@ class SortableTableFromArrayConfig extends SortableTable
      */
     public function get_total_number_of_items()
     {
-        if (isset($this->total_number_of_items) && !empty($this->total_number_of_items)) {
+        if (!empty($this->total_number_of_items) && $this->total_number_of_items !== -1) {
             return $this->total_number_of_items;
         } else {
             if (!empty($this->table_data)) {

public/main/inc/lib/api.lib.php

@@ -1889,7 +1889,7 @@ function api_get_user_info_from_entity(
         $result['user_is_online'] = true == $result['user_is_online'] ? 1 : 0;
     }
     if (isset($result['user_is_online_in_chat'])) {
-        $result['user_is_online_in_chat'] = (int) $result['user_is_online_in_chat'];
+        $result['user_is_online_in_chat'] = $result['user_is_online_in_chat'];
     }
 
     $result['password'] = '';

public/main/inc/lib/career.lib.php

@@ -594,7 +594,7 @@ class Career extends Model
                                     '',
                                     $value
                                 );
-                                $simpleSecondConnection = 'g'.(int) $groupValueId;
+                                $simpleSecondConnection = 'g'.$groupValueId;
                             } else {
                                 // Course block (row_123 id)
                                 if (!empty($explode[0]) && isset($explode[1])) {

public/main/inc/lib/course.lib.php

@@ -289,7 +289,7 @@ class CourseManager
         if (!in_array($orderdirection, ['ASC', 'DESC'])) {
             $sql .= 'ASC';
         } else {
-            $sql .= ('ASC' == $orderdirection ? 'ASC' : 'DESC');
+            $sql .= ('ASC' === $orderdirection ? 'ASC' : 'DESC');
         }
 
         if (!empty($howmany) && is_int($howmany) and $howmany > 0) {
@@ -299,7 +299,7 @@ class CourseManager
         }
         if (!empty($from)) {
             $from = (int) $from;
-            $sql .= ' OFFSET '.(int) $from;
+            $sql .= ' OFFSET '.$from;
         } else {
             $sql .= ' OFFSET 0';
         }
@@ -476,7 +476,6 @@ class CourseManager
 
         // Erase user student publications (works) in the course - by André Boivin
         if (!empty($userList)) {
-            require_once api_get_path(SYS_CODE_PATH).'work/work.lib.php';
             foreach ($userList as $userId) {
                 // Getting all work from user
                 $workList = getWorkPerUser($userId);
@@ -891,7 +890,7 @@ class CourseManager
                 'status' => $status,
                 'sort' => $maxSort + 1,
                 'relation_type' => 0,
-                'user_course_cat' => (int) $userCourseCategoryId,
+                'user_course_cat' => $userCourseCategoryId,
             ];
             $insertId = Database::insert($courseUserTable, $params);
 
@@ -924,11 +923,9 @@ class CourseManager
 
                 $subscribe = (int) api_get_course_setting('subscribe_users_to_forum_notifications', $courseInfo);
                 if (1 === $subscribe) {
-                    require_once api_get_path(SYS_CODE_PATH).'forum/forumfunction.inc.php';
                     $forums = get_forums(0, $courseCode, true, $sessionId);
                     foreach ($forums as $forum) {
-                        $forumId = $forum['iid'];
-                        set_notification('forum', $forumId, false, $userInfo, $courseInfo);
+                        set_notification('forum', $forum->getIid(), false, $userInfo, $courseInfo);
                     }
                 }
 
@@ -2926,8 +2923,9 @@ class CourseManager
 
         // Restriction by user id
         $currentUserRestriction = '';
-        if ($byUserId > 0) {
+
         $byUserId = (int) $byUserId;
+        if ($byUserId > 0) {
             $currentUserRestriction = " AND tcruc.user_id = $byUserId ";
         }
 

public/main/inc/lib/dashboard.lib.php

@@ -47,13 +47,13 @@ class DashboardManager
 
                 // change index to lower case
                 $plugin_info = array_change_key_case($plugin_info);
-
                 echo '<tr>';
                 self::display_dashboard_plugin_checkboxes($testplugin);
                 for ($i = 0; $i < count($table_cols); $i++) {
-                    if (isset($plugin_info[strtolower($table_cols[$i])])) {
+                    $key = $table_cols[$i];
+                    if (isset($plugin_info[$key])) {
                         echo '<td>';
-                        echo $plugin_info[$table_cols[$i]];
+                        echo $plugin_info[$key];
                         echo '</td>';
                     } else {
                         echo '<td></td>';
@@ -80,15 +80,16 @@ class DashboardManager
                 echo '<tr style="background-color:#eee">';
                 echo '<td><center><input type="checkbox" name="disabled_block" value="true" checked disabled /></center>';
                 for ($j = 0; $j < count($table_cols); $j++) {
-                    if (isset($disabled_block[strtolower($table_cols[$j])])) {
+                    $key = $table_cols[$j];
+                    if (isset($disabled_block[$key])) {
                         if (2 == $j) {
                             echo '<td>';
-                            echo '<font color="#aaa">'.$disabled_block[$table_cols[$j]].'</font><br />';
+                            echo '<font color="#aaa">'.$disabled_block[$key].'</font><br />';
                             echo '<font color="red">'.get_lang('This plugin has been deleted from the dashboard plugin directory').'</font>';
                             echo '</td>';
                         } else {
                             echo '<td>';
-                            echo '<font color="#aaa">'.$disabled_block[$table_cols[$j]].'</font>';
+                            echo '<font color="#aaa">'.$disabled_block[$key].'</font>';
                             echo '</td>';
                         }
                     } else {
@@ -101,7 +102,11 @@ class DashboardManager
 
         echo '</table>';
         echo '<br />';
-        echo '<button class="btn btn-default" type="submit" name="submit_dashboard_plugins" value="'.get_lang('EnableDashboard plugins').'">'.
+        echo '<button
+            class="btn btn-default"
+            type="submit"
+            name="submit_dashboard_plugins"
+            value="'.get_lang('EnableDashboard plugins').'">'.
             get_lang('EnableDashboard plugins').'</button></form>';
     }
 

public/main/inc/lib/link.lib.php

@@ -628,7 +628,7 @@ class Link extends Model
                     SE_COURSE_ID => $course_id,
                     SE_TOOL_ID => TOOL_LINK,
                     SE_DATA => [
-                        'link_id' => (int) $id,
+                        'link_id' => $id,
                     ],
                     SE_USER => (int) api_get_user_id(),
                 ];

public/main/inc/lib/online.inc.php

@@ -287,10 +287,12 @@ function who_is_online(
         }
     }
 
+    $direction = strtolower($direction);
+
     if (empty($direction)) {
         $direction = 'DESC';
     } else {
-        if (!in_array(strtolower($direction), ['asc', 'desc'])) {
+        if (!in_array($direction, ['asc', 'desc'])) {
             $direction = 'DESC';
         }
     }

public/main/inc/lib/sessionmanager.lib.php

@@ -2428,13 +2428,13 @@ class SessionManager
                 }
             }
 
-            if (!empty($forums)) {
+            /*if (!empty($forums)) {
                 $userInfo = api_get_user_info($enreg_user);
                 foreach ($forums as $forum) {
                     $forumId = $forum['iid'];
                     //set_notification('forum', $forumId, false, $userInfo, $courseInfo);
                 }
-            }
+            }*/
 
             // Checking if user exists in session - user table.
             $sql = "SELECT count(user_id) as count

public/main/inc/lib/social.lib.php

@@ -2934,6 +2934,7 @@ class SocialManager extends UserManager
      */
     public static function getThreadList($userId)
     {
+        return [];
         $forumCourseId = api_get_configuration_value('global_forums_course_id');
 
         require_once api_get_path(SYS_CODE_PATH).'forum/forumfunction.inc.php';
@@ -2941,16 +2942,15 @@ class SocialManager extends UserManager
         $threads = [];
         if (!empty($forumCourseId)) {
             $courseInfo = api_get_course_info_by_id($forumCourseId);
-            getNotificationsPerUser($userId, true, $forumCourseId);
+            /*getNotificationsPerUser($userId, true, $forumCourseId);
             $notification = Session::read('forum_notification');
-            Session::erase('forum_notification');
+            Session::erase('forum_notification');*/
 
             $threadUrlBase = api_get_path(WEB_CODE_PATH).'forum/viewthread.php?'.http_build_query([
                 'cid' => $courseInfo['real_id'],
             ]).'&';
             if (isset($notification['thread']) && !empty($notification['thread'])) {
                 $threadList = array_filter(array_unique($notification['thread']));
-                $em = Database::getManager();
                 $repo = Container::getForumThreadRepository();
                 foreach ($threadList as $threadId) {
                     /** @var CForumThread $thread */

public/main/lp/learnpath.class.php

@@ -7182,6 +7182,7 @@ class learnpath
         $item_type = 'dir';
 
         $lpItem = new CLpItem();
+        $lpItem->setTitle('dir');
         $lpItem->setItemType('dir');
 
         $url = api_get_self().'?'.api_get_cidreq().'&action='.$action.'&type='.$item_type.'&lp_id='.$this->lp_id;

public/main/session/add_users_to_session.php

@@ -65,8 +65,7 @@ if (is_array($extra_field_list)) {
 
 function search_users($needle, $type)
 {
-    global $id_session;
-
+    $id_session = isset($_GET['id_session']) ? (int) $_GET['id_session'] : 0;
     $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
     $tbl_session_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
 
@@ -101,7 +100,6 @@ function search_users($needle, $type)
         // Only for single & multiple
         if (in_array($type, ['single', 'multiple'])) {
             if (!empty($id_session)) {
-                $id_session = (int) $id_session;
                 // check id_user from session_rel_user table
                 $sql = "
                     SELECT user_id FROM $tbl_session_rel_user

public/main/session/add_users_to_session_course.php

@@ -78,7 +78,8 @@ if (is_array($extra_field_list)) {
 
 function search_users($needle, $type)
 {
-    global $id_session, $courseId;
+    $courseId = isset($_GET['course_id']) ? (int) $_GET['course_id'] : 0;
+    $id_session = isset($_GET['id_session']) ? (int) $_GET['id_session'] : 0;
 
     $tbl_user = Database::get_main_table(TABLE_MAIN_USER);
     $tbl_session_rel_user = Database::get_main_table(TABLE_MAIN_SESSION_USER);
@@ -115,7 +116,6 @@ function search_users($needle, $type)
         // Only for single & multiple
         if (in_array($type, ['single', 'multiple'])) {
             if (!empty($id_session)) {
-                $id_session = (int) $id_session;
                 // check id_user from session_rel_user table
                 $sql = "
                     SELECT su.user_id

src/CoreBundle/Framework/Container.php

@@ -151,7 +151,7 @@ class Container
      */
     public static function getProjectDir()
     {
-        if (isset(self::$container)) {
+        if (self::$container) {
             return self::$container->get('kernel')->getProjectDir().'/';
         }