chamilo / chamilo-lms

main/auth/sso/sso.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
 
     /**
      * Validates the received active connection data with the database
-     * @return	bool	Return the loginFailed variable value to local.inc.php
+     * @return	null|false	Return the loginFailed variable value to local.inc.php
      */
     public function check_user()
     {

Spacing +9 added lines, -9 removed lines

@@ -34,7 +34,7 @@ 
      */
     public function __construct()
     {
-        $this->protocol   = api_get_setting('sso_authentication_protocol');
+        $this->protocol = api_get_setting('sso_authentication_protocol');
         // There can be multiple domains, so make sure to take only the first
         // This might be later extended with a decision process
         $domains = explode(',', api_get_setting('sso_authentication_domain'));
@@ -42,7 +42,7 @@ 
         $this->auth_uri = api_get_setting('sso_authentication_auth_uri');
         $this->deauth_uri = api_get_setting('sso_authentication_unauth_uri');
         //cut the string to avoid recursive URL construction in case of failure
-        $this->referer = $this->protocol.$_SERVER['HTTP_HOST'].substr($_SERVER['REQUEST_URI'],0,strpos($_SERVER['REQUEST_URI'],'sso'));
+        $this->referer = $this->protocol.$_SERVER['HTTP_HOST'].substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], 'sso'));
         $this->deauth_url = $this->protocol.$this->domain.$this->deauth_uri;
         $this->master_url = $this->protocol.$this->domain.$this->auth_uri;
         $this->referrer_uri = base64_encode($_SERVER['REQUEST_URI']);
