chamilo / chamilo-lms

main/inc/lib/access_url_edit_users_to_url_functions.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
      * search string
      * @param string Search string
      * @param int Deprecated param
-     * @return string Xajax response block
+     * @return xajaxResponse Xajax response block
      * @assert () === false
      */
     function search_users($needle, $id)

Spacing +4 added lines, -4 removed lines

@@ -43,22 +43,22 @@
                    ' WHERE (username LIKE "'.$needle.'%" '.
                    ' OR firstname LIKE "'.$needle.'%" '.
                    ' OR lastname LIKE "'.$needle.'%") '.
-                    $order_clause .
+                    $order_clause.
                    ' LIMIT 11';
 
             $rs = Database::query($sql);
-            $i=0;
+            $i = 0;
 
             while ($user = Database :: fetch_array($rs)) {
                 $i++;
-                if ($i<=10) {
+                if ($i <= 10) {
                     $return .= '<a href="javascript: void(0);" onclick="javascript: add_user_to_url(\''.addslashes($user['user_id']).'\',\''.api_get_person_name(addslashes($user['firstname']), addslashes($user['lastname'])).' ('.addslashes($user['username']).')'.'\')">'.api_get_person_name($user['firstname'], $user['lastname']).' ('.$user['username'].')</a><br />';
                 } else {
                     $return .= '...<br />';
                 }
             }
         }
-        $xajax_response -> addAssign('ajax_list_users','innerHTML',api_utf8_encode($return));
+        $xajax_response -> addAssign('ajax_list_users', 'innerHTML', api_utf8_encode($return));
         return $xajax_response;
     }
 }

Indentation +4 added lines, -4 removed lines

@@ -40,11 +40,11 @@
             // search users where username or firstname or lastname begins likes $needle
             $order_clause = api_sort_by_first_name() ? ' ORDER BY firstname, lastname, username' : ' ORDER BY lastname, firstname, username';
             $sql = 'SELECT u.user_id, username, lastname, firstname FROM '.$tbl_user.' u '.
-                   ' WHERE (username LIKE "'.$needle.'%" '.
-                   ' OR firstname LIKE "'.$needle.'%" '.
-                   ' OR lastname LIKE "'.$needle.'%") '.
+                    ' WHERE (username LIKE "'.$needle.'%" '.
+                    ' OR firstname LIKE "'.$needle.'%" '.
+                    ' OR lastname LIKE "'.$needle.'%") '.
                     $order_clause .
-                   ' LIMIT 11';
+                    ' LIMIT 11';
 
             $rs = Database::query($sql);
             $i=0;

main/inc/lib/add_course.lib.inc.php

Doc Comments +4 added lines, -1 removed lines

@@ -189,7 +189,7 @@ 
 
     /**
      * Gets an array with all the course tables (deprecated?)
-     * @return array
+     * @return string[]
      * @assert (null) !== null
      */
     public static function get_course_tables()
@@ -310,6 +310,8 @@ 
      * @param string Complete path to directory we want to list
      * @param array A list of files to which we want to add the files found
      * @param string Type of base directory from which we want to recover the files
+     * @param string $path
+     * @param string $media
      * @return array
      * @assert (null,null,null) === false
      * @assert ('abc',array(),'') === array()
@@ -371,6 +373,7 @@ 
      * Sorts pictures by type (used?)
      * @param array List of files (sthg like array(0=>array('png'=>1)))
      * @param string File type
+     * @param string $type
      * @return array The received array without files not matching type
      * @assert (array(),null) === array()
      */

Spacing +160 added lines, -160 removed lines

@@ -41,9 +41,9 @@ 
 
         while (!$keys_are_unique) {
 
-            $keys_course_id = $prefix_for_all . $unique_prefix . $wanted_code . $final_suffix['CourseId'];
+            $keys_course_id = $prefix_for_all.$unique_prefix.$wanted_code.$final_suffix['CourseId'];
             //$keys_course_db_name = $prefix_for_base_name . $unique_prefix . strtoupper($keys_course_id) . $final_suffix['CourseDb'];
-            $keys_course_repository = $prefix_for_path . $unique_prefix . $wanted_code . $final_suffix['CourseDir'];
+            $keys_course_repository = $prefix_for_path.$unique_prefix.$wanted_code.$final_suffix['CourseDir'];
             $keys_are_unique = true;
 
             // Check whether they are unique.
@@ -52,12 +52,12 @@ 
 
             if (Database::num_rows($result)) {
                 $keys_are_unique = false;
-                $try_new_fsc_id ++;
+                $try_new_fsc_id++;
                 $final_suffix['CourseId'] = substr(md5(uniqid(rand())), 0, 4);
             }
             if (file_exists(api_get_path(SYS_COURSE_PATH).$keys_course_repository)) {
                 $keys_are_unique = false;
-                $try_new_fsc_dir ++;
+                $try_new_fsc_dir++;
                 $final_suffix['CourseDir'] = substr(md5(uniqid(rand())), 0, 4);
             }
 
@@ -85,12 +85,12 @@ 
         $perm = api_get_permissions_for_new_directories();
         $perm_file = api_get_permissions_for_new_files();
         $htmlpage = "<!DOCTYPE html>\n<html lang=\"en\">\n  <head>\n    <meta charset=\"utf-8\">\n    <title>Not authorized</title>\n  </head>\n  <body>\n  </body>\n</html>";
-        $cp = api_get_path(SYS_COURSE_PATH) . $course_repository;
+        $cp = api_get_path(SYS_COURSE_PATH).$course_repository;
 
         //Creating document folder
         mkdir($cp, $perm);
-        mkdir($cp . '/document', $perm);
-        $cpt = $cp . '/document/index.html';
+        mkdir($cp.'/document', $perm);
+        $cpt = $cp.'/document/index.html';
         $fd = fopen($cpt, 'w');
         fwrite($fd, $htmlpage);
         fclose($fd);
@@ -112,49 +112,49 @@ 
         @copy($cpt, $cp . '/document/video/index.html');    */
 
         //Creatind dropbox folder
-        mkdir($cp . '/dropbox', $perm);
-        $cpt = $cp . '/dropbox/index.html';
+        mkdir($cp.'/dropbox', $perm);
+        $cpt = $cp.'/dropbox/index.html';
         $fd = fopen($cpt, 'w');
         fwrite($fd, $htmlpage);
         fclose($fd);
         @chmod($cpt, $perm_file);
-        mkdir($cp . '/group', $perm);
-        @copy($cpt, $cp . '/group/index.html');
-        mkdir($cp . '/page', $perm);
-        @copy($cpt, $cp . '/page/index.html');
-        mkdir($cp . '/scorm', $perm);
-        @copy($cpt, $cp . '/scorm/index.html');
-        mkdir($cp . '/upload', $perm);
-        @copy($cpt, $cp . '/upload/index.html');
-        mkdir($cp . '/upload/forum', $perm);
-        @copy($cpt, $cp . '/upload/forum/index.html');
-        mkdir($cp . '/upload/forum/images', $perm);
-        @copy($cpt, $cp . '/upload/forum/images/index.html');
-        mkdir($cp . '/upload/test', $perm);
-        @copy($cpt, $cp . '/upload/test/index.html');
-        mkdir($cp . '/upload/blog', $perm);
-        @copy($cpt, $cp . '/upload/blog/index.html');
-        mkdir($cp . '/upload/learning_path', $perm);
-        @copy($cpt, $cp . '/upload/learning_path/index.html');
-        mkdir($cp . '/upload/learning_path/images', $perm);
-        @copy($cpt, $cp . '/upload/learning_path/images/index.html');
-        mkdir($cp . '/upload/calendar', $perm);
-        @copy($cpt, $cp . '/upload/calendar/index.html');
-        mkdir($cp . '/upload/calendar/images', $perm);
-        @copy($cpt, $cp . '/upload/calendar/images/index.html');
-        mkdir($cp . '/work', $perm);
-        @copy($cpt, $cp . '/work/index.html');
-        mkdir($cp . '/upload/announcements', $perm);
-        @copy($cpt, $cp . '/upload/announcements/index.html');
-        mkdir($cp . '/upload/announcements/images', $perm);
-        @copy($cpt, $cp . '/upload/announcements/images/index.html');
+        mkdir($cp.'/group', $perm);
+        @copy($cpt, $cp.'/group/index.html');
+        mkdir($cp.'/page', $perm);
+        @copy($cpt, $cp.'/page/index.html');
+        mkdir($cp.'/scorm', $perm);
+        @copy($cpt, $cp.'/scorm/index.html');
+        mkdir($cp.'/upload', $perm);
+        @copy($cpt, $cp.'/upload/index.html');
+        mkdir($cp.'/upload/forum', $perm);
+        @copy($cpt, $cp.'/upload/forum/index.html');
+        mkdir($cp.'/upload/forum/images', $perm);
+        @copy($cpt, $cp.'/upload/forum/images/index.html');
+        mkdir($cp.'/upload/test', $perm);
+        @copy($cpt, $cp.'/upload/test/index.html');
+        mkdir($cp.'/upload/blog', $perm);
+        @copy($cpt, $cp.'/upload/blog/index.html');
+        mkdir($cp.'/upload/learning_path', $perm);
+        @copy($cpt, $cp.'/upload/learning_path/index.html');
+        mkdir($cp.'/upload/learning_path/images', $perm);
+        @copy($cpt, $cp.'/upload/learning_path/images/index.html');
+        mkdir($cp.'/upload/calendar', $perm);
+        @copy($cpt, $cp.'/upload/calendar/index.html');
+        mkdir($cp.'/upload/calendar/images', $perm);
+        @copy($cpt, $cp.'/upload/calendar/images/index.html');
+        mkdir($cp.'/work', $perm);
+        @copy($cpt, $cp.'/work/index.html');
+        mkdir($cp.'/upload/announcements', $perm);
+        @copy($cpt, $cp.'/upload/announcements/index.html');
+        mkdir($cp.'/upload/announcements/images', $perm);
+        @copy($cpt, $cp.'/upload/announcements/images/index.html');
 
         //Oral expression question type
-        mkdir($cp . '/exercises', $perm);
-        @copy($cpt, $cp . '/exercises/index.html');
+        mkdir($cp.'/exercises', $perm);
+        @copy($cpt, $cp.'/exercises/index.html');
 
         // Create .htaccess in the dropbox directory.
-        $fp = fopen($cp . '/dropbox/.htaccess', 'w');
+        $fp = fopen($cp.'/dropbox/.htaccess', 'w');
         fwrite(
             $fp,
             "AuthName AllowLocalAccess
@@ -297,7 +297,7 @@ 
     {
         $list = self::get_course_tables();
         foreach ($list as $table) {
-            $sql = "DROP TABLE IF EXISTS " . DB_COURSE_PREFIX . $table;
+            $sql = "DROP TABLE IF EXISTS ".DB_COURSE_PREFIX.$table;
             Database::query($sql);
         }
     }
@@ -319,47 +319,47 @@ 
         if ($media == 'images') {
             $code_path = api_get_path(
                     SYS_CODE_PATH
-                ) . 'default_course_document/images/';
+                ).'default_course_document/images/';
         }
         if ($media == 'audio') {
             $code_path = api_get_path(
                     SYS_CODE_PATH
-                ) . 'default_course_document/audio/';
+                ).'default_course_document/audio/';
         }
         if ($media == 'flash') {
             $code_path = api_get_path(
                     SYS_CODE_PATH
-                ) . 'default_course_document/flash/';
+                ).'default_course_document/flash/';
         }
         if ($media == 'video') {
             $code_path = api_get_path(
                     SYS_CODE_PATH
-                ) . 'default_course_document/video/';
+                ).'default_course_document/video/';
         }
         if ($media == 'certificates') {
             $code_path = api_get_path(
                     SYS_CODE_PATH
-                ) . 'default_course_document/certificates/';
+                ).'default_course_document/certificates/';
         }
         if (is_dir($path)) {
             $handle = opendir($path);
             while (false !== ($file = readdir($handle))) {
-                if (is_dir($path . $file) && strpos($file, '.') !== 0) {
+                if (is_dir($path.$file) && strpos($file, '.') !== 0) {
                     $files[]['dir'] = str_replace(
                         $code_path,
                         '',
-                        $path . $file . '/'
+                        $path.$file.'/'
                     );
                     $files = self::browse_folders(
-                        $path . $file . '/',
+                        $path.$file.'/',
                         $files,
                         $media
                     );
-                } elseif (is_file($path . $file) && strpos($file, '.') !== 0) {
+                } elseif (is_file($path.$file) && strpos($file, '.') !== 0) {
                     $files[]['file'] = str_replace(
                         $code_path,
                         '',
-                        $path . $file
+                        $path.$file
                     );
                 }
             }
@@ -471,8 +471,8 @@ 
             TABLE_MAIN_GRADEBOOK_CERTIFICATE
         );
 
-        include_once api_get_path(SYS_CODE_PATH) . 'lang/english/trad4all.inc.php';
-        $file_to_include = api_get_path(SYS_CODE_PATH) . 'lang/' . $language . '/trad4all.inc.php';
+        include_once api_get_path(SYS_CODE_PATH).'lang/english/trad4all.inc.php';
+        $file_to_include = api_get_path(SYS_CODE_PATH).'lang/'.$language.'/trad4all.inc.php';
 
         if (file_exists($file_to_include)) {
             include_once $file_to_include;
@@ -486,117 +486,117 @@ 
 
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 1, '" . TOOL_COURSE_DESCRIPTION . "','course_description/','info.gif','" . self::string2binary(
+            VALUES ($course_id, 1, '".TOOL_COURSE_DESCRIPTION."','course_description/','info.gif','".self::string2binary(
                 api_get_setting(
                     'course_create_active_tools',
                     'course_description'
                 )
-            ) . "','0','squaregrey.gif', 0,'_self','authoring','0')"
+            )."','0','squaregrey.gif', 0,'_self','authoring','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 2, '" . TOOL_CALENDAR_EVENT . "','calendar/agenda.php','agenda.gif','" . self::string2binary(
+            VALUES ($course_id, 2, '".TOOL_CALENDAR_EVENT."','calendar/agenda.php','agenda.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'agenda')
-            ) . "','0','squaregrey.gif',0,'_self','interaction','0')"
+            )."','0','squaregrey.gif',0,'_self','interaction','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage  (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 3, '" . TOOL_DOCUMENT . "','document/document.php','folder_document.gif','" . self::string2binary(
+            VALUES ($course_id, 3, '".TOOL_DOCUMENT."','document/document.php','folder_document.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'documents')
-            ) . "','0','squaregrey.gif',0,'_self','authoring','0')"
+            )."','0','squaregrey.gif',0,'_self','authoring','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 4, '" . TOOL_LEARNPATH . "','newscorm/lp_controller.php','scorms.gif','" . self::string2binary(
+            VALUES ($course_id, 4, '".TOOL_LEARNPATH."','newscorm/lp_controller.php','scorms.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'learning_path')
-            ) . "','0','squaregrey.gif',0,'_self','authoring','0')"
+            )."','0','squaregrey.gif',0,'_self','authoring','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-             VALUES ($course_id, 5, '" . TOOL_LINK . "','link/link.php','links.gif','" . self::string2binary(
+             VALUES ($course_id, 5, '".TOOL_LINK."','link/link.php','links.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'links')
-            ) . "','0','squaregrey.gif',0,'_self','authoring','0')"
+            )."','0','squaregrey.gif',0,'_self','authoring','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage  (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES  ($course_id, 6, '" . TOOL_QUIZ . "','exercice/exercice.php','quiz.gif','" . self::string2binary(
+            VALUES  ($course_id, 6, '".TOOL_QUIZ."','exercice/exercice.php','quiz.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'quiz')
-            ) . "','0','squaregrey.gif',0,'_self','authoring','0')"
+            )."','0','squaregrey.gif',0,'_self','authoring','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 7, '" . TOOL_ANNOUNCEMENT . "','announcements/announcements.php','valves.gif','" . self::string2binary(
+            VALUES ($course_id, 7, '".TOOL_ANNOUNCEMENT."','announcements/announcements.php','valves.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'announcements')
-            ) . "','0','squaregrey.gif', 0,'_self','authoring','0')"
+            )."','0','squaregrey.gif', 0,'_self','authoring','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 8, '" . TOOL_FORUM . "','forum/index.php','forum.gif','" . self::string2binary(
+            VALUES ($course_id, 8, '".TOOL_FORUM."','forum/index.php','forum.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'forums')
-            ) . "','0','squaregrey.gif',0,'_self','interaction','0')"
+            )."','0','squaregrey.gif',0,'_self','interaction','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 9, '" . TOOL_DROPBOX . "','dropbox/index.php','dropbox.gif','" . self::string2binary(
+            VALUES ($course_id, 9, '".TOOL_DROPBOX."','dropbox/index.php','dropbox.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'dropbox')
-            ) . "','0','squaregrey.gif',0,'_self','interaction','0')"
+            )."','0','squaregrey.gif',0,'_self','interaction','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 10, '" . TOOL_USER . "','user/user.php','members.gif','" . self::string2binary(
+            VALUES ($course_id, 10, '".TOOL_USER."','user/user.php','members.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'users')
-            ) . "','0','squaregrey.gif',0,'_self','interaction','0')"
+            )."','0','squaregrey.gif',0,'_self','interaction','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 11, '" . TOOL_GROUP . "','group/group.php','group.gif','" . self::string2binary(
+            VALUES ($course_id, 11, '".TOOL_GROUP."','group/group.php','group.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'groups')
-            ) . "','0','squaregrey.gif',0,'_self','interaction','0')"
+            )."','0','squaregrey.gif',0,'_self','interaction','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 12, '" . TOOL_CHAT . "','chat/chat.php','chat.gif','" . self::string2binary(
+            VALUES ($course_id, 12, '".TOOL_CHAT."','chat/chat.php','chat.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'chat')
-            ) . "','0','squaregrey.gif',0,'_self','interaction','0')"
+            )."','0','squaregrey.gif',0,'_self','interaction','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 13, '" . TOOL_STUDENTPUBLICATION . "','work/work.php','works.gif','" . self::string2binary(
+            VALUES ($course_id, 13, '".TOOL_STUDENTPUBLICATION."','work/work.php','works.gif','".self::string2binary(
                 api_get_setting(
                     'course_create_active_tools',
                     'student_publications'
                 )
-            ) . "','0','squaregrey.gif',0,'_self','interaction','0')"
+            )."','0','squaregrey.gif',0,'_self','interaction','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 14, '" . TOOL_SURVEY . "','survey/survey_list.php','survey.gif','" . self::string2binary(
+            VALUES ($course_id, 14, '".TOOL_SURVEY."','survey/survey_list.php','survey.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'survey')
-            ) . "','0','squaregrey.gif',0,'_self','interaction','0')"
+            )."','0','squaregrey.gif',0,'_self','interaction','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 15, '" . TOOL_WIKI . "','wiki/index.php','wiki.gif','" . self::string2binary(
+            VALUES ($course_id, 15, '".TOOL_WIKI."','wiki/index.php','wiki.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'wiki')
-            ) . "','0','squaregrey.gif',0,'_self','interaction','0')"
+            )."','0','squaregrey.gif',0,'_self','interaction','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 16, '" . TOOL_GRADEBOOK . "','gradebook/index.php','gradebook.gif','" . self::string2binary(
+            VALUES ($course_id, 16, '".TOOL_GRADEBOOK."','gradebook/index.php','gradebook.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'gradebook')
-            ) . "','0','squaregrey.gif',0,'_self','authoring','0')"
+            )."','0','squaregrey.gif',0,'_self','authoring','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 17, '" . TOOL_GLOSSARY . "','glossary/index.php','glossary.gif','" . self::string2binary(
+            VALUES ($course_id, 17, '".TOOL_GLOSSARY."','glossary/index.php','glossary.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'glossary')
-            ) . "','0','squaregrey.gif',0,'_self','authoring','0')"
+            )."','0','squaregrey.gif',0,'_self','authoring','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 18, '" . TOOL_NOTEBOOK . "','notebook/index.php','notebook.gif','" . self::string2binary(
+            VALUES ($course_id, 18, '".TOOL_NOTEBOOK."','notebook/index.php','notebook.gif','".self::string2binary(
                 api_get_setting('course_create_active_tools', 'notebook')
-            ) . "','0','squaregrey.gif',0,'_self','interaction','0')"
+            )."','0','squaregrey.gif',0,'_self','interaction','0')"
         );
 
         $setting = intval(self::string2binary(
@@ -605,13 +605,13 @@ 
 
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 19, '" . TOOL_ATTENDANCE . "','attendance/index.php','attendance.gif','" . $setting. "','0','squaregrey.gif',0,'_self','authoring','0')"
+            VALUES ($course_id, 19, '".TOOL_ATTENDANCE."','attendance/index.php','attendance.gif','".$setting."','0','squaregrey.gif',0,'_self','authoring','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 20, '" . TOOL_COURSE_PROGRESS . "','course_progress/index.php','course_progress.gif','" . self::string2binary(
+            VALUES ($course_id, 20, '".TOOL_COURSE_PROGRESS."','course_progress/index.php','course_progress.gif','".self::string2binary(
                 intval(api_get_setting('course_create_active_tools', 'course_progress'))
-            ) . "','0','squaregrey.gif',0,'_self','authoring','0')"
+            )."','0','squaregrey.gif',0,'_self','authoring','0')"
         );
 
         if (api_get_setting('service_visio', 'active') == 'true') {
@@ -619,11 +619,11 @@ 
             if (!empty($mycheck)) {
                 Database::query(
                     "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-                     VALUES ($course_id, 21, '" . TOOL_VISIO_CONFERENCE . "','conference/index.php?type=conference','visio_meeting.gif','1','0','squaregrey.gif','NO','_self','interaction','0')"
+                     VALUES ($course_id, 21, '".TOOL_VISIO_CONFERENCE."','conference/index.php?type=conference','visio_meeting.gif','1','0','squaregrey.gif','NO','_self','interaction','0')"
                 );
                 Database::query(
                     "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-                     VALUES ($course_id, 22, '" . TOOL_VISIO_CLASSROOM . "','conference/index.php?type=classroom','visio.gif','1','0','squaregrey.gif','NO','_self','authoring','0')"
+                     VALUES ($course_id, 22, '".TOOL_VISIO_CLASSROOM."','conference/index.php?type=classroom','visio.gif','1','0','squaregrey.gif','NO','_self','authoring','0')"
                 );
             }
         }
