Minor - format code, fix php docs (from master)

main/coursecopy/copy_course_session.php

@@ -9,7 +9,7 @@ use ChamiloSession as Session;
 /**
  * Copy resources from one course in a session to another one.
  *
- * @author Christian Fasanando <christian.fasanando@dokeos.com>
+ * @author Christian Fasanando
  * @author Julio Montoya <gugli100@gmail.com> Lots of bug fixes/improvements
  *
  * @package chamilo.backup

main/coursecopy/copy_course_session_selected.php

@@ -9,7 +9,7 @@ use ChamiloSession as Session;
 /**
  * Copy resources from one course in a session to another one.
  *
- * @author Christian Fasanando <christian.fasanando@dokeos.com>
+ * @author Christian Fasanando
  * @author Julio Montoya <gugli100@gmail.com> Lots of bug fixes/improvements
  * @author Angel Fernando Quiroz Campos <angel.quiroz@beeznest.com> Code conventions
  *

main/document/create_audio.php

@@ -113,7 +113,6 @@ if (!($is_allowed_to_edit || $groupRights ||
     api_not_allowed(true);
 }
 
-/*	Header */
 Event::event_access_tool(TOOL_DOCUMENT);
 
 $display_dir = $dir;

main/document/create_document.php

@@ -63,10 +63,9 @@ if (isset($_REQUEST['certificate']) && $_REQUEST['certificate'] == 'true') {
     $is_certificate_mode = true;
 }
 
+$nameTools = get_lang('CreateDocument');
 if ($is_certificate_mode) {
     $nameTools = get_lang('CreateCertificate');
-} else {
-    $nameTools = get_lang('CreateDocument');
 }
 
 /* Constants and variables */

main/exercise/exercise_show.php

@@ -1210,3 +1210,4 @@ unset($questionList);
 
 Session::erase('exerciseResult');
 unset($exerciseResult);
+Session::erase('calculatedAnswerId');

main/exercise/hotspot.class.php