@@ -130,11 +130,11 @@ 
                 ) {
                     //error_log('user n password are ok');
                     //Check if the account is active (not locked)
-                    if ($uData['active']=='1') {
+                    if ($uData['active'] == '1') {
                         // check if the expiration date has not been reached
                         if (empty($uData['expiration_date'])
                             or $uData['expiration_date'] > date('Y-m-d H:i:s')
-                            or $uData['expiration_date']=='0000-00-00 00:00:00') {
+                            or $uData['expiration_date'] == '0000-00-00 00:00:00') {
 
                             //If Multiple URL is enabled
                             if (api_get_multiple_access_url()) {
@@ -168,11 +168,11 @@ 
                                             // the user credentials are OK, which
                                             // should be protection enough
                                             // against evil URL spoofing...
-                                            $sso_target = api_get_path(WEB_PATH) . base64_decode($sso['ruri']);
+                                            $sso_target = api_get_path(WEB_PATH).base64_decode($sso['ruri']);
                                         } else {
-                                            $sso_target = isset($sso['target']) ? $sso['target'] : api_get_path(WEB_PATH) . 'index.php';
+                                            $sso_target = isset($sso['target']) ? $sso['target'] : api_get_path(WEB_PATH).'index.php';
                                         }
-                                        header('Location: '. $sso_target);
+                                        header('Location: '.$sso_target);
                                         exit;
                                     } else {
                                         // user does not have permission for this site
@@ -286,9 +286,9 @@ 
         $userId = intval($userId);
 
         if ($asAdmin && api_is_platform_admin(true)) {
-            return api_get_path(WEB_CODE_PATH) . "admin/user_edit.php?user_id=$userId";
+            return api_get_path(WEB_CODE_PATH)."admin/user_edit.php?user_id=$userId";
         }
 
-        return api_get_path(WEB_CODE_PATH) . 'auth/profile.php';
+        return api_get_path(WEB_CODE_PATH).'auth/profile.php';
     }
 }

main/coursecopy/classes/CourseArchiver.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
 
     /**
      * @param array $file
-     * @return bool|string
+     * @return string|false
      */
     public static function import_uploaded_file($file)
     {

Spacing +35 added lines, -35 removed lines

@@ -23,9 +23,9 @@ 
             while (($file = readdir($handle)) !== false) {
                 if ($file != "." && $file != ".." &&
                     strpos($file, 'CourseArchiver_') === 0 &&
-                    is_dir($dir . '/' . $file)
+                    is_dir($dir.'/'.$file)
                 ) {
-                    rmdirr($dir . '/' . $file);
+                    rmdirr($dir.'/'.$file);
                 }
             }
             closedir($handle);
@@ -43,48 +43,48 @@ 
         CourseArchiver::clean_backup_dir();
 
         // Create a temp directory
-        $tmp_dir_name = 'CourseArchiver_' . api_get_unique_id();
-        $backup_dir = api_get_path(SYS_ARCHIVE_PATH) . $tmp_dir_name . '/';
+        $tmp_dir_name = 'CourseArchiver_'.api_get_unique_id();
+        $backup_dir = api_get_path(SYS_ARCHIVE_PATH).$tmp_dir_name.'/';
 
         // All course-information will be stored in course_info.dat
-        $course_info_file = $backup_dir . 'course_info.dat';
+        $course_info_file = $backup_dir.'course_info.dat';
         $zip_dir = api_get_path(SYS_ARCHIVE_PATH);
         $user = api_get_user_info();
         $date = new DateTime(api_get_local_time());
-        $zip_file = $user['user_id'] . '_' . $course->code . '_' . $date->format('Ymd-His') . '.zip';
+        $zip_file = $user['user_id'].'_'.$course->code.'_'.$date->format('Ymd-His').'.zip';
         $php_errormsg = '';
         $res = @mkdir($backup_dir, $perm_dirs);
         if ($res === false) {
             //TODO set and handle an error message telling the user to review the permissions on the archive directory
-            error_log(__FILE__ . ' line ' . __LINE__ . ': ' . (ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini') . ' - This error, occuring because your archive directory will not let this script write data into it, will prevent courses backups to be created', 0);
+            error_log(__FILE__.' line '.__LINE__.': '.(ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini').' - This error, occuring because your archive directory will not let this script write data into it, will prevent courses backups to be created', 0);
         }
         // Write the course-object to the file
         $fp = @fopen($course_info_file, 'w');
         if ($fp === false) {
-            error_log(__FILE__ . ' line ' . __LINE__ . ': ' . (ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
+            error_log(__FILE__.' line '.__LINE__.': '.(ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
         }
 
         $res = @fwrite($fp, base64_encode(serialize($course)));
         if ($res === false) {
-            error_log(__FILE__ . ' line ' . __LINE__ . ': ' . (ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
+            error_log(__FILE__.' line '.__LINE__.': '.(ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
         }
 
         $res = @fclose($fp);
         if ($res === false) {
-            error_log(__FILE__ . ' line ' . __LINE__ . ': ' . (ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
+            error_log(__FILE__.' line '.__LINE__.': '.(ini_get('track_errors') != false ? $php_errormsg : 'error not recorded because track_errors is off in your php.ini'), 0);
         }
 
         // Copy all documents to the temp-dir
         if (isset($course->resources[RESOURCE_DOCUMENT]) && is_array($course->resources[RESOURCE_DOCUMENT])) {
             foreach ($course->resources[RESOURCE_DOCUMENT] as $document) {
                 if ($document->file_type == DOCUMENT) {
-                    $doc_dir = $backup_dir . $document->path;
+                    $doc_dir = $backup_dir.$document->path;
                     @mkdir(dirname($doc_dir), $perm_dirs, true);
-                    if (file_exists($course->path . $document->path)) {
-                        copy($course->path . $document->path, $doc_dir);
+                    if (file_exists($course->path.$document->path)) {
+                        copy($course->path.$document->path, $doc_dir);
                     }
                 } else {
-                    @mkdir($backup_dir . $document->path, $perm_dirs, true);
+                    @mkdir($backup_dir.$document->path, $perm_dirs, true);
                 }
             }
         }
@@ -92,49 +92,49 @@ 
         // Copy all scorm documents to the temp-dir
         if (isset($course->resources[RESOURCE_SCORM]) && is_array($course->resources[RESOURCE_SCORM])) {
             foreach ($course->resources[RESOURCE_SCORM] as $document) {
-                $doc_dir = dirname($backup_dir . $document->path);
+                $doc_dir = dirname($backup_dir.$document->path);
                 @mkdir($doc_dir, $perm_dirs, true);
-                copyDirTo($course->path . $document->path, $doc_dir, false);
+                copyDirTo($course->path.$document->path, $doc_dir, false);
             }
         }
 
         // Copy calendar attachments.
 
         if (isset($course->resources[RESOURCE_EVENT]) && is_array($course->resources[RESOURCE_EVENT])) {
-            $doc_dir = dirname($backup_dir . '/upload/calendar/');
+            $doc_dir = dirname($backup_dir.'/upload/calendar/');
             @mkdir($doc_dir, $perm_dirs, true);
-            copyDirTo($course->path . 'upload/calendar/', $doc_dir, false);
+            copyDirTo($course->path.'upload/calendar/', $doc_dir, false);
         }
 
         // Copy Learning path author image.
         if (isset($course->resources[RESOURCE_LEARNPATH]) && is_array($course->resources[RESOURCE_LEARNPATH])) {
-            $doc_dir = dirname($backup_dir . '/upload/learning_path/');
+            $doc_dir = dirname($backup_dir.'/upload/learning_path/');
             @mkdir($doc_dir, $perm_dirs, true);
-            copyDirTo($course->path . 'upload/learning_path/', $doc_dir, false);
+            copyDirTo($course->path.'upload/learning_path/', $doc_dir, false);
         }
 
         // Copy announcements attachments.
         if (isset($course->resources[RESOURCE_ANNOUNCEMENT]) && is_array($course->resources[RESOURCE_ANNOUNCEMENT])) {
-            $doc_dir = dirname($backup_dir . '/upload/announcements/');
+            $doc_dir = dirname($backup_dir.'/upload/announcements/');
             @mkdir($doc_dir, $perm_dirs, true);
-            copyDirTo($course->path . 'upload/announcements/', $doc_dir, false);
+            copyDirTo($course->path.'upload/announcements/', $doc_dir, false);
         }
 
         // Copy work folders (only folders)
         if (isset($course->resources[RESOURCE_WORK]) && is_array($course->resources[RESOURCE_WORK])) {
-            $doc_dir = dirname($backup_dir . '/upload/work/');
+            $doc_dir = dirname($backup_dir.'/upload/work/');
             @mkdir($doc_dir, $perm_dirs, true);
             // @todo: adjust to only create subdirs, but not copy files
-            copyDirTo($course->path . 'upload/work/', $doc_dir, false);
+            copyDirTo($course->path.'upload/work/', $doc_dir, false);
         }
 
         // Zip the course-contents
-        $zip = new PclZip($zip_dir . $zip_file);
-        $zip->create($zip_dir . $tmp_dir_name, PCLZIP_OPT_REMOVE_PATH, $zip_dir . $tmp_dir_name . '/');
+        $zip = new PclZip($zip_dir.$zip_file);
+        $zip->create($zip_dir.$tmp_dir_name, PCLZIP_OPT_REMOVE_PATH, $zip_dir.$tmp_dir_name.'/');
         //$zip->deleteByIndex(0);
         // Remove the temp-dir.
         rmdirr($backup_dir);
-        return '' . $zip_file;
+        return ''.$zip_file;
     }
 
     /**
@@ -145,7 +145,7 @@ 
     {
         global $dateTimeFormatLong;
         $backup_files = array();
-        $dirname = api_get_path(SYS_ARCHIVE_PATH) . '';
+        $dirname = api_get_path(SYS_ARCHIVE_PATH).'';
         if ($dir = opendir($dirname)) {
             while (($file = readdir($dir)) !== false) {
                 $file_parts = explode('_', $file);
@@ -156,7 +156,7 @@ 
                     $date = $file_parts[0];
                     $ext = isset($file_parts[1]) ? $file_parts[1] : null;
                     if ($ext == 'zip' && ($user_id != null && $owner_id == $user_id || $user_id == null)) {
-                        $date = substr($date, 0, 4) . '-' . substr($date, 4, 2) . '-' . substr($date, 6, 2) . ' ' . substr($date, 9, 2) . ':' . substr($date, 11, 2) . ':' . substr($date, 13, 2);
+                        $date = substr($date, 0, 4).'-'.substr($date, 4, 2).'-'.substr($date, 6, 2).' '.substr($date, 9, 2).':'.substr($date, 11, 2).':'.substr($date, 13, 2);
                         $backup_files[] = array(
                             'file' => $file,
                             'date' => $date,
@@ -177,7 +177,7 @@ 
      */
     public static function import_uploaded_file($file)
     {
-        $new_filename = uniqid('') . '.zip';
+        $new_filename = uniqid('').'.zip';
         $new_dir = api_get_path(SYS_ARCHIVE_PATH);
         if (is_dir($new_dir) && is_writable($new_dir)) {
             move_uploaded_file($file, api_get_path(SYS_ARCHIVE_PATH).$new_filename);
@@ -200,17 +200,17 @@ 
     {
         CourseArchiver::clean_backup_dir();
         // Create a temp directory
-        $tmp_dir_name = 'CourseArchiver_' . uniqid('');
-        $unzip_dir = api_get_path(SYS_ARCHIVE_PATH) . '' . $tmp_dir_name;
+        $tmp_dir_name = 'CourseArchiver_'.uniqid('');
+        $unzip_dir = api_get_path(SYS_ARCHIVE_PATH).''.$tmp_dir_name;
         @mkdir($unzip_dir, api_get_permissions_for_new_directories(), true);
-        @copy(api_get_path(SYS_ARCHIVE_PATH) . '' . $filename, $unzip_dir . '/backup.zip');
+        @copy(api_get_path(SYS_ARCHIVE_PATH).''.$filename, $unzip_dir.'/backup.zip');
         // unzip the archive
-        $zip = new PclZip($unzip_dir . '/backup.zip');
+        $zip = new PclZip($unzip_dir.'/backup.zip');
         @chdir($unzip_dir);
         $zip->extract(PCLZIP_OPT_TEMP_FILE_ON);
         // remove the archive-file
         if ($delete) {
-            @unlink(api_get_path(SYS_ARCHIVE_PATH) . '' . $filename);
+            @unlink(api_get_path(SYS_ARCHIVE_PATH).''.$filename);
         }
         // read the course
         if (!is_file('course_info.dat')) {

main/coursecopy/classes/CourseRecycler.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
      * course
      * @param string $type 'full_backup' or 'select_items'
      *
-     * @return bool
+     * @return false|null
      *
      * @assert (null) === false
      */

Indentation +4 added lines, -4 removed lines

@@ -619,8 +619,8 @@ 
     }
 
     /**
-    * Recycle Thematics
-    */
+     * Recycle Thematics
+     */
     public function recycle_thematic($session_id = 0)
     {
         if ($this->course->has_resources(RESOURCE_THEMATIC)) {
@@ -685,8 +685,8 @@ 
     }
 
     /**
-    * Recycle Attendances
-    */
+     * Recycle Attendances
+     */
     public function recycle_attendance($session_id = 0)
     {
         if ($this->course->has_resources(RESOURCE_ATTENDANCE)) {

Spacing +7 added lines, -7 removed lines

@@ -160,7 +160,7 @@ 
     public function recycle_glossary()
     {
         if ($this->course->has_resources(RESOURCE_GLOSSARY)) {
-            $table_glossary	= Database::get_course_table(TABLE_GLOSSARY);
+            $table_glossary = Database::get_course_table(TABLE_GLOSSARY);
             $ids = implode(',', array_filter(array_keys($this->course->resources[RESOURCE_GLOSSARY])));
             if (!empty($ids)) {
                 $sql = "DELETE FROM ".$table_glossary."
@@ -556,7 +556,7 @@ 
                     if (trim($learnpath->path) != '') {
                         // when $learnpath->path value is incorrect for some reason.
                         // The directory trat contains files of the SCORM package is to be deleted.
-                        $scorm_package_dir = realpath($this->course->path . 'scorm/' . $learnpath->path);
+                        $scorm_package_dir = realpath($this->course->path.'scorm/'.$learnpath->path);
                         rmdirr($scorm_package_dir);
                     }
                 }
@@ -632,7 +632,7 @@ 
             foreach ($resources[RESOURCE_THEMATIC] as $last_id => $thematic) {
                 if (is_numeric($last_id)) {
 
-                    foreach($thematic->thematic_advance_list as $thematic_advance) {
+                    foreach ($thematic->thematic_advance_list as $thematic_advance) {
                         $cond = array(
                             'id = ? AND  c_id = ?' => array(
                                 $thematic_advance['id'],
@@ -649,7 +649,7 @@ 
                         Database::delete($table_thematic_advance, $cond);
                     }
 
-                    foreach($thematic->thematic_plan_list as $thematic_plan) {
+                    foreach ($thematic->thematic_plan_list as $thematic_plan) {
                         $cond = array(
                             'id = ? AND  c_id = ?' => array(
                                 $thematic_plan['id'],
@@ -678,7 +678,7 @@ 
                         'ThematicDeleted',
                         api_get_user_id()
                     );
-                    Database::delete($table_thematic,$cond);
+                    Database::delete($table_thematic, $cond);
                 }
             }
         }
@@ -696,7 +696,7 @@ 
             $resources = $this->course->resources;
             foreach ($resources[RESOURCE_ATTENDANCE] as $last_id => $obj) {
                 if (is_numeric($last_id)) {
-                    foreach($obj->attendance_calendar as $attendance_calendar) {
+                    foreach ($obj->attendance_calendar as $attendance_calendar) {
                         $cond = array('id = ? AND c_id = ? '=>array($attendance_calendar['id'], $this->course_id));
                         Database::delete($table_attendance_calendar, $cond);
                     }
@@ -720,7 +720,7 @@ 
     public function recycle_work($session_id = 0)
     {
         if ($this->course->has_resources(RESOURCE_WORK)) {
-            $table_work          = Database :: get_course_table(TABLE_STUDENT_PUBLICATION);
+            $table_work = Database :: get_course_table(TABLE_STUDENT_PUBLICATION);
             $table_work_assignment = Database :: get_course_table(TABLE_STUDENT_PUBLICATION_ASSIGNMENT);
 
             $resources = $this->course->resources;

main/coursecopy/copy_course_session.php

Doc Comments +3 added lines

@@ -47,6 +47,9 @@
 
 /* FUNCTIONS */
 
+/**
+ * @param string $name
+ */
 function make_select_session_list($name, $sessions, $attr = array())
 {
     $attributes = '';

Spacing +21 added lines, -21 removed lines

@@ -11,7 +11,7 @@ 
 
 $cidReset = true;
 require_once '../inc/global.inc.php';
-$current_course_tool  = TOOL_COURSE_MAINTENANCE;
+$current_course_tool = TOOL_COURSE_MAINTENANCE;
 
 api_protect_global_admin_script();
 api_protect_limit_for_session_admin();
@@ -82,7 +82,7 @@ 
 
 function display_form()
 {
-    $html  = '';
+    $html = '';
     $sessions = SessionManager::get_sessions_list(array(), array('name', 'ASC'));
 
     // Actions
@@ -109,7 +109,7 @@ 
 
     //destination
     $html .= '<div class="form-group">';
-    $html .= '<label class="col-sm-2 control-label">' . get_lang('DestinationCoursesFromSession') . ': </label>';
+    $html .= '<label class="col-sm-2 control-label">'.get_lang('DestinationCoursesFromSession').': </label>';
     $html .= '<div class="col-sm-5" id="ajax_sessions_list_destination">';
     $html .= '<select class="form-control" name="sessions_list_destination" onchange="javascript: xajax_search_courses(this.value,\'destination\');">';
     $html .= '<option value = "0">'.get_lang('ThereIsNotStillASession').'</option></select ></div>';
@@ -131,7 +131,7 @@ 
     $html .= '<button class="btn btn-success" type="submit" onclick="javascript:if(!confirm('."'".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES))."'".')) return false;"><em class="fa fa-files-o"></em> '.get_lang('CopyCourse').'</button>';
 
     // Add Security token
-    $html .= '<input type="hidden" value="' . Security::get_token() . '" name="sec_token">';
+    $html .= '<input type="hidden" value="'.Security::get_token().'" name="sec_token">';
     $html .= '</div></div>';
 
     $html .= '</form>';
@@ -229,7 +229,7 @@ 
 
 /* HTML head extra */
 
-$htmlHeadXtra[] = $xajax->getJavascript( api_get_path(WEB_LIBRARY_PATH).'xajax/');
+$htmlHeadXtra[] = $xajax->getJavascript(api_get_path(WEB_LIBRARY_PATH).'xajax/');
 $htmlHeadXtra[] = '<script type="text/javascript">
 function checkSelected(id_select,id_radio,id_title,id_destination) {
    var num=0;
@@ -299,22 +299,22 @@ 
         display_form();
     } else {
 
-        $arr_course_origin 		= array();
+        $arr_course_origin = array();
         $arr_course_destination = array();
-        $destination_session 	= '';
-        $origin_session 		= '';
+        $destination_session = '';
+        $origin_session = '';
 
         if (isset($_POST['SessionCoursesListOrigin'])) {
-            $arr_course_origin 		= $_POST['SessionCoursesListOrigin'];
+            $arr_course_origin = $_POST['SessionCoursesListOrigin'];
         }
         if (isset($_POST['SessionCoursesListDestination'])) {
             $arr_course_destination = $_POST['SessionCoursesListDestination'];
         }
         if (isset($_POST['sessions_list_destination'])) {
-            $destination_session 	= $_POST['sessions_list_destination'];
+            $destination_session = $_POST['sessions_list_destination'];
         }
         if (isset($_POST['sessions_list_origin'])) {
-            $origin_session 		= $_POST['sessions_list_origin'];
+            $origin_session = $_POST['sessions_list_origin'];
         }
 
         if ((is_array($arr_course_origin) && count($arr_course_origin) > 0) && !empty($destination_session)) {
@@ -354,22 +354,22 @@ 
         Display::display_normal_message(get_lang('ToExportDocumentsWithGlossaryYouHaveToSelectGlossary'));
     }
 
-    $arr_course_origin 		= array();
+    $arr_course_origin = array();
     $arr_course_destination = array();
-    $destination_session 	= '';
-    $origin_session 		= '';
+    $destination_session = '';
+    $origin_session = '';
 
     if (isset($_POST['SessionCoursesListOrigin'])) {
-        $arr_course_origin 		= $_POST['SessionCoursesListOrigin'];
+        $arr_course_origin = $_POST['SessionCoursesListOrigin'];
     }
     if (isset($_POST['SessionCoursesListDestination'])) {
         $arr_course_destination = $_POST['SessionCoursesListDestination'];
     }
     if (isset($_POST['sessions_list_destination'])) {
-        $destination_session 	= $_POST['sessions_list_destination'];
+        $destination_session = $_POST['sessions_list_destination'];
     }
     if (isset($_POST['sessions_list_origin'])) {
-        $origin_session 		= $_POST['sessions_list_origin'];
+        $origin_session = $_POST['sessions_list_origin'];
     }
 
     if ((is_array($arr_course_origin) && count($arr_course_origin) > 0) && !empty($destination_session)) {
@@ -378,10 +378,10 @@ 
         $cb = new CourseBuilder('', $course_origin);
         $course = $cb->build($origin_session, $arr_course_origin[0], $with_base_content);
         //$hiddenFields['same_file_name_option'] = $_POST['same_file_name_option'];
-        $hiddenFields['destination_course'] 	= $arr_course_destination[0];
-        $hiddenFields['origin_course'] 		= $arr_course_origin[0];
-        $hiddenFields['destination_session'] 	= $destination_session;
-        $hiddenFields['origin_session'] 		= $origin_session;
+        $hiddenFields['destination_course'] = $arr_course_destination[0];
+        $hiddenFields['origin_course'] = $arr_course_origin[0];
+        $hiddenFields['destination_session'] = $destination_session;
+        $hiddenFields['origin_session'] = $origin_session;
         // Add token to Course select form
         $hiddenFields['sec_token'] = Security::get_token();
 

main/document/downloadfolder.inc.php

Doc Comments +1 added lines, -1 removed lines

@@ -327,7 +327,7 @@
  * @param array $arr1 first array
  * @param array $arr2 second array
  *
- * @return array difference between the two arrays
+ * @return string difference between the two arrays
  */
 function diff($arr1, $arr2)
 {

Spacing +5 added lines, -5 removed lines

@@ -51,7 +51,7 @@ 
 
 // A student should not be able to download a root shared directory
 if (($path == '/shared_folder' ||
-    $path == '/shared_folder_session_' . api_get_session_id()) &&
+    $path == '/shared_folder_session_'.api_get_session_id()) &&
     (!api_is_allowed_to_edit() || !api_is_platform_admin())
 ) {
     api_not_allowed(true);
@@ -149,7 +149,7 @@ 
                 (props.session_id IN ('0', '$sessionId') OR props.session_id IS NULL) AND
                 docs.c_id = ".$courseId." ";
 
-    $sql.= DocumentManager::getSessionFolderFilters($querypath, $sessionId);
+    $sql .= DocumentManager::getSessionFolderFilters($querypath, $sessionId);
 
     $result = Database::query($sql);
 
@@ -214,7 +214,7 @@ 
                 $groupCondition
             ";
 
-    $sql.= DocumentManager::getSessionFolderFilters($querypath, $sessionId);
+    $sql .= DocumentManager::getSessionFolderFilters($querypath, $sessionId);
     $result = Database::query($sql);
 
     $files = array();
@@ -294,9 +294,9 @@ 
     // Add all files in our final array to the zipfile
     for ($i = 0; $i < count($files_for_zipfile); $i++) {
         $zip->add(
-            $sysCoursePath . $courseInfo['path'] . '/document' . $files_for_zipfile[$i],
+            $sysCoursePath.$courseInfo['path'].'/document'.$files_for_zipfile[$i],
             PCLZIP_OPT_REMOVE_PATH,
-            $sysCoursePath . $courseInfo['path'] . '/document' . $remove_dir,
+            $sysCoursePath.$courseInfo['path'].'/document'.$remove_dir,
             PCLZIP_CB_PRE_ADD,
             'fixDocumentNameCallback'
         );

main/gradebook/lib/be/learnpathlink.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 
 	/**
 	 * Get the progress of this learnpath. Only the last attempt are taken into account.
-	 * @param $stud_id student id (default: all students who have results - then the average is returned)
+	 * @param integer $stud_id student id (default: all students who have results - then the average is returned)
 	 * @return	array (score, max) if student is given
 	 * 			array (sum of scores, number of scores) otherwise
 	 * 			or null if no scores available

Indentation +242 added lines, -242 removed lines

@@ -9,260 +9,260 @@
  */
 class LearnpathLink extends AbstractLink
 {
-	private $course_info = null;
-	private $learnpath_table = null;
-	private $learnpath_data = null;
-
-	/**
-	 * Constructor
-	 */
-	public function __construct()
-	{
-		parent::__construct();
-		$this->set_type(LINK_LEARNPATH);
-	}
-
-	/**
-	 * Generate an array of learnpaths that a teacher hasn't created a link for.
-	 * @return array 2-dimensional array - every element contains 2 subelements (id, name)
-	 */
-	public function get_not_created_links()
-	{
-		return false;
-		if (empty($this->course_code))
-			die('Error in get_not_created_links() : course code not set');
-
-		$tbl_grade_links = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
-
-		$sql = 'SELECT id, name from '.$this->get_learnpath_table().' lp
+    private $course_info = null;
+    private $learnpath_table = null;
+    private $learnpath_data = null;
+
+    /**
+     * Constructor
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->set_type(LINK_LEARNPATH);
+    }
+
+    /**
+     * Generate an array of learnpaths that a teacher hasn't created a link for.
+     * @return array 2-dimensional array - every element contains 2 subelements (id, name)
+     */
+    public function get_not_created_links()
+    {
+        return false;
+        if (empty($this->course_code))
+            die('Error in get_not_created_links() : course code not set');
+
+        $tbl_grade_links = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
+
+        $sql = 'SELECT id, name from '.$this->get_learnpath_table().' lp
 				WHERE c_id = '.$this->course_id.' AND id NOT IN '
-			.' (SELECT ref_id FROM '.$tbl_grade_links
-			.' WHERE type = '.LINK_LEARNPATH
-			." AND course_code = '".$this->get_course_code()."'"
-			.') AND lp.session_id='.api_get_session_id().'';
-
-		$result = Database::query($sql);
-
-		$cats=array();
-		while ($data=Database::fetch_array($result)) {
-			$cats[] = array ($data['id'], $data['name']);
-		}
-
-		return $cats;
-	}
-
-	/**
-	 * Generate an array of all learnpaths available.
-	 * @return array 2-dimensional array - every element contains 2 subelements (id, name)
-	 */
-	public function get_all_links()
-	{
-		if (empty($this->course_code))
-			die('Error in get_not_created_links() : course code not set');
-
-		$session_id = api_get_session_id();
-		if (empty($session_id)) {
-			$session_condition = api_get_session_condition(0, true);
-		} else {
-			$session_condition = api_get_session_condition($session_id, true, true);
-		}
-
-		$sql = 'SELECT id, name FROM '.$this->get_learnpath_table().'
+            .' (SELECT ref_id FROM '.$tbl_grade_links
+            .' WHERE type = '.LINK_LEARNPATH
+            ." AND course_code = '".$this->get_course_code()."'"
+            .') AND lp.session_id='.api_get_session_id().'';
+
+        $result = Database::query($sql);
+
+        $cats=array();
+        while ($data=Database::fetch_array($result)) {
+            $cats[] = array ($data['id'], $data['name']);
+        }
+
+        return $cats;
+    }
+
+    /**
+     * Generate an array of all learnpaths available.
+     * @return array 2-dimensional array - every element contains 2 subelements (id, name)
+     */
+    public function get_all_links()
+    {
+        if (empty($this->course_code))
+            die('Error in get_not_created_links() : course code not set');
+
+        $session_id = api_get_session_id();
+        if (empty($session_id)) {
+            $session_condition = api_get_session_condition(0, true);
+        } else {
+            $session_condition = api_get_session_condition($session_id, true, true);
+        }
+
+        $sql = 'SELECT id, name FROM '.$this->get_learnpath_table().'
                 WHERE c_id = '.$this->course_id.' '.$session_condition.' ';
-		$result = Database::query($sql);
+        $result = Database::query($sql);
 
-		$cats = array();
-		while ($data=Database::fetch_array($result)) {
-			$cats[] = array ($data['id'], $data['name']);
-		}
+        $cats = array();
+        while ($data=Database::fetch_array($result)) {
+            $cats[] = array ($data['id'], $data['name']);
+        }
 
-		return $cats;
-	}
+        return $cats;
+    }
 
 
-	/**
-	 * Has anyone used this learnpath yet ?
-	 */
-	public function has_results()
-	{
-		$tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
-		$sql = "SELECT count(id) AS number FROM $tbl_stats
+    /**
+     * Has anyone used this learnpath yet ?
+     */
+    public function has_results()
+    {
+        $tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
+        $sql = "SELECT count(id) AS number FROM $tbl_stats
 				WHERE c_id = ".$this->course_id." AND lp_id = ".$this->get_ref_id();
-		$result = Database::query($sql);
-		$number = Database::fetch_array($result,'NUM');
-		return ($number[0] != 0);
-	}
-
-	/**
-	 * Get the progress of this learnpath. Only the last attempt are taken into account.
-	 * @param $stud_id student id (default: all students who have results - then the average is returned)
-	 * @return	array (score, max) if student is given
-	 * 			array (sum of scores, number of scores) otherwise
-	 * 			or null if no scores available
-	 */
-	public function calc_score($stud_id = null, $type = null)
-	{
-		$tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
-		$session_id = api_get_session_id();
-
-		$sql = "SELECT * FROM $tbl_stats
+        $result = Database::query($sql);
+        $number = Database::fetch_array($result,'NUM');
+        return ($number[0] != 0);
+    }
+
+    /**
+     * Get the progress of this learnpath. Only the last attempt are taken into account.
+     * @param $stud_id student id (default: all students who have results - then the average is returned)
+     * @return	array (score, max) if student is given
+     * 			array (sum of scores, number of scores) otherwise
+     * 			or null if no scores available
+     */
+    public function calc_score($stud_id = null, $type = null)
+    {
+        $tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
+        $session_id = api_get_session_id();
+
+        $sql = "SELECT * FROM $tbl_stats
                 WHERE
                 	c_id = ".$this->course_id." AND
                     lp_id = ".$this->get_ref_id()." AND
                     session_id = $session_id ";
 
-		if (isset($stud_id))
-			$sql .= ' AND user_id = '.intval($stud_id);
-
-		// order by id, that way the student's first attempt is accessed first
-		$sql .= ' ORDER BY view_count DESC';
-
-		$scores = Database::query($sql);
-		// for 1 student
-		if (isset($stud_id)) {
-			if ($data = Database::fetch_assoc($scores)) {
-				return array ($data['progress'], 100);
-			} else
-				return null;
-		} else {
-			// all students -> get average
-			$students = array();  // user list, needed to make sure we only
-			// take first attempts into account
-			$rescount = 0;
-			$sum = 0;
-			$bestResult = 0;
-			$sumResult = 0;
-			while ($data = Database::fetch_array($scores)) {
-				if (!(array_key_exists($data['user_id'], $students))) {
-					$students[$data['user_id']] = $data['progress'];
-					$rescount++;
-					$sum += $data['progress'] / 100;
-					$sumResult += $data['progress'];
-
-					if ($data['progress'] > $bestResult) {
-						$bestResult = $data['progress'];
-					}
-				}
-			}
-
-			if ($rescount == 0) {
-				return null;
-			} else {
-
-				switch ($type) {
-					case 'best':
-						return array($bestResult, 100);
-						break;
-					case 'average':
-						return array($sumResult/$rescount, 100);
-						break;
-					case 'ranking':
-						return AbstractLink::getCurrentUserRanking($stud_id, $students);
-						break;
-					default:
-						return array($sum, $rescount);
-						break;
-				}
-			}
-		}
-	}
-
-	/**
-	 * Get URL where to go to if the user clicks on the link.
-	 */
-	public function get_link()
-	{
-		$url = api_get_path(WEB_PATH).'main/newscorm/lp_controller.php?cidReq='.$this->get_course_code().'&gradebook=view';
-		$session_id = api_get_session_id();
-		if (!api_is_allowed_to_edit() || $this->calc_score(api_get_user_id()) == null) {
-			$url .= '&action=view&session_id='.$session_id.'&lp_id='.$this->get_ref_id();
-		} else {
-			$url .= '&action=build&session_id='.$session_id.'&lp_id='.$this->get_ref_id();
-		}
-		return $url;
-	}
-
-	/**
-	 * Get name to display: same as learnpath title
-	 */
-	public function get_name()
-	{
-		$data = $this->get_learnpath_data();
-		return $data['name'];
-	}
-
-	/**
-	 * Get description to display: same as learnpath description
-	 */
-	public function get_description()
-	{
-		$data = $this->get_learnpath_data();
-		return $data['description'];
-	}
-
-	/**
-	 * Check if this still links to a learnpath
-	 */
-	public function is_valid_link() {
-		$sql = 'SELECT count(id) FROM '.$this->get_learnpath_table().'
+        if (isset($stud_id))
+            $sql .= ' AND user_id = '.intval($stud_id);
+
+        // order by id, that way the student's first attempt is accessed first
+        $sql .= ' ORDER BY view_count DESC';
+
+        $scores = Database::query($sql);
+        // for 1 student
+        if (isset($stud_id)) {
+            if ($data = Database::fetch_assoc($scores)) {
+                return array ($data['progress'], 100);
+            } else
+                return null;
+        } else {
+            // all students -> get average
+            $students = array();  // user list, needed to make sure we only
+            // take first attempts into account
+            $rescount = 0;
+            $sum = 0;
+            $bestResult = 0;
+            $sumResult = 0;
+            while ($data = Database::fetch_array($scores)) {
+                if (!(array_key_exists($data['user_id'], $students))) {
+                    $students[$data['user_id']] = $data['progress'];
+                    $rescount++;
+                    $sum += $data['progress'] / 100;
+                    $sumResult += $data['progress'];
+
+                    if ($data['progress'] > $bestResult) {
+                        $bestResult = $data['progress'];
+                    }
+                }
+            }
+
+            if ($rescount == 0) {
+                return null;
+            } else {
+
+                switch ($type) {
+                    case 'best':
+                        return array($bestResult, 100);
+                        break;
+                    case 'average':
+                        return array($sumResult/$rescount, 100);
+                        break;
+                    case 'ranking':
+                        return AbstractLink::getCurrentUserRanking($stud_id, $students);
+                        break;
+                    default:
+                        return array($sum, $rescount);
+                        break;
+                }
+            }
+        }
+    }
+
+    /**
+     * Get URL where to go to if the user clicks on the link.
+     */
+    public function get_link()
+    {
+        $url = api_get_path(WEB_PATH).'main/newscorm/lp_controller.php?cidReq='.$this->get_course_code().'&gradebook=view';
+        $session_id = api_get_session_id();
+        if (!api_is_allowed_to_edit() || $this->calc_score(api_get_user_id()) == null) {
+            $url .= '&action=view&session_id='.$session_id.'&lp_id='.$this->get_ref_id();
+        } else {
+            $url .= '&action=build&session_id='.$session_id.'&lp_id='.$this->get_ref_id();
+        }
+        return $url;
+    }
+
+    /**
+     * Get name to display: same as learnpath title
+     */
+    public function get_name()
+    {
+        $data = $this->get_learnpath_data();
+        return $data['name'];
+    }
+
+    /**
+     * Get description to display: same as learnpath description
+     */
+    public function get_description()
+    {
+        $data = $this->get_learnpath_data();
+        return $data['description'];
+    }
+
+    /**
+     * Check if this still links to a learnpath
+     */
+    public function is_valid_link() {
+        $sql = 'SELECT count(id) FROM '.$this->get_learnpath_table().'
                 WHERE c_id = '.$this->course_id.' AND id = '.$this->get_ref_id().' ';
-		$result = Database::query($sql);
-		$number = Database::fetch_row($result,'NUM');
-		return ($number[0] != 0);
-	}
-
-	public function get_type_name()
-	{
-		return get_lang('LearningPaths');
-	}
-
-	public function needs_name_and_description()
-	{
-		return false;
-	}
-
-	public function needs_max()
-	{
-		return false;
-	}
-
-	public function needs_results()
-	{
-		return false;
-	}
-
-	public function is_allowed_to_change_name()
-	{
-		return false;
-	}
-
-	// INTERNAL FUNCTIONS
-
-	/**
-	 * Lazy load function to get the database table of the learnpath
-	 */
-	private function get_learnpath_table()
-	{
-		$this->learnpath_table = Database :: get_course_table(TABLE_LP_MAIN);
-		return $this->learnpath_table;
-	}
-
-	/**
-	 * Lazy load function to get the database contents of this learnpath
-	 */
-	private function get_learnpath_data()
-	{
-		if (!isset($this->learnpath_data)) {
-			$sql = 'SELECT * FROM '.$this->get_learnpath_table().'
+        $result = Database::query($sql);
+        $number = Database::fetch_row($result,'NUM');
+        return ($number[0] != 0);
+    }
+
+    public function get_type_name()
+    {
+        return get_lang('LearningPaths');
+    }
+
+    public function needs_name_and_description()
+    {
+        return false;
+    }
+
+    public function needs_max()
+    {
+        return false;
+    }
+
+    public function needs_results()
+    {
+        return false;
+    }
+
+    public function is_allowed_to_change_name()
+    {
+        return false;
+    }
+
+    // INTERNAL FUNCTIONS
+
+    /**
+     * Lazy load function to get the database table of the learnpath
+     */
+    private function get_learnpath_table()
+    {
+        $this->learnpath_table = Database :: get_course_table(TABLE_LP_MAIN);
+        return $this->learnpath_table;
+    }
+
+    /**
+     * Lazy load function to get the database contents of this learnpath
+     */
+    private function get_learnpath_data()
+    {
+        if (!isset($this->learnpath_data)) {
+            $sql = 'SELECT * FROM '.$this->get_learnpath_table().'
                     WHERE c_id = '.$this->course_id.' AND id = '.$this->get_ref_id().' ';
-			$result = Database::query($sql);
-			$this->learnpath_data = Database::fetch_array($result);
-		}
-		return $this->learnpath_data;
-	}
-
-	public function get_icon_name()
-	{
-		return 'learnpath';
-	}
+            $result = Database::query($sql);
+            $this->learnpath_data = Database::fetch_array($result);
+        }
+        return $this->learnpath_data;
+    }
+
+    public function get_icon_name()
+    {
+        return 'learnpath';
+    }
 }

Braces +12 added lines, -8 removed lines

@@ -29,8 +29,9 @@ 
 	public function get_not_created_links()
 	{
 		return false;
-		if (empty($this->course_code))
-			die('Error in get_not_created_links() : course code not set');
+		if (empty($this->course_code)) {
+					die('Error in get_not_created_links() : course code not set');
+		}
 
 		$tbl_grade_links = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
 
@@ -57,8 +58,9 @@ 
 	 */
 	public function get_all_links()
 	{
-		if (empty($this->course_code))
-			die('Error in get_not_created_links() : course code not set');
+		if (empty($this->course_code)) {
+					die('Error in get_not_created_links() : course code not set');
+		}
 
 		$session_id = api_get_session_id();
 		if (empty($session_id)) {
@@ -111,8 +113,9 @@ 
                     lp_id = ".$this->get_ref_id()." AND
                     session_id = $session_id ";
 
-		if (isset($stud_id))
-			$sql .= ' AND user_id = '.intval($stud_id);
+		if (isset($stud_id)) {
+					$sql .= ' AND user_id = '.intval($stud_id);
+		}
 
 		// order by id, that way the student's first attempt is accessed first
 		$sql .= ' ORDER BY view_count DESC';
@@ -122,8 +125,9 @@ 
 		if (isset($stud_id)) {
 			if ($data = Database::fetch_assoc($scores)) {
 				return array ($data['progress'], 100);
-			} else
-				return null;
+			} else {
+							return null;
+			}
 		} else {
 			// all students -> get average
 			$students = array();  // user list, needed to make sure we only

Spacing +10 added lines, -10 removed lines

@@ -43,9 +43,9 @@ 
 
 		$result = Database::query($sql);
 
-		$cats=array();
-		while ($data=Database::fetch_array($result)) {
-			$cats[] = array ($data['id'], $data['name']);
+		$cats = array();
+		while ($data = Database::fetch_array($result)) {
+			$cats[] = array($data['id'], $data['name']);
 		}
 
 		return $cats;
@@ -72,8 +72,8 @@ 
 		$result = Database::query($sql);
 
 		$cats = array();
-		while ($data=Database::fetch_array($result)) {
-			$cats[] = array ($data['id'], $data['name']);
+		while ($data = Database::fetch_array($result)) {
+			$cats[] = array($data['id'], $data['name']);
 		}
 
 		return $cats;
@@ -89,7 +89,7 @@ 
 		$sql = "SELECT count(id) AS number FROM $tbl_stats
 				WHERE c_id = ".$this->course_id." AND lp_id = ".$this->get_ref_id();
 		$result = Database::query($sql);
-		$number = Database::fetch_array($result,'NUM');
+		$number = Database::fetch_array($result, 'NUM');
 		return ($number[0] != 0);
 	}
 
@@ -121,12 +121,12 @@ 
 		// for 1 student
 		if (isset($stud_id)) {
 			if ($data = Database::fetch_assoc($scores)) {
-				return array ($data['progress'], 100);
+				return array($data['progress'], 100);
 			} else
 				return null;
 		} else {
 			// all students -> get average
-			$students = array();  // user list, needed to make sure we only
+			$students = array(); // user list, needed to make sure we only
 			// take first attempts into account
 			$rescount = 0;
 			$sum = 0;
@@ -154,7 +154,7 @@ 
 						return array($bestResult, 100);
 						break;
 					case 'average':
-						return array($sumResult/$rescount, 100);
+						return array($sumResult / $rescount, 100);
 						break;
 					case 'ranking':
 						return AbstractLink::getCurrentUserRanking($stud_id, $students);
@@ -207,7 +207,7 @@ 
 		$sql = 'SELECT count(id) FROM '.$this->get_learnpath_table().'
                 WHERE c_id = '.$this->course_id.' AND id = '.$this->get_ref_id().' ';
 		$result = Database::query($sql);
-		$number = Database::fetch_row($result,'NUM');
+		$number = Database::fetch_row($result, 'NUM');
 		return ($number[0] != 0);
 	}
 

main/gradebook/lib/fe/gradebooktable.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -32,6 +32,8 @@ 
      * @param array $evals
      * @param array $links
      * @param null $addparams
+     * @param boolean $showTeacherView
+     * @param integer $userId
      */
     public function __construct(
         $currentcat,
@@ -895,7 +897,7 @@ 
 
     /**
      * @param $item
-     * @return mixed
+     * @return string|null
      */
     private function build_course_code($item)
     {

Braces +3 added lines, -2 removed lines

@@ -256,10 +256,11 @@
         }
 
         // Categories.
-        if (!empty($data_array))
-        foreach ($data_array as $data) {
+        if (!empty($data_array)) {
+                foreach ($data_array as $data) {
             // list of items inside the gradebook (exercises, lps, forums, etc)
             $row  = array();
+        }
             /** @var AbstractLink $item */
             $item = $mainCategory = $data[0];
 

Spacing +42 added lines, -42 removed lines

@@ -71,7 +71,7 @@ 
             $this->set_additional_parameters($addparams);
         }
 
-        $column= 0;
+        $column = 0;
         if ($this->teacherView) {
             if ($this->exportToPdf == false) {
                 $this->set_header($column++, '', '', 'width="25px"');
@@ -283,13 +283,13 @@ 
                 $main_categories[$item->get_id()]['name'] = $item->get_name();
             } else {
                 $name = $this->build_name_link($item, $type);
-                $row[] = $invisibility_span_open.$name. $invisibility_span_close;
+                $row[] = $invisibility_span_open.$name.$invisibility_span_close;
                 $main_categories[$item->get_id()]['name'] = $name;
             }
 
             $this->dataForGraph['categories'][] = $item->get_name();
 
-            $main_categories[$item->get_id()]['weight']= $item->get_weight();
+            $main_categories[$item->get_id()]['weight'] = $item->get_weight();
             $total_categories_weight += $item->get_weight();
 
             // Description.
@@ -309,9 +309,9 @@ 
             );
 
             if ($this->teacherView) {
-                $row[] = $invisibility_span_open .Display::tag('p', $weight, array('class' => 'score')).$invisibility_span_close;
+                $row[] = $invisibility_span_open.Display::tag('p', $weight, array('class' => 'score')).$invisibility_span_close;
             } else {
-                $row[] = $invisibility_span_open .$weight.$invisibility_span_close;
+                $row[] = $invisibility_span_open.$weight.$invisibility_span_close;
             }
 
             $category_weight = $item->get_weight();
@@ -337,7 +337,7 @@ 
 
                 if (!empty($score[1])) {
                     $completeScore = $scoredisplay->display_score($score, SCORE_DIV_PERCENT);
-                    $score = $score[0]/$score[1]*$item->get_weight();
+                    $score = $score[0] / $score[1] * $item->get_weight();
                     $score = $scoredisplay->display_score(array($score, null), SCORE_SIMPLE);
                     $scoreToDisplay = Display::tip($score, $completeScore);
                 } else {
@@ -373,7 +373,7 @@ 
                     $totalResultAverageValue = strip_tags($scoredisplay->display_score($totalResult, SCORE_AVERAGE));
                     $this->dataForGraph['my_result'][] = (float) str_replace('%', '', $totalResultAverageValue);
                     $totalAverageValue = strip_tags($scoredisplay->display_score($totalAverage, SCORE_AVERAGE));
-                    $this->dataForGraph['average'][] =  (float) str_replace('%', '', $totalAverageValue);
+                    $this->dataForGraph['average'][] = (float) str_replace('%', '', $totalAverageValue);
                     // Ranking
                     $row[] = $ranking;
                     // Best
@@ -456,7 +456,7 @@ 
                         $row[] = $this->build_type_column($item, array('style' => 'padding-left:5px'));
 
                         // Name.
-                        $row[] = $invisibility_span_open."     ".$this->build_name_link($item, $type) . $invisibility_span_close;
+                        $row[] = $invisibility_span_open."     ".$this->build_name_link($item, $type).$invisibility_span_close;
 
                         // Description.
                         if ($this->exportToPdf == false) {
@@ -494,7 +494,7 @@ 
                             // Students get the results and certificates columns
                             $eval_n_links = array_merge($alleval, $alllink);
 
-                            if (count($eval_n_links)> 0) {
+                            if (count($eval_n_links) > 0) {
                                 $value_data = isset($data[4]) ? $data[4] : null;
 
                                 if (!is_null($value_data)) {
@@ -593,7 +593,7 @@ 
                 $row = array(
                     null,
                     null,
-                    '<strong>' . get_lang('Total') . '</strong>',
+                    '<strong>'.get_lang('Total').'</strong>',
                     null,
                     $total
                 );
@@ -663,7 +663,7 @@ 
                 if ($this->exportToPdf) {
                     $row = array(
                         null,
-                        '<h3>' . get_lang('Total') . '</h3>',
+                        '<h3>'.get_lang('Total').'</h3>',
                         $main_weight,
                         $totalResult,
                         $totalRanking,
@@ -673,7 +673,7 @@ 
                 } else {
                     $row = array(
                         null,
-                        '<h3>' . get_lang('Total') . '</h3>',
+                        '<h3>'.get_lang('Total').'</h3>',
                         null,
                         $main_weight,
                         $totalResult,
@@ -688,7 +688,7 @@ 
         }
 
         // Warning messages
-        $view = isset($_GET['view']) ? $_GET['view']: null;
+        $view = isset($_GET['view']) ? $_GET['view'] : null;
 
         if ($this->teacherView) {
             if (isset($_GET['selectcat']) &&
@@ -701,14 +701,14 @@ 
                 $weight_category = intval($this->build_weight($category[0]));
 
                 $course_code = $this->build_course_code($category[0]);
-                $weight_total_links  = round($weight_total_links);
+                $weight_total_links = round($weight_total_links);
 
                 if ($weight_total_links > $weight_category ||
                     $weight_total_links < $weight_category ||
                     $weight_total_links > $weight_category
                 ) {
                     $warning_message = sprintf(get_lang('TotalWeightMustBeX'), $weight_category);
-                    $modify_icons  = '<a href="gradebook_edit_cat.php?editcat='.$id_cat.'&cidReq='.$course_code.'&id_session='.api_get_session_id().'">'.
+                    $modify_icons = '<a href="gradebook_edit_cat.php?editcat='.$id_cat.'&cidReq='.$course_code.'&id_session='.api_get_session_id().'">'.
                         Display::return_icon('edit.png', $warning_message, array(), ICON_SIZE_SMALL).'</a>';
                     $warning_message .= $modify_icons;
                     Display::display_warning_message($warning_message, false);
@@ -721,7 +721,7 @@ 
                 );
 
                 if (!empty($content_html)) {
-                    $new_content = explode('</head>',$content_html['content']);
+                    $new_content = explode('</head>', $content_html['content']);
                 }
 
                 if (empty($new_content[0])) {
@@ -755,7 +755,7 @@ 
                     is_array($course_codes)
                 ) {
                     $warning_message = '';
-                    for ($x = 0; $x<count($weight_categories);$x++) {
+                    for ($x = 0; $x < count($weight_categories); $x++) {
                         $weight_category = intval($weight_categories[$x]);
                         $certificate_min_score = intval($certificate_min_scores[$x]);
                         $course_code = $course_codes[$x];
@@ -763,12 +763,12 @@ 
                         if (empty($certificate_min_score) ||
                             ($certificate_min_score > $weight_category)
                         ) {
-                            $warning_message .= $course_code .'&nbsp;-&nbsp;'.get_lang('CertificateMinimunScoreIsRequiredAndMustNotBeMoreThan').'&nbsp;'.$weight_category.'<br />';
+                            $warning_message .= $course_code.'&nbsp;-&nbsp;'.get_lang('CertificateMinimunScoreIsRequiredAndMustNotBeMoreThan').'&nbsp;'.$weight_category.'<br />';
                         }
                     }
 
                     if (!empty($warning_message)) {
-                        Display::display_warning_message($warning_message,false);
+                        Display::display_warning_message($warning_message, false);
                     }
                 }
             }
@@ -812,15 +812,15 @@ 
             $pChart->Antialias = false;
 
             /* Add a border to the picture */
-            $pChart->drawRectangle(0,0,$xSize-10,$ySize-10,array("R"=>0,"G"=>0,"B"=>0));
+            $pChart->drawRectangle(0, 0, $xSize - 10, $ySize - 10, array("R"=>0, "G"=>0, "B"=>0));
 
-            $pChart->drawText(10,16,get_lang('Results'),array("FontSize"=>11,"Align"=>TEXT_ALIGN_BOTTOMLEFT));
+            $pChart->drawText(10, 16, get_lang('Results'), array("FontSize"=>11, "Align"=>TEXT_ALIGN_BOTTOMLEFT));
 
-            $pChart->setGraphArea(50, 30, $xSize-50, $ySize-50);
+            $pChart->setGraphArea(50, 30, $xSize - 50, $ySize - 50);
 
             $pChart->setFontProperties(
                 array(
-                    'FontName' => api_get_path(SYS_FONTS_PATH) . 'opensans/OpenSans-Regular.ttf',
+                    'FontName' => api_get_path(SYS_FONTS_PATH).'opensans/OpenSans-Regular.ttf',
                     'FontSize' => 10,
                 )
             );
@@ -840,7 +840,7 @@ 
 
             /* Draw the line chart */
             $pChart->drawLineChart();
-            $pChart->drawPlotChart(array("DisplayValues"=>TRUE,"PlotBorder"=>TRUE,"BorderSize"=>2,"Surrounding"=>-60,"BorderAlpha"=>80));
+            $pChart->drawPlotChart(array("DisplayValues"=>TRUE, "PlotBorder"=>TRUE, "BorderSize"=>2, "Surrounding"=>-60, "BorderAlpha"=>80));
 
             /* Write the chart legend */
             $pChart->drawLegend(
@@ -860,13 +860,13 @@ 
             $chartHash = $myCache->getHash($dataSet);
 
             $myCache->writeToCache($chartHash, $pChart);
-            $imgSysPath = api_get_path(SYS_ARCHIVE_PATH) . $chartHash;
+            $imgSysPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash;
             $myCache->saveFromCache($chartHash, $imgSysPath);
-            $imgWebPath = api_get_path(WEB_ARCHIVE_PATH) . $chartHash;
+            $imgWebPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash;
 
             if (file_exists($imgSysPath)) {
                 $result = '<div id="contentArea" style="text-align: center;" >';
-                $result .= '<img src="' . $imgWebPath.'" >';
+                $result .= '<img src="'.$imgWebPath.'" >';
                 $result .= '</div>';
                 return $result;
             }
@@ -911,13 +911,13 @@ 
         switch ($item->get_item_type()) {
             // category
             case 'C' :
-                return 'CATE' . $item->get_id();
+                return 'CATE'.$item->get_id();
             // evaluation
             case 'E' :
-                return 'EVAL' . $item->get_id();
+                return 'EVAL'.$item->get_id();
             // link
             case 'L' :
-                return 'LINK' . $item->get_id();
+                return 'LINK'.$item->get_id();
         }
     }
 
@@ -945,20 +945,20 @@ 
         switch ($item->get_item_type()) {
             // category
             case 'C' :
-                $prms_uri='?selectcat=' . $item->get_id() . '&amp;view='.$view;
+                $prms_uri = '?selectcat='.$item->get_id().'&amp;view='.$view;
 
                 if (isset($_GET['isStudentView'])) {
-                    if ( isset($is_student) || ( isset($_SESSION['studentview']) && $_SESSION['studentview']=='studentview') ) {
-                        $prms_uri=$prms_uri.'&amp;isStudentView='.Security::remove_XSS($_GET['isStudentView']);
+                    if (isset($is_student) || (isset($_SESSION['studentview']) && $_SESSION['studentview'] == 'studentview')) {
+                        $prms_uri = $prms_uri.'&amp;isStudentView='.Security::remove_XSS($_GET['isStudentView']);
                     }
                 }
 
                 $cat = new Category();
-                $show_message=$cat->show_message_resource_delete($item->get_course_code());
+                $show_message = $cat->show_message_resource_delete($item->get_course_code());
                 return '&nbsp;<a href="'.Security::remove_XSS($_SESSION['gradebook_dest']).$prms_uri.'">'
                 . $item->get_name()
                 . '</a>'
-                . ($item->is_course() ? ' &nbsp;[' . $item->get_course_code() . ']'.$show_message : '');
+                . ($item->is_course() ? ' &nbsp;['.$item->get_course_code().']'.$show_message : '');
                 // evaluation
             case 'E' :
                 $cat = new Category();
@@ -966,10 +966,10 @@ 
                 $show_message = $cat->show_message_resource_delete($course_id);
 
                 // course/platform admin can go to the view_results page
-                if (api_is_allowed_to_edit() && $show_message===false) {
+                if (api_is_allowed_to_edit() && $show_message === false) {
                     if ($item->get_type() == 'presence') {
                         return '&nbsp;'
-                        . '<a href="gradebook_view_result.php?cidReq='.$course_id.'&amp;selecteval=' . $item->get_id() . '">'
+                        . '<a href="gradebook_view_result.php?cidReq='.$course_id.'&amp;selecteval='.$item->get_id().'">'
                         . $item->get_name()
                         . '</a>';
                     } else {
@@ -978,20 +978,20 @@ 
                             $extra = '';
                         }
                         return '&nbsp;'
-                        . '<a href="gradebook_view_result.php?' . api_get_cidreq() . '&selecteval=' . $item->get_id() . '">'
+                        . '<a href="gradebook_view_result.php?'.api_get_cidreq().'&selecteval='.$item->get_id().'">'
                         . $item->get_name()
                         . '</a>&nbsp;'.$extra;
                     }
-                } elseif (ScoreDisplay :: instance()->is_custom() && $show_message===false) {
+                } elseif (ScoreDisplay :: instance()->is_custom() && $show_message === false) {
                     // students can go to the statistics page (if custom display enabled)
                     return '&nbsp;'
-                    . '<a href="gradebook_statistics.php?' . api_get_cidreq() . '&selecteval=' . $item->get_id() . '">'
+                    . '<a href="gradebook_statistics.php?'.api_get_cidreq().'&selecteval='.$item->get_id().'">'
                     . $item->get_name()
                     . '</a>';
 
                 } elseif ($show_message === false && !api_is_allowed_to_edit() && !ScoreDisplay :: instance()->is_custom()) {
                     return '&nbsp;'
-                    . '<a href="gradebook_statistics.php?' . api_get_cidreq() . '&selecteval=' . $item->get_id() . '">'
+                    . '<a href="gradebook_statistics.php?'.api_get_cidreq().'&selecteval='.$item->get_id().'">'
                     . $item->get_name()
                     . '</a>';
                 } else {
@@ -1006,7 +1006,7 @@ 
                 $url = $item->get_link();
 
                 if (isset($url) && $show_message === false) {
-                    $text = '&nbsp;<a href="' . $item->get_link() . '">'
+                    $text = '&nbsp;<a href="'.$item->get_link().'">'
                         . $item->get_name()
                         . '</a>';
                 } else {

main/gradebook/lib/user_data_generator.class.php

Doc Comments +5 added lines, -4 removed lines

@@ -72,6 +72,7 @@ 
 
 	/**
 	 * Get actual array data
+	 * @param integer $count
 	 * @return array 2-dimensional array - each array contains the elements:
 	 * 0: eval/link object
 	 * 1: item name
@@ -285,7 +286,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_average_column($item, $ignore_score_color)
@@ -306,7 +307,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_result_column($item, $ignore_score_color)
@@ -323,7 +324,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_mask_column($item, $ignore_score_color)
@@ -339,7 +340,7 @@ 
 
 	/**
 	 * @param $coursecode
-	 * @return mixed
+	 * @return string
 	 */
 	private function get_course_name_from_code_cached($coursecode)
 	{

Indentation +346 added lines, -346 removed lines

@@ -10,28 +10,28 @@ 
  */
 class UserDataGenerator
 {
-	// Sorting types constants
-	const UDG_SORT_TYPE = 1;
-	const UDG_SORT_NAME = 2;
-	const UDG_SORT_COURSE = 4;
-	const UDG_SORT_CATEGORY = 8;
-	const UDG_SORT_AVERAGE = 16;
-	const UDG_SORT_SCORE = 32;
-	const UDG_SORT_MASK = 64;
-
-	const UDG_SORT_ASC = 128;
-	const UDG_SORT_DESC = 256;
-
-	private $items;
-	private $userid;
-
-	private $coursecodecache;
-	private $categorycache;
-	private $scorecache;
-	private $avgcache;
-
-	public function UserDataGenerator($userid, $evals = array(), $links = array())
-	{
+    // Sorting types constants
+    const UDG_SORT_TYPE = 1;
+    const UDG_SORT_NAME = 2;
+    const UDG_SORT_COURSE = 4;
+    const UDG_SORT_CATEGORY = 8;
+    const UDG_SORT_AVERAGE = 16;
+    const UDG_SORT_SCORE = 32;
+    const UDG_SORT_MASK = 64;
+
+    const UDG_SORT_ASC = 128;
+    const UDG_SORT_DESC = 256;
+
+    private $items;
+    private $userid;
+
+    private $coursecodecache;
+    private $categorycache;
+    private $scorecache;
+    private $avgcache;
+
+    public function UserDataGenerator($userid, $evals = array(), $links = array())
+    {
         $this->userid = $userid;
         $evals_filtered = array();
         $result = array();
@@ -62,330 +62,330 @@ 
         $this->avgcache = null;
     }
 
-	/**
-	 * Get total number of items (rows)
-	 */
-	public function get_total_items_count()
-	{
-		return count($this->items);
-	}
-
-	/**
-	 * Get actual array data
-	 * @return array 2-dimensional array - each array contains the elements:
-	 * 0: eval/link object
-	 * 1: item name
-	 * 2: course name
-	 * 3: category name
-	 * 4: average score
-	 * 5: student's score
-	 * 6: student's score as custom display (only if custom scoring enabled)
-	 */
-	public function get_data($sorting = 0, $start = 0, $count = null, $ignore_score_color = false)
-	{
-		// do some checks on count, redefine if invalid value
-		if (!isset($count)) {
-			$count = count ($this->items) - $start;
-		}
-		if ($count < 0) {
-			$count = 0;
-		}
-		$allitems = $this->items;
-
-		// sort users array
-		if ($sorting & self :: UDG_SORT_TYPE) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_type'));
-		}elseif ($sorting & self :: UDG_SORT_NAME) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_name'));
-		} elseif ($sorting & self :: UDG_SORT_COURSE) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_course'));
-		} elseif ($sorting & self :: UDG_SORT_CATEGORY) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_category'));
-		} elseif ($sorting & self :: UDG_SORT_AVERAGE) {
-			// if user sorts on average scores, first calculate them and cache them
-			foreach ($allitems as $item) {
-				$this->avgcache[$item->get_item_type() . $item->get_id()]= $item->calc_score();
-			}
-			usort($allitems, array('UserDataGenerator', 'sort_by_average'));
-		} elseif ($sorting & self :: UDG_SORT_SCORE) {
-			// if user sorts on student's scores, first calculate them and cache them
-			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
-					= $item->calc_score($this->userid);
-			}
-			usort($allitems, array('UserDataGenerator', 'sort_by_score'));
-		} elseif ($sorting & self :: UDG_SORT_MASK) {
-			// if user sorts on student's masks, first calculate scores and cache them
-			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
-					= $item->calc_score($this->userid);
-			}
-			usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
-		}
-
-		if ($sorting & self :: UDG_SORT_DESC) {
-			$allitems = array_reverse($allitems);
-		}
-		// select the items we have to display
-		$visibleitems = array_slice($allitems, $start, $count);
-
-		// fill score cache if not done yet
-		if (!isset ($this->scorecache)) {
-			foreach ($visibleitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
-					= $item->calc_score($this->userid);
-			}
-
-		}
-		// generate the data to display
-		$scoredisplay = ScoreDisplay :: instance();
-		$data = array();
-		foreach ($visibleitems as $item) {
-			$row = array ();
-			$row[] = $item;
-			$row[] = $item->get_name();
-			$row[] = $this->build_course_name($item);
-			$row[] = $this->build_category_name($item);
-			$row[] = $this->build_average_column($item, $ignore_score_color);
-			$row[] = $this->build_result_column($item, $ignore_score_color);
-			if ($scoredisplay->is_custom())
-				$row[] = $this->build_mask_column($item, $ignore_score_color);
-			$data[] = $row;
-		}
-		return $data;
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_type($item1, $item2)
-	{
-		if ($item1->get_item_type() == $item2->get_item_type()) {
-			return $this->sort_by_name($item1,$item2);
-		} else {
-			return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
-		}
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_course($item1, $item2)
-	{
-		$name1 = api_strtolower($this->get_course_name_from_code_cached($item1->get_course_code()));
-		$name2 = api_strtolower($this->get_course_name_from_code_cached($item2->get_course_code()));
-		return api_strnatcmp($name1, $name2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_category($item1, $item2)
-	{
-		$cat1 = $this->get_category_cached($item1->get_category_id());
-		$cat2 = $this->get_category_cached($item2->get_category_id());
-		$name1 = api_strtolower($this->get_category_name_to_display($cat1));
-		$name2 = api_strtolower($this->get_category_name_to_display($cat2));
-
-		return api_strnatcmp($name1, $name2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_name($item1, $item2)
-	{
-		return api_strnatcmp($item1->get_name(),$item2->get_name());
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_average($item1, $item2)
-	{
-		$score1 = $this->avgcache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->avgcache[$item2->get_item_type() . $item2->get_id()];
-
-		return $this->compare_scores($score1, $score2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_score($item1, $item2)
-	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
-
-		return $this->compare_scores($score1, $score2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_mask($item1, $item2)
-	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
-
-		return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
-	}
-
-	/**
-	 * @param $score1
-	 * @param $score2
-	 * @return int
-	 */
-	function compare_scores($score1, $score2)
-	{
-		if (!isset($score1)) {
-			return (isset($score2) ? 1 : 0);
-		} elseif (!isset($score2)) {
-			return -1;
-		} elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
-			return 0;
-		} else {
-			return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
-		}
-	}
-
-	/**
-	 * @param $item
-	 * @return mixed
-	 */
-	private function build_course_name($item)
-	{
-		return $this->get_course_name_from_code_cached($item->get_course_code());
-	}
-
-	/**
-	 * @param $item
-	 * @return string
-	 */
-	private function build_category_name($item)
-	{
-		$cat = $this->get_category_cached($item->get_category_id());
-
-		return $this->get_category_name_to_display($cat);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_average_column($item, $ignore_score_color)
-	{
-		if (isset($this->avgcache)) {
-			$avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
-		} else {
-			$avgscore = $item->calc_score();
-		}
-
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_AVERAGE;
-		/*if ($ignore_score_color)
+    /**
+     * Get total number of items (rows)
+     */
+    public function get_total_items_count()
+    {
+        return count($this->items);
+    }
+
+    /**
+     * Get actual array data
+     * @return array 2-dimensional array - each array contains the elements:
+     * 0: eval/link object
+     * 1: item name
+     * 2: course name
+     * 3: category name
+     * 4: average score
+     * 5: student's score
+     * 6: student's score as custom display (only if custom scoring enabled)
+     */
+    public function get_data($sorting = 0, $start = 0, $count = null, $ignore_score_color = false)
+    {
+        // do some checks on count, redefine if invalid value
+        if (!isset($count)) {
+            $count = count ($this->items) - $start;
+        }
+        if ($count < 0) {
+            $count = 0;
+        }
+        $allitems = $this->items;
+
+        // sort users array
+        if ($sorting & self :: UDG_SORT_TYPE) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_type'));
+        }elseif ($sorting & self :: UDG_SORT_NAME) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_name'));
+        } elseif ($sorting & self :: UDG_SORT_COURSE) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_course'));
+        } elseif ($sorting & self :: UDG_SORT_CATEGORY) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_category'));
+        } elseif ($sorting & self :: UDG_SORT_AVERAGE) {
+            // if user sorts on average scores, first calculate them and cache them
+            foreach ($allitems as $item) {
+                $this->avgcache[$item->get_item_type() . $item->get_id()]= $item->calc_score();
+            }
+            usort($allitems, array('UserDataGenerator', 'sort_by_average'));
+        } elseif ($sorting & self :: UDG_SORT_SCORE) {
+            // if user sorts on student's scores, first calculate them and cache them
+            foreach ($allitems as $item) {
+                $this->scorecache[$item->get_item_type() . $item->get_id()]
+                    = $item->calc_score($this->userid);
+            }
+            usort($allitems, array('UserDataGenerator', 'sort_by_score'));
+        } elseif ($sorting & self :: UDG_SORT_MASK) {
+            // if user sorts on student's masks, first calculate scores and cache them
+            foreach ($allitems as $item) {
+                $this->scorecache[$item->get_item_type() . $item->get_id()]
+                    = $item->calc_score($this->userid);
+            }
+            usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
+        }
+
+        if ($sorting & self :: UDG_SORT_DESC) {
+            $allitems = array_reverse($allitems);
+        }
+        // select the items we have to display
+        $visibleitems = array_slice($allitems, $start, $count);
+
+        // fill score cache if not done yet
+        if (!isset ($this->scorecache)) {
+            foreach ($visibleitems as $item) {
+                $this->scorecache[$item->get_item_type() . $item->get_id()]
+                    = $item->calc_score($this->userid);
+            }
+
+        }
+        // generate the data to display
+        $scoredisplay = ScoreDisplay :: instance();
+        $data = array();
+        foreach ($visibleitems as $item) {
+            $row = array ();
+            $row[] = $item;
+            $row[] = $item->get_name();
+            $row[] = $this->build_course_name($item);
+            $row[] = $this->build_category_name($item);
+            $row[] = $this->build_average_column($item, $ignore_score_color);
+            $row[] = $this->build_result_column($item, $ignore_score_color);
+            if ($scoredisplay->is_custom())
+                $row[] = $this->build_mask_column($item, $ignore_score_color);
+            $data[] = $row;
+        }
+        return $data;
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_type($item1, $item2)
+    {
+        if ($item1->get_item_type() == $item2->get_item_type()) {
+            return $this->sort_by_name($item1,$item2);
+        } else {
+            return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
+        }
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_course($item1, $item2)
+    {
+        $name1 = api_strtolower($this->get_course_name_from_code_cached($item1->get_course_code()));
+        $name2 = api_strtolower($this->get_course_name_from_code_cached($item2->get_course_code()));
+        return api_strnatcmp($name1, $name2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_category($item1, $item2)
+    {
+        $cat1 = $this->get_category_cached($item1->get_category_id());
+        $cat2 = $this->get_category_cached($item2->get_category_id());
+        $name1 = api_strtolower($this->get_category_name_to_display($cat1));
+        $name2 = api_strtolower($this->get_category_name_to_display($cat2));
+
+        return api_strnatcmp($name1, $name2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_name($item1, $item2)
+    {
+        return api_strnatcmp($item1->get_name(),$item2->get_name());
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_average($item1, $item2)
+    {
+        $score1 = $this->avgcache[$item1->get_item_type() . $item1->get_id()];
+        $score2 = $this->avgcache[$item2->get_item_type() . $item2->get_id()];
+
+        return $this->compare_scores($score1, $score2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_score($item1, $item2)
+    {
+        $score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
+        $score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+
+        return $this->compare_scores($score1, $score2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_mask($item1, $item2)
+    {
+        $score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
+        $score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+
+        return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
+    }
+
+    /**
+     * @param $score1
+     * @param $score2
+     * @return int
+     */
+    function compare_scores($score1, $score2)
+    {
+        if (!isset($score1)) {
+            return (isset($score2) ? 1 : 0);
+        } elseif (!isset($score2)) {
+            return -1;
+        } elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
+            return 0;
+        } else {
+            return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
+        }
+    }
+
+    /**
+     * @param $item
+     * @return mixed
+     */
+    private function build_course_name($item)
+    {
+        return $this->get_course_name_from_code_cached($item->get_course_code());
+    }
+
+    /**
+     * @param $item
+     * @return string
+     */
+    private function build_category_name($item)
+    {
+        $cat = $this->get_category_cached($item->get_category_id());
+
+        return $this->get_category_name_to_display($cat);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_average_column($item, $ignore_score_color)
+    {
+        if (isset($this->avgcache)) {
+            $avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
+        } else {
+            $avgscore = $item->calc_score();
+        }
+
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_AVERAGE;
+        /*if ($ignore_score_color)
 			$displaytype |= SCORE_IGNORE_SPLIT;
         */
-		return $scoredisplay->display_score($avgscore, $displaytype);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_result_column($item, $ignore_score_color)
-	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_DIV_PERCENT;
-		if ($ignore_score_color) {
-			$displaytype |= SCORE_IGNORE_SPLIT;
-		}
-
-		return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_DEFAULT);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_mask_column($item, $ignore_score_color)
-	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_DIV_PERCENT;
-		if ($ignore_score_color) {
-			$displaytype |= SCORE_IGNORE_SPLIT;
-		}
-		return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_CUSTOM);
-	}
-
-	/**
-	 * @param $coursecode
-	 * @return mixed
-	 */
-	private function get_course_name_from_code_cached($coursecode)
-	{
-		if (isset ($this->coursecodecache)
-			&& isset ($this->coursecodecache[$coursecode])) {
-			return $this->coursecodecache[$coursecode];
-		} else {
-			$name = CourseManager::getCourseNameFromCode($coursecode);
-			$this->coursecodecache[$coursecode] = $name;
-			return $name;
-		}
-	}
-
-	/**
-	 * @param $category_id
-	 * @return null
-	 */
-	private function get_category_cached($category_id)
-	{
-		if (isset ($this->categorycache)
-			&& isset ($this->categorycache[$category_id])) {
-			return $this->categorycache[$category_id];
-		}else {
-			$cat = Category::load($category_id);
-			if (isset($cat)){
-				$this->categorycache[$category_id] = $cat[0];
-				return $cat[0];
-			}else
-				return null;
-		}
-	}
-
-	/**
-	 * @param $cat
-	 * @return string
-	 */
-	private function get_category_name_to_display($cat)
-	{
-		if (isset($cat)) {
-			if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
-				return '';
-			} else {
-				return $cat->get_name();
-			}
-		} else {
-			return '';
-		}
-	}
+        return $scoredisplay->display_score($avgscore, $displaytype);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_result_column($item, $ignore_score_color)
+    {
+        $studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_DIV_PERCENT;
+        if ($ignore_score_color) {
+            $displaytype |= SCORE_IGNORE_SPLIT;
+        }
+
+        return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_DEFAULT);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_mask_column($item, $ignore_score_color)
+    {
+        $studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_DIV_PERCENT;
+        if ($ignore_score_color) {
+            $displaytype |= SCORE_IGNORE_SPLIT;
+        }
+        return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_CUSTOM);
+    }
+
+    /**
+     * @param $coursecode
+     * @return mixed
+     */
+    private function get_course_name_from_code_cached($coursecode)
+    {
+        if (isset ($this->coursecodecache)
+            && isset ($this->coursecodecache[$coursecode])) {
+            return $this->coursecodecache[$coursecode];
+        } else {
+            $name = CourseManager::getCourseNameFromCode($coursecode);
+            $this->coursecodecache[$coursecode] = $name;
+            return $name;
+        }
+    }
+
+    /**
+     * @param $category_id
+     * @return null
+     */
+    private function get_category_cached($category_id)
+    {
+        if (isset ($this->categorycache)
+            && isset ($this->categorycache[$category_id])) {
+            return $this->categorycache[$category_id];
+        }else {
+            $cat = Category::load($category_id);
+            if (isset($cat)){
+                $this->categorycache[$category_id] = $cat[0];
+                return $cat[0];
+            }else
+                return null;
+        }
+    }
+
+    /**
+     * @param $cat
+     * @return string
+     */
+    private function get_category_name_to_display($cat)
+    {
+        if (isset($cat)) {
+            if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
+                return '';
+            } else {
+                return $cat->get_name();
+            }
+        } else {
+            return '';
+        }
+    }
 }

Spacing +25 added lines, -25 removed lines

@@ -50,9 +50,9 @@ 
 
         }
         if (count($result) == 0) {
-            $evals_filtered=$evals;
+            $evals_filtered = $evals;
         } else {
-            $evals_filtered=$evals_filtered_copy;
+            $evals_filtered = $evals_filtered_copy;
         }
         $this->items = array_merge($evals_filtered, $links);
 
@@ -85,7 +85,7 @@ 
 	{
 		// do some checks on count, redefine if invalid value
 		if (!isset($count)) {
-			$count = count ($this->items) - $start;
+			$count = count($this->items) - $start;
 		}
 		if ($count < 0) {
 			$count = 0;
@@ -104,20 +104,20 @@ 
 		} elseif ($sorting & self :: UDG_SORT_AVERAGE) {
 			// if user sorts on average scores, first calculate them and cache them
 			foreach ($allitems as $item) {
-				$this->avgcache[$item->get_item_type() . $item->get_id()]= $item->calc_score();
+				$this->avgcache[$item->get_item_type().$item->get_id()] = $item->calc_score();
 			}
 			usort($allitems, array('UserDataGenerator', 'sort_by_average'));
 		} elseif ($sorting & self :: UDG_SORT_SCORE) {
 			// if user sorts on student's scores, first calculate them and cache them
 			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
+				$this->scorecache[$item->get_item_type().$item->get_id()]
 					= $item->calc_score($this->userid);
 			}
 			usort($allitems, array('UserDataGenerator', 'sort_by_score'));
 		} elseif ($sorting & self :: UDG_SORT_MASK) {
 			// if user sorts on student's masks, first calculate scores and cache them
 			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
+				$this->scorecache[$item->get_item_type().$item->get_id()]
 					= $item->calc_score($this->userid);
 			}
 			usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
@@ -132,7 +132,7 @@ 
 		// fill score cache if not done yet
 		if (!isset ($this->scorecache)) {
 			foreach ($visibleitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
+				$this->scorecache[$item->get_item_type().$item->get_id()]
 					= $item->calc_score($this->userid);
 			}
 
@@ -141,7 +141,7 @@ 
 		$scoredisplay = ScoreDisplay :: instance();
 		$data = array();
 		foreach ($visibleitems as $item) {
-			$row = array ();
+			$row = array();
 			$row[] = $item;
 			$row[] = $item->get_name();
 			$row[] = $this->build_course_name($item);
@@ -163,7 +163,7 @@ 
 	function sort_by_type($item1, $item2)
 	{
 		if ($item1->get_item_type() == $item2->get_item_type()) {
-			return $this->sort_by_name($item1,$item2);
+			return $this->sort_by_name($item1, $item2);
 		} else {
 			return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
 		}
@@ -203,7 +203,7 @@ 
 	 */
 	function sort_by_name($item1, $item2)
 	{
-		return api_strnatcmp($item1->get_name(),$item2->get_name());
+		return api_strnatcmp($item1->get_name(), $item2->get_name());
 	}
 
 	/**
@@ -213,8 +213,8 @@ 
 	 */
 	function sort_by_average($item1, $item2)
 	{
-		$score1 = $this->avgcache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->avgcache[$item2->get_item_type() . $item2->get_id()];
+		$score1 = $this->avgcache[$item1->get_item_type().$item1->get_id()];
+		$score2 = $this->avgcache[$item2->get_item_type().$item2->get_id()];
 
 		return $this->compare_scores($score1, $score2);
 	}
@@ -226,8 +226,8 @@ 
 	 */
 	function sort_by_score($item1, $item2)
 	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+		$score1 = $this->scorecache[$item1->get_item_type().$item1->get_id()];
+		$score2 = $this->scorecache[$item2->get_item_type().$item2->get_id()];
 
 		return $this->compare_scores($score1, $score2);
 	}
@@ -239,8 +239,8 @@ 
 	 */
 	function sort_by_mask($item1, $item2)
 	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+		$score1 = $this->scorecache[$item1->get_item_type().$item1->get_id()];
+		$score2 = $this->scorecache[$item2->get_item_type().$item2->get_id()];
 
 		return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
 	}
@@ -256,10 +256,10 @@ 
 			return (isset($score2) ? 1 : 0);
 		} elseif (!isset($score2)) {
 			return -1;
-		} elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
+		} elseif (($score1[0] / $score1[1]) == ($score2[0] / $score2[1])) {
 			return 0;
 		} else {
-			return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
+			return (($score1[0] / $score1[1]) < ($score2[0] / $score2[1]) ? -1 : 1);
 		}
 	}
 
@@ -291,7 +291,7 @@ 
 	private function build_average_column($item, $ignore_score_color)
 	{
 		if (isset($this->avgcache)) {
-			$avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
+			$avgscore = $this->avgcache[$item->get_item_type().$item->get_id()];
 		} else {
 			$avgscore = $item->calc_score();
 		}
@@ -311,7 +311,7 @@ 
 	 */
 	private function build_result_column($item, $ignore_score_color)
 	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+		$studscore = $this->scorecache[$item->get_item_type().$item->get_id()];
 		$scoredisplay = ScoreDisplay :: instance();
 		$displaytype = SCORE_DIV_PERCENT;
 		if ($ignore_score_color) {
@@ -328,7 +328,7 @@ 
 	 */
 	private function build_mask_column($item, $ignore_score_color)
 	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+		$studscore = $this->scorecache[$item->get_item_type().$item->get_id()];
 		$scoredisplay = ScoreDisplay :: instance();
 		$displaytype = SCORE_DIV_PERCENT;
 		if ($ignore_score_color) {
@@ -362,12 +362,12 @@ 
 		if (isset ($this->categorycache)
 			&& isset ($this->categorycache[$category_id])) {
 			return $this->categorycache[$category_id];
-		}else {
+		} else {
 			$cat = Category::load($category_id);
-			if (isset($cat)){
+			if (isset($cat)) {
 				$this->categorycache[$category_id] = $cat[0];
 				return $cat[0];
-			}else
+			} else
 				return null;
 		}
 	}
@@ -379,7 +379,7 @@ 
 	private function get_category_name_to_display($cat)
 	{
 		if (isset($cat)) {
-			if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
+			if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null) {
 				return '';
 			} else {
 				return $cat->get_name();

Braces +8 added lines, -6 removed lines

@@ -95,7 +95,7 @@ 
 		// sort users array
 		if ($sorting & self :: UDG_SORT_TYPE) {
 			usort($allitems, array('UserDataGenerator', 'sort_by_type'));
-		}elseif ($sorting & self :: UDG_SORT_NAME) {
+		} elseif ($sorting & self :: UDG_SORT_NAME) {
 			usort($allitems, array('UserDataGenerator', 'sort_by_name'));
 		} elseif ($sorting & self :: UDG_SORT_COURSE) {
 			usort($allitems, array('UserDataGenerator', 'sort_by_course'));
@@ -148,8 +148,9 @@ 
 			$row[] = $this->build_category_name($item);
 			$row[] = $this->build_average_column($item, $ignore_score_color);
 			$row[] = $this->build_result_column($item, $ignore_score_color);
-			if ($scoredisplay->is_custom())
-				$row[] = $this->build_mask_column($item, $ignore_score_color);
+			if ($scoredisplay->is_custom()) {
+							$row[] = $this->build_mask_column($item, $ignore_score_color);
+			}
 			$data[] = $row;
 		}
 		return $data;
@@ -362,13 +363,14 @@ 
 		if (isset ($this->categorycache)
 			&& isset ($this->categorycache[$category_id])) {
 			return $this->categorycache[$category_id];
-		}else {
+		} else {
 			$cat = Category::load($category_id);
 			if (isset($cat)){
 				$this->categorycache[$category_id] = $cat[0];
 				return $cat[0];
-			}else
-				return null;
+			} else {
+							return null;
+			}
 		}
 	}
 

main/inc/lib/access_url_edit_sessions_to_url_functions.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
      * Search sessions by name, based on a search string
      * @param string Search string
      * @param int Deprecated param
-     * @return string Xajax response block
+     * @return xajaxResponse Xajax response block
      * @assert () === false
      */
     function search_sessions($needle, $id)

Spacing +3 added lines, -3 removed lines

@@ -44,17 +44,17 @@
                     ORDER BY name, id
                     LIMIT 11';
             $rs = Database::query($sql);
-            $i=0;
+            $i = 0;
             while ($session = Database :: fetch_array($rs)) {
                 $i++;
-                if ($i<=10) {
+                if ($i <= 10) {
                      $return .= '<a href="#" onclick="add_user_to_url(\''.addslashes($session['id']).'\',\''.addslashes($session['name']).' ('.addslashes($session['id']).')'.'\')">'.$session['name'].' </a><br />';
                 } else {
                     $return .= '...<br />';
                 }
             }
         }
-        $xajax_response -> addAssign('ajax_list_courses','innerHTML',api_utf8_encode($return));
+        $xajax_response -> addAssign('ajax_list_courses', 'innerHTML', api_utf8_encode($return));
         return $xajax_response;
     }
 }

Indentation +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
             while ($session = Database :: fetch_array($rs)) {
                 $i++;
                 if ($i<=10) {
-                     $return .= '<a href="#" onclick="add_user_to_url(\''.addslashes($session['id']).'\',\''.addslashes($session['name']).' ('.addslashes($session['id']).')'.'\')">'.$session['name'].' </a><br />';
+                        $return .= '<a href="#" onclick="add_user_to_url(\''.addslashes($session['id']).'\',\''.addslashes($session['name']).' ('.addslashes($session['id']).')'.'\')">'.$session['name'].' </a><br />';
                 } else {
                     $return .= '...<br />';
                 }