@@ -631,33 +631,33 @@ 
         if (api_get_setting('search_enabled') == 'true') {
             Database::query(
                 "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-                VALUES ($course_id, 23, '" . TOOL_SEARCH . "','search/','info.gif','" . self::string2binary(
+                VALUES ($course_id, 23, '".TOOL_SEARCH."','search/','info.gif','".self::string2binary(
                     api_get_setting(
                         'course_create_active_tools',
                         'enable_search'
                     )
-                ) . "','0','search.gif',0,'_self','authoring','0')"
+                )."','0','search.gif',0,'_self','authoring','0')"
             );
         }
 
         $sql = "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-                VALUES ($course_id, 24,'" . TOOL_BLOGS . "','blog/blog_admin.php','blog_admin.gif','" . intval(self::string2binary(
+                VALUES ($course_id, 24,'".TOOL_BLOGS."','blog/blog_admin.php','blog_admin.gif','".intval(self::string2binary(
                 api_get_setting('course_create_active_tools', 'blogs'))
-            ) . "','1','squaregrey.gif',0,'_self','admin','0')";
+            )."','1','squaregrey.gif',0,'_self','admin','0')";
         Database::query($sql);
 
         /*  Course homepage tools for course admin only  */
         Database::query(
             "INSERT INTO $tbl_course_homepage  (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 25, '" . TOOL_TRACKING . "','tracking/courseLog.php','statistics.gif','$visible_for_course_admin','1','', 0,'_self','admin','0')"
+            VALUES ($course_id, 25, '".TOOL_TRACKING."','tracking/courseLog.php','statistics.gif','$visible_for_course_admin','1','', 0,'_self','admin','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 26, '" . TOOL_COURSE_SETTING . "','course_info/infocours.php','reference.gif','$visible_for_course_admin','1','', 0,'_self','admin','0')"
+            VALUES ($course_id, 26, '".TOOL_COURSE_SETTING."','course_info/infocours.php','reference.gif','$visible_for_course_admin','1','', 0,'_self','admin','0')"
         );
         Database::query(
             "INSERT INTO $tbl_course_homepage (c_id, id, name, link, image, visibility, admin, address, added_tool, target, category, session_id)
-            VALUES ($course_id, 27, '" . TOOL_COURSE_MAINTENANCE . "','course_info/maintenance.php','backup.gif','$visible_for_course_admin','1','',0,'_self', 'admin','0')"
+            VALUES ($course_id, 27, '".TOOL_COURSE_MAINTENANCE."','course_info/maintenance.php','backup.gif','$visible_for_course_admin','1','',0,'_self', 'admin','0')"
         );
 
         $defaultEmailExerciseAlert = 1;
@@ -708,7 +708,7 @@ 
 
         Database::query(
             "INSERT INTO $TABLEGROUPCATEGORIES (c_id, id, title , description, max_student, self_reg_allowed, self_unreg_allowed, groups_per_user, display_order, doc_state,calendar_state, work_state ,announcements_state, forum_state, wiki_state, chat_state)
-             VALUES ($course_id, '2', '" . self::lang2db(get_lang('DefaultGroupCategory')) . "', '', '8', '0', '0', '0', '0', 1, 1 ,1 ,1 ,1, 1, 1);"
+             VALUES ($course_id, '2', '".self::lang2db(get_lang('DefaultGroupCategory'))."', '', '8', '0', '0', '0', '0', 1, 1 ,1 ,1 ,1, 1, 1);"
         );
 
         /*    Example Material  */
@@ -738,7 +738,7 @@ 
         $perm = api_get_permissions_for_new_directories();
         $perm_file = api_get_permissions_for_new_files();
 
-        $chat_path = $sys_course_path . $course_repository . '/document/chat_files';
+        $chat_path = $sys_course_path.$course_repository.'/document/chat_files';
 
         if (!is_dir($chat_path)) {
             @mkdir($chat_path, api_get_permissions_for_new_directories());
@@ -770,11 +770,11 @@ 
                 'certificates',
             );
 
-            $default_course_path = api_get_path(SYS_CODE_PATH) . 'default_course_document/';
+            $default_course_path = api_get_path(SYS_CODE_PATH).'default_course_document/';
 
             $default_document_array = array();
             foreach ($folders_to_copy_from_default_course as $folder) {
-                $default_course_folder_path = $default_course_path . $folder . '/';
+                $default_course_folder_path = $default_course_path.$folder.'/';
                 $files = self::browse_folders(
                     $default_course_folder_path,
                     array(),
@@ -805,30 +805,30 @@ 
                     //hack until feature #5242 is implemented
                     if ($media_type == 'images') {
                         $media_type = 'images/gallery';
-                        $images_folder = $sys_course_path . $course_repository . "/document/images/";
+                        $images_folder = $sys_course_path.$course_repository."/document/images/";
 
                         if (!is_dir($images_folder)) {
                             //Creating index.html
                             mkdir($images_folder, $perm);
-                            $fd = fopen($images_folder . 'index.html', 'w');
+                            $fd = fopen($images_folder.'index.html', 'w');
                             fwrite($fd, $htmlpage);
-                            @chmod($images_folder . 'index.html', $perm_file);
+                            @chmod($images_folder.'index.html', $perm_file);
                         }
                     }
 
-                    $course_documents_folder = $sys_course_path . $course_repository . "/document/$media_type/";
-                    $default_course_path = api_get_path(SYS_CODE_PATH) . 'default_course_document' . $path_documents;
+                    $course_documents_folder = $sys_course_path.$course_repository."/document/$media_type/";
+                    $default_course_path = api_get_path(SYS_CODE_PATH).'default_course_document'.$path_documents;
 
                     if (!is_dir($course_documents_folder)) {
                         // Creating index.html
                         mkdir($course_documents_folder, $perm);
                         $fd = fopen(
-                            $course_documents_folder . 'index.html',
+                            $course_documents_folder.'index.html',
                             'w'
                         );
                         fwrite($fd, $htmlpage);
                         @chmod(
-                            $course_documents_folder . 'index.html',
+                            $course_documents_folder.'index.html',
                             $perm_file
                         );
                     }
@@ -836,15 +836,15 @@ 
                     if (is_array($array_media) && count($array_media) > 0) {
                         foreach ($array_media as $key => $value) {
                             if (isset($value['dir']) && !empty($value['dir'])) {
-                                if (!is_dir($course_documents_folder . $value['dir'])) {
+                                if (!is_dir($course_documents_folder.$value['dir'])) {
                                     //Creating folder
                                     mkdir(
-                                        $course_documents_folder . $value['dir'],
+                                        $course_documents_folder.$value['dir'],
                                         $perm
                                     );
 
                                     //Creating index.html (for light protection)
-                                    $index_html = $course_documents_folder . $value['dir'] . '/index.html';
+                                    $index_html = $course_documents_folder.$value['dir'].'/index.html';
                                     $fd = fopen($index_html, 'w');
                                     fwrite($fd, $htmlpage);
                                     @chmod($index_html, $perm_file);
@@ -866,12 +866,12 @@ 
                                     }
 
                                     if ($media_type == 'images/gallery') {
-                                        $folder_path = 'gallery/' . $folder_path;
+                                        $folder_path = 'gallery/'.$folder_path;
                                     }
 
                                     Database::query(
                                         "INSERT INTO $TABLETOOLDOCUMENT (c_id, path,title,filetype,size)
-                                        VALUES ($course_id,'$path_documents" . $folder_path . "','" . $title . "','folder','0')"
+                                        VALUES ($course_id,'$path_documents".$folder_path."','".$title."','folder','0')"
                                     );
                                     $image_id = Database:: insert_id();
 
@@ -884,33 +884,33 @@ 
 
                             if (isset($value['file']) && !empty($value['file'])) {
                                 if (!file_exists(
-                                    $course_documents_folder . $value['file']
+                                    $course_documents_folder.$value['file']
                                 )
                                 ) {
                                     //Copying file
                                     copy(
-                                        $default_course_path . $value['file'],
-                                        $course_documents_folder . $value['file']
+                                        $default_course_path.$value['file'],
+                                        $course_documents_folder.$value['file']
                                     );
                                     chmod(
-                                        $course_documents_folder . $value['file'],
+                                        $course_documents_folder.$value['file'],
                                         $perm_file
                                     );
                                     //echo $default_course_path.$value['file']; echo ' - '; echo $course_documents_folder.$value['file']; echo '<br />';
                                     $temp = explode('/', $value['file']);
                                     $file_size = filesize(
-                                        $course_documents_folder . $value['file']
+                                        $course_documents_folder.$value['file']
                                     );
 
                                     //hack until feature #5242 is implemented
                                     if ($media_type == 'images/gallery') {
-                                        $value["file"] = 'gallery/' . $value["file"];
+                                        $value["file"] = 'gallery/'.$value["file"];
                                     }
 
                                     //Inserting file in the DB
                                     Database::query(
                                         "INSERT INTO $TABLETOOLDOCUMENT (c_id, path,title,filetype,size)
-                                        VALUES ($course_id,'$path_documents" . $value["file"] . "','" . $temp[count($temp) - 1] . "','file','$file_size')"
+                                        VALUES ($course_id,'$path_documents".$value["file"]."','".$temp[count($temp) - 1]."','file','$file_size')"
                                     );
                                     $image_id = Database:: insert_id();
                                     if ($image_id) {
@@ -918,7 +918,7 @@ 
                                         $sql = "UPDATE $TABLETOOLDOCUMENT SET id = iid WHERE iid = $image_id";
                                         Database::query($sql);
 
-                                        if ($path_documents . $value['file'] == '/certificates/default.html') {
+                                        if ($path_documents.$value['file'] == '/certificates/default.html') {
                                             $example_cert_id = $image_id;
                                         }
                                         Database::query(
@@ -958,7 +958,7 @@ 
                     'c_id' => $course_id,
                     'url' => 'http://www.google.com',
                     'title' => 'Google',
-                    'description' => get_lang('Google') ,
+                    'description' => get_lang('Google'),
                     'category_id' => 0,
                     'on_homepage' => 0,
                     'target' => '_self',
@@ -968,7 +968,7 @@ 
                     'c_id' => $course_id,
                     'url' => 'http://www.wikipedia.org',
                     'title' => 'Wikipedia',
-                    'description' => get_lang('Wikipedia') ,
+                    'description' => get_lang('Wikipedia'),
                     'category_id' => 0,
                     'on_homepage' => 0,
                     'target' => '_self',
@@ -976,7 +976,7 @@ 
                 ]
             ];
 
-            foreach($links as $params) {
+            foreach ($links as $params) {
                 $link->save($params);
             }
 
@@ -995,8 +995,8 @@ 
             /* Introduction text */
 
             $intro_text = '<p style="text-align: center;">
-                            <img src="' . api_get_path(REL_CODE_PATH) . 'img/mascot.png" alt="Mr. Chamilo" title="Mr. Chamilo" />
-                            <h2>' . self::lang2db(get_lang('IntroductionText')) . '</h2>
+                            <img src="' . api_get_path(REL_CODE_PATH).'img/mascot.png" alt="Mr. Chamilo" title="Mr. Chamilo" />
+                            <h2>' . self::lang2db(get_lang('IntroductionText')).'</h2>
                          </p>';
 
             $toolIntro = new Chamilo\CourseBundle\Entity\CToolIntro();
@@ -1032,9 +1032,9 @@ 
             $html = '<table width="100%" border="0" cellpadding="0" cellspacing="0">
                         <tr>
                         <td width="220" valign="top" align="left">
-                            <img src="' . api_get_path(WEB_CODE_PATH) . 'default_course_document/images/mr_chamilo/doubts.png">
+                            <img src="' . api_get_path(WEB_CODE_PATH).'default_course_document/images/mr_chamilo/doubts.png">
                         </td>
-                        <td valign="top" align="left">' . get_lang('Antique') . '</td></tr>
+                        <td valign="top" align="left">' . get_lang('Antique').'</td></tr>
                     </table>';
             $exercise->type = 1;
             $exercise->setRandom(0);
@@ -1279,7 +1279,7 @@ 
                 'https://'
             ) === false
         ) {
-            $department_url = 'http://' . $department_url;
+            $department_url = 'http://'.$department_url;
         }
         //just in case
         if ($department_url == 'http://') {
@@ -1290,26 +1290,26 @@ 
         if ($ok_to_register_course) {
 
             // Here we must add 2 fields.
-            $sql = "INSERT INTO " . $TABLECOURSE . " SET
+            $sql = "INSERT INTO ".$TABLECOURSE." SET
                         code = '".Database:: escape_string($code)."',
                         directory = '".Database:: escape_string($directory)."',
                         course_language = '".Database:: escape_string($course_language)."',
                         title = '".Database:: escape_string($title)."',
                         description = '".self::lang2db(get_lang('CourseDescription'))."',
                         category_code = '".Database:: escape_string($category_code)."',
-                        visibility      = '" . $visibility . "',
+                        visibility      = '" . $visibility."',
                         show_score      = '1',
-                        disk_quota      = '" . intval($disk_quota) . "',
+                        disk_quota      = '" . intval($disk_quota)."',
                         creation_date   = '$time',
-                        expiration_date = '" . $expiration_date . "',
+                        expiration_date = '".$expiration_date."',
                         last_edit       = '$time',
                         last_visit      = NULL,
-                        tutor_name = '" . Database:: escape_string($tutor_name) . "',
-                        department_name = '" . Database:: escape_string($department_name) . "',
-                        department_url = '" . Database:: escape_string($department_url) . "',
-                        subscribe = '" . intval($subscribe) . "',
-                        unsubscribe = '" . intval($unsubscribe) . "',
-                        visual_code = '" . Database:: escape_string($visual_code) . "'";
+                        tutor_name = '".Database:: escape_string($tutor_name)."',
+                        department_name = '" . Database:: escape_string($department_name)."',
+                        department_url = '" . Database:: escape_string($department_url)."',
+                        subscribe = '" . intval($subscribe)."',
+                        unsubscribe = '" . intval($unsubscribe)."',
+                        visual_code = '" . Database:: escape_string($visual_code)."'";
             Database::query($sql);
             $course_id = Database::insert_id();
 
@@ -1324,12 +1324,12 @@ 
                         $code
                     );
                     if (!empty($user_id)) {
-                        $sql = "INSERT INTO " . $TABLECOURSUSER . " SET
-                                c_id     = '" . $course_id . "',
-                                user_id         = '" . intval($user_id) . "',
+                        $sql = "INSERT INTO ".$TABLECOURSUSER." SET
+                                c_id     = '" . $course_id."',
+                                user_id         = '" . intval($user_id)."',
                                 status          = '1',
                                 is_tutor        = '0',
-                                sort            = '" . ($i_course_sort) . "',
+                                sort            = '" . ($i_course_sort)."',
                                 relation_type = 0,
                                 user_course_cat = '0'";
                         Database::query($sql);
@@ -1348,12 +1348,12 @@ 
                         if (empty($key)) {
                             continue;
                         }
-                        $sql = "INSERT INTO " . $TABLECOURSUSER . " SET
-                            c_id     = '" . Database::escape_string($course_id) . "',
-                            user_id         = '" . Database::escape_string($key) . "',
+                        $sql = "INSERT INTO ".$TABLECOURSUSER." SET
+                            c_id     = '" . Database::escape_string($course_id)."',
+                            user_id         = '" . Database::escape_string($key)."',
                             status          = '1',
                             is_tutor        = '0',
-                            sort            = '" . ($sort + 1) . "',
+                            sort            = '" . ($sort + 1)."',
                             relation_type = 0,
                             user_course_cat = '0'";
                         Database::query($sql);
@@ -1397,18 +1397,18 @@ 
                     $iname = api_get_setting('Institution');
                     $subject = get_lang(
                             'NewCourseCreatedIn'
-                        ) . ' ' . $siteName . ' - ' . $iname;
+                        ).' '.$siteName.' - '.$iname;
                     $message = get_lang(
                             'Dear'
-                        ) . ' ' . $recipient_name . ",\n\n" . get_lang(
+                        ).' '.$recipient_name.",\n\n".get_lang(
                             'MessageOfNewCourseToAdmin'
-                        ) . ' ' . $siteName . ' - ' . $iname . "\n";
-                    $message .= get_lang('CourseName') . ' ' . $title . "\n";
+                        ).' '.$siteName.' - '.$iname."\n";
+                    $message .= get_lang('CourseName').' '.$title."\n";
                     $message .= get_lang(
                             'Category'
-                        ) . ' ' . $category_code . "\n";
-                    $message .= get_lang('Tutor') . ' ' . $tutor_name . "\n";
-                    $message .= get_lang('Language') . ' ' . $course_language;
+                        ).' '.$category_code."\n";
+                    $message .= get_lang('Tutor').' '.$tutor_name."\n";
+                    $message .= get_lang('Language').' '.$course_language;
 
                     $userInfo = api_get_user_info($user_id);
 

main/inc/lib/add_courses_to_session_functions.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -10,7 +10,7 @@
 	 * Searches a course, given a search string and a type of search box
 	 * @param string $needle Search string
 	 * @param string $type Type of search box ('single' or anything else)
-	 * @return string XajaxResponse
+	 * @return xajaxResponse XajaxResponse
 	 * @assert ('abc', 'single') !== null
 	 * @assert ('abc', 'multiple') !== null
 	 */

Indentation +73 added lines, -73 removed lines

@@ -6,47 +6,47 @@ 
  */
 class AddCourseToSession
 {
-	/**
-	 * Searches a course, given a search string and a type of search box
-	 * @param string $needle Search string
-	 * @param string $type Type of search box ('single' or anything else)
-	 * @return string XajaxResponse
-	 * @assert ('abc', 'single') !== null
-	 * @assert ('abc', 'multiple') !== null
-	 */
-	public static function search_courses($needle, $type)
-	{
-		global $tbl_session_rel_course, $id_session;
+    /**
+     * Searches a course, given a search string and a type of search box
+     * @param string $needle Search string
+     * @param string $type Type of search box ('single' or anything else)
+     * @return string XajaxResponse
+     * @assert ('abc', 'single') !== null
+     * @assert ('abc', 'multiple') !== null
+     */
+    public static function search_courses($needle, $type)
+    {
+        global $tbl_session_rel_course, $id_session;
         $tbl_course = Database::get_main_table(TABLE_MAIN_COURSE);
-		$course_title = null;
-		$xajax_response = new xajaxResponse();
-		$return = '';
-		if(!empty($needle) && !empty($type)) {
-			// xajax send utf8 datas... datas in db can be non-utf8 datas
-			$charset = api_get_system_encoding();
-			$needle = api_convert_encoding($needle, $charset, 'utf-8');
+        $course_title = null;
+        $xajax_response = new xajaxResponse();
+        $return = '';
+        if(!empty($needle) && !empty($type)) {
+            // xajax send utf8 datas... datas in db can be non-utf8 datas
+            $charset = api_get_system_encoding();
+            $needle = api_convert_encoding($needle, $charset, 'utf-8');
 
-			$cond_course_code = '';
-			if (!empty($id_session)) {
-				$id_session = intval($id_session);
-				// check course_code from session_rel_course table
-				$sql = 'SELECT c_id FROM '.$tbl_session_rel_course.'
+            $cond_course_code = '';
+            if (!empty($id_session)) {
+                $id_session = intval($id_session);
+                // check course_code from session_rel_course table
+                $sql = 'SELECT c_id FROM '.$tbl_session_rel_course.'
 						WHERE session_id = '.$id_session;
-				$res = Database::query($sql);
-				$course_codes = '';
-				if (Database::num_rows($res) > 0) {
-					while ($row = Database::fetch_row($res)) {
-						$course_codes .= '\''.$row[0].'\',';
-					}
-					$course_codes = substr($course_codes,0,(strlen($course_codes)-1));
+                $res = Database::query($sql);
+                $course_codes = '';
+                if (Database::num_rows($res) > 0) {
+                    while ($row = Database::fetch_row($res)) {
+                        $course_codes .= '\''.$row[0].'\',';
+                    }
+                    $course_codes = substr($course_codes,0,(strlen($course_codes)-1));
 
-					$cond_course_code = ' AND course.id NOT IN('.$course_codes.') ';
-				}
-			}
+                    $cond_course_code = ' AND course.id NOT IN('.$course_codes.') ';
+                }
+            }
 
-			if ($type=='single') {
-				// search users where username or firstname or lastname begins likes $needle
-				$sql = 'SELECT
+            if ($type=='single') {
+                // search users where username or firstname or lastname begins likes $needle
+                $sql = 'SELECT
 							course.code,
 						 	course.visual_code,
 						 	course.title,
@@ -58,21 +58,21 @@ 
 						WHERE
 							course.visual_code LIKE "'.$needle.'%" OR
 							course.title LIKE "'.$needle.'%"';
-			} else {
-				$sql = 'SELECT course.code, course.visual_code, course.title
+            } else {
+                $sql = 'SELECT course.code, course.visual_code, course.title
 						FROM '.$tbl_course.' course
 						WHERE
 							course.visual_code LIKE "'.$needle.'%" '.$cond_course_code.'
 						ORDER BY course.code ';
-			}
+            }
 
-			if (api_is_multiple_url_enabled()) {
-				$tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
-				$access_url_id = api_get_current_access_url_id();
-				if ($access_url_id != -1){
+            if (api_is_multiple_url_enabled()) {
+                $tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
+                $access_url_id = api_get_current_access_url_id();
+                if ($access_url_id != -1){
 
-					if ($type=='single') {
-						$sql = 'SELECT
+                    if ($type=='single') {
+                        $sql = 'SELECT
 						            course.code,
 						            course.visual_code,
 						            course.title,
@@ -87,42 +87,42 @@ 
 									access_url_id = '.$access_url_id.' AND
 									(course.visual_code LIKE "'.$needle.'%" OR
 									course.title LIKE "'.$needle.'%" )';
-					} else {
-						$sql = 'SELECT course.code, course.visual_code, course.title
+                    } else {
+                        $sql = 'SELECT course.code, course.visual_code, course.title
 								FROM '.$tbl_course.' course, '.$tbl_course_rel_access_url.' url_course
 								WHERE
 									url_course.c_id = course.id AND
 									access_url_id = '.$access_url_id.' AND
 									course.visual_code LIKE "'.$needle.'%" '.$cond_course_code.'
 								ORDER BY course.code ';
-					}
-				}
-			}
+                    }
+                }
+            }
 
-			$rs = Database::query($sql);
-			$course_list = array();
-			if ($type=='single') {
+            $rs = Database::query($sql);
+            $course_list = array();
+            if ($type=='single') {
 
-				while($course = Database :: fetch_array($rs)) {
-					$course_list[] = $course['code'];
-					$course_title=str_replace("'","\'",$course_title);
-					$return .= '<a href="javascript: void(0);" onclick="javascript: add_course_to_session(\''.$course['code'].'\',\''.$course_title.' ('.$course['visual_code'].')'.'\')">'.$course['title'].' ('.$course['visual_code'].')</a><br />';
-				}
-				$xajax_response -> addAssign('ajax_list_courses_single','innerHTML',api_utf8_encode($return));
-			} else {
-				$return .= '<select id="origin" name="NoSessionCoursesList[]" multiple="multiple" size="20" style="width:340px;">';
-				while($course = Database :: fetch_array($rs)) {
-					$course_list[] = $course['code'];
-					$course_title=str_replace("'","\'",$course_title);
-					$return .= '<option value="'.$course['code'].'" title="'.htmlspecialchars($course['title'].' ('.$course['visual_code'].')',ENT_QUOTES).'">'.$course['title'].' ('.$course['visual_code'].')</option>';
-				}
-				$return .= '</select>';
+                while($course = Database :: fetch_array($rs)) {
+                    $course_list[] = $course['code'];
+                    $course_title=str_replace("'","\'",$course_title);
+                    $return .= '<a href="javascript: void(0);" onclick="javascript: add_course_to_session(\''.$course['code'].'\',\''.$course_title.' ('.$course['visual_code'].')'.'\')">'.$course['title'].' ('.$course['visual_code'].')</a><br />';
+                }
+                $xajax_response -> addAssign('ajax_list_courses_single','innerHTML',api_utf8_encode($return));
+            } else {
+                $return .= '<select id="origin" name="NoSessionCoursesList[]" multiple="multiple" size="20" style="width:340px;">';
+                while($course = Database :: fetch_array($rs)) {
+                    $course_list[] = $course['code'];
+                    $course_title=str_replace("'","\'",$course_title);
+                    $return .= '<option value="'.$course['code'].'" title="'.htmlspecialchars($course['title'].' ('.$course['visual_code'].')',ENT_QUOTES).'">'.$course['title'].' ('.$course['visual_code'].')</option>';
+                }
+                $return .= '</select>';
 
-				$xajax_response -> addAssign('ajax_list_courses_multiple','innerHTML',api_utf8_encode($return));
-			}
-		}
-		$_SESSION['course_list'] = $course_list;
+                $xajax_response -> addAssign('ajax_list_courses_multiple','innerHTML',api_utf8_encode($return));
+            }
+        }
+        $_SESSION['course_list'] = $course_list;
 
-		return $xajax_response;
-	}
+        return $xajax_response;
+    }
 }

Spacing +13 added lines, -13 removed lines

@@ -21,7 +21,7 @@ 
 		$course_title = null;
 		$xajax_response = new xajaxResponse();
 		$return = '';
-		if(!empty($needle) && !empty($type)) {
+		if (!empty($needle) && !empty($type)) {
 			// xajax send utf8 datas... datas in db can be non-utf8 datas
 			$charset = api_get_system_encoding();
 			$needle = api_convert_encoding($needle, $charset, 'utf-8');
@@ -38,13 +38,13 @@ 
 					while ($row = Database::fetch_row($res)) {
 						$course_codes .= '\''.$row[0].'\',';
 					}
-					$course_codes = substr($course_codes,0,(strlen($course_codes)-1));
+					$course_codes = substr($course_codes, 0, (strlen($course_codes) - 1));
 
 					$cond_course_code = ' AND course.id NOT IN('.$course_codes.') ';
 				}
 			}
 
-			if ($type=='single') {
+			if ($type == 'single') {
 				// search users where username or firstname or lastname begins likes $needle
 				$sql = 'SELECT
 							course.code,
@@ -69,9 +69,9 @@ 
 			if (api_is_multiple_url_enabled()) {
 				$tbl_course_rel_access_url = Database::get_main_table(TABLE_MAIN_ACCESS_URL_REL_COURSE);
 				$access_url_id = api_get_current_access_url_id();
-				if ($access_url_id != -1){
+				if ($access_url_id != -1) {
 
-					if ($type=='single') {
+					if ($type == 'single') {
 						$sql = 'SELECT
 						            course.code,
 						            course.visual_code,
@@ -101,24 +101,24 @@ 
 
 			$rs = Database::query($sql);
 			$course_list = array();
-			if ($type=='single') {
+			if ($type == 'single') {
 
-				while($course = Database :: fetch_array($rs)) {
+				while ($course = Database :: fetch_array($rs)) {
 					$course_list[] = $course['code'];
-					$course_title=str_replace("'","\'",$course_title);
+					$course_title = str_replace("'", "\'", $course_title);
 					$return .= '<a href="javascript: void(0);" onclick="javascript: add_course_to_session(\''.$course['code'].'\',\''.$course_title.' ('.$course['visual_code'].')'.'\')">'.$course['title'].' ('.$course['visual_code'].')</a><br />';
 				}
-				$xajax_response -> addAssign('ajax_list_courses_single','innerHTML',api_utf8_encode($return));
+				$xajax_response -> addAssign('ajax_list_courses_single', 'innerHTML', api_utf8_encode($return));
 			} else {
 				$return .= '<select id="origin" name="NoSessionCoursesList[]" multiple="multiple" size="20" style="width:340px;">';
-				while($course = Database :: fetch_array($rs)) {
+				while ($course = Database :: fetch_array($rs)) {
 					$course_list[] = $course['code'];
-					$course_title=str_replace("'","\'",$course_title);
-					$return .= '<option value="'.$course['code'].'" title="'.htmlspecialchars($course['title'].' ('.$course['visual_code'].')',ENT_QUOTES).'">'.$course['title'].' ('.$course['visual_code'].')</option>';
+					$course_title = str_replace("'", "\'", $course_title);
+					$return .= '<option value="'.$course['code'].'" title="'.htmlspecialchars($course['title'].' ('.$course['visual_code'].')', ENT_QUOTES).'">'.$course['title'].' ('.$course['visual_code'].')</option>';
 				}
 				$return .= '</select>';
 
-				$xajax_response -> addAssign('ajax_list_courses_multiple','innerHTML',api_utf8_encode($return));
+				$xajax_response -> addAssign('ajax_list_courses_multiple', 'innerHTML', api_utf8_encode($return));
 			}
 		}
 		$_SESSION['course_list'] = $course_list;

main/inc/lib/add_many_session_to_category_functions.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -17,7 +17,7 @@
      * Search for a session based on a given search string
      * @param string A search string
      * @param string A search box type (single or anything else)
-     * @return string XajaxResponse
+     * @return xajaxResponse XajaxResponse
      * @assert () !== ''
      * @assert ('abc','single') !== ''
      */

Spacing +5 added lines, -5 removed lines

@@ -21,12 +21,12 @@ 
      * @assert () !== ''
      * @assert ('abc','single') !== ''
      */
-    function search_courses($needle,$type)
+    function search_courses($needle, $type)
     {
         $tbl_session = Database :: get_main_table(TABLE_MAIN_SESSION);
 		$xajax_response = new xajaxResponse();
 		$return = '';
-		if(!empty($needle) && !empty($type)) {
+		if (!empty($needle) && !empty($type)) {
 			// xajax send utf8 datas... datas in db can be non-utf8 datas
 			$charset = api_get_system_encoding();
 			$needle = api_convert_encoding($needle, $charset, 'utf-8');
@@ -38,12 +38,12 @@ 
 			$course_list = array();
 
 			$return .= '<select id="origin" name="NoSessionCategoryList[]" multiple="multiple" size="20" style="width:340px;">';
-			while($course = Database :: fetch_array($rs)) {
+			while ($course = Database :: fetch_array($rs)) {
 				$course_list[] = $course['id'];
-				$return .= '<option value="'.$course['id'].'" title="'.htmlspecialchars($course['name'],ENT_QUOTES).'">'.$course['name'].'</option>';
+				$return .= '<option value="'.$course['id'].'" title="'.htmlspecialchars($course['name'], ENT_QUOTES).'">'.$course['name'].'</option>';
 			}
 			$return .= '</select>';
-			$xajax_response -> addAssign('ajax_list_courses_multiple','innerHTML',api_utf8_encode($return));
+			$xajax_response -> addAssign('ajax_list_courses_multiple', 'innerHTML', api_utf8_encode($return));
 		}
 		$_SESSION['course_list'] = $course_list;
 		return $xajax_response;

Indentation +21 added lines, -21 removed lines

@@ -24,28 +24,28 @@
     function search_courses($needle,$type)
     {
         $tbl_session = Database :: get_main_table(TABLE_MAIN_SESSION);
-		$xajax_response = new xajaxResponse();
-		$return = '';
-		if(!empty($needle) && !empty($type)) {
-			// xajax send utf8 datas... datas in db can be non-utf8 datas
-			$charset = api_get_system_encoding();
-			$needle = api_convert_encoding($needle, $charset, 'utf-8');
-			$needle = Database::escape_string($needle);
+        $xajax_response = new xajaxResponse();
+        $return = '';
+        if(!empty($needle) && !empty($type)) {
+            // xajax send utf8 datas... datas in db can be non-utf8 datas
+            $charset = api_get_system_encoding();
+            $needle = api_convert_encoding($needle, $charset, 'utf-8');
+            $needle = Database::escape_string($needle);
 
-			$sql = 'SELECT * FROM '.$tbl_session.' WHERE name LIKE "'.$needle.'%" ORDER BY id';
+            $sql = 'SELECT * FROM '.$tbl_session.' WHERE name LIKE "'.$needle.'%" ORDER BY id';
 
-			$rs = Database::query($sql);
-			$course_list = array();
+            $rs = Database::query($sql);
+            $course_list = array();
 
-			$return .= '<select id="origin" name="NoSessionCategoryList[]" multiple="multiple" size="20" style="width:340px;">';
-			while($course = Database :: fetch_array($rs)) {
-				$course_list[] = $course['id'];
-				$return .= '<option value="'.$course['id'].'" title="'.htmlspecialchars($course['name'],ENT_QUOTES).'">'.$course['name'].'</option>';
-			}
-			$return .= '</select>';
-			$xajax_response -> addAssign('ajax_list_courses_multiple','innerHTML',api_utf8_encode($return));
-		}
-		$_SESSION['course_list'] = $course_list;
-		return $xajax_response;
-	}
+            $return .= '<select id="origin" name="NoSessionCategoryList[]" multiple="multiple" size="20" style="width:340px;">';
+            while($course = Database :: fetch_array($rs)) {
+                $course_list[] = $course['id'];
+                $return .= '<option value="'.$course['id'].'" title="'.htmlspecialchars($course['name'],ENT_QUOTES).'">'.$course['name'].'</option>';
+            }
+            $return .= '</select>';
+            $xajax_response -> addAssign('ajax_list_courses_multiple','innerHTML',api_utf8_encode($return));
+        }
+        $_SESSION['course_list'] = $course_list;
+        return $xajax_response;
+    }
 }

main/inc/lib/AnnouncementEmail.php

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
     /**
      *
      * @param int|array $course
-     * @param int|array $annoucement
+     * @param integer $announcement
      *
      * @return AnnouncementEmail
      */
@@ -50,7 +50,7 @@ 
      *
      * @param string $key
      *
-     * @return array
+     * @return string|null
      */
     public function course($key = '')
     {

Spacing +1 added lines, -1 removed lines

@@ -196,7 +196,7 @@
      *
      * @return array
      */
-    public function sender($key = '',  $userId = '')
+    public function sender($key = '', $userId = '')
     {
         $_user = api_get_user_info($userId);
 

main/inc/lib/AnnouncementManager.php

Doc Comments +9 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_tags()
     {
@@ -40,7 +40,7 @@ 
      * @param string    $course_code
      * @param int       $session_id
      *
-     * @return mixed
+     * @return string
      */
     public static function parse_content($userId, $content, $course_code, $session_id = 0)
     {
@@ -349,7 +349,7 @@ 
      * @param array	    uploaded file $_FILES
      * @param string    Comment describing the attachment
      * @param bool  $sendToUsersInSession
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $emailTitle,
@@ -460,7 +460,7 @@ 
      * @param $to_users
      * @param array $file
      * @param string $file_comment
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $emailTitle,
@@ -699,7 +699,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -719,6 +719,7 @@ 
      * Gets all announcements from a user by course
      * @param	string course db
      * @param	int user id
+     * @param integer $user_id
      * @return	array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1184,6 +1185,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1308,6 +1310,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file($id_attach, $file, $file_comment)

Indentation +1 added lines, -1 removed lines

@@ -1510,7 +1510,7 @@
                             ip.to_user_id=$user_id OR (ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".implode(", ", $group_memberships)."))
                         ) ";
                     } else {
-                       $cond_user_id = " AND (
+                        $cond_user_id = " AND (
                             ip.to_user_id=$user_id OR (ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".api_get_group_id()."))
                         )";
                     }

Spacing +73 added lines, -73 removed lines

@@ -216,8 +216,8 @@ 
                             announcement.id = '$announcement_id' AND
                             toolitemproperties.tool='announcement' AND
                             (
-                                toolitemproperties.to_user_id='" . api_get_user_id() . "' OR
-                                toolitemproperties.to_group_id IN ('0', '" . implode("', '", $group_list) . "') OR
+                                toolitemproperties.to_user_id='".api_get_user_id()."' OR
+                                toolitemproperties.to_group_id IN ('0', '" . implode("', '", $group_list)."') OR
                                 toolitemproperties.to_group_id IS NULL
                             ) AND
                             toolitemproperties.visibility='1' AND
@@ -246,13 +246,13 @@ 
             $title = $result['title'];
             $content = $result['content'];
             $html .= "<table height=\"100\" width=\"100%\" cellpadding=\"5\" cellspacing=\"0\" class=\"data_table\">";
-            $html .= "<tr><td><h2>" . $title . "</h2></td></tr>";
+            $html .= "<tr><td><h2>".$title."</h2></td></tr>";
 
             if (api_is_allowed_to_edit(false, true) ||
                 (api_get_course_setting('allow_user_edit_announcement') && !api_is_anonymous())
             ) {
-                $modify_icons = "<a href=\"" . api_get_self() . "?" . api_get_cidreq() . "&action=modify&id=" . $announcement_id . "\">" .
-                    Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL) . "</a>";
+                $modify_icons = "<a href=\"".api_get_self()."?".api_get_cidreq()."&action=modify&id=".$announcement_id."\">".
+                    Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL)."</a>";
                 if ($result['visibility'] == 1) {
                     $image_visibility = "visible";
                     $alt_visibility = get_lang('Hide');
@@ -262,12 +262,12 @@ 
                 }
                 global $stok;
 
-                $modify_icons .= "<a href=\"" . api_get_self() . "?" . api_get_cidreq() . "&origin=" . (!empty($_GET['origin']) ? Security::remove_XSS($_GET['origin']) : '') . "&action=showhide&id=" . $announcement_id . "&sec_token=" . $stok . "\">" .
-                    Display::return_icon($image_visibility . '.png', $alt_visibility, '', ICON_SIZE_SMALL) . "</a>";
+                $modify_icons .= "<a href=\"".api_get_self()."?".api_get_cidreq()."&origin=".(!empty($_GET['origin']) ? Security::remove_XSS($_GET['origin']) : '')."&action=showhide&id=".$announcement_id."&sec_token=".$stok."\">".
+                    Display::return_icon($image_visibility.'.png', $alt_visibility, '', ICON_SIZE_SMALL)."</a>";
 
                 if (api_is_allowed_to_edit(false, true)) {
-                    $modify_icons .= "<a href=\"" . api_get_self() . "?" . api_get_cidreq() . "&action=delete&id=" . $announcement_id . "&sec_token=" . $stok . "\" onclick=\"javascript:if(!confirm('" . addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, $charset)) . "')) return false;\">" .
-                        Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL) .
+                    $modify_icons .= "<a href=\"".api_get_self()."?".api_get_cidreq()."&action=delete&id=".$announcement_id."&sec_token=".$stok."\" onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, $charset))."')) return false;\">".
+                        Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).
                         "</a>";
                 }
                 $html .= "<tr><th style='text-align:right'>$modify_icons</th></tr>";
@@ -276,7 +276,7 @@ 
             $content = self::parse_content($result['to_user_id'], $content, api_get_course_id(), api_get_session_id());
 
             $html .= "<tr><td>$content</td></tr>";
-            $html .= "<tr><td class=\"announcements_datum\">" . get_lang('LastUpdateDate') . " : " . api_convert_and_format_date($result['insert_date'], DATE_TIME_FORMAT_LONG) . "</td></tr>";
+            $html .= "<tr><td class=\"announcements_datum\">".get_lang('LastUpdateDate')." : ".api_convert_and_format_date($result['insert_date'], DATE_TIME_FORMAT_LONG)."</td></tr>";
 
             // User or group icon
             $sent_to_icon = '';
@@ -288,7 +288,7 @@ 
                 $sent_to_form = self::sent_to_form($sent_to);
                 $html .= Display::tag(
                     'td',
-                    get_lang('SentTo') . ' : ' . $sent_to_form,
+                    get_lang('SentTo').' : '.$sent_to_form,
                     array('class' => 'announcements_datum')
                 );
             }
@@ -298,15 +298,15 @@ 
                 $html .= "<tr><td>";
                 $realname = $attachment_list['path'];
                 $user_filename = $attachment_list['filename'];
-                $full_file_name = 'download.php?'.api_get_cidreq().'&file=' . $realname;
+                $full_file_name = 'download.php?'.api_get_cidreq().'&file='.$realname;
                 $html .= '<br/>';
                 $html .= Display::return_icon('attachment.gif', get_lang('Attachment'));
-                $html .= '<a href="' . $full_file_name . ' "> ' . $user_filename . ' </a>';
-                $html .= ' - <span class="forum_attach_comment" >' . $attachment_list['comment'] . '</span>';
+                $html .= '<a href="'.$full_file_name.' "> '.$user_filename.' </a>';
+                $html .= ' - <span class="forum_attach_comment" >'.$attachment_list['comment'].'</span>';
                 if (api_is_allowed_to_edit(false, true)) {
                     $html .= Display::url(
                         Display::return_icon('delete.png', get_lang('Delete'), '', 16),
-                        api_get_self() . "?" . api_get_cidreq() . "&action=delete_attachment&id_attach=" . $attachment_list['id'] . "&sec_token=" . $stok
+                        api_get_self()."?".api_get_cidreq()."&action=delete_attachment&id_attach=".$attachment_list['id']."&sec_token=".$stok
                     );
                 }
                 $html .= '</td></tr>';
@@ -334,7 +334,7 @@ 
         $order = 0;
         if (Database::num_rows($res_max)) {
             $row_max = Database::fetch_array($res_max);
-            $order = intval($row_max[0])+1;
+            $order = intval($row_max[0]) + 1;
         }
 
         return $order;
@@ -754,8 +754,8 @@ 
             $result = array();
             if ($num_rows > 0) {
                 while ($myrow = Database::fetch_array($rs)) {
-                    $content.= '<strong>' . $myrow['title'] . '</strong><br /><br />';
-                    $content.= $myrow['content'];
+                    $content .= '<strong>'.$myrow['title'].'</strong><br /><br />';
+                    $content .= $myrow['content'];
                     $i++;
                 }
                 $result['content'] = $content;
@@ -786,7 +786,7 @@ 
         echo "<table id=\"recipient_list\" >";
         echo '<tr>';
         echo '<td>';
-        echo '<label><input type="checkbox" id="send_to_all_users">'.get_lang('SendToAllUsers') . "</label>";
+        echo '<label><input type="checkbox" id="send_to_all_users">'.get_lang('SendToAllUsers')."</label>";
         echo "</td>";
         echo '</tr>';
         echo '<tr>';
@@ -794,7 +794,7 @@ 
 
         // the form containing all the groups and all the users of the course
         echo '<td>';
-        echo "<strong>" . get_lang('Users') . "</strong><br />";
+        echo "<strong>".get_lang('Users')."</strong><br />";
 
         self::construct_not_selected_select_form($groupList, $userList, $to_already_selected);
         echo "</td>";
@@ -809,7 +809,7 @@ 
         echo "<td>";
 
         // the form containing the selected groups and users
-        echo "<strong>" . get_lang('DestinationUsers') . "</strong><br />";
+        echo "<strong>".get_lang('DestinationUsers')."</strong><br />";
         self::construct_selected_select_form($groupList, $userList, $to_already_selected);
         echo "</td>";
         echo "</tr>";
@@ -827,8 +827,8 @@ 
         echo "<select id=\"not_selected_form\" name=\"not_selected_form[]\" size=5 style=\"width:200px\" multiple>";
         $group_users = GroupManager::getStudentsAndTutors($group_id);
         foreach ($group_users as $user) {
-            echo '<option value="' . $user['user_id'] . '" title="' . sprintf(get_lang('LoginX'), $user['username']) . '" >' .
-                api_get_person_name($user['firstname'], $user['lastname']) .
+            echo '<option value="'.$user['user_id'].'" title="'.sprintf(get_lang('LoginX'), $user['username']).'" >'.
+                api_get_person_name($user['firstname'], $user['lastname']).
                 '</option>';
         }
         echo '</select>';
@@ -866,12 +866,12 @@ 
         if (!empty($groupList)) {
             foreach ($groupList as $this_group) {
                 if (is_array($to_already_selected)) {
-                    if (!in_array("GROUP:" . $this_group['id'], $to_already_selected)) {
+                    if (!in_array("GROUP:".$this_group['id'], $to_already_selected)) {
                         // $to_already_selected is the array containing the groups (and users) that are already selected
-                        $user_label = ($this_group['userNb'] > 0) ? get_lang('Users') : get_lang('LowerCaseUser') ;
-                        $user_disabled = ($this_group['userNb'] > 0) ? "" : "disabled=disabled" ;
-                        echo "<option $user_disabled value=\"GROUP:" . $this_group['id'] . "\">",
-                        "G: ", $this_group['name'], " - " . $this_group['userNb'] . " " . $user_label .
+                        $user_label = ($this_group['userNb'] > 0) ? get_lang('Users') : get_lang('LowerCaseUser');
+                        $user_disabled = ($this_group['userNb'] > 0) ? "" : "disabled=disabled";
+                        echo "<option $user_disabled value=\"GROUP:".$this_group['id']."\">",
+                        "G: ", $this_group['name'], " - ".$this_group['userNb']." ".$user_label.
                             "</option>";
                     }
                 }
@@ -885,15 +885,15 @@ 
         if (!empty($userList)) {
             foreach ($userList as $user) {
                 if (is_array($to_already_selected)) {
-                    if (!in_array("USER:" . $user['user_id'], $to_already_selected)) {
+                    if (!in_array("USER:".$user['user_id'], $to_already_selected)) {
                         // $to_already_selected is the array containing the users (and groups) that are already selected
-                        echo "<option value=\"USER:" . $user['user_id'] . "\" title='" . sprintf(get_lang('LoginX'), $user['username']) . "'>",
+                        echo "<option value=\"USER:".$user['user_id']."\" title='".sprintf(get_lang('LoginX'), $user['username'])."'>",
                         "", api_get_person_name($user['firstname'], $user['lastname']),
                         "</option>";
 
                         if (isset($user['drh_list']) && !empty($user['drh_list'])) {
                             foreach ($user['drh_list'] as $drh) {
-                                echo "<option value=\"USER:" . $drh['user_id'] . "\" title='" . sprintf(get_lang('LoginX'), $drh['username']) . "'>&nbsp;&nbsp;&nbsp;&nbsp;",
+                                echo "<option value=\"USER:".$drh['user_id']."\" title='".sprintf(get_lang('LoginX'), $drh['username'])."'>&nbsp;&nbsp;&nbsp;&nbsp;",
                                 "", api_get_person_name($drh['firstname'], $drh['lastname']),
                                 "</option>";
                             }
@@ -925,16 +925,16 @@ 
             foreach ($to_already_selected as $groupuser) {
                 list($type, $id) = explode(":", $groupuser);
                 if ($type == "GROUP") {
-                    echo "<option value=\"" . $groupuser . "\">G: " . $ref_array_groups[$id]['name'] . "</option>";
+                    echo "<option value=\"".$groupuser."\">G: ".$ref_array_groups[$id]['name']."</option>";
                 } else {
                     foreach ($ref_array_users as $key => $value) {
                         if ($value['user_id'] == $id) {
-                            echo "<option value=\"" . $groupuser . "\" title='" . sprintf(get_lang('LoginX'), $value['username']) . "'>" .
-                                api_get_person_name($value['firstname'], $value['lastname']) . "</option>";
+                            echo "<option value=\"".$groupuser."\" title='".sprintf(get_lang('LoginX'), $value['username'])."'>".
+                                api_get_person_name($value['firstname'], $value['lastname'])."</option>";
 
                             if (isset($value['drh_list']) && !empty($value['drh_list'])) {
                                 foreach ($value['drh_list'] as $drh) {
-                                    echo "<option value=\"USER:" . $drh['user_id'] . "\" title='" . sprintf(get_lang('LoginX'), $drh['username']) . "'>&nbsp;&nbsp;&nbsp;&nbsp;",
+                                    echo "<option value=\"USER:".$drh['user_id']."\" title='".sprintf(get_lang('LoginX'), $drh['username'])."'>&nbsp;&nbsp;&nbsp;&nbsp;",
                                     "", api_get_person_name($drh['firstname'], $drh['lastname']),
                                     "</option>";
                                 }
@@ -950,17 +950,17 @@ 
                 if (is_array($ref_array_groups)) {
                     foreach ($ref_array_groups as $this_group) {
                         //api_display_normal_message("group " . $thisGroup[id] . $thisGroup[name]);
-                        if (!is_array($to_already_selected) || !in_array("GROUP:" . $this_group['id'], $to_already_selected)) { // $to_already_selected is the array containing the groups (and users) that are already selected
-                            echo "<option value=\"GROUP:" . $this_group['id'] . "\">",
-                            "G: ", $this_group['name'], " &ndash; " . $this_group['userNb'] . " " . get_lang('Users') .
+                        if (!is_array($to_already_selected) || !in_array("GROUP:".$this_group['id'], $to_already_selected)) { // $to_already_selected is the array containing the groups (and users) that are already selected
+                            echo "<option value=\"GROUP:".$this_group['id']."\">",
+                            "G: ", $this_group['name'], " &ndash; ".$this_group['userNb']." ".get_lang('Users').
                                 "</option>";
                         }
                     }
                 }
                 // adding the individual users to the select form
                 foreach ($ref_array_users as $this_user) {
-                    if (!is_array($to_already_selected) || !in_array("USER:" . $this_user['user_id'], $to_already_selected)) { // $to_already_selected is the array containing the users (and groups) that are already selected
-                        echo "<option value=\"USER:", $this_user['user_id'], "\"  title='" . sprintf(get_lang('LoginX'), $this_user['username']) . "'>",
+                    if (!is_array($to_already_selected) || !in_array("USER:".$this_user['user_id'], $to_already_selected)) { // $to_already_selected is the array containing the users (and groups) that are already selected
+                        echo "<option value=\"USER:", $this_user['user_id'], "\"  title='".sprintf(get_lang('LoginX'), $this_user['username'])."'>",
                         "", api_get_person_name($this_user['firstname'], $this_user['lastname']),
                         "</option>";
                     }
@@ -1073,14 +1073,14 @@ 
             switch ($to_group) {
                 // it was send to one specific user
                 case null:
-                    $to[] = "USER:" . $row['to_user_id'];
+                    $to[] = "USER:".$row['to_user_id'];
                     break;
                 // it was sent to everyone
                 case 0:
                     return "everyone";
                     break;
                 default:
-                    $to[] = "GROUP:" . $row['to_group_id'];
+                    $to[] = "GROUP:".$row['to_group_id'];
             }
         }
         return $to;
@@ -1161,10 +1161,10 @@ 
                 $sent_to_array['groups'][0] !== 0
             ) {
                 $group_id = $sent_to_array['groups'][0];
-                $output[] = "&nbsp;" . $group_names[$group_id]['name'];
+                $output[] = "&nbsp;".$group_names[$group_id]['name'];
             }
             if (empty($sent_to_array['groups']) and empty($sent_to_array['users'])) {
-                $output[] = "&nbsp;" . get_lang('Everybody');
+                $output[] = "&nbsp;".get_lang('Everybody');
             }
         }
 
@@ -1199,7 +1199,7 @@ 
 
         $sql = "SELECT to_group_id, to_user_id
                 FROM $tbl_item_property
-                WHERE c_id = $course_id AND tool = '$tool' AND ref=" . $id;
+                WHERE c_id = $course_id AND tool = '$tool' AND ref=".$id;
         $result = Database::query($sql);
 
         while ($row = Database::fetch_array($result)) {
@@ -1238,8 +1238,8 @@ 
         $announcement_id = intval($announcement_id);
         $course_id = api_get_course_int_id();
         $row = array();
-        $sql = 'SELECT id, path, filename, comment FROM ' . $tbl_announcement_attachment . '
-				WHERE c_id = ' . $course_id . ' AND announcement_id = ' . $announcement_id . '';
+        $sql = 'SELECT id, path, filename, comment FROM '.$tbl_announcement_attachment.'
+				WHERE c_id = ' . $course_id.' AND announcement_id = '.$announcement_id.'';
         $result = Database::query($sql);
         if (Database::num_rows($result) != 0) {
             $row = Database::fetch_array($result, 'ASSOC');
@@ -1264,9 +1264,9 @@ 
 
         if (is_array($file) && $file['error'] == 0) {
             // TODO: This path is obsolete. The new document repository scheme should be kept in mind here.
-            $courseDir = $_course['path'] . '/upload/announcements';
+            $courseDir = $_course['path'].'/upload/announcements';
             $sys_course_path = api_get_path(SYS_COURSE_PATH);
-            $updir = $sys_course_path . $courseDir;
+            $updir = $sys_course_path.$courseDir;
 
             // Try to add an extension to the file if it hasn't one
             $new_file_name = add_ext_on_mime(stripslashes($file['name']), $file['type']);
@@ -1278,7 +1278,7 @@ 
                 Display :: display_error_message(get_lang('UplUnableToSaveFileFilteredExtension'));
             } else {
                 $new_file_name = uniqid('');
-                $new_path = $updir . '/' . $new_file_name;
+                $new_path = $updir.'/'.$new_file_name;
                 move_uploaded_file($file['tmp_name'], $new_path);
 
                 $params = [
@@ -1319,9 +1319,9 @@ 
 
         if (is_array($file) && $file['error'] == 0) {
             // TODO: This path is obsolete. The new document repository scheme should be kept in mind here.
-            $courseDir = $_course['path'] . '/upload/announcements';
+            $courseDir = $_course['path'].'/upload/announcements';
             $sys_course_path = api_get_path(SYS_COURSE_PATH);
-            $updir = $sys_course_path . $courseDir;
+            $updir = $sys_course_path.$courseDir;
 
             // Try to add an extension to the file if it hasn't one
             $new_file_name = add_ext_on_mime(stripslashes($file['name']), $file['type']);
@@ -1333,13 +1333,13 @@ 
                 Display :: display_error_message(get_lang('UplUnableToSaveFileFilteredExtension'));
             } else {
                 $new_file_name = uniqid('');
-                $new_path = $updir . '/' . $new_file_name;
+                $new_path = $updir.'/'.$new_file_name;
                 @move_uploaded_file($file['tmp_name'], $new_path);
                 $safe_file_comment = Database::escape_string($file_comment);
                 $safe_file_name = Database::escape_string($file_name);
                 $safe_new_file_name = Database::escape_string($new_file_name);
                 $id_attach = intval($id_attach);
-                $sql = "UPDATE $tbl_announcement_attachment SET filename = '$safe_file_name', comment = '$safe_file_comment', path = '$safe_new_file_name', size ='" . intval($file['size']) . "'
+                $sql = "UPDATE $tbl_announcement_attachment SET filename = '$safe_file_name', comment = '$safe_file_comment', path = '$safe_new_file_name', size ='".intval($file['size'])."'
 					 	WHERE c_id = $course_id AND id = '$id_attach'";
                 $result = Database::query($sql);
                 if ($result === false) {
@@ -1441,7 +1441,7 @@ 
 
             //if (!empty($user_id)) {
             if (0) {
-                if (is_array($group_memberships) && count($group_memberships) > 0 ) {
+                if (is_array($group_memberships) && count($group_memberships) > 0) {
                     $sql = "SELECT $select
                             FROM $tbl_announcement announcement, $tbl_item_property ip
                             WHERE
@@ -1652,8 +1652,8 @@ 
                 $attachment_list = AnnouncementManager::get_attachment($myrow['id']);
 
                 $attachment_icon = '';
-                if (count($attachment_list)>0) {
-                    $attachment_icon = ' '.Display::return_icon('attachment.gif',get_lang('Attachment'));
+                if (count($attachment_list) > 0) {
+                    $attachment_icon = ' '.Display::return_icon('attachment.gif', get_lang('Attachment'));
                 }
 
                 /* TITLE */
@@ -1672,16 +1672,16 @@ 
                     || (api_get_course_setting('allow_user_edit_announcement') && !api_is_anonymous())
                 ) {
                     $modify_icons = "<a href=\"".$actionUrl."&action=modify&id=".$myrow['id']."\">".
-                        Display::return_icon('edit.png', get_lang('Edit'),'',ICON_SIZE_SMALL)."</a>";
-                    if ($myrow['visibility']==1) {
-                        $image_visibility="visible";
-                        $alt_visibility=get_lang('Hide');
+                        Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL)."</a>";
+                    if ($myrow['visibility'] == 1) {
+                        $image_visibility = "visible";
+                        $alt_visibility = get_lang('Hide');
                     } else {
-                        $image_visibility="invisible";
-                        $alt_visibility=get_lang('Visible');
+                        $image_visibility = "invisible";
+                        $alt_visibility = get_lang('Visible');
                     }
-                    $modify_icons .=  "<a href=\"".$actionUrl."&origin=".$origin."&action=showhide&id=".$myrow['id']."&sec_token=".$stok."\">".
-                        Display::return_icon($image_visibility.'.png', $alt_visibility,'',ICON_SIZE_SMALL)."</a>";
+                    $modify_icons .= "<a href=\"".$actionUrl."&origin=".$origin."&action=showhide&id=".$myrow['id']."&sec_token=".$stok."\">".
+                        Display::return_icon($image_visibility.'.png', $alt_visibility, '', ICON_SIZE_SMALL)."</a>";
 
                     // DISPLAY MOVE UP COMMAND only if it is not the top announcement
                     if ($iterator != 1) {
@@ -1696,12 +1696,12 @@ 
                     } else {
                         $modify_icons .= Display::return_icon('down_na.gif', get_lang('Down'));
                     }
-                    if (api_is_allowed_to_edit(false,true)) {
-                        $modify_icons .= "<a href=\"".$actionUrl."&action=delete&id=".$myrow['id']."&sec_token=".$stok."\" onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'),ENT_QUOTES,api_get_system_encoding()))."')) return false;\">".
-                            Display::return_icon('delete.png', get_lang('Delete'),'',ICON_SIZE_SMALL).
+                    if (api_is_allowed_to_edit(false, true)) {
+                        $modify_icons .= "<a href=\"".$actionUrl."&action=delete&id=".$myrow['id']."&sec_token=".$stok."\" onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice'), ENT_QUOTES, api_get_system_encoding()))."')) return false;\">".
+                            Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).
                             "</a>";
                     }
-                    $iterator ++;
+                    $iterator++;
                 } else {
                     $modify_icons = Display::url(
                         Display::return_icon('default.png'),
@@ -1731,7 +1731,7 @@ 
     public static function getNumberAnnouncements()
     {
         // Maximum title messages to display
-        $maximum 	= '12';
+        $maximum = '12';
         // Database Table Definitions
         $tbl_announcement = Database::get_course_table(TABLE_ANNOUNCEMENT);
         $tbl_item_property = Database::get_course_table(TABLE_ITEM_PROPERTY);
@@ -1742,7 +1742,7 @@ 
         $userId = api_get_user_id();
         $condition_session = api_get_session_condition($session_id, true, true, 'announcement.session_id');
 
-        if (api_is_allowed_to_edit(false,true))  {
+        if (api_is_allowed_to_edit(false, true)) {
             // check teacher status
             if (empty($_GET['origin']) or $_GET['origin'] !== 'learnpath') {
 
@@ -1805,7 +1805,7 @@ 
                 }
 
                 // the user is member of several groups => display personal announcements AND his group announcements AND the general announcements
-                if (is_array($group_memberships) && count($group_memberships)>0) {
+                if (is_array($group_memberships) && count($group_memberships) > 0) {
                     $sql = "SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
                     FROM $tbl_announcement announcement, $tbl_item_property ip
                     WHERE
@@ -1855,7 +1855,7 @@ 
                         }
 
                         // the user is not identiefied => show only the general announcements
-                        $sql="SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
+                        $sql = "SELECT announcement.*, ip.visibility, ip.to_group_id, ip.insert_user_id
                                 FROM $tbl_announcement announcement, $tbl_item_property ip
                                 WHERE
                                     announcement.c_id = $course_id AND

main/inc/lib/app_view.php

Doc Comments +3 added lines

@@ -18,6 +18,7 @@ 
     /**
      * Constructor, init tool path for rendering
      * @param string  tool name (optional)
+     * @param string $template_path
      */
     public function __construct($toolname = '', $template_path=null)
     {
@@ -50,6 +51,7 @@ 
     /**
      * Set layout view sent from a controller
      * @param string layout view
+     * @param string $layout
      */
     public function set_layout( $layout )
     {
@@ -59,6 +61,7 @@ 
     /**
      * Set template view sent from a controller
      * @param string template view
+     * @param string $template
      */
     public function set_template($template)
     {

Spacing +4 added lines, -4 removed lines

@@ -19,7 +19,7 @@ 
      * Constructor, init tool path for rendering
      * @param string  tool name (optional)
      */
-    public function __construct($toolname = '', $template_path=null)
+    public function __construct($toolname = '', $template_path = null)
     {
         if (!empty($toolname)) {
             if (isset($template_path)) {
@@ -30,7 +30,7 @@ 
             if (is_dir($path)) {
                 $this->tool_path = $path;
             } else {
-                throw new ViewException('View::__construct() $path directory does not exist ' . $path);
+                throw new ViewException('View::__construct() $path directory does not exist '.$path);
             }
         }
     }
@@ -42,7 +42,7 @@ 
     public function set_data($data)
     {
         if (!is_array($data)) {
-            throw new ViewException('View::set_data() $data must to be an array, you have sent a' . gettype( $data ));
+            throw new ViewException('View::set_data() $data must to be an array, you have sent a'.gettype($data));
         }
         $this->data = $data;
     }
@@ -51,7 +51,7 @@ 
      * Set layout view sent from a controller
      * @param string layout view
      */
-    public function set_layout( $layout )
+    public function set_layout($layout)
     {
         $this->layout = $layout;
     }

main/inc/lib/banner.lib.php

Doc Comments +6 added lines

@@ -147,6 +147,9 @@ 
     return $customTabs;
 }
 
+/**
+ * @param string $theme
+ */
 function return_logo($theme)
 {
     $_course = api_get_course_info();
@@ -497,6 +500,9 @@ 
     return $menu;
 }
 
+/**
+ * @param string $nameTools
+ */
 function return_breadcrumb($interbreadcrumb, $language_file, $nameTools)
 {
     $session_id = api_get_session_id();

Indentation +20 added lines, -20 removed lines

@@ -42,20 +42,20 @@ 
     $navigation['myprofile']['url'] = api_get_path(WEB_CODE_PATH).'auth/profile.php'.(!empty($_course['path']) ? '?coursePath='.$_course['path'].'&courseCode='.$_course['official_code'] : '' );
     $navigation['myprofile']['title'] = get_lang('ModifyProfile');
     $navigation['myprofile']['key'] = 'profile';
-	// Link to my agenda
+    // Link to my agenda
     $navigation['myagenda']['url'] = api_get_path(WEB_CODE_PATH).'calendar/agenda_js.php?type=personal';
     $navigation['myagenda']['title'] = get_lang('MyAgenda');
     $navigation['myagenda']['key'] = 'agenda';
 
-	// Gradebook
-	if (api_get_setting('gradebook_enable') == 'true') {
+    // Gradebook
+    if (api_get_setting('gradebook_enable') == 'true') {
         $navigation['mygradebook']['url'] = api_get_path(WEB_CODE_PATH).'gradebook/gradebook.php'.(!empty($_course['path']) ? '?coursePath='.$_course['path'].'&courseCode='.$_course['official_code'] : '' );
         $navigation['mygradebook']['title'] = get_lang('MyGradebook');
         $navigation['mygradebook']['key'] = 'gradebook';
-	}
+    }
 
-	// Reporting
-	if (api_is_allowed_to_create_course() || api_is_drh() || api_is_session_admin()) {
+    // Reporting
+    if (api_is_allowed_to_create_course() || api_is_drh() || api_is_session_admin()) {
         // Link to my space
         $navigation['session_my_space']['url'] = api_get_path(WEB_CODE_PATH).'mySpace/'.(api_is_drh()?'session.php':'');
         $navigation['session_my_space']['title'] = get_lang('MySpace');
@@ -79,21 +79,21 @@ 
         $navigation['session_my_progress']['key'] = 'my-progress';
     }
 
-	// Social
-	if (api_get_setting('allow_social_tool')=='true') {
+    // Social
+    if (api_get_setting('allow_social_tool')=='true') {
         $navigation['social']['url'] = api_get_path(WEB_CODE_PATH).'social/home.php';
         $navigation['social']['title'] = get_lang('SocialNetwork');
         $navigation['social']['key'] = 'social-network';
-	}
+    }
 
-	// Dashboard
-	if (api_is_platform_admin() || api_is_drh() || api_is_session_admin()) {
+    // Dashboard
+    if (api_is_platform_admin() || api_is_drh() || api_is_session_admin()) {
         $navigation['dashboard']['url'] = api_get_path(WEB_CODE_PATH).'dashboard/index.php';
         $navigation['dashboard']['title'] = get_lang('Dashboard');
         $navigation['dashboard']['key'] = 'dashboard';
-	}
+    }
 
-	// Reports
+    // Reports
     /*
 	if (api_is_platform_admin() || api_is_drh() || api_is_session_admin()) {
         $navigation['reports']['url'] = api_get_path(WEB_CODE_PATH).'reports/index.php';
@@ -116,14 +116,14 @@ 
     }
     // End Custom Tabs
 
-	// Platform administration
-	if (api_is_platform_admin(true)) {
+    // Platform administration
+    if (api_is_platform_admin(true)) {
         $navigation['platform_admin']['url'] = api_get_path(WEB_CODE_PATH).'admin/';
         $navigation['platform_admin']['title'] = get_lang('PlatformAdmin');
         $navigation['platform_admin']['key'] = 'admin';
-	}
+    }
 
-	return $navigation;
+    return $navigation;
 }
 
 /**
@@ -351,7 +351,7 @@ 
             }
         }
 
-		// Reports
+        // Reports
         if (!empty($possible_tabs['reports'])) {
             if (api_get_setting('show_tabs', 'reports') == 'true') {
                 if ((api_is_platform_admin() || api_is_drh() || api_is_session_admin()) && Rights::hasRight('show_tabs:reports')) {
@@ -492,7 +492,7 @@ 
 
     $menu = null;
     if (!empty($lis)) {
-         $menu .= $lis;
+            $menu .= $lis;
     }
     return $menu;
 }
@@ -548,7 +548,7 @@ 
         $navigation_item_my_courses['title'] = get_lang('MyCourses');
         $navigation_item_my_courses['url'] = api_get_path(WEB_PATH).'user_portal.php';
         $navigation[] = $navigation_item_my_courses;
-        */
+         */
         $navigation[] = $navigation_item;
     }
 

Spacing +38 added lines, -38 removed lines

@@ -39,7 +39,7 @@ 
     $navigation['mycourses']['key'] = 'my-course';
 
     // My Profile
-    $navigation['myprofile']['url'] = api_get_path(WEB_CODE_PATH).'auth/profile.php'.(!empty($_course['path']) ? '?coursePath='.$_course['path'].'&courseCode='.$_course['official_code'] : '' );
+    $navigation['myprofile']['url'] = api_get_path(WEB_CODE_PATH).'auth/profile.php'.(!empty($_course['path']) ? '?coursePath='.$_course['path'].'&courseCode='.$_course['official_code'] : '');
     $navigation['myprofile']['title'] = get_lang('ModifyProfile');
     $navigation['myprofile']['key'] = 'profile';
 	// Link to my agenda
@@ -49,7 +49,7 @@ 
 
 	// Gradebook
 	if (api_get_setting('gradebook_enable') == 'true') {
-        $navigation['mygradebook']['url'] = api_get_path(WEB_CODE_PATH).'gradebook/gradebook.php'.(!empty($_course['path']) ? '?coursePath='.$_course['path'].'&courseCode='.$_course['official_code'] : '' );
+        $navigation['mygradebook']['url'] = api_get_path(WEB_CODE_PATH).'gradebook/gradebook.php'.(!empty($_course['path']) ? '?coursePath='.$_course['path'].'&courseCode='.$_course['official_code'] : '');
         $navigation['mygradebook']['title'] = get_lang('MyGradebook');
         $navigation['mygradebook']['key'] = 'gradebook';
 	}
@@ -57,11 +57,11 @@ 
 	// Reporting
 	if (api_is_allowed_to_create_course() || api_is_drh() || api_is_session_admin()) {
         // Link to my space
-        $navigation['session_my_space']['url'] = api_get_path(WEB_CODE_PATH).'mySpace/'.(api_is_drh()?'session.php':'');
+        $navigation['session_my_space']['url'] = api_get_path(WEB_CODE_PATH).'mySpace/'.(api_is_drh() ? 'session.php' : '');
         $navigation['session_my_space']['title'] = get_lang('MySpace');
         $navigation['session_my_space']['key'] = 'my-space';
     } else if (api_is_student_boss()) {
-        $navigation['session_my_space']['url'] = api_get_path(WEB_CODE_PATH) . 'mySpace/student.php';
+        $navigation['session_my_space']['url'] = api_get_path(WEB_CODE_PATH).'mySpace/student.php';
         $navigation['session_my_space']['title'] = get_lang('MySpace');
         $navigation['session_my_space']['key'] = 'my-space';
     } else {
@@ -80,7 +80,7 @@ 
     }
 
 	// Social
-	if (api_get_setting('allow_social_tool')=='true') {
+	if (api_get_setting('allow_social_tool') == 'true') {
         $navigation['social']['url'] = api_get_path(WEB_CODE_PATH).'social/home.php';
         $navigation['social']['title'] = get_lang('SocialNetwork');
         $navigation['social']['key'] = 'social-network';
@@ -161,14 +161,14 @@ 
         'id' => 'header-logo'
     );
     $testServer = api_get_setting('server_type');
-    if ($testServer == 'test' && is_file($logoBase . 'svg')) {
-        $logo = $logoBase . 'svg';
+    if ($testServer == 'test' && is_file($logoBase.'svg')) {
+        $logo = $logoBase.'svg';
         $attributes['width'] = '245';
         $attributes['height'] = '68';
         $imageUrl = api_get_path(WEB_CSS_PATH).'themes/'.$theme.'/images/header-logo.svg';
     } else {
-        $logo = $logoBase . 'png';
-        $customLogo = $customLogoBase . 'png';
+        $logo = $logoBase.'png';
+        $customLogo = $customLogoBase.'png';
         $imageUrl = api_get_path(WEB_CSS_PATH).'themes/'.$theme.'/images/header-logo.png';
         $customImageUrl = api_get_path(WEB_CSS_PATH).'themes/'.$theme.'/images/header-logo-custom.png';
     }
@@ -218,7 +218,7 @@ 
     $_course = api_get_course_info();
     $course_id = 0;
     if (!empty($_course)) {
-        $course_id  = $_course['code'];
+        $course_id = $_course['code'];
     }
 
     $user_id = api_get_user_id();
@@ -315,7 +315,7 @@ 
         if (api_get_setting('gradebook_enable') == 'true') {
             if (api_get_setting('show_tabs', 'my_gradebook') == 'true') {
                 $navigation['mygradebook'] = $possible_tabs['mygradebook'];
-            } else{
+            } else {
                 $menu_navigation['mygradebook'] = $possible_tabs['mygradebook'];
             }
         }
@@ -340,7 +340,7 @@ 
             if (api_get_setting('allow_social_tool') == 'true') {
                 $navigation['social'] = isset($possible_tabs['social']) ? $possible_tabs['social'] : null;
             }
-        } else{
+        } else {
             $menu_navigation['social'] = isset($possible_tabs['social']) ? $possible_tabs['social'] : null;
         }
 
@@ -349,7 +349,7 @@ 
             if (api_is_platform_admin() || api_is_drh() || api_is_session_admin()) {
                 $navigation['dashboard'] = isset($possible_tabs['dashboard']) ? $possible_tabs['dashboard'] : null;
             }
-        } else{
+        } else {
             $menu_navigation['dashboard'] = isset($possible_tabs['dashboard']) ? $possible_tabs['dashboard'] : null;
         }
 
@@ -440,32 +440,32 @@ 
     $home_top = '';
 
     if (is_file($homep.$menutabs.'_'.$lang.$ext) && is_readable($homep.$menutabs.'_'.$lang.$ext)) {
-        $home_top = @(string)file_get_contents($homep.$menutabs.'_'.$lang.$ext);
+        $home_top = @(string) file_get_contents($homep.$menutabs.'_'.$lang.$ext);
     } elseif (is_file($homep.$menutabs.$lang.$ext) && is_readable($homep.$menutabs.$lang.$ext)) {
-        $home_top = @(string)file_get_contents($homep.$menutabs.$lang.$ext);
+        $home_top = @(string) file_get_contents($homep.$menutabs.$lang.$ext);
     } else {
         //$errorMsg = get_lang('HomePageFilesNotReadable');
     }
 
     $home_top = api_to_system_encoding($home_top, api_detect_encoding(strip_tags($home_top)));
 
-    $open = str_replace('{rel_path}',api_get_path(REL_PATH), $home_top);
+    $open = str_replace('{rel_path}', api_get_path(REL_PATH), $home_top);
     $open = api_to_system_encoding($open, api_detect_encoding(strip_tags($open)));
 
     $open_mtloggedin = '';
     if (api_get_user_id() && !api_is_anonymous()) {
         if (is_file($homep.$mtloggedin.'_'.$lang.$ext) && is_readable($homep.$mtloggedin.'_'.$lang.$ext)) {
-            $home_top = @(string)file_get_contents($homep.$mtloggedin.'_'.$lang.$ext);
+            $home_top = @(string) file_get_contents($homep.$mtloggedin.'_'.$lang.$ext);
             $home_top = str_replace('::private', '', $home_top);
         } elseif (is_file($homep.$mtloggedin.$lang.$ext) && is_readable($homep.$mtloggedin.$lang.$ext)) {
-            $home_top = @(string)file_get_contents($homep.$mtloggedin.$lang.$ext);
+            $home_top = @(string) file_get_contents($homep.$mtloggedin.$lang.$ext);
             $home_top = str_replace('::private', '', $home_top);
         } else {
             //$errorMsg = get_lang('HomePageFilesNotReadable');
         }
 
         $home_top = api_to_system_encoding($home_top, api_detect_encoding(strip_tags($home_top)));
-        $open_mtloggedin = str_replace('{rel_path}',api_get_path(REL_PATH), $home_top);
+        $open_mtloggedin = str_replace('{rel_path}', api_get_path(REL_PATH), $home_top);
         $open_mtloggedin = api_to_system_encoding($open_mtloggedin, api_detect_encoding(strip_tags($open_mtloggedin)));
     }
 
@@ -474,7 +474,7 @@ 
     if (!empty($open) OR !empty($open_mtloggedin)) {
         if (strpos($open.$open_mtloggedin, 'show_menu') === false) {
             if (api_is_anonymous()) {
-                $navigation[SECTION_CAMPUS]  = null;
+                $navigation[SECTION_CAMPUS] = null;
             }
         } else {
             if (api_get_user_id() && !api_is_anonymous()) {
@@ -488,7 +488,7 @@ 
     if (count($navigation) > 0 || !empty($lis)) {
         $pre_lis = '';
         foreach ($navigation as $section => $navigation_info) {
-            $key = (!empty($navigation_info['key'])?'tab-'.$navigation_info['key']:'');
+            $key = (!empty($navigation_info['key']) ? 'tab-'.$navigation_info['key'] : '');
             if (isset($GLOBALS['this_section'])) {
                 $current = $section == $GLOBALS['this_section'] ? ' id="current" class="active '.$key.'" ' : ' class="'.$key.'"';
             } else {
@@ -532,7 +532,7 @@ 
 
     if (!empty($_course) && !isset($_GET['hide_course_breadcrumb'])) {
 
-        $navigation_item['url'] = $web_course_path . $_course['path'].'/index.php'.(!empty($session_id) ? '?id_session='.$session_id : '');
+        $navigation_item['url'] = $web_course_path.$_course['path'].'/index.php'.(!empty($session_id) ? '?id_session='.$session_id : '');
         $_course['name'] = api_htmlentities($_course['name']);
         $course_title = cut($_course['name'], MAX_LENGTH_BREADCRUMB);
 
@@ -547,7 +547,7 @@ 
                 $navigation_item['title'] = Display::img(api_get_path(WEB_IMG_PATH).'home.png', $_course['name'].$my_session_name).' '.$course_title.$my_session_name;
                 break;
             default:
-                if (api_get_session_id() != -1 ) {
+                if (api_get_session_id() != -1) {
                     $navigation_item['title'] = Display::img(api_get_path(WEB_IMG_PATH).'home.png', $_course['name'].$my_session_name).' '.$course_title.$my_session_name;
                 } else {
                     $navigation_item['title'] = Display::img(api_get_path(WEB_IMG_PATH).'home.png', $_course['name']).' '.$course_title;
@@ -581,22 +581,22 @@ 
             // titles for shared folders
             if ($breadcrumb_step['name'] == 'shared_folder') {
                 $navigation_item['title'] = get_lang('UserFolders');
-            } elseif(strstr($breadcrumb_step['name'], 'shared_folder_session_')) {
+            } elseif (strstr($breadcrumb_step['name'], 'shared_folder_session_')) {
                 $navigation_item['title'] = get_lang('UserFolders');
-            } elseif(strstr($breadcrumb_step['name'], 'sf_user_')) {
+            } elseif (strstr($breadcrumb_step['name'], 'sf_user_')) {
                 $userinfo = api_get_user_info(substr($breadcrumb_step['name'], 8));
                 $navigation_item['title'] = $userinfo['complete_name'];
-            } elseif($breadcrumb_step['name'] == 'chat_files') {
+            } elseif ($breadcrumb_step['name'] == 'chat_files') {
                 $navigation_item['title'] = get_lang('ChatFiles');
-            } elseif($breadcrumb_step['name'] == 'images') {
+            } elseif ($breadcrumb_step['name'] == 'images') {
                 $navigation_item['title'] = get_lang('Images');
-            } elseif($breadcrumb_step['name'] == 'video') {
+            } elseif ($breadcrumb_step['name'] == 'video') {
                 $navigation_item['title'] = get_lang('Video');
-            } elseif($breadcrumb_step['name'] == 'audio') {
+            } elseif ($breadcrumb_step['name'] == 'audio') {
                 $navigation_item['title'] = get_lang('Audio');
-            } elseif($breadcrumb_step['name'] == 'flash') {
+            } elseif ($breadcrumb_step['name'] == 'flash') {
                 $navigation_item['title'] = get_lang('Flash');
-            } elseif($breadcrumb_step['name'] == 'gallery') {
+            } elseif ($breadcrumb_step['name'] == 'gallery') {
                 $navigation_item['title'] = get_lang('Gallery');
             }
             // Fixes breadcrumb title now we applied the Security::remove_XSS and
@@ -663,35 +663,35 @@ 
         if (!empty($final_navigation)) {
             // $home_link.= '<span class="divider">/</span>';
             if (!empty($home_link)) {
-                $lis.= Display::tag('li', $home_link);
+                $lis .= Display::tag('li', $home_link);
             }
 
             foreach ($final_navigation as $bread) {
                 $bread_check = trim(strip_tags($bread));
                 if (!empty($bread_check)) {
-                    if ($final_navigation_count-1 > $i) {
+                    if ($final_navigation_count - 1 > $i) {
                         $bread .= '';
                     }
-                    $lis.= Display::tag('li', $bread,array('class'=>'active'));
+                    $lis .= Display::tag('li', $bread, array('class'=>'active'));
                     $i++;
                 }
             }
         } else {
             if (!empty($home_link)) {
-                $lis.= Display::tag('li', $home_link);
+                $lis .= Display::tag('li', $home_link);
             }
         }
 
         // View as student/teacher link
         $view = null;
         if (!empty($view_as_student_link)) {
-            $view .= Display::tag('div', $view_as_student_link, array('id' => 'view_as_link','class' => 'pull-right'));
+            $view .= Display::tag('div', $view_as_student_link, array('id' => 'view_as_link', 'class' => 'pull-right'));
         }
 
         if (!empty($navigation_right)) {
-            foreach($navigation_right as $item){
+            foreach ($navigation_right as $item) {
                 $extra_class = isset($item['class']) ? $item['class'] : null;
-                $lis.= Display::tag('li', $item['title'], array('class' => $extra_class.' pull-right'));
+                $lis .= Display::tag('li', $item['title'], array('class' => $extra_class.' pull-right'));
             }
         }
 

main/inc/lib/browser/Browser.php

Doc Comments +2 added lines, -2 removed lines

@@ -158,7 +158,7 @@ 
 
     /**
      * Set the name of the browser
-     * @param $browser string The name of the Browser
+     * @param string $browser string The name of the Browser
      */
     public function setBrowser($browser)
     {
@@ -266,7 +266,7 @@ 
 
     /**
      * Set the browser to be from AOL
-     * @param $isAol
+     * @param boolean $isAol
      */
     public function setAol($isAol)
     {

Indentation +9 added lines, -9 removed lines

@@ -256,9 +256,9 @@ 
     }
 
     /**
-    * Is the browser from facebook?
-    * @return boolean True if the browser is from facebook otherwise false
-    */
+     * Is the browser from facebook?
+     * @return boolean True if the browser is from facebook otherwise false
+     */
     public function isFacebook() 
     { 
         return $this->_is_facebook;
@@ -591,12 +591,12 @@ 
             }
             return true;
         } // Test for versions > IE 10
-		else if(stripos($this->_agent, 'trident') !== false) {
-			$this->setBrowser(self::BROWSER_IE);
-			$result = explode('rv:', $this->_agent);
-			$this->setVersion(preg_replace('/[^0-9.]+/', '', $result[1]));
-			$this->_agent = str_replace(array("Mozilla", "Gecko"), "MSIE", $this->_agent);
-		} // Test for Pocket IE
+        else if(stripos($this->_agent, 'trident') !== false) {
+            $this->setBrowser(self::BROWSER_IE);
+            $result = explode('rv:', $this->_agent);
+            $this->setVersion(preg_replace('/[^0-9.]+/', '', $result[1]));
+            $this->_agent = str_replace(array("Mozilla", "Gecko"), "MSIE", $this->_agent);
+        } // Test for Pocket IE
         else if (stripos($this->_agent, 'mspie') !== false || stripos($this->_agent, 'pocket') !== false) {
             $aresult = explode(' ', stristr($this->_agent, 'mspie'));
             $this->setPlatform(self::PLATFORM_WINDOWS_CE);

Spacing +16 added lines, -16 removed lines

@@ -345,9 +345,9 @@ 
      */
     public function __toString()
     {
-        return "<strong>Browser Name:</strong> {$this->getBrowser()}<br/>\n" .
-        "<strong>Browser Version:</strong> {$this->getVersion()}<br/>\n" .
-        "<strong>Browser User Agent String:</strong> {$this->getUserAgent()}<br/>\n" .
+        return "<strong>Browser Name:</strong> {$this->getBrowser()}<br/>\n".
+        "<strong>Browser Version:</strong> {$this->getVersion()}<br/>\n".
+        "<strong>Browser User Agent String:</strong> {$this->getUserAgent()}<br/>\n".
         "<strong>Platform:</strong> {$this->getPlatform()}<br/>";
     }
 
@@ -585,13 +585,13 @@ 
             $aresult = explode(' ', stristr(str_replace(';', '; ', $this->_agent), 'msie'));
             $this->setBrowser(self::BROWSER_IE);
             $this->setVersion(str_replace(array('(', ')', ';'), '', $aresult[1]));
-            if(stripos($this->_agent, 'IEMobile') !== false) {
+            if (stripos($this->_agent, 'IEMobile') !== false) {
                 $this->setBrowser(self::BROWSER_POCKET_IE);
                 $this->setMobile(true);
             }
             return true;
         } // Test for versions > IE 10
-		else if(stripos($this->_agent, 'trident') !== false) {
+		else if (stripos($this->_agent, 'trident') !== false) {
 			$this->setBrowser(self::BROWSER_IE);
 			$result = explode('rv:', $this->_agent);
 			$this->setVersion(preg_replace('/[^0-9.]+/', '', $result[1]));
@@ -1012,7 +1012,7 @@ 
      */
     protected function checkFacebookExternalHit()
     {
-        if(stristr($this->_agent,'FacebookExternalHit'))
+        if (stristr($this->_agent, 'FacebookExternalHit'))
         {
             $this->setRobot(true);
             $this->setFacebook(true);
@@ -1027,7 +1027,7 @@ 
      */
     protected function checkForFacebookIos()
     {
-        if(stristr($this->_agent,'FBIOS'))
+        if (stristr($this->_agent, 'FBIOS'))
         {
             $this->setFacebook(true);
             return true;
@@ -1041,10 +1041,10 @@ 
      */
     protected function getSafariVersionOnIos()
     {
-        $aresult = explode('/',stristr($this->_agent,'Version'));
-        if( isset($aresult[1]) )
+        $aresult = explode('/', stristr($this->_agent, 'Version'));
+        if (isset($aresult[1]))
         {
-            $aversion = explode(' ',$aresult[1]);
+            $aversion = explode(' ', $aresult[1]);
             $this->setVersion($aversion[0]);
             return true;
         }
@@ -1057,10 +1057,10 @@ 
      */
     protected function getChromeVersionOnIos()
     {
-        $aresult = explode('/',stristr($this->_agent,'CriOS'));
-        if( isset($aresult[1]) )
+        $aresult = explode('/', stristr($this->_agent, 'CriOS'));
+        if (isset($aresult[1]))
         {
-            $aversion = explode(' ',$aresult[1]);
+            $aversion = explode(' ', $aresult[1]);
             $this->setVersion($aversion[0]);
             $this->setBrowser(self::BROWSER_CHROME);
             return true;
@@ -1073,7 +1073,7 @@ 
      * @return boolean True if the browser is iPhone otherwise false
      */
     protected function checkBrowseriPhone() {
-        if( stripos($this->_agent,'iPhone') !== false ) {
+        if (stripos($this->_agent, 'iPhone') !== false) {
             $this->setVersion(self::VERSION_UNKNOWN);
             $this->setBrowser(self::BROWSER_IPHONE);
             $this->getSafariVersionOnIos();
@@ -1090,7 +1090,7 @@ 
      * @return boolean True if the browser is iPad otherwise false
      */
     protected function checkBrowseriPad() {
-        if( stripos($this->_agent,'iPad') !== false ) {
+        if (stripos($this->_agent, 'iPad') !== false) {
             $this->setVersion(self::VERSION_UNKNOWN);
             $this->setBrowser(self::BROWSER_IPAD);
             $this->getSafariVersionOnIos();
@@ -1107,7 +1107,7 @@ 
      * @return boolean True if the browser is iPod otherwise false
      */
     protected function checkBrowseriPod() {
-        if( stripos($this->_agent,'iPod') !== false ) {
+        if (stripos($this->_agent, 'iPod') !== false) {
             $this->setVersion(self::VERSION_UNKNOWN);
             $this->setBrowser(self::BROWSER_IPOD);
             $this->getSafariVersionOnIos();

Braces +16 added lines, -32 removed lines

@@ -1152,68 +1152,52 @@
         if (stripos($this->_agent, 'windows') !== false)
         {
             $this->_platform = self::PLATFORM_WINDOWS;
-        }
-        else if (stripos($this->_agent, 'iPad') !== false)
+        } else if (stripos($this->_agent, 'iPad') !== false)
         {
             $this->_platform = self::PLATFORM_IPAD;
-        }
-        else if (stripos($this->_agent, 'iPod') !== false)
+        } else if (stripos($this->_agent, 'iPod') !== false)
         {
             $this->_platform = self::PLATFORM_IPOD;
-        }
-        else if (stripos($this->_agent, 'iPhone') !== false)
+        } else if (stripos($this->_agent, 'iPhone') !== false)
         {
             $this->_platform = self::PLATFORM_IPHONE;
-        }
-        elseif (stripos($this->_agent, 'mac') !== false)
+        } elseif (stripos($this->_agent, 'mac') !== false)
         {
             $this->_platform = self::PLATFORM_APPLE;
-        }
-        elseif (stripos($this->_agent, 'android') !== false)
+        } elseif (stripos($this->_agent, 'android') !== false)
         {
             $this->_platform = self::PLATFORM_ANDROID;
-        }
-        elseif (stripos($this->_agent, 'linux') !== false)
+        } elseif (stripos($this->_agent, 'linux') !== false)
         {
             $this->_platform = self::PLATFORM_LINUX;
-        }
-        else if (stripos($this->_agent, 'Nokia') !== false)
+        } else if (stripos($this->_agent, 'Nokia') !== false)
         {
             $this->_platform = self::PLATFORM_NOKIA;
-        }
-        else if (stripos($this->_agent, 'BlackBerry') !== false)
+        } else if (stripos($this->_agent, 'BlackBerry') !== false)
         {
             $this->_platform = self::PLATFORM_BLACKBERRY;
-        }
-        elseif (stripos($this->_agent, 'FreeBSD') !== false)
+        } elseif (stripos($this->_agent, 'FreeBSD') !== false)
         {
             $this->_platform = self::PLATFORM_FREEBSD;
-        }
-        elseif (stripos($this->_agent, 'OpenBSD') !== false)
+        } elseif (stripos($this->_agent, 'OpenBSD') !== false)
         {
             $this->_platform = self::PLATFORM_OPENBSD;
-        }
-        elseif (stripos($this->_agent, 'NetBSD') !== false)
+        } elseif (stripos($this->_agent, 'NetBSD') !== false)
         {
             $this->_platform = self::PLATFORM_NETBSD;
-        }
-        elseif (stripos($this->_agent, 'OpenSolaris') !== false)
+        } elseif (stripos($this->_agent, 'OpenSolaris') !== false)
         {
             $this->_platform = self::PLATFORM_OPENSOLARIS;
-        }
-        elseif (stripos($this->_agent, 'SunOS') !== false)
+        } elseif (stripos($this->_agent, 'SunOS') !== false)
         {
             $this->_platform = self::PLATFORM_SUNOS;
-        }
-        elseif (stripos($this->_agent, 'OS\/2') !== false)
+        } elseif (stripos($this->_agent, 'OS\/2') !== false)
         {
             $this->_platform = self::PLATFORM_OS2;
-        }
-        elseif (stripos($this->_agent, 'BeOS') !== false)
+        } elseif (stripos($this->_agent, 'BeOS') !== false)
         {
             $this->_platform = self::PLATFORM_BEOS;
-        }
-        elseif (stripos($this->_agent, 'win') !== false)
+        } elseif (stripos($this->_agent, 'win') !== false)
         {
             $this->_platform = self::PLATFORM_WINDOWS;
         }