@@ -77,17 +77,15 @@ class HotSpot extends Question
      */
     public function processCreation($form, $exercise)
     {
-        $file_info = $form->getSubmitValue('imageUpload');
+        $fileInfo = $form->getSubmitValue('imageUpload');
         parent::processCreation($form, $exercise);
 
-        if (!empty($file_info['tmp_name'])) {
-            $result = $this->uploadPicture($file_info['tmp_name']);
+        if (!empty($fileInfo['tmp_name'])) {
+            $result = $this->uploadPicture($fileInfo);
             if ($result) {
                 $this->save($exercise);
 
                 return true;
-            } else {
-                return false;
             }
         }
 

main/exercise/hotspot_actionscript.as.php

@@ -18,6 +18,7 @@ require_once __DIR__.'/../inc/global.inc.php';
 
 api_protect_course_script(true);
 
+$_course = api_get_course_info();
 require api_get_path(LIBRARY_PATH).'geometry.lib.php';
 
 // set vars

main/exercise/hotspot_actionscript_admin.as.php

@@ -21,10 +21,9 @@ if (!$isAllowedToEdit) {
     exit;
 }
 
-// set vars
-$questionId = intval($_GET['modifyAnswers']);
-$objQuestion = Question::read($questionId);
 $_course = api_get_course_info();
+$questionId = isset($_GET['modifyAnswers']) ? (int) $_GET['modifyAnswers'] : 0;
+$objQuestion = Question::read($questionId);
 $documentPath = api_get_path(SYS_COURSE_PATH).$_course['path'].'/document';
 $picturePath = $documentPath.'/images';
 $pictureName = $objQuestion->getPictureFilename();

main/exercise/hotspot_answers.as.php

@@ -15,6 +15,7 @@ require_once __DIR__.'/../inc/global.inc.php';
 
 api_protect_course_script();
 
+$_course = api_get_course_info();
 $questionId = isset($_GET['modifyAnswers']) ? (int) $_GET['modifyAnswers'] : 0;
 $exerciseId = isset($_GET['exerciseId']) ? (int) $_GET['exerciseId'] : 0;
 $exeId = isset($_GET['exeId']) ? (int) $_GET['exeId'] : 0;

main/exercise/question_list_admin.inc.php

@@ -151,9 +151,6 @@ $ajax_url = api_get_path(WEB_AJAX_PATH).'exercise.ajax.php?'.api_get_cidreq().'&
 //we filter the type of questions we can add
 Question::displayTypeMenu($objExercise);
 
-// Re sets the question list
-//$objExercise->setQuestionList();
-
 echo '<div id="message"></div>';
 $token = Security::get_token();
 //deletes a session when using don't know question type (ugly fix)

main/inc/lib/course.lib.php

@@ -4270,6 +4270,7 @@ class CourseManager
             if (Skill::isAllowed($user_id, false)) {
                 $em = Database::getManager();
                 $objUser = api_get_user_entity($user_id);
+                /** @var Course $objCourse */
                 $objCourse = $em->find('ChamiloCoreBundle:Course', $course['real_id']);
                 $objSession = $em->find('ChamiloCoreBundle:Session', $session_id);
 

main/inc/lib/exercise.lib.php

@@ -3721,8 +3721,6 @@ EOT;
                 }
             }
             //We asumme that all exe_weighting
-            //$avg_score = show_score( $avg_score / count($user_results) , $result['exe_weighting']);
-            //$avg_score = ($avg_score / count($user_results));
             if (!empty($user_count)) {
                 $avg_score = float_format($avg_score / $user_count, 1) * 100;
             } else {

main/inc/lib/extra_field.lib.php

@@ -1977,7 +1977,7 @@ class ExtraField extends Model
         $header = get_lang('Add');
         $defaults = [];
 
-        if ($action == 'edit') {
+        if ($action === 'edit') {
             $header = get_lang('Modify');
             // Setting the defaults
             $defaults = $this->get($id, false);
@@ -1985,7 +1985,7 @@ class ExtraField extends Model
 
         $form->addElement('header', $header);
 
-        if ($action == 'edit') {
+        if ($action === 'edit') {
             $translateUrl = api_get_path(WEB_CODE_PATH).'extrafield/translate.php?'
                 .http_build_query(['extra_field' => $id]);
             $translateButton = Display::toolbarButton(get_lang('TranslateThisTerm'), $translateUrl, 'language', 'link');

main/inc/lib/message.lib.php

@@ -470,7 +470,7 @@ class MessageManager
             return false;
         } elseif ($totalFileSize > intval(api_get_setting('message_max_upload_filesize'))) {
             $warning = sprintf(
-                get_lang("FilesSizeExceedsX"),
+                get_lang('FilesSizeExceedsX'),
                 format_file_size(api_get_setting('message_max_upload_filesize'))
             );
 

main/inc/lib/myspace.lib.php

@@ -63,8 +63,8 @@ class MySpace
      */
     public static function getTopMenu()
     {
-        $menu_items = [];
-        $menu_items[] = Display::url(
+        $menuItems = [];
+        $menuItems[] = Display::url(
             Display::return_icon(
                 'statistics.png',
                 get_lang('MyStats'),
@@ -73,7 +73,7 @@ class MySpace
             ),
             api_get_path(WEB_CODE_PATH)."auth/my_progress.php"
         );
-        $menu_items[] = Display::url(
+        $menuItems[] = Display::url(
             Display::return_icon(
                 'teacher.png',
                 get_lang('TeacherInterface'),
@@ -82,7 +82,7 @@ class MySpace
             ),
             api_get_path(WEB_CODE_PATH).'mySpace/?view=teacher'
         );
-        $menu_items[] = Display::url(
+        $menuItems[] = Display::url(
             Display::return_icon(
                 'star_na.png',
                 get_lang('AdminInterface'),
@@ -91,12 +91,12 @@ class MySpace
             ),
             '#'
         );
-        $menu_items[] = Display::url(
+        $menuItems[] = Display::url(
             Display::return_icon('quiz.png', get_lang('ExamTracking'), [], 32),
             api_get_path(WEB_CODE_PATH).'tracking/exams.php'
         );
         $menu = '';
-        foreach ($menu_items as $item) {
+        foreach ($menuItems as $item) {
             $menu .= $item;
         }
         $menu .= '<br />';

main/inc/lib/pdf.lib.php

@@ -83,9 +83,8 @@ class PDF
      * Export the given HTML to PDF, using a global template.
      *
      * @uses \export/table_pdf.tpl
-
      *
-     * @param $content
+     * @param string     $content
      * @param bool|false $saveToFile
      * @param bool|false $returnHtml
      * @param bool       $addDefaultCss (bootstrap/default/base.css)

main/inc/lib/sessionmanager.lib.php

@@ -103,9 +103,9 @@ class SessionManager
         ];
 
         foreach ($variables as $value) {
-            $result[$value."_to_local_time"] = null;
+            $result[$value.'_to_local_time'] = null;
             if (!empty($result[$value])) {
-                $result[$value."_to_local_time"] = api_get_local_time($result[$value]);
+                $result[$value.'_to_local_time'] = api_get_local_time($result[$value]);
             }
         }
 
@@ -182,8 +182,8 @@ class SessionManager
         }
 
         $name = Database::escape_string(trim($name));
-        $sessionCategoryId = intval($sessionCategoryId);
-        $visibility = intval($visibility);
+        $sessionCategoryId = (int) $sessionCategoryId;
+        $visibility = (int) $visibility;
         $tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
 
         $startDate = Database::escape_string($startDate);
@@ -238,7 +238,7 @@ class SessionManager
                     'session_admin_id' => $sessionAdminId,
                     'visibility' => $visibility,
                     'description' => $description,
-                    'show_description' => intval($showDescription),
+                    'show_description' => $showDescription,
                     'send_subscription_notification' => (int) $sendSubscriptionNotification,
                 ];
 
@@ -270,8 +270,7 @@ class SessionManager
                 }
 
                 $session_id = Database::insert($tbl_session, $values);
-
-                $duration = intval($duration);
+                $duration = (int) $duration;
 
                 if (!empty($duration)) {
                     $sql = "UPDATE $tbl_session SET
@@ -1551,9 +1550,9 @@ class SessionManager
         $sessionAdminId = 0,
         $sendSubscriptionNotification = false
     ) {
-        $coachId = intval($coachId);
-        $sessionCategoryId = intval($sessionCategoryId);
-        $visibility = intval($visibility);
+        $coachId = (int) $coachId;
+        $sessionCategoryId = (int) $sessionCategoryId;
+        $visibility = (int) $visibility;
         $tbl_session = Database::get_main_table(TABLE_MAIN_SESSION);
 
         if (empty($name)) {
@@ -3395,8 +3394,8 @@ class SessionManager
         // Definition of variables
         $userId = (int) $userId;
 
-        $sessionId = !empty($sessionId) ? intval($sessionId) : api_get_session_id();
-        $courseId = !empty($courseId) ? intval($courseId) : api_get_course_id();
+        $sessionId = !empty($sessionId) ? (int) $sessionId : api_get_session_id();
+        $courseId = !empty($courseId) ? (int) $courseId : api_get_course_id();
 
         if (empty($sessionId) || empty($courseId) || empty($userId)) {
             return false;
@@ -7753,7 +7752,7 @@ SQL;
         $form->addElement('html', '<div id="advanced_params_options" style="display:none">');
 
         if (empty($sessionId)) {
-            $sessions = SessionManager::formatSessionsAdminForGrid();
+            $sessions = self::formatSessionsAdminForGrid();
             $sessionList = [];
             $sessionList[] = '';
             foreach ($sessions as $session) {

main/inc/lib/social.lib.php

@@ -409,12 +409,14 @@ class SocialManager extends UserManager
      * @author isaac flores paz
      *
      * @param int $userId
+     * @param int $limit
      *
      * @return array
      */
-    public static function get_list_invitation_of_friends_by_user_id($userId)
+    public static function get_list_invitation_of_friends_by_user_id($userId, $limit = 0)
     {
         $userId = (int) $userId;
+        $limit = (int) $limit;
 
         if (empty($userId)) {
             return [];
@@ -426,6 +428,9 @@ class SocialManager extends UserManager
                 WHERE
                     user_receiver_id = '.$userId.' AND
                     msg_status = '.MESSAGE_STATUS_INVITATION_PENDING;
+        if ($limit != null && $limit > 0) {
+            $sql .= ' LIMIT '.$limit;
+        }
         $res = Database::query($sql);
         $list = [];
         while ($row = Database::fetch_array($res, 'ASSOC')) {

main/inc/lib/sortable_table.class.php

@@ -142,9 +142,9 @@ class SortableTable extends HTML_Table
         $this->param_prefix = $table_name.'_';
 
         $this->page_nr = Session::read($this->param_prefix.'page_nr', 1);
-        $this->page_nr = isset($_GET[$this->param_prefix.'page_nr']) ? intval($_GET[$this->param_prefix.'page_nr']) : $this->page_nr;
+        $this->page_nr = isset($_GET[$this->param_prefix.'page_nr']) ? (int) $_GET[$this->param_prefix.'page_nr'] : $this->page_nr;
         $this->column = Session::read($this->param_prefix.'column', $default_column);
-        $this->column = isset($_GET[$this->param_prefix.'column']) ? intval($_GET[$this->param_prefix.'column']) : $this->column;
+        $this->column = isset($_GET[$this->param_prefix.'column']) ? (int) $_GET[$this->param_prefix.'column'] : $this->column;
 
         $defaultRow = api_get_configuration_value('table_default_row');
         if (!empty($defaultRow)) {
@@ -174,9 +174,9 @@ class SortableTable extends HTML_Table
             if (!in_array($my_get_direction, ['ASC', 'DESC'])) {
                 $this->direction = 'ASC';
             } else {
-                if ($my_get_direction == 'ASC') {
+                if ($my_get_direction === 'ASC') {
                     $this->direction = 'ASC';
-                } elseif ($my_get_direction == 'DESC') {
+                } elseif ($my_get_direction === 'DESC') {
                     $this->direction = 'DESC';
                 }
             }

main/inc/lib/system_announcements.lib.php

@@ -900,11 +900,12 @@ class SystemAnnouncementManager
         $selectedUserLanguage = Database::escape_string(api_get_interface_language());
         $announcementTable = Database::get_main_table(TABLE_MAIN_SYSTEM_ANNOUNCEMENTS);
         $now = api_get_utc_datetime();
+        $announcementId = (int) $announcementId;
 
         $whereConditions = [
             "(lang = ? OR lang IS NULL OR lang = '') " => $selectedUserLanguage,
             "AND (? >= date_start AND ? <= date_end) " => [$now, $now],
-            "AND id = ? " => intval($announcementId),
+            "AND id = ? " => $announcementId,
         ];
 
         $condition = self::getVisibilityCondition($visibility);

main/inc/lib/urlmanager.lib.php

@@ -280,14 +280,14 @@ class UrlManager
      */
     public static function getCountUrlRelCourse($courseId)
     {
-        $courseId = intval($courseId);
+        $courseId = (int) $courseId;
         $tableUrlRelCourse = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
         $sql = "SELECT *
                 FROM $tableUrlRelCourse
                 WHERE c_id = '$courseId'";
         $res = Database::query($sql);
 
-        return Database::num_rows($res);
+        return (int) Database::num_rows($res);
     }
 
     /**

main/inc/lib/usermanager.lib.php

@@ -683,6 +683,7 @@ class UserManager
      * @param int $user_id The user id
      *
      * @return bool true if user can be deleted
+     *
      * @assert (null) === false
      * @assert (-1) === false
      * @assert ('abc') === false

main/mySpace/admin_view.php

@@ -23,13 +23,13 @@ if (!$allowToTrack) {
 }
 
 if ($exportCSV) {
-    if ($display == 'user') {
+    if ($display === 'user') {
         MySpace::export_tracking_user_overview();
         exit;
-    } elseif ($display == 'session') {
+    } elseif ($display === 'session') {
         MySpace::export_tracking_session_overview();
         exit;
-    } elseif ($display == 'course') {
+    } elseif ($display === 'course') {
         MySpace::export_tracking_course_overview();
         exit;
     }

main/social/group_view.php

@@ -109,9 +109,9 @@ $role = 0;
 $usergroup = new UserGroup();
 
 if ($group_id != 0) {
-    $group_info = $usergroup->get($group_id);
-    $group_info['name'] = Security::remove_XSS($group_info['name']);
-    $group_info['description'] = Security::remove_XSS($group_info['description']);
+    $groupInfo = $usergroup->get($group_id);
+    $groupInfo['name'] = Security::remove_XSS($groupInfo['name']);
+    $groupInfo['description'] = Security::remove_XSS($groupInfo['description']);
 
     $interbreadcrumb[] = ['url' => '#', 'name' => $group_info['name']];
 
@@ -119,7 +119,7 @@ if ($group_id != 0) {
         $user_leaved = intval($_GET['u']);
         // I can "leave me myself"
         if (api_get_user_id() == $user_leaved) {
-            if (UserGroup::canLeave($group_info)) {
+            if (UserGroup::canLeave($groupInfo)) {
                 $usergroup->delete_user_rel_group($user_leaved, $group_id);
                 Display::addFlash(
                     Display::return_message(get_lang('UserIsNotSubscribedToThisGroup'), 'confirmation', false)
@@ -133,7 +133,7 @@ if ($group_id != 0) {
         // we add a user only if is a open group
         $user_join = intval($_GET['u']);
         if (api_get_user_id() == $user_join && !empty($group_id)) {
-            if ($group_info['visibility'] == GROUP_PERMISSION_OPEN) {
+            if ($groupInfo['visibility'] == GROUP_PERMISSION_OPEN) {
                 $usergroup->add_user_to_group($user_join, $group_id);
                 Display::addFlash(
                     Display::return_message(get_lang('UserIsSubscribedToThisGroup'), 'confirmation', false)
@@ -155,9 +155,9 @@ $create_thread_link = '';
 $social_right_content = null;
 $socialForum = '';
 
-$group_info = $usergroup->get($group_id);
-$group_info['name'] = Security::remove_XSS($group_info['name']);
-$group_info['description'] = Security::remove_XSS($group_info['description']);
+$groupInfo = $usergroup->get($group_id);
+$groupInfo['name'] = Security::remove_XSS($groupInfo['name']);
+$groupInfo['description'] = Security::remove_XSS($groupInfo['description']);
 
 //Loading group information
 if (isset($_GET['status']) && $_GET['status'] == 'sent') {
@@ -167,13 +167,13 @@ if (isset($_GET['status']) && $_GET['status'] == 'sent') {
 $is_group_member = $usergroup->is_group_member($group_id);
 $role = $usergroup->get_user_group_role(api_get_user_id(), $group_id);
 
-if (!$is_group_member && $group_info['visibility'] == GROUP_PERMISSION_CLOSED) {
+if (!$is_group_member && $groupInfo['visibility'] == GROUP_PERMISSION_CLOSED) {
     if ($role == GROUP_USER_PERMISSION_PENDING_INVITATION_SENT_BY_USER) {
         $social_right_content .= Display::return_message(get_lang('YouAlreadySentAnInvitation'));
     }
 }
 
-if ($is_group_member || $group_info['visibility'] == GROUP_PERMISSION_OPEN) {
+if ($is_group_member || $groupInfo['visibility'] == GROUP_PERMISSION_OPEN) {
     if (!$is_group_member) {
         if (!in_array(
             $role,

main/social/personal_data.php

@@ -10,6 +10,8 @@ $cidReset = true;
 
 require_once __DIR__.'/../inc/global.inc.php';
 
+api_set_more_memory_and_time_limits();
+
 api_block_anonymous_users();
 
 if (api_get_configuration_value('disable_gdpr')) {

main/tracking/exams.php

@@ -12,7 +12,7 @@ $toolTable = Database::get_course_table(TABLE_TOOL_LIST);
 $quizTable = Database::get_course_table(TABLE_QUIZ_TEST);
 
 $this_section = SECTION_TRACKING;
-$is_allowedToTrack = $is_courseAdmin || api_is_platform_admin(true) || $is_session_general_coach;
+$is_allowedToTrack = api_is_course_admin() || api_is_platform_admin(true) || $is_session_general_coach;
 
 if (!$is_allowedToTrack) {
     api_not_allowed(true);

main/upload/upload.document.php

@@ -36,7 +36,7 @@ if (!DocumentManager::get_document_id($_course, $path)) {
 $nameTools = get_lang('UplUploadDocument');
 $interbreadcrumb[] = [
     "url" => api_get_path(WEB_CODE_PATH)."document/document.php?curdirpath=".urlencode($path).'&'.api_get_cidreq(),
-    "name" => $langDocuments,
+    "name" => get_lang('Documents'),
 ];
 Display::display_header($nameTools, "Doc");
 //show the title