chamilo / chamilo-lms

main/inc/lib/course_home.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -213,7 +213,7 @@ 
     /**
      * Displays the tools of a certain category.
      *
-     * @return void
+     * @return string
      * @param string $course_tool_category	contains the category of tools to display:
      * "Public", "PublicButHide", "courseAdmin", "claroAdmin"
      */
@@ -650,7 +650,7 @@ 
      * @param array $all_tools_list List of tools as returned by get_tools_category()
      * @param bool  $rows
      *
-     * @return void
+     * @return string
      */
     public static function show_tools_category($all_tools_list, $rows = false)
     {
@@ -1194,6 +1194,7 @@ 
 
     /**
      * Show a toolbar with shortcuts to the course tool
+     * @param integer $orientation
      */
     public static function show_navigation_tool_shortcuts($orientation = SHORTCUTS_HORIZONTAL)
     {

Spacing +6 added lines, -6 removed lines

@@ -356,7 +356,7 @@ 
                         array(),
                         null,
                         ICON_SIZE_MEDIUM
-                    ) . '&nbsp;' . $tool_name . '</a>';
+                    ).'&nbsp;'.$tool_name.'</a>';
 
                 // This part displays the links to hide or remove a tool.
                 // These links are only visible by the course manager.
@@ -683,7 +683,7 @@ 
         $session_id = api_get_session_id();
         $is_platform_admin = api_is_platform_admin();
 
-        if ($session_id == 0 ) {
+        if ($session_id == 0) {
             $is_allowed_to_edit = api_is_allowed_to_edit(null, true) && api_is_course_admin();
         } else {
             $is_allowed_to_edit = api_is_allowed_to_edit(null, true) && !api_is_coach();
@@ -1061,8 +1061,8 @@ 
 
         $toolName = api_underscore_to_camel_case($toolName);
 
-        if (isset($GLOBALS['Tool' . $toolName])) {
-            return get_lang('Tool' . $toolName);
+        if (isset($GLOBALS['Tool'.$toolName])) {
+            return get_lang('Tool'.$toolName);
         }
 
         return $toolName;
@@ -1266,7 +1266,7 @@ 
             return array();
         }
 
-        $table  = Database::get_course_table(TABLE_TOOL_LIST);
+        $table = Database::get_course_table(TABLE_TOOL_LIST);
         $sql = "SELECT * FROM $table
                 WHERE category in ('authoring','interaction')
                 AND c_id = $courseId
@@ -1372,7 +1372,7 @@ 
             $temp = new Image($path);
             $r = $temp->convert2bw();
             $ext = pathinfo($path, PATHINFO_EXTENSION);
-            $bwPath = substr($path,0,-(strlen($ext)+1)) . '_na.' . $ext;
+            $bwPath = substr($path, 0, -(strlen($ext) + 1)).'_na.'.$ext;
 
             if ($r === false) {
                 error_log('Conversion to B&W of '.$path.' failed in '.__FILE__.' at line '.__LINE__);

main/inc/lib/diagnoser.lib.php

Doc Comments +6 added lines

@@ -351,6 +351,12 @@
 
     /**
      * Additional functions needed for fast integration
+     * @param integer $status
+     * @param string $section
+     * @param string $title
+     * @param string $url
+     * @param string|null $formatter
+     * @param string $comment
      */
     public function build_setting($status, $section, $title, $url, $current_value, $expected_value, $formatter, $comment, $img_path = null) {
         switch ($status) {

Indentation +13 added lines, -13 removed lines

@@ -401,19 +401,19 @@
 
     public function format_yes_no_optional($value)
     {
-    	$return = '';
-    	switch($value) {
-     		case 0:
-     			$return = get_lang('No');
-     			break;
-     		case 1:
-     			$return = get_lang('Yes');
-     			break;
-			case 2:
-				$return = get_lang('Optional');
-				break;
-    	}
-    	return $return;
+        $return = '';
+        switch($value) {
+                case 0:
+                 $return = get_lang('No');
+                    break;
+                case 1:
+                 $return = get_lang('Yes');
+                    break;
+            case 2:
+                $return = get_lang('Optional');
+                break;
+        }
+        return $return;
 
     }
 

Braces +13 added lines, -9 removed lines

@@ -158,8 +158,9 @@ 
         $array[] = $this->build_setting($status, '[INI]', 'display_errors', 'http://www.php.net/manual/en/ini.core.php#ini.display_errors', $setting, $req_setting, 'on_off', get_lang('DisplayErrorsInfo'));
 
         $setting = ini_get('default_charset');
-        if ($setting == '')
-            $setting = null;
+        if ($setting == '') {
+                    $setting = null;
+        }
         $req_setting = null;
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_ERROR;
         $array[] = $this->build_setting($status, '[INI]', 'default_charset', 'http://www.php.net/manual/en/ini.core.php#ini.default-charset', $setting, $req_setting, null, get_lang('DefaultCharsetInfo'));
@@ -177,22 +178,25 @@ 
         $setting = ini_get('memory_limit');
         $req_setting = '>= '.REQUIRED_MIN_MEMORY_LIMIT.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_MEMORY_LIMIT)
-            $status = self :: STATUS_OK;
+        if ((float)$setting >= REQUIRED_MIN_MEMORY_LIMIT) {
+                    $status = self :: STATUS_OK;
+        }
         $array[] = $this->build_setting($status, '[INI]', 'memory_limit', 'http://www.php.net/manual/en/ini.core.php#ini.memory-limit', $setting, $req_setting, null, get_lang('MemoryLimitInfo'));
 
         $setting = ini_get('post_max_size');
         $req_setting = '>= '.REQUIRED_MIN_POST_MAX_SIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_POST_MAX_SIZE)
-            $status = self :: STATUS_OK;
+        if ((float)$setting >= REQUIRED_MIN_POST_MAX_SIZE) {
+                    $status = self :: STATUS_OK;
+        }
         $array[] = $this->build_setting($status, '[INI]', 'post_max_size', 'http://www.php.net/manual/en/ini.core.php#ini.post-max-size', $setting, $req_setting, null, get_lang('PostMaxSizeInfo'));
 
         $setting = ini_get('upload_max_filesize');
         $req_setting = '>= '.REQUIRED_MIN_UPLOAD_MAX_FILESIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE)
-            $status = self :: STATUS_OK;
+        if ((float)$setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE) {
+                    $status = self :: STATUS_OK;
+        }
         $array[] = $this->build_setting($status, '[INI]', 'upload_max_filesize', 'http://www.php.net/manual/en/ini.core.php#ini.upload_max_filesize', $setting, $req_setting, null, get_lang('UploadMaxFilesizeInfo'));
 
         $setting = ini_get('variables_order');
@@ -205,7 +209,7 @@ 
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[SESSION]', 'session.gc_maxlifetime', 'http://www.php.net/manual/en/ini.core.php#session.gc-maxlifetime', $setting, $req_setting, null, get_lang('SessionGCMaxLifetimeInfo'));
 
-        if (api_check_browscap()){$setting = true;}else{$setting=false;}
+        if (api_check_browscap()){$setting = true;} else{$setting=false;}
         $req_setting = true;
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'browscap', 'http://www.php.net/manual/en/misc.configuration.php#ini.browscap', $setting, $req_setting, 'on_off', get_lang('BrowscapInfo'));

Spacing +27 added lines, -27 removed lines

@@ -15,7 +15,7 @@ 
 {
     const STATUS_OK = 1;
     const STATUS_WARNING = 2;
-    const STATUS_ERROR 	= 3;
+    const STATUS_ERROR = 3;
     const STATUS_INFORMATION = 4;
 
     /**
@@ -44,21 +44,21 @@ 
                 $html .= '<li>';
             }
             $params['section'] = $section;
-            $html .='<a href="system_status.php?section='.$section.'">'.get_lang($section).'</a></li>';
+            $html .= '<a href="system_status.php?section='.$section.'">'.get_lang($section).'</a></li>';
         }
 
         $html .= '</ul><div class="tab-pane">';
 
-        $data = call_user_func(array($this, 'get_' . $current_section . '_data'));
+        $data = call_user_func(array($this, 'get_'.$current_section.'_data'));
         echo $html;
         $table = new SortableTableFromArray($data, 1, 100);
 
-        $table->set_header(0,'', false);
-        $table->set_header(1,get_lang('Section'), false);
-        $table->set_header(2,get_lang('Setting'), false);
-        $table->set_header(3,get_lang('Current'), false);
-        $table->set_header(4,get_lang('Expected'), false);
-        $table->set_header(5,get_lang('Comment'), false);
+        $table->set_header(0, '', false);
+        $table->set_header(1, get_lang('Section'), false);
+        $table->set_header(2, get_lang('Setting'), false);
+        $table->set_header(3, get_lang('Current'), false);
+        $table->set_header(4, get_lang('Expected'), false);
+        $table->set_header(5, get_lang('Comment'), false);
 
         $table->display();
         echo '</div></div>';
@@ -72,11 +72,11 @@ 
     {
         $array = array();
         $writable_folders = array(
-            api_get_path(SYS_APP_PATH) .'cache',
+            api_get_path(SYS_APP_PATH).'cache',
             api_get_path(SYS_COURSE_PATH),
-            api_get_path(SYS_APP_PATH) .'home',
-            api_get_path(SYS_APP_PATH) .'upload/users/',
-            api_get_path(SYS_PATH) .'main/default_course_document/images/',
+            api_get_path(SYS_APP_PATH).'home',
+            api_get_path(SYS_APP_PATH).'upload/users/',
+            api_get_path(SYS_PATH).'main/default_course_document/images/',
         );
 
         foreach ($writable_folders as $index => $folder) {
@@ -99,7 +99,7 @@ 
         $array[] = $this->build_setting(
             $status,
             '[FILES]',
-            get_lang('DirectoryExists') . ': /install',
+            get_lang('DirectoryExists').': /install',
             'http://be2.php.net/file_exists',
             $exists,
             0,
@@ -129,7 +129,7 @@ 
                     $message2 .= get_lang('SpaceUsedOnSystemCannotBeMeasuredOnWindows');
                 } else {
                     $dir = api_get_path(SYS_PATH);
-                    $du = exec('du -sh ' . $dir, $err);
+                    $du = exec('du -sh '.$dir, $err);
                     list($size, $none) = explode("\t", $du);
                     $limit = $_configuration[$access_url_id]['hosting_limit_disk_space'];
                     $message2 .= sprintf(get_lang('TotalSpaceUsedByPortalXLimitIsYMB'), $size, $limit);
@@ -216,33 +216,33 @@ 
         $array[] = $this->build_setting($status, '[INI]', 'default_charset', 'http://www.php.net/manual/en/ini.core.php#ini.default-charset', $setting, $req_setting, null, get_lang('DefaultCharsetInfo'));
 
         $setting = ini_get('max_execution_time');
-        $req_setting = '300 (' . get_lang('Minimum') . ')';
+        $req_setting = '300 ('.get_lang('Minimum').')';
         $status = $setting >= 300 ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'max_execution_time', 'http://www.php.net/manual/en/ini.core.php#ini.max-execution-time', $setting, $req_setting, null, get_lang('MaxExecutionTimeInfo'));
 
         $setting = ini_get('max_input_time');
-        $req_setting = '300 (' . get_lang('Minimum') . ')';
+        $req_setting = '300 ('.get_lang('Minimum').')';
         $status = $setting >= 300 ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'max_input_time', 'http://www.php.net/manual/en/ini.core.php#ini.max-input-time', $setting, $req_setting, null, get_lang('MaxInputTimeInfo'));
 
         $setting = ini_get('memory_limit');
         $req_setting = '>= '.REQUIRED_MIN_MEMORY_LIMIT.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_MEMORY_LIMIT)
+        if ((float) $setting >= REQUIRED_MIN_MEMORY_LIMIT)
             $status = self :: STATUS_OK;
         $array[] = $this->build_setting($status, '[INI]', 'memory_limit', 'http://www.php.net/manual/en/ini.core.php#ini.memory-limit', $setting, $req_setting, null, get_lang('MemoryLimitInfo'));
 
         $setting = ini_get('post_max_size');
         $req_setting = '>= '.REQUIRED_MIN_POST_MAX_SIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_POST_MAX_SIZE)
+        if ((float) $setting >= REQUIRED_MIN_POST_MAX_SIZE)
             $status = self :: STATUS_OK;
         $array[] = $this->build_setting($status, '[INI]', 'post_max_size', 'http://www.php.net/manual/en/ini.core.php#ini.post-max-size', $setting, $req_setting, null, get_lang('PostMaxSizeInfo'));
 
         $setting = ini_get('upload_max_filesize');
         $req_setting = '>= '.REQUIRED_MIN_UPLOAD_MAX_FILESIZE.'M';
         $status = self :: STATUS_ERROR;
-        if ((float)$setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE)
+        if ((float) $setting >= REQUIRED_MIN_UPLOAD_MAX_FILESIZE)
             $status = self :: STATUS_OK;
         $array[] = $this->build_setting($status, '[INI]', 'upload_max_filesize', 'http://www.php.net/manual/en/ini.core.php#ini.upload_max_filesize', $setting, $req_setting, null, get_lang('UploadMaxFilesizeInfo'));
 
@@ -256,7 +256,7 @@ 
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[SESSION]', 'session.gc_maxlifetime', 'http://www.php.net/manual/en/ini.core.php#session.gc-maxlifetime', $setting, $req_setting, null, get_lang('SessionGCMaxLifetimeInfo'));
 
-        if (api_check_browscap()){$setting = true;}else{$setting=false;}
+        if (api_check_browscap()) {$setting = true; } else {$setting = false; }
         $req_setting = true;
         $status = $setting == $req_setting ? self :: STATUS_OK : self :: STATUS_WARNING;
         $array[] = $this->build_setting($status, '[INI]', 'browscap', 'http://www.php.net/manual/en/misc.configuration.php#ini.browscap', $setting, $req_setting, 'on_off', get_lang('BrowscapInfo'));
@@ -312,7 +312,7 @@ 
 
             $loaded = extension_loaded($extension);
             $status = $loaded ? self :: STATUS_OK : self :: STATUS_ERROR;
-            $array[] = $this->build_setting($status, '[EXTENSION]', get_lang('LoadedExtension') . ': ' . $extension, $url, $loaded, $expected_value, 'yes_no_optional', $comment);
+            $array[] = $this->build_setting($status, '[EXTENSION]', get_lang('LoadedExtension').': '.$extension, $url, $loaded, $expected_value, 'yes_no_optional', $comment);
         }
 
         return $array;
@@ -435,9 +435,9 @@ 
         $formatted_expected_value = $expected_value;
 
         if ($formatter) {
-            if (method_exists($this, 'format_' . $formatter)) {
-                $formatted_current_value = call_user_func(array($this, 'format_' . $formatter), $current_value);
-                $formatted_expected_value = call_user_func(array($this, 'format_' . $formatter), $expected_value);
+            if (method_exists($this, 'format_'.$formatter)) {
+                $formatted_current_value = call_user_func(array($this, 'format_'.$formatter), $current_value);
+                $formatted_expected_value = call_user_func(array($this, 'format_'.$formatter), $expected_value);
             }
         }
 
@@ -452,13 +452,13 @@ 
      */
     public function get_link($title, $url)
     {
-        return '<a href="' . $url . '" target="about:bank">' . $title . '</a>';
+        return '<a href="'.$url.'" target="about:bank">'.$title.'</a>';
     }
 
     public function format_yes_no_optional($value)
     {
     	$return = '';
-    	switch($value) {
+    	switch ($value) {
      		case 0:
      			$return = get_lang('No');
      			break;

main/inc/lib/display.lib.php

Doc Comments +26 added lines, -15 removed lines

@@ -32,7 +32,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function toolList()
     {
@@ -290,7 +290,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show.
      * i.e: $visibility_options= array(true, false) we will only show the first column
      * 				Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -331,7 +330,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show. i.e:
      *  $visibility_options= array(true, false) we will only show the first column
      * 	Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -388,10 +386,11 @@ 
      * 					'per_page' = number of items to show per page
      * 					'page_nr' = The page to display
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $column_show Array of binaries 1= show columns 0. hide a column
+     * @param integer[] $column_show Array of binaries 1= show columns 0. hide a column
      * @param array $column_order An array of integers that let us decide how the columns are going to be sort.
      * 						      i.e:  $column_order=array('1''4','3','4'); The 2nd column will be order like the 4th column
      * @param array $form_actions Set optional forms actions
+     * @param string $table_name
      *
      * @author Julio Montoya
      */
@@ -444,7 +443,7 @@ 
      * @param bool	$filter (true) or not (false)
      * @param bool $returnValue
      *
-     * @return void
+     * @return string|null
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
@@ -474,7 +473,7 @@ 
     /**
      * Displays an confirmation message. Use this if something has been done successfully
      * @param bool	Filter (true) or not (false)
-     * @return void
+     * @return string|null
      */
     public static function display_confirmation_message ($message, $filter = true, $returnValue = false)
     {
@@ -491,7 +490,7 @@ 
      * @param string $message - include any additional html
      *                          tags if you need them
      * @param bool	Filter (true) or not (false)
-     * @return void
+     * @return string|null
      */
     public static function display_error_message ($message, $filter = true, $returnValue = false)
     {
@@ -681,6 +680,7 @@ 
      * @param string   The alt text (probably a language variable)
      * @param array    additional attributes (for instance height, width, onclick, ...)
      * @param integer  The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
+     * @param string $image
      * @return void
     */
     public static function display_icon(
@@ -881,6 +881,7 @@ 
     /**
      * Displays an HTML input tag
      *
+     * @param string $type
      */
     public static function input($type, $name, $value, $attributes = array())
     {
@@ -897,8 +898,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      * @param array $attributes
      * @return string
      */
@@ -913,6 +914,7 @@ 
     /**
      * Displays an HTML select tag
      *
+     * @param string $blank_item_text
      */
     public static function select(
         $name,
@@ -983,6 +985,8 @@ 
      * @param   array   content that will be showed
      * @param   string  the id of the container of the tab in the example "tabs"
      * @param   array   attributes for the ul
+     * @param string[] $header_list
+     * @param string[] $content_list
      *
      */
     public static function tabs($header_list, $content_list, $id = 'tabs', $attributes = array(), $ul_attributes = array())
@@ -1029,7 +1033,7 @@ 
 
     /**
      * @param $headers
-     * @param null $selected
+     * @param integer $selected
      *
      * @return string
      */
@@ -1067,6 +1071,7 @@ 
      * As you can see both function use the same "my_grid_name" this is very important otherwise nothing will work
      *
      * @param   string  the div id, this value must be the same with the first parameter of Display::grid_js()
+     * @param string $div_id
      * @return  string  html
      *
      */
@@ -1622,6 +1627,8 @@ 
      * @param  string  url that will be added (for jquery see hot_courses.tpl)
 	 * @param	string	point info array see function CourseManager::get_course_ranking()
 	 * @param	bool	add a div wrapper
+	 * @param string $id
+	 * @param string $url
 	 * @todo	use     templates
      **/
     public static function return_rating_system($id, $url, $point_info = array(), $add_div_wrapper = true)
@@ -1717,6 +1724,9 @@ 
         return '<'.$size.'>'.Security::remove_XSS($title).'</'.$size.'>';
     }
 
+    /**
+     * @param string $title
+     */
     public static function page_subheader2($title, $second_title = null)
     {
         return self::page_header($title, $second_title, 'h4');
@@ -1947,6 +1957,7 @@ 
 
     /**
      * @todo use twig
+     * @param string $title
      */
     public static function group_button($title, $elements)
     {
@@ -2164,9 +2175,9 @@ 
 
     /**
      * @param int $id
-     * @param array $content
+     * @param string[] $content
      * @param int $col
-     * @param bool|true $right
+     * @param boolean $right
      * @return string
      */
     public static function toolbarAction($id, $content = array(), $col = 2, $right = true)
@@ -2248,10 +2259,10 @@ 
     /**
      * @param string $title
      * @param string $content
-     * @param null $id
+     * @param string $id
      * @param array $params
-     * @param null $idAccordion
-     * @param null $idCollapse
+     * @param string $idAccordion
+     * @param string $idCollapse
      * @param bool|true $open
      * @param bool|false $fullClickable
      * @return null|string

Indentation +69 added lines, -69 removed lines

@@ -49,12 +49,12 @@ 
         );
     }
 
-     /**
-     * Displays the page header
-     * @param string The name of the page (will be showed in the page title)
-     * @param string Optional help file name
-     * @param string $page_header
-     */
+        /**
+         * Displays the page header
+         * @param string The name of the page (will be showed in the page title)
+         * @param string Optional help file name
+         * @param string $page_header
+         */
     public static function display_header($tool_name ='', $help = null, $page_header = null)
     {
         $origin = api_get_origin();
@@ -448,7 +448,7 @@ 
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
-    	$message = self::return_message($message, 'normal', $filter);
+        $message = self::return_message($message, 'normal', $filter);
         if ($returnValue) {
             return $message;
         } else {
@@ -524,22 +524,22 @@ 
     public static function return_message($message, $type = 'normal', $filter = true)
     {
         if ($filter) {
-        	$message = api_htmlentities($message, ENT_QUOTES, api_is_xml_http_request() ? 'UTF-8' : api_get_system_encoding());
+            $message = api_htmlentities($message, ENT_QUOTES, api_is_xml_http_request() ? 'UTF-8' : api_get_system_encoding());
         }
 
         $class = "";
         switch($type) {
             case 'warning':
                $class .= 'alert alert-warning';
-               break;
+                break;
             case 'error':
                $class .= 'alert alert-danger';
-               break;
+                break;
             case 'confirmation':
             case 'confirm':
             case 'success':
                 $class .= 'alert alert-success';
-               break;
+                break;
             case 'normal':
             default:
                 $class .= 'alert alert-info';
@@ -682,7 +682,7 @@ 
      * @param array    additional attributes (for instance height, width, onclick, ...)
      * @param integer  The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
      * @return void
-    */
+     */
     public static function display_icon(
         $image,
         $alt_text = '',
@@ -705,7 +705,7 @@ 
      * @author Julio Montoya 2010 Function improved, adding image constants
      * @author Yannick Warnier 2011 Added size handler
      * @version Feb 2011
-    */
+     */
     public static function return_icon(
         $image,
         $alt_text = '',
@@ -884,14 +884,14 @@ 
      */
     public static function input($type, $name, $value, $attributes = array())
     {
-         if (isset($type)) {
-             $attributes['type']= $type;
-         }
-         if (isset($name)) {
-             $attributes['name']= $name;
-         }
-         if (isset($value)) {
-             $attributes['value']= $value;
+            if (isset($type)) {
+                $attributes['type']= $type;
+            }
+            if (isset($name)) {
+                $attributes['name']= $name;
+            }
+            if (isset($value)) {
+                $attributes['value']= $value;
         }
         return self::tag('input', '', $attributes);
     }
@@ -904,10 +904,10 @@ 
      */
     public static function button($name, $value, $attributes = array())
     {
-    	if (!empty($name)) {
+        if (!empty($name)) {
             $attributes['name'] = $name;
-    	}
-    	return self::tag('button', $value, $attributes);
+        }
+        return self::tag('button', $value, $attributes);
     }
 
     /**
@@ -974,7 +974,7 @@ 
      * in the $htmlHeadXtra variable before the display_header
      * Add this script
      * @example
-             * <script>
+     * <script>
                     $(function() {
                         $( "#tabs" ).tabs();
                     });
@@ -1035,20 +1035,20 @@ 
      */
     public static function tabsOnlyLink($headers, $selected = null)
     {
-         $id = uniqid();
-         $i = 1;
-         $lis = null;
-         foreach ($headers as $item) {
+            $id = uniqid();
+            $i = 1;
+            $lis = null;
+            foreach ($headers as $item) {
             $class = null;
             if ($i == $selected) {
                 $class = 'active';
             }
-             $item = self::tag(
-                 'a',
-                 $item['content'],
-                 array('id' => $id.'-'.$i, 'href' => $item['url'])
-             );
-             $lis .= self::tag('li', $item, array('class' => $class));
+                $item = self::tag(
+                    'a',
+                    $item['content'],
+                    array('id' => $id.'-'.$i, 'href' => $item['url'])
+                );
+                $lis .= self::tag('li', $item, array('class' => $class));
             $i++;
         }
         return self::tag('ul', $lis, array('class' => 'nav nav-tabs tabs-margin'));
@@ -1260,8 +1260,8 @@ 
      */
     public static function table($headers, $rows, $attributes = array())
     {
-    	if (empty($attributes)) {
-    		$attributes['class'] = 'data_table';
+        if (empty($attributes)) {
+            $attributes['class'] = 'data_table';
         }
         $table = new HTML_Table($attributes);
         $row = 0;
@@ -1269,17 +1269,17 @@ 
 
         // Course headers
         if (!empty($headers)) {
-	        foreach ($headers as $item) {
-	            $table->setHeaderContents($row, $column, $item);
-	            $column++;
-	        }
-	        $row = 1;
-	        $column = 0;
+            foreach ($headers as $item) {
+                $table->setHeaderContents($row, $column, $item);
+                $column++;
+            }
+            $row = 1;
+            $column = 0;
         }
 
         if (!empty($rows)) {
-	        foreach($rows as $content) {
-	            $table->setCellContents($row, $column, $content);
+            foreach($rows as $content) {
+                $table->setCellContents($row, $column, $content);
                 $row++;
             }
         }
@@ -1385,7 +1385,7 @@ 
                         //$item_property['tool'] != TOOL_DROPBOX &&
                         $item_property['tool'] != TOOL_NOTEBOOK &&
                         $item_property['tool'] != TOOL_CHAT)
-                   )
+                    )
                 )
                 // Take only what's visible or "invisible but where the user is a teacher" or where the visibility is unset.
                 && ($item_property['visibility'] == '1'
@@ -1401,7 +1401,7 @@ 
                         ($item_property['to_user_id'] != $user_id) &&
                         (!isset($item_property['to_group_id']) || !in_array($item_property['to_group_id'], $group_ids)))
                 ) {
-                   continue;
+                    continue;
                 }
 
                 // If it's a survey, make sure the user's invited. Otherwise drop it.
@@ -1620,21 +1620,21 @@ 
      *
      * @param  string  id of the rating ul element
      * @param  string  url that will be added (for jquery see hot_courses.tpl)
-	 * @param	string	point info array see function CourseManager::get_course_ranking()
-	 * @param	bool	add a div wrapper
-	 * @todo	use     templates
+     * @param	string	point info array see function CourseManager::get_course_ranking()
+     * @param	bool	add a div wrapper
+     * @todo	use     templates
      **/
     public static function return_rating_system($id, $url, $point_info = array(), $add_div_wrapper = true)
     {
-		$number_of_users_who_voted = isset($point_info['users_who_voted']) ? $point_info['users_who_voted'] : null;
-		$percentage = isset($point_info['point_average']) ? $point_info['point_average'] : 0;
+        $number_of_users_who_voted = isset($point_info['users_who_voted']) ? $point_info['users_who_voted'] : null;
+        $percentage = isset($point_info['point_average']) ? $point_info['point_average'] : 0;
 
-		if (!empty($percentage)) {
+        if (!empty($percentage)) {
             $percentage = $percentage*125/100;
         }
-		$accesses =  isset($point_info['accesses']) ? $point_info['accesses'] : 0;
+        $accesses =  isset($point_info['accesses']) ? $point_info['accesses'] : 0;
 
-		$star_label = sprintf(get_lang('XStarsOutOf5'), $point_info['point_average_star']);
+        $star_label = sprintf(get_lang('XStarsOutOf5'), $point_info['point_average_star']);
 
         $html = '<ul id="'.$id.'" class="star-rating">
 					<li class="current-rating" style="width:'.$percentage.'px;"></li>
@@ -1645,26 +1645,26 @@ 
 					<li><a href="javascript:void(0);" data-link="'.$url.'&amp;star=5" title="'.$star_label.'" class="five-stars">5</a></li>
 				</ul>';
 
-		$labels = array();
+        $labels = array();
 
-		$labels[]= $number_of_users_who_voted == 1 ? $number_of_users_who_voted.' '.get_lang('Vote') : $number_of_users_who_voted.' '.get_lang('Votes');
-		$labels[]= $accesses == 1 ? $accesses.' '.get_lang('Visit') : $accesses.' '.get_lang('Visits');
-		if (!empty($number_of_users_who_voted)) {
-			$labels[]= get_lang('Average').' '.$point_info['point_average_star'].'/5';
-		}
+        $labels[]= $number_of_users_who_voted == 1 ? $number_of_users_who_voted.' '.get_lang('Vote') : $number_of_users_who_voted.' '.get_lang('Votes');
+        $labels[]= $accesses == 1 ? $accesses.' '.get_lang('Visit') : $accesses.' '.get_lang('Visits');
+        if (!empty($number_of_users_who_voted)) {
+            $labels[]= get_lang('Average').' '.$point_info['point_average_star'].'/5';
+        }
 
-		$labels[]= $point_info['user_vote']  ? get_lang('YourVote').' ['.$point_info['user_vote'].']' : get_lang('YourVote'). ' [?] ';
+        $labels[]= $point_info['user_vote']  ? get_lang('YourVote').' ['.$point_info['user_vote'].']' : get_lang('YourVote'). ' [?] ';
 
-		if (!$add_div_wrapper && api_is_anonymous()) {
-			$labels[]= Display::tag('span', get_lang('LoginToVote'), array('class' => 'error'));
-		}
+        if (!$add_div_wrapper && api_is_anonymous()) {
+            $labels[]= Display::tag('span', get_lang('LoginToVote'), array('class' => 'error'));
+        }
 
         $html .= Display::div(implode(' | ', $labels) , array('id' =>  'vote_label_'.$id, 'class' => 'vote_label_info'));
         $html .= ' '.Display::span(' ', array('id' =>  'vote_label2_'.$id));
 
         if ($add_div_wrapper) {
-			$html = Display::div($html, array('id' => 'rating_wrapper_'.$id));
-		}
+            $html = Display::div($html, array('id' => 'rating_wrapper_'.$id));
+        }
 
         return $html;
     }
@@ -1702,8 +1702,8 @@ 
         return self::page_header($title, $second_title);
     }
 
-     public static function page_subheader_and_translate($title, $second_title = null)
-     {
+        public static function page_subheader_and_translate($title, $second_title = null)
+        {
         $title = get_lang($title);
         return self::page_subheader($title, $second_title);
     }

Braces +3 added lines, -2 removed lines

@@ -666,9 +666,10 @@
         $result = '';
         for ($i = $min; $i <= $max; $i ++) {
             $result .= '<option value="'.$i.'"';
-            if (is_int($selected_num))
-                if ($selected_num == $i) {
+            if (is_int($selected_num)) {
+                            if ($selected_num == $i) {
                     $result .= ' selected="selected"';
+            }
                 }
             $result .= '>'.$i.'</option>';
         }

Spacing +73 added lines, -73 removed lines

@@ -55,7 +55,7 @@ 
      * @param string Optional help file name
      * @param string $page_header
      */
-    public static function display_header($tool_name ='', $help = null, $page_header = null)
+    public static function display_header($tool_name = '', $help = null, $page_header = null)
     {
         $origin = api_get_origin();
         $showHeader = true;
@@ -351,7 +351,7 @@ 
         $grid_class = array(),
         $elementCount = 0
     ) {
-        $column =  0;
+        $column = 0;
         $default_items_per_page = isset($paging_options['per_page']) ? $paging_options['per_page'] : 20;
 
         $table = new SortableTableFromArray($content, $column, $default_items_per_page, $name);
@@ -476,7 +476,7 @@ 
      * @param bool	Filter (true) or not (false)
      * @return void
      */
-    public static function display_confirmation_message ($message, $filter = true, $returnValue = false)
+    public static function display_confirmation_message($message, $filter = true, $returnValue = false)
     {
         $message = self::return_message($message, 'confirm', $filter);
         if ($returnValue) {
@@ -493,7 +493,7 @@ 
      * @param bool	Filter (true) or not (false)
      * @return void
      */
-    public static function display_error_message ($message, $filter = true, $returnValue = false)
+    public static function display_error_message($message, $filter = true, $returnValue = false)
     {
         $message = self::return_message($message, 'error', $filter);
         if ($returnValue) {
@@ -508,7 +508,7 @@ 
      * @param string $type
      * @param bool $filter
      */
-    public static function return_message_and_translate($message, $type='normal', $filter = true)
+    public static function return_message_and_translate($message, $type = 'normal', $filter = true)
     {
         $message = get_lang($message);
         echo self::return_message($message, $type, $filter);
@@ -532,7 +532,7 @@ 
         }
 
         $class = "";
-        switch($type) {
+        switch ($type) {
             case 'warning':
                $class .= 'alert alert-warning';
                break;
@@ -560,7 +560,7 @@ 
      * @param string  optional, class from stylesheet
      * @return string encrypted mailto hyperlink
      */
-    public static function encrypted_mailto_link ($email, $clickable_text = null, $style_class = '')
+    public static function encrypted_mailto_link($email, $clickable_text = null, $style_class = '')
     {
         if (is_null($clickable_text)) {
             $clickable_text = $email;
@@ -575,14 +575,14 @@ 
         }
         // Encrypt email
         $hmail = '';
-        for ($i = 0; $i < strlen($email); $i ++) {
+        for ($i = 0; $i < strlen($email); $i++) {
             $hmail .= '&#'.ord($email {
             $i }).';';
         }
         $hclickable_text = null;
         // Encrypt clickable text if @ is present
         if (strpos($clickable_text, '@')) {
-            for ($i = 0; $i < strlen($clickable_text); $i ++) {
+            for ($i = 0; $i < strlen($clickable_text); $i++) {
                 $hclickable_text .= '&#'.ord($clickable_text {
                 $i }).';';
             }
@@ -614,7 +614,7 @@ 
         }
         // Encrypt email
         $hmail = '';
-        for ($i = 0; $i < strlen($email); $i ++) {
+        for ($i = 0; $i < strlen($email); $i++) {
             $hmail .= '&#'.ord($email {
             $i }).';';
         }
@@ -647,7 +647,7 @@ 
     public static function get_alphabet_options($selected_letter = '')
     {
         $result = '';
-        for ($i = 65; $i <= 90; $i ++) {
+        for ($i = 65; $i <= 90; $i++) {
             $letter = chr($i);
             $result .= '<option value="'.$letter.'"';
             if ($selected_letter == $letter) {
@@ -668,7 +668,7 @@ 
     public static function get_numeric_options($min, $max, $selected_num = 0)
     {
         $result = '';
-        for ($i = $min; $i <= $max; $i ++) {
+        for ($i = $min; $i <= $max; $i++) {
             $result .= '<option value="'.$i.'"';
             if (is_int($selected_num))
                 if ($selected_num == $i) {
@@ -745,7 +745,7 @@ 
             $size = ICON_SIZE_SMALL;
         }
 
-        $size_extra = $size . '/';
+        $size_extra = $size.'/';
 
         // Checking the img/ folder
         $icon = $w_code_path.'img/'.$image;
@@ -753,7 +753,7 @@ 
         $theme = 'themes/chamilo/icons/';
 
         if ($loadThemeIcon) {
-            $theme = 'themes/' . api_get_visual_theme() . '/icons/';
+            $theme = 'themes/'.api_get_visual_theme().'/icons/';
             // Checking the theme icons folder example: app/Resources/public/css/themes/chamilo/icons/XXX
             if (is_file($alternateCssPath.$theme.$size_extra.$image)) {
                 $icon = $alternateWebCssPath.$theme.$size_extra.$image;
@@ -775,11 +775,11 @@ 
         // ask for the SVG version directly
         $testServer = api_get_setting('server_type');
         if ($testServer == 'test' && $return_only_path == false) {
-            $svgImage = substr($image, 0, -3) . 'svg';
-            if (is_file($code_path . $theme . 'svg/' . $svgImage)) {
-                $icon = $w_code_path . $theme . 'svg/' . $svgImage;
-            } elseif (is_file($code_path . 'img/icons/svg/' . $svgImage)) {
-                $icon = $w_code_path . 'img/icons/svg/' . $svgImage;
+            $svgImage = substr($image, 0, -3).'svg';
+            if (is_file($code_path.$theme.'svg/'.$svgImage)) {
+                $icon = $w_code_path.$theme.'svg/'.$svgImage;
+            } elseif (is_file($code_path.'img/icons/svg/'.$svgImage)) {
+                $icon = $w_code_path.'img/icons/svg/'.$svgImage;
             }
 
             if (empty($additional_attributes['height'])) {
@@ -859,7 +859,7 @@ 
             }
         }
         //some tags don't have this </XXX>
-        if (in_array($tag, array('img','input','br'))) {
+        if (in_array($tag, array('img', 'input', 'br'))) {
             $return_value = '<'.$tag.' '.$attribute_list.' />';
         } else {
             $return_value = '<'.$tag.' '.$attribute_list.' > '.$content.'</'.$tag.'>';
@@ -912,13 +912,13 @@ 
     public static function input($type, $name, $value, $attributes = array())
     {
          if (isset($type)) {
-             $attributes['type']= $type;
+             $attributes['type'] = $type;
          }
          if (isset($name)) {
-             $attributes['name']= $name;
+             $attributes['name'] = $name;
          }
          if (isset($value)) {
-             $attributes['value']= $value;
+             $attributes['value'] = $value;
         }
         return self::tag('input', '', $attributes);
     }
@@ -951,14 +951,14 @@ 
     ) {
         $html = '';
         $extra = '';
-        $default_id = 'id="' . $name . '" ';
+        $default_id = 'id="'.$name.'" ';
         foreach ($extra_attributes as $key => $parameter) {
             if ($key == 'id') {
                 $default_id = '';
             }
-            $extra .= $key . '="' . $parameter . '" ';
+            $extra .= $key.'="'.$parameter.'" ';
         }
-        $html .= '<select name="' . $name . '" ' . $default_id . ' ' . $extra . '>';
+        $html .= '<select name="'.$name.'" '.$default_id.' '.$extra.'>';
 
         if ($show_blank_item) {
             if (empty($blank_item_text)) {
@@ -966,14 +966,14 @@ 
             } else {
                 $blank_item_text = Security::remove_XSS($blank_item_text);
             }
-            $html .= self::tag('option', '-- ' . $blank_item_text . ' --', array('value' => '-1'));
+            $html .= self::tag('option', '-- '.$blank_item_text.' --', array('value' => '-1'));
         }
         if ($values) {
             foreach ($values as $key => $value) {
                 if (is_array($value) && isset($value['name'])) {
                     $value = $value['name'];
                 }
-                $html .= '<option value="' . $key . '"';
+                $html .= '<option value="'.$key.'"';
 
                 if (is_array($default)) {
                     foreach ($default as $item) {
@@ -988,7 +988,7 @@ 
                     }
                 }
 
-                $html .= '>' . $value . '</option>';
+                $html .= '>'.$value.'</option>';
             }
         }
         $html .= '</select>';
@@ -1014,7 +1014,7 @@ 
      */
     public static function tabs($header_list, $content_list, $id = 'tabs', $attributes = array(), $ul_attributes = array())
     {
-        if (empty($header_list) || count($header_list) == 0 ) {
+        if (empty($header_list) || count($header_list) == 0) {
             return '';
         }
 
@@ -1051,7 +1051,7 @@ 
 
         $main_div = self::tag('div', $ul.self::tag('div', $divs, ['class' => 'tab-content']), $attributes);
 
-        return $main_div ;
+        return $main_div;
     }
 
     /**
@@ -1099,8 +1099,8 @@ 
      */
     public static function grid_html($div_id)
     {
-        $table  = self::tag('table','', array('id' => $div_id));
-        $table .= self::tag('div','', array('id' => $div_id.'_pager'));
+        $table  = self::tag('table', '', array('id' => $div_id));
+        $table .= self::tag('div', '', array('id' => $div_id.'_pager'));
         return $table;
     }
 
@@ -1161,7 +1161,7 @@ 
         $obj->colNames      = $column_names;
         $obj->colModel      = $column_model;
         $obj->pager         = '#'.$div_id.'_pager';
-        $obj->datatype  = 'json';
+        $obj->datatype = 'json';
         $obj->viewrecords = 'true';
 
         $all_value = 10000000;
@@ -1222,10 +1222,10 @@ 
         // Adding static data.
         if (!empty($data)) {
             $data_var = $div_id.'_data';
-            $json.=' var '.$data_var.' = '.json_encode($data).';';
+            $json .= ' var '.$data_var.' = '.json_encode($data).';';
             $obj->data = $data_var;
             $obj->datatype = 'local';
-            $json.="\n";
+            $json .= "\n";
         }
 
         $obj->end = 'end';
@@ -1239,12 +1239,12 @@ 
         }
 
         // Fixing true/false js values that doesn't need the ""
-        $json_encode = str_replace(':"true"',':true',$json_encode);
+        $json_encode = str_replace(':"true"', ':true', $json_encode);
         // wrap_cell is not a valid jqgrid attributes is a hack to wrap a text
         $json_encode = str_replace('"wrap_cell":true', 'cellattr : function(rowId, value, rowObject, colModel, arrData) { return \'class = "jqgrid_whitespace"\'; }', $json_encode);
-        $json_encode = str_replace(':"false"',':false',$json_encode);
+        $json_encode = str_replace(':"false"', ':false', $json_encode);
         $json_encode = str_replace('"formatter":"action_formatter"', 'formatter:action_formatter', $json_encode);
-        $json_encode = str_replace(array('{"first":"first",','"end":"end"}'), '', $json_encode);
+        $json_encode = str_replace(array('{"first":"first",', '"end":"end"}'), '', $json_encode);
 
         // Creating the jqgrid element.
         $json .= '$("#'.$div_id.'").jqGrid({';
@@ -1259,22 +1259,22 @@ 
             $groups = '';
             foreach ($extra_params['groupHeaders'] as $group) {
                 //{ "startColumnName" : "courses", "numberOfColumns" : 1, "titleText" : "Order Info" },
-                $groups .= '{ "startColumnName" : "' . $group['startColumnName'] . '", "numberOfColumns" : ' . $group['numberOfColumns'] . ', "titleText" : "' . $group['titleText']  . '" },';
+                $groups .= '{ "startColumnName" : "'.$group['startColumnName'].'", "numberOfColumns" : '.$group['numberOfColumns'].', "titleText" : "'.$group['titleText'].'" },';
 
             }
             $json .= '$("#'.$div_id.'").jqGrid("setGroupHeaders", {
                 "useColSpanStyle" : false,
                 "groupHeaders"    : [
-                    ' . $groups . '
+                    ' . $groups.'
                 ]
             });';
         }
 
         $all_text = addslashes(get_lang('All'));
         $json .= '$("'.$obj->pager.' option[value='.$all_value.']").text("'.$all_text.'");';
-        $json.= "\n";
+        $json .= "\n";
         // Adding edit/delete icons.
-        $json.= $formatter;
+        $json .= $formatter;
 
         return $json;
     }
@@ -1305,7 +1305,7 @@ 
         }
 
         if (!empty($rows)) {
-	        foreach($rows as $content) {
+	        foreach ($rows as $content) {
 	            $table->setCellContents($row, $column, $content);
                 $row++;
             }
@@ -1467,7 +1467,7 @@ 
 
         // Show all tool icons where there is something new.
         $return = '&nbsp;';
-        foreach($notifications as $notification) {
+        foreach ($notifications as $notification) {
             $lastDate = date('d/m/Y H:i', convert_sql_date($notification['lastedit_date']));
             $type = $notification['lastedit_type'];
             $label = get_lang('TitleNotification').": ".get_lang($type)." ($lastDate)";
@@ -1510,9 +1510,9 @@ 
             $tbl_session            = Database :: get_main_table(TABLE_MAIN_SESSION);
             $active = false;
             // Request for the name of the general coach
-            $sql ='SELECT tu.lastname, tu.firstname, ts.*
+            $sql = 'SELECT tu.lastname, tu.firstname, ts.*
                     FROM '.$tbl_session.' ts
-                    LEFT JOIN '.$main_user_table .' tu
+                    LEFT JOIN '.$main_user_table.' tu
                     ON ts.id_coach = tu.user_id
                     WHERE ts.id = '.intval($session_id);
             $rs = Database::query($sql);
@@ -1522,7 +1522,7 @@ 
             $session = array();
             $session['title'] = $session_info['name'];
             $session['coach'] = '';
-            $session['dates'] =  '';
+            $session['dates'] = '';
 
             if (
                 (
@@ -1605,7 +1605,7 @@ 
                 }
 
                 if (api_get_setting('show_session_coach') === 'true') {
-                    $session['coach'] = get_lang('GeneralCoach') . ': ' . api_get_person_name(
+                    $session['coach'] = get_lang('GeneralCoach').': '.api_get_person_name(
                         $session_info['firstname'],
                         $session_info['lastname']
                     );
@@ -1656,9 +1656,9 @@ 
 		$percentage = isset($point_info['point_average']) ? $point_info['point_average'] : 0;
 
 		if (!empty($percentage)) {
-            $percentage = $percentage*125/100;
+            $percentage = $percentage * 125 / 100;
         }
-		$accesses =  isset($point_info['accesses']) ? $point_info['accesses'] : 0;
+		$accesses = isset($point_info['accesses']) ? $point_info['accesses'] : 0;
 
 		$star_label = sprintf(get_lang('XStarsOutOf5'), $point_info['point_average_star']);
 
@@ -1673,19 +1673,19 @@ 
 
 		$labels = array();
 
-		$labels[]= $number_of_users_who_voted == 1 ? $number_of_users_who_voted.' '.get_lang('Vote') : $number_of_users_who_voted.' '.get_lang('Votes');
-		$labels[]= $accesses == 1 ? $accesses.' '.get_lang('Visit') : $accesses.' '.get_lang('Visits');
+		$labels[] = $number_of_users_who_voted == 1 ? $number_of_users_who_voted.' '.get_lang('Vote') : $number_of_users_who_voted.' '.get_lang('Votes');
+		$labels[] = $accesses == 1 ? $accesses.' '.get_lang('Visit') : $accesses.' '.get_lang('Visits');
 		if (!empty($number_of_users_who_voted)) {
-			$labels[]= get_lang('Average').' '.$point_info['point_average_star'].'/5';
+			$labels[] = get_lang('Average').' '.$point_info['point_average_star'].'/5';
 		}
 
-		$labels[]= $point_info['user_vote']  ? get_lang('YourVote').' ['.$point_info['user_vote'].']' : get_lang('YourVote'). ' [?] ';
+		$labels[] = $point_info['user_vote'] ? get_lang('YourVote').' ['.$point_info['user_vote'].']' : get_lang('YourVote').' [?] ';
 
 		if (!$add_div_wrapper && api_is_anonymous()) {
-			$labels[]= Display::tag('span', get_lang('LoginToVote'), array('class' => 'error'));
+			$labels[] = Display::tag('span', get_lang('LoginToVote'), array('class' => 'error'));
 		}
 
-        $html .= Display::div(implode(' | ', $labels) , array('id' =>  'vote_label_'.$id, 'class' => 'vote_label_info'));
+        $html .= Display::div(implode(' | ', $labels), array('id' =>  'vote_label_'.$id, 'class' => 'vote_label_info'));
         $html .= ' '.Display::span(' ', array('id' =>  'vote_label2_'.$id));
 
         if ($add_div_wrapper) {
@@ -1763,8 +1763,8 @@ 
         if (!empty($list)) {
             $html = '<dl class="dl-horizontal">';
             foreach ($list as $item) {
-                $html .= '<dt>' . $item['title'] . '</dt>';
-                $html .= '<dd>' . $item['content'] . '</dd>';
+                $html .= '<dt>'.$item['title'].'</dt>';
+                $html .= '<dd>'.$item['content'].'</dd>';
             }
             $html .= '</dl>';
         }
@@ -1806,7 +1806,7 @@ 
      * @param string $type
      * @return null|string
      */
-    public static function badge($count, $type ="warning")
+    public static function badge($count, $type = "warning")
     {
         $class = '';
 
@@ -1882,7 +1882,7 @@ 
         if (!empty($content)) {
             $html = '<span class="label '.$class.'">';
             $html .= $content;
-            $html .='</span>';
+            $html .= '</span>';
         }
 
         return $html;
@@ -1903,7 +1903,7 @@ 
                     $class = 'class ="active"';
                 }
 
-                if (basename($_SERVER['REQUEST_URI']) == basename($value['url']) ) {
+                if (basename($_SERVER['REQUEST_URI']) == basename($value['url'])) {
                     $class = 'class ="active"';
                 }
                 $html .= "<li $class >";
@@ -2154,7 +2154,7 @@ 
         }
         $label = $nextValue + $localCounter + 1;
         if ($isMedia) {
-            $label = ($fixedValue + 1) .' '.chr(97 + $localCounter);
+            $label = ($fixedValue + 1).' '.chr(97 + $localCounter);
             $link_to_show = $link.$fixedValue.'#questionanchor'.$itemId;
         }
         $link = Display::url($label.' ', $link_to_show, $linkAttributes);
@@ -2266,7 +2266,7 @@ 
      */
     public static function getVCardUserLink($userId)
     {
-        $vCardUrl = api_get_path(WEB_PATH).'main/social/vcard_export.php?userId='.intval($userId);;
+        $vCardUrl = api_get_path(WEB_PATH).'main/social/vcard_export.php?userId='.intval($userId); ;
 
         return $vCardUrl;
     }
@@ -2284,7 +2284,7 @@ 
     {
         $title = !empty($title) ? '<div class="panel-heading"><h3 class="panel-title">'.$title.'</h3>'.$extra.'</div>' : '';
         $footer = !empty($footer) ? '<div class="panel-footer ">'.$footer.'</div>' : '';
-        $styles = ['primary','success','info','warning','danger'];
+        $styles = ['primary', 'success', 'info', 'warning', 'danger'];
         $style = !in_array($style, $styles) ? 'default' : $style;
 
         return '
@@ -2329,7 +2329,7 @@ 
         $attributes['class'] = isset($attributes['class']) ? "$buttonClass {$attributes['class']}" : $buttonClass;
 
         if (!$includeText) {
-            $text = '<span class="sr-only">' . $text . '</span>';
+            $text = '<span class="sr-only">'.$text.'</span>';
         }
 
         return self::url("$icon $text", $url, $attributes);
@@ -2344,16 +2344,16 @@ 
      */
     public static function toolbarAction($id, $content = array(), $col = 2, $right = true)
     {
-        $columns = 12/$col;
+        $columns = 12 / $col;
         $html = '';
-        $html .= '<div id="' . $id . '" class="actions">';
+        $html .= '<div id="'.$id.'" class="actions">';
         $html .= '<div class="row">';
         if ($col > 4) {
             $html = '<div class="alert alert-warning" role="alert">Action toolbar design does not work when exceeding four columns - check Display::toolbarAction()</div>';
         } else {
-            for ( $i = 0; $i < $col; $i++ ) {
-                $html .= '<div class="col-md-' . $columns . '">';
-                if ( $col == 2 && $i == 1 ) {
+            for ($i = 0; $i < $col; $i++) {
+                $html .= '<div class="col-md-'.$columns.'">';
+                if ($col == 2 && $i == 1) {
                     if ($right === true) {
                         $html .= '<div class="pull-right">';
                         $html .= (isset($content[$i]) ? $content[$i] : '');
@@ -2468,9 +2468,9 @@ 
             $params['class'] = 'panel panel-default';
             $html = null;
             if (!empty($title)) {
-                $html .= '<div class="panel-heading">'.$title.'</div>' . PHP_EOL;
+                $html .= '<div class="panel-heading">'.$title.'</div>'.PHP_EOL;
             }
-            $html.= '<div class="panel-body">'.$content.'</div>' . PHP_EOL;
+            $html .= '<div class="panel-body">'.$content.'</div>'.PHP_EOL;
             $html = Display::div($html, $params);
         }
         return $html;

main/inc/lib/exercise.lib.php

Doc Comments +9 added lines, -6 removed lines

@@ -1255,6 +1255,7 @@ 
 
     /**
      * Validates the time control key
+     * @param integer $exercise_id
      */
     public static function exercise_time_control_is_valid(
         $exercise_id,
@@ -1388,7 +1389,7 @@ 
      * @param int $in_direction
      * @param string $in_hotpot_path
      * @param bool $in_get_count
-     * @param null $where_condition
+     * @param string $where_condition
      * @return array|int
      */
     public static function get_exam_results_hotpotatoes_data(
@@ -2179,7 +2180,7 @@ 
     /**
      * Return true if pass_pourcentage activated (we use the pass pourcentage feature
      * return false if pass_percentage = 0 (we don't use the pass pourcentage feature
-     * @param $in_pass_pourcentage
+     * @param string $in_pass_pourcentage
      * @return boolean
      * In this version, pass_percentage and show_success_message are disabled if
      * pass_percentage is set to 0
@@ -2192,7 +2193,7 @@ 
     /**
      * Converts a numeric value in a percentage example 0.66666 to 66.67 %
      * @param $value
-     * @return float Converted number
+     * @return string Converted number
      */
     public static function convert_to_percentage($value)
     {
@@ -2208,7 +2209,7 @@ 
      * @param   float $score
      * @param   float $weight
      * @deprecated seem not to be used
-     * @return  float   the score rounded converted to the new range
+     * @return  string|null   the score rounded converted to the new range
      */
     public static function convert_score($score, $weight)
     {
@@ -2759,6 +2760,7 @@ 
      * @param    int        exercise id
      * @param    int    $courseId
      * @param    int        session id
+     * @param integer $user_count
      * @return    float    Best average score
      */
     public static function get_best_average_score_by_exercise(
@@ -3198,8 +3200,9 @@ 
     }
 
     /**
-     * @param array $answer
+     * @param string|null $answer
      * @param string $user_answer
+     * @param string|null $current_answer
      * @return array
      */
     public static function check_fill_in_blanks($answer, $user_answer, $current_answer)
@@ -3805,7 +3808,7 @@ 
 
     /**
      * @param int $countLetter
-     * @return mixed
+     * @return string
      */
     public static function detectInputAppropriateClass($countLetter)
     {

Spacing +114 added lines, -114 removed lines

@@ -67,7 +67,7 @@ 
                 if ($show_title) {
                     TestCategory::displayCategoryAndTitle($objQuestionTmp->id);
                     echo Display::div(
-                        $current_item . '. ' . $objQuestionTmp->selectTitle(),
+                        $current_item.'. '.$objQuestionTmp->selectTitle(),
                         array('class' => 'question_title')
                     );
                 }
@@ -112,7 +112,7 @@ 
                         <div class="clearfix">
                         <ul class="exercise-draggable-answer ui-helper-reset ui-helper-clearfix">';
                 } else {
-                    $s .= '<div id="drag' . $questionId . '_question" class="drag_question">
+                    $s .= '<div id="drag'.$questionId.'_question" class="drag_question">
                            <table class="data_table">';
                 }
 
@@ -159,12 +159,12 @@ 
             } elseif ($answerType == FREE_ANSWER) {
                 $fck_content = isset($user_choice[0]) && !empty($user_choice[0]['answer']) ? $user_choice[0]['answer'] : null;
 
-                $form = new FormValidator('free_choice_' . $questionId);
+                $form = new FormValidator('free_choice_'.$questionId);
                 $config = array(
                     'ToolbarSet' => 'TestFreeAnswer'
                 );
-                $form->addHtmlEditor("choice[" . $questionId . "]", null, false, false, $config);
-                $form->setDefaults(array("choice[" . $questionId . "]" => $fck_content));
+                $form->addHtmlEditor("choice[".$questionId."]", null, false, false, $config);
+                $form->setDefaults(array("choice[".$questionId."]" => $fck_content));
                 $s .= $form->returnForm();
             } elseif ($answerType == ORAL_EXPRESSION) {
                 // Add nanog
@@ -189,11 +189,11 @@ 
                     echo $nano->show_button();
                 }
 
-                $form = new FormValidator('free_choice_' . $questionId);
+                $form = new FormValidator('free_choice_'.$questionId);
                 $config = array(
                     'ToolbarSet' => 'TestFreeAnswer'
                 );
-                $form->addHtmlEditor("choice[" . $questionId . "]", null, false, false, $config);
+                $form->addHtmlEditor("choice[".$questionId."]", null, false, false, $config);
                 //$form->setDefaults(array("choice[" . $questionId . "]" => $fck_content));
                 $s .= $form->returnForm();
             }
@@ -278,7 +278,7 @@ 
                     case UNIQUE_ANSWER_NO_OPTION:
                         //no break
                     case UNIQUE_ANSWER_IMAGE:
-                        $input_id = 'choice-' . $questionId . '-' . $answerId;
+                        $input_id = 'choice-'.$questionId.'-'.$answerId;
 
                         if (isset($user_choice[0]['answer']) && $user_choice[0]['answer'] == $numAnswer) {
                             $attributes = array(
@@ -304,14 +304,14 @@ 
                         if ($answerType == UNIQUE_ANSWER_IMAGE) {
                             if ($show_comment) {
                                 if (empty($comment)) {
-                                    $s .= '<div id="answer' . $questionId . $numAnswer . '" '
+                                    $s .= '<div id="answer'.$questionId.$numAnswer.'" '
                                         . 'class="exercise-unique-answer-image" style="text-align: center">';
                                 } else {
-                                    $s .= '<div id="answer' . $questionId . $numAnswer . '" '
+                                    $s .= '<div id="answer'.$questionId.$numAnswer.'" '
                                         . 'class="exercise-unique-answer-image col-xs-6 col-sm-12" style="text-align: center">';
                                 }
                             } else {
-                                $s .= '<div id="answer' . $questionId . $numAnswer . '" '
+                                $s .= '<div id="answer'.$questionId.$numAnswer.'" '
                                     . 'class="exercise-unique-answer-image col-xs-6 col-md-3" style="text-align: center">';
                             }
                         }
@@ -319,7 +319,7 @@ 
                         $answer = Security::remove_XSS($answer, STUDENT);
                         $s .= Display::input(
                             'hidden',
-                            'choice2[' . $questionId . ']',
+                            'choice2['.$questionId.']',
                             '0'
                         );
 
@@ -327,13 +327,13 @@ 
 
                         if ($answerType == UNIQUE_ANSWER_IMAGE) {
                             $attributes['style'] = 'display: none;';
-                            $answer = '<div class="thumbnail">' . $answer . '</div>';
+                            $answer = '<div class="thumbnail">'.$answer.'</div>';
                         }
 
                         $answer_input .= '<label class="radio">';
                         $answer_input .= Display::input(
                             'radio',
-                            'choice[' . $questionId . ']',
+                            'choice['.$questionId.']',
                             $numAnswer,
                             $attributes
                         );
@@ -360,7 +360,7 @@ 
                     case MULTIPLE_ANSWER_TRUE_FALSE:
                         //no break
                     case GLOBAL_MULTIPLE_ANSWER:
-                        $input_id = 'choice-' . $questionId . '-' . $answerId;
+                        $input_id = 'choice-'.$questionId.'-'.$answerId;
                         $answer = Security::remove_XSS($answer, STUDENT);
 
                         if (in_array($numAnswer, $user_choice_array)) {
@@ -381,12 +381,12 @@ 
                         }
 
                         if ($answerType == MULTIPLE_ANSWER || $answerType == GLOBAL_MULTIPLE_ANSWER) {
-                            $s .= '<input type="hidden" name="choice2[' . $questionId . ']" value="0" />';
+                            $s .= '<input type="hidden" name="choice2['.$questionId.']" value="0" />';
 
                             $answer_input = '<label class="checkbox">';
                             $answer_input .= Display::input(
                                 'checkbox',
-                                'choice[' . $questionId . '][' . $numAnswer . ']',
+                                'choice['.$questionId.']['.$numAnswer.']',
                                 $numAnswer,
                                 $attributes
                             );
@@ -439,7 +439,7 @@ 
                                         'td',
                                         Display::input(
                                             'radio',
-                                            'choice[' . $questionId . '][' . $numAnswer . ']',
+                                            'choice['.$questionId.']['.$numAnswer.']',
                                             $id,
                                             $attributes
                                         ),
@@ -458,7 +458,7 @@ 
                         break;
                     case MULTIPLE_ANSWER_COMBINATION:
                         // multiple answers
-                        $input_id = 'choice-' . $questionId . '-' . $answerId;
+                        $input_id = 'choice-'.$questionId.'-'.$answerId;
 
                         if (in_array($numAnswer, $user_choice_array)) {
                             $attributes = array(
@@ -478,11 +478,11 @@ 
                         }
 
                         $answer = Security::remove_XSS($answer, STUDENT);
-                        $answer_input = '<input type="hidden" name="choice2[' . $questionId . ']" value="0" />';
+                        $answer_input = '<input type="hidden" name="choice2['.$questionId.']" value="0" />';
                         $answer_input .= '<label class="checkbox">';
                         $answer_input .= Display::input(
                             'checkbox',
-                            'choice[' . $questionId . '][' . $numAnswer . ']',
+                            'choice['.$questionId.']['.$numAnswer.']',
                             1,
                             $attributes
                         );
@@ -503,7 +503,7 @@ 
                         }
                         break;
                     case MULTIPLE_ANSWER_COMBINATION_TRUE_FALSE:
-                        $s .= '<input type="hidden" name="choice2[' . $questionId . ']" value="0" />';
+                        $s .= '<input type="hidden" name="choice2['.$questionId.']" value="0" />';
 
                         $my_choice = array();
                         if (!empty($user_choice_array)) {
@@ -538,7 +538,7 @@ 
                                 'td',
                                 Display::input(
                                     'radio',
-                                    'choice[' . $questionId . '][' . $numAnswer . ']',
+                                    'choice['.$questionId.']['.$numAnswer.']',
                                     $key,
                                     $attributes
                                 )
@@ -595,7 +595,7 @@ 
                                     // may be "" if student viewed the question, but did not fill the blanks
                                     $correctItem = $studentAnswerList[$i];
                                 }
-                                $attributes["style"] = "width:" . $listAnswerInformations["tabinputsize"][$i] . "px";
+                                $attributes["style"] = "width:".$listAnswerInformations["tabinputsize"][$i]."px";
                                 $answer .= FillBlanks::getFillTheBlankHtml($separatorStartRegexp, $separatorEndRegexp, $correctItemRegexp, $questionId, $correctItem, $attributes, $answer, $listAnswerInformations, $displayForStudent, $i);
                             }
                             // display the last common word
@@ -609,7 +609,7 @@ 
                                 // display the common words
                                 $answer .= $listAnswerInformations["commonwords"][$i];
                                 // display the blank word
-                                $attributes["style"] = "width:" . $listAnswerInformations["tabinputsize"][$i] . "px";
+                                $attributes["style"] = "width:".$listAnswerInformations["tabinputsize"][$i]."px";
                                 $correctItem = $listAnswerInformations["tabwords"][$i];
                                 $correctItemRegexp = $correctItem;
                                 // replace / with \/ to allow the preg_replace bellow and all the regexp char
@@ -635,8 +635,8 @@ 
                             $trackAttempts = Database::get_main_table(
                                 TABLE_STATISTIC_TRACK_E_ATTEMPT
                             );
-                            $sql = 'SELECT answer FROM ' . $trackAttempts . '
-                                WHERE exe_id=' . $exe_id . ' AND question_id=' . $questionId;
+                            $sql = 'SELECT answer FROM '.$trackAttempts.'
+                                WHERE exe_id=' . $exe_id.' AND question_id='.$questionId;
                             $rsLastAttempt = Database::query($sql);
                             $rowLastAttempt = Database::fetch_array($rsLastAttempt);
                             $answer = $rowLastAttempt['answer'];
@@ -693,7 +693,7 @@ 
                                     '',
                                     $answerCorrected
                                 );
-                                $answerCorrected = '[' . $answerCorrected . ']';
+                                $answerCorrected = '['.$answerCorrected.']';
                                 $studentAnswerList[] = $answerCorrected;
                             }
                         }
@@ -714,7 +714,7 @@ 
                         */
                         $tabComments = api_preg_split(
                             '/\[[^]]+\]/',
-                            ' ' . $answer . ' '
+                            ' '.$answer.' '
                         );
                         if (!empty($correctAnswerList) && !empty($studentAnswerList)) {
                             $answer = "";
@@ -731,7 +731,7 @@ 
                                     $size
                                 );
 
-                                $answer .= $tabComments[$i] .
+                                $answer .= $tabComments[$i].
                                     Display::input(
                                         'text',
                                         "choice[$questionId][]",
@@ -778,12 +778,12 @@ 
                             $s .= '<tr><td width="45%" valign="top">';
                             $parsed_answer = $answer;
                             //left part questions
-                            $s .= '<p class="indent">' . $lines_count . '.&nbsp;' . $parsed_answer . '</p></td>';
+                            $s .= '<p class="indent">'.$lines_count.'.&nbsp;'.$parsed_answer.'</p></td>';
                             //middle part (matches selects)
 
                             $s .= '<td width="10%" valign="top" align="center" >
                                 <div class="select-matching">
-                                <select name="choice[' . $questionId . '][' . $numAnswer . ']">';
+                                <select name="choice[' . $questionId.']['.$numAnswer.']">';
 
                             // fills the list-box
                             foreach ($select_items as $key => $val) {
@@ -799,14 +799,14 @@ 
                                 if (isset($user_choice_array_position[$numAnswer]) && $val['id'] == $user_choice_array_position[$numAnswer]) {
                                     $selected = 'selected="selected"';
                                 }
-                                $s .= '<option value="' . $val['id'] . '" ' . $selected . '>' . $val['letter'] . '</option>';
+                                $s .= '<option value="'.$val['id'].'" '.$selected.'>'.$val['letter'].'</option>';
 
                             }  // end foreach()
 
                             $s .= '</select></div></td><td width="5%" class="separate">&nbsp;</td>';
                             $s .= '<td width="40%" valign="top" >';
                             if (isset($select_items[$lines_count])) {
-                                $s .= '<div class="text-right"><p class="indent">' . $select_items[$lines_count]['letter'] . '.&nbsp; ' . $select_items[$lines_count]['answer'] . '</p></div>';
+                                $s .= '<div class="text-right"><p class="indent">'.$select_items[$lines_count]['letter'].'.&nbsp; '.$select_items[$lines_count]['answer'].'</p></div>';
                             } else {
                                 $s .= '&nbsp;';
                             }
@@ -821,7 +821,7 @@ 
                                     $s .= '<tr>
                                       <td colspan="2"></td>
                                       <td valign="top">';
-                                    $s .= '<b>' . $select_items[$lines_count]['letter'] . '.</b> ' . $select_items[$lines_count]['answer'];
+                                    $s .= '<b>'.$select_items[$lines_count]['letter'].'.</b> '.$select_items[$lines_count]['answer'];
                                     $s .= "</td>
                                 </tr>";
                                     $lines_count++;
@@ -838,9 +838,9 @@ 
                             $data = $objAnswerTmp->getAnswerByAutoId($data['correct']);
                             $lines_count = $data['answer'];*/
 
-                            $windowId = $questionId . '_' . $lines_count;
+                            $windowId = $questionId.'_'.$lines_count;
 
-                            $s .= '<li class="touch-items" id="' . $windowId . '">';
+                            $s .= '<li class="touch-items" id="'.$windowId.'">';
                             $s .= Display::div(
                                 $parsed_answer,
                                 [
@@ -898,7 +898,7 @@ 
                                     Display::tag(
                                         'b',
                                         $select_items[$lines_count]['letter']
-                                    ) . $select_items[$lines_count]['answer'],
+                                    ).$select_items[$lines_count]['answer'],
                                     [
                                         'id' => "window_{$windowId}_answer",
                                         'style' => 'display: none;'
@@ -1069,7 +1069,7 @@ 
 
                 for ($answerId = 1; $answerId <= $nbrAnswers; $answerId++) {
                     $answerCorrect = $objAnswerTmp->isCorrect($answerId);
-                    $windowId = $questionId . '_' . $counterAnswer;
+                    $windowId = $questionId.'_'.$counterAnswer;
 
                     if ($answerCorrect) {
                         $s .= Display::div(
@@ -1114,7 +1114,7 @@ 
                 $course = api_get_course_info();
                 $doc_id = DocumentManager::get_document_id(
                     $course,
-                    '/images/' . $pictureName
+                    '/images/'.$pictureName
                 );
                 if (is_numeric($doc_id)) {
                     $images_folder_visibility = api_get_item_visibility(
@@ -1139,7 +1139,7 @@ 
                 echo "
                     <script>
                         $(document).on('ready', function () {
-                            new " . ($answerType == HOT_SPOT ? "HotspotQuestion" : "DelineationQuestion") . "({
+                            new " . ($answerType == HOT_SPOT ? "HotspotQuestion" : "DelineationQuestion")."({
                                 questionId: $questionId,
                                 exerciseId: $exerciseId,
                                 selector: '#hotspot-preview-$questionId',
@@ -1173,7 +1173,7 @@ 
             if ($answerType != HOT_SPOT_DELINEATION) {
                 $answerList = '
                     <div class="well well-sm">
-                        <h5 class="page-header">' . get_lang('HotspotZones') . '</h5>
+                        <h5 class="page-header">' . get_lang('HotspotZones').'</h5>
                         <ol>
                 ';
 
@@ -1198,7 +1198,7 @@ 
             if (!$only_questions) {
                 if ($show_title) {
                     TestCategory::displayCategoryAndTitle($objQuestionTmp->id);
-                    echo '<div class="question_title">' . $current_item . '. ' . $questionName . '</div>';
+                    echo '<div class="question_title">'.$current_item.'. '.$questionName.'</div>';
                 }
                 //@todo I need to the get the feedback type
                 echo <<<HOTSPOT
@@ -1215,7 +1215,7 @@ 
                                 <div class=\"hotspot-image\"></div>
                                 <script>
                                     $(document).on('ready', function () {
-                                        new " . ($answerType == HOT_SPOT_DELINEATION ? 'DelineationQuestion' : 'HotspotQuestion') . "({
+                                        new " . ($answerType == HOT_SPOT_DELINEATION ? 'DelineationQuestion' : 'HotspotQuestion')."({
                                             questionId: $questionId,
                                             exerciseId: $exe_id,
                                             selector: '#question_div_' + $questionId + ' .hotspot-image',
@@ -1336,11 +1336,11 @@ 
         $lp_id = intval($lp_id);
         $lp_item_id = intval($lp_item_id);
         return
-            api_get_course_int_id() . '_' .
-            api_get_session_id() . '_' .
-            $exercise_id . '_' .
-            api_get_user_id() . '_' .
-            $lp_id . '_' .
+            api_get_course_int_id().'_'.
+            api_get_session_id().'_'.
+            $exercise_id.'_'.
+            api_get_user_id().'_'.
+            $lp_id.'_'.
             $lp_item_id;
     }
 
@@ -1454,14 +1454,14 @@ 
         $res = Database::query($sql);
         $result = array();
         $apiIsAllowedToEdit = api_is_allowed_to_edit();
-        $urlBase = api_get_path(WEB_CODE_PATH) .
-            'exercice/hotpotatoes_exercise_report.php?action=delete&' .
-            api_get_cidreq() . '&id=';
+        $urlBase = api_get_path(WEB_CODE_PATH).
+            'exercice/hotpotatoes_exercise_report.php?action=delete&'.
+            api_get_cidreq().'&id=';
         while ($data = Database::fetch_array($res)) {
             $actions = null;
 
             if ($apiIsAllowedToEdit) {
-                $url = $urlBase . $data['id'] . '&path=' . $data['exe_name'];
+                $url = $urlBase.$data['id'].'&path='.$data['exe_name'];
                 $actions = Display::url(
                     Display::return_icon('delete.png', get_lang('Delete')),
                     $url
@@ -1477,7 +1477,7 @@ 
                     GroupManager::get_user_group_name($data['user_id'])
                 ),
                 'exe_date' => $data['exe_date'],
-                'score' => $data['exe_result'] . ' / ' . $data['exe_weighting'],
+                'score' => $data['exe_result'].' / '.$data['exe_weighting'],
                 'actions' => $actions,
             );
         }
@@ -1562,18 +1562,18 @@ 
         $TBL_TRACK_HOTPOTATOES = Database:: get_main_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
         $TBL_TRACK_ATTEMPT_RECORDING = Database:: get_main_table(TABLE_STATISTIC_TRACK_E_ATTEMPT_RECORDING);
 
-        $session_id_and = ' AND te.session_id = ' . $sessionId . ' ';
+        $session_id_and = ' AND te.session_id = '.$sessionId.' ';
         $exercise_id = intval($exercise_id);
 
         $exercise_where = '';
         if (!empty($exercise_id)) {
-            $exercise_where .= ' AND te.exe_exo_id = ' . $exercise_id . '  ';
+            $exercise_where .= ' AND te.exe_exo_id = '.$exercise_id.'  ';
         }
 
         $hotpotatoe_where = '';
         if (!empty($_GET['path'])) {
             $hotpotatoe_path = Database::escape_string($_GET['path']);
-            $hotpotatoe_where .= ' AND exe_name = "' . $hotpotatoe_path . '"  ';
+            $hotpotatoe_where .= ' AND exe_name = "'.$hotpotatoe_path.'"  ';
         }
 
         // sql for chamilo-type tests for teacher / tutor view
@@ -1585,7 +1585,7 @@ 
             WHERE
                 c_id = $course_id AND
                 exe_exo_id = $exercise_id AND
-                ttte.session_id = " . $sessionId . "
+                ttte.session_id = ".$sessionId."
         )";
 
         if ($is_allowedToEdit) {
@@ -1608,9 +1608,9 @@ 
                         g.id as group_id
                     FROM $TBL_USER u
                     INNER JOIN $TBL_GROUP_REL_USER gru
-                    ON (gru.user_id = u.user_id AND gru.c_id=" . $course_id . ")
+                    ON (gru.user_id = u.user_id AND gru.c_id=".$course_id.")
                     INNER JOIN $TBL_GROUP g
-                    ON (gru.group_id = g.id AND g.c_id=" . $course_id . ")
+                    ON (gru.group_id = g.id AND g.c_id=".$course_id.")
                 )";
             }
 
@@ -1672,9 +1672,9 @@ 
                     g.id as group_id
                 FROM $TBL_USER u
                 LEFT OUTER JOIN $TBL_GROUP_REL_USER gru
-                ON ( gru.user_id = u.user_id AND gru.c_id=" . $course_id . " )
+                ON ( gru.user_id = u.user_id AND gru.c_id=".$course_id." )
                 LEFT OUTER JOIN $TBL_GROUP g
-                ON (gru.group_id = g.id AND g.c_id = " . $course_id . ")
+                ON (gru.group_id = g.id AND g.c_id = ".$course_id.")
             )";
             }
 
@@ -1687,12 +1687,12 @@ 
             (
                 SELECT u.user_id, firstname, lastname, email, username, ' ' as group_name, '' as group_id, official_code
                 FROM $TBL_USER u
-                WHERE u.status NOT IN(" . api_get_users_status_ignored_in_reports('string') . ")
+                WHERE u.status NOT IN(".api_get_users_status_ignored_in_reports('string').")
             )";
             }
 
             $sqlFromOption = " , $TBL_GROUP_REL_USER AS gru ";
-            $sqlWhereOption = "  AND gru.c_id = " . $course_id . " AND gru.user_id = user.user_id ";
+            $sqlWhereOption = "  AND gru.c_id = ".$course_id." AND gru.user_id = user.user_id ";
             $first_and_last_name = api_is_western_name_order() ? "firstname, lastname" : "lastname, firstname";
 
             if ($get_count) {
@@ -1729,8 +1729,8 @@ 
                 ON (user.user_id = exe_user_id)
                 WHERE
                     te.status != 'incomplete' AND
-                    te.c_id = " . $course_id . " $session_id_and AND
-                    ce.active <>-1 AND ce.c_id = " . $course_id . "
+                    te.c_id = ".$course_id." $session_id_and AND
+                    ce.active <>-1 AND ce.c_id = ".$course_id."
                     $exercise_where
                     $extra_where_conditions
                 ";
@@ -1757,12 +1757,12 @@ 
                     $sqlFromOption
                 WHERE
                     user.user_id=tth.exe_user_id
-                    AND tth.c_id = " . $course_id . "
+                    AND tth.c_id = ".$course_id."
                     $hotpotatoe_where
                     $sqlWhereOption
-                    AND user.status NOT IN(" . api_get_users_status_ignored_in_reports(
+                    AND user.status NOT IN(".api_get_users_status_ignored_in_reports(
                     'string'
-                ) . ")
+                ).")
                 ORDER BY
                     tth.c_id ASC,
                     tth.exe_date DESC";
@@ -1835,12 +1835,12 @@ 
 
                     if ($from_gradebook && ($is_allowedToEdit)) {
                         if (in_array(
-                            $results[$i]['username'] . $results[$i]['firstname'] . $results[$i]['lastname'],
+                            $results[$i]['username'].$results[$i]['firstname'].$results[$i]['lastname'],
                             $users_array_id
                         )) {
                             continue;
                         }
-                        $users_array_id[] = $results[$i]['username'] . $results[$i]['firstname'] . $results[$i]['lastname'];
+                        $users_array_id[] = $results[$i]['username'].$results[$i]['firstname'].$results[$i]['lastname'];
                     }
 
                     $lp_obj = isset($results[$i]['orig_lp_id']) && isset($lp_list[$results[$i]['orig_lp_id']]) ? $lp_list[$results[$i]['orig_lp_id']] : null;
@@ -1849,7 +1849,7 @@ 
                     if ($lp_obj) {
                         $url = api_get_path(
                                 WEB_CODE_PATH
-                            ) . 'newscorm/lp_controller.php?' . api_get_cidreq() . '&action=view&lp_id=' . $results[$i]['orig_lp_id'];
+                            ).'newscorm/lp_controller.php?'.api_get_cidreq().'&action=view&lp_id='.$results[$i]['orig_lp_id'];
                         $lp_name = Display::url(
                             $lp_obj['lp_name'],
                             $url,
@@ -1867,7 +1867,7 @@ 
                         );
 
                         foreach ($group_list as $id) {
-                            $group_name_list .= $clean_group_list[$id] . '<br/>';
+                            $group_name_list .= $clean_group_list[$id].'<br/>';
                         }
                         $results[$i]['group_name'] = $group_name_list;
                     }
@@ -1923,7 +1923,7 @@ 
                                 }
                             }
                             if ($revised) {
-                                $actions .= "<a href='exercise_show.php?" . api_get_cidreq() . "&action=edit&id=$id'>" .
+                                $actions .= "<a href='exercise_show.php?".api_get_cidreq()."&action=edit&id=$id'>".
                                     Display:: return_icon(
                                         'edit.png',
                                         get_lang('Edit'),
@@ -1932,7 +1932,7 @@ 
                                     );
                                 $actions .= '&nbsp;';
                             } else {
-                                $actions .= "<a href='exercise_show.php?" . api_get_cidreq() . "&action=qualify&id=$id'>" .
+                                $actions .= "<a href='exercise_show.php?".api_get_cidreq()."&action=qualify&id=$id'>".
                                     Display:: return_icon(
                                         'quiz.gif',
                                         get_lang('Qualify')
@@ -1942,11 +1942,11 @@ 
                             $actions .= "</a>";
 
                             if ($filter == 2) {
-                                $actions .= ' <a href="exercise_history.php?' . api_get_cidreq() . '&exe_id=' . $id . '">' .
+                                $actions .= ' <a href="exercise_history.php?'.api_get_cidreq().'&exe_id='.$id.'">'.
                                     Display:: return_icon(
                                         'history.gif',
                                         get_lang('ViewHistoryChange')
-                                    ) . '</a>';
+                                    ).'</a>';
                             }
 
                             //Admin can always delete the attempt
@@ -1957,31 +1957,31 @@ 
                                     date('Y-m-d h:i:s'),
                                     false
                                 );
-                                $actions .= '<a href="http://www.whatsmyip.org/ip-geo-location/?ip=' . $ip . '" target="_blank">
-                                ' . Display::return_icon('info.png', $ip) . '
+                                $actions .= '<a href="http://www.whatsmyip.org/ip-geo-location/?ip='.$ip.'" target="_blank">
+                                ' . Display::return_icon('info.png', $ip).'
                                 </a>';
 
-                                $delete_link = '<a href="exercise_report.php?' . api_get_cidreq() . '&filter_by_user=' . intval($_GET['filter_by_user']) . '&filter=' . $filter . '&exerciseId=' . $exercise_id . '&delete=delete&did=' . $id . '"
+                                $delete_link = '<a href="exercise_report.php?'.api_get_cidreq().'&filter_by_user='.intval($_GET['filter_by_user']).'&filter='.$filter.'&exerciseId='.$exercise_id.'&delete=delete&did='.$id.'"
                                 onclick="javascript:if(!confirm(\'' . sprintf(
                                         get_lang('DeleteAttempt'),
                                         $results[$i]['username'],
                                         $dt
-                                    ) . '\')) return false;">' . Display:: return_icon(
+                                    ).'\')) return false;">'.Display:: return_icon(
                                         'delete.png',
                                         get_lang('Delete')
-                                    ) . '</a>';
+                                    ).'</a>';
                                 $delete_link = utf8_encode($delete_link);
 
                                 if (api_is_drh() && !api_is_platform_admin()) {
                                     $delete_link = null;
                                 }
-                                $actions .= $delete_link . '&nbsp;';
+                                $actions .= $delete_link.'&nbsp;';
                             }
 
                         } else {
                             $attempt_url = api_get_path(
                                     WEB_CODE_PATH
-                                ) . 'exercice/result.php?' . api_get_cidreq() . '&id=' . $results[$i]['exe_id'] . '&id_session=' . $sessionId;
+                                ).'exercice/result.php?'.api_get_cidreq().'&id='.$results[$i]['exe_id'].'&id_session='.$sessionId;
                             $attempt_link = Display::url(
                                 get_lang('Show'),
                                 $attempt_url,
@@ -2038,7 +2038,7 @@ 
                     $hp_result = round(
                             ($hpresults[$i][4] / ($hpresults[$i][5] != 0 ? $hpresults[$i][5] : 1)) * 100,
                             2
-                        ) . '% (' . $hpresults[$i][4] . ' / ' . $hpresults[$i][5] . ')';
+                        ).'% ('.$hpresults[$i][4].' / '.$hpresults[$i][5].')';
                     if ($is_allowedToEdit) {
                         $list_info[] = array(
                             $hpresults[$i][0],
@@ -2112,13 +2112,13 @@ 
 
         $html = null;
         if ($show_percentage) {
-            $parent = '(' . $score . ' / ' . $weight . ')';
-            $html = $percentage . "%  $parent";
+            $parent = '('.$score.' / '.$weight.')';
+            $html = $percentage."%  $parent";
             if ($show_only_percentage) {
-                $html = $percentage . "% ";
+                $html = $percentage."% ";
             }
         } else {
-            $html = $score . ' / ' . $weight;
+            $html = $score.' / '.$weight;
         }
         $html = Display::span($html, array('class' => 'score_exercise'));
 
@@ -2212,7 +2212,7 @@ 
     {
         $return = '-';
         if ($value != '') {
-            $return = float_format($value * 100, 1) . ' %';
+            $return = float_format($value * 100, 1).' %';
         }
         return $return;
     }
@@ -2291,7 +2291,7 @@ 
         }
 
         $needle_where = !empty($search) ? " AND title LIKE '?' " : '';
-        $needle = !empty($search) ? "%" . $search . "%" : '';
+        $needle = !empty($search) ? "%".$search."%" : '';
 
         // Show courses by active status
         $active_sql = '';
@@ -2306,7 +2306,7 @@ 
         if ($search_all_sessions == true) {
             $conditions = array(
                 'where' => array(
-                    $active_sql . ' c_id = ? ' . $needle_where . $time_conditions => array(
+                    $active_sql.' c_id = ? '.$needle_where.$time_conditions => array(
                         $course_id,
                         $needle
                     )
@@ -2317,7 +2317,7 @@ 
             if ($session_id == 0) {
                 $conditions = array(
                     'where' => array(
-                        $active_sql . ' session_id = ? AND c_id = ? ' . $needle_where . $time_conditions => array(
+                        $active_sql.' session_id = ? AND c_id = ? '.$needle_where.$time_conditions => array(
                             $session_id,
                             $course_id,
                             $needle
@@ -2328,7 +2328,7 @@ 
             } else {
                 $conditions = array(
                     'where' => array(
-                        $active_sql . ' (session_id = 0 OR session_id = ? ) AND c_id = ? ' . $needle_where . $time_conditions => array(
+                        $active_sql.' (session_id = 0 OR session_id = ? ) AND c_id = ? '.$needle_where.$time_conditions => array(
                             $session_id,
                             $course_id,
                             $needle
@@ -2509,7 +2509,7 @@ 
 
             if ($return_string) {
                 if (!empty($position) && !empty($my_ranking)) {
-                    $return_value = $position . '/' . count($my_ranking);
+                    $return_value = $position.'/'.count($my_ranking);
                 } else {
                     $return_value = '-';
                 }
@@ -2590,7 +2590,7 @@ 
 
             if ($return_string) {
                 if (!empty($position) && !empty($my_ranking)) {
-                    return $position . '/' . count($my_ranking);
+                    return $position.'/'.count($my_ranking);
                 }
             }
             return $return_value;
@@ -2996,7 +2996,7 @@ 
             $courseCondition = "
             INNER JOIN $courseUser cu
             ON cu.c_id = c.id AND cu.user_id  = exe_user_id";
-            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = " . STUDENT;
+            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = ".STUDENT;
         } else {
             $courseCondition = "
             INNER JOIN $courseUserSession cu
@@ -3072,7 +3072,7 @@ 
             $courseCondition = "
             INNER JOIN $courseUser cu
             ON cu.c_id = c.id AND cu.user_id  = exe_user_id";
-            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = " . STUDENT;
+            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = ".STUDENT;
         } else {
             $courseCondition = "
             INNER JOIN $courseUserSession cu
@@ -3165,7 +3165,7 @@ 
             $courseCondition = "
             INNER JOIN $courseUser cu
             ON cu.c_id = c.id AND cu.user_id  = exe_user_id";
-            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = " . STUDENT;
+            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = ".STUDENT;
         } else {
             $courseCondition = "
             INNER JOIN $courseUserSession cu
@@ -3347,7 +3347,7 @@ 
                 }
             }
             // adds the correct word, followed by ] to close the blank
-            $answer .= ' / <font color="green"><b>' . $real_correct_tags[$i] . '</b></font>]';
+            $answer .= ' / <font color="green"><b>'.$real_correct_tags[$i].'</b></font>]';
             if (isset ($real_text[$i + 1])) {
                 $answer .= $real_text[$i + 1];
             }
@@ -3407,13 +3407,13 @@ 
         // check the default value of option
         $tabSelected = array($in_default => " selected='selected' ");
         $res = "";
-        $res .= "<select name='$in_name' id='$in_name' onchange='" . $in_onchange . "' >";
-        $res .= "<option value='-1'" . $tabSelected["-1"] . ">-- " . get_lang(
+        $res .= "<select name='$in_name' id='$in_name' onchange='".$in_onchange."' >";
+        $res .= "<option value='-1'".$tabSelected["-1"].">-- ".get_lang(
                 'AllGroups'
-            ) . " --</option>";
-        $res .= "<option value='0'" . $tabSelected["0"] . ">- " . get_lang(
+            )." --</option>";
+        $res .= "<option value='0'".$tabSelected["0"].">- ".get_lang(
                 'NotInAGroup'
-            ) . " -</option>";
+            )." -</option>";
         $tabGroups = GroupManager::get_group_list();
         $currentCatId = 0;
         for ($i = 0; $i < count($tabGroups); $i++) {
@@ -3421,10 +3421,10 @@ 
                 $tabGroups[$i]["id"]
             );
             if ($tabCategory["id"] != $currentCatId) {
-                $res .= "<option value='-1' disabled='disabled'>" . $tabCategory["title"] . "</option>";
+                $res .= "<option value='-1' disabled='disabled'>".$tabCategory["title"]."</option>";
                 $currentCatId = $tabCategory["id"];
             }
-            $res .= "<option " . $tabSelected[$tabGroups[$i]["id"]] . "style='margin-left:40px' value='" . $tabGroups[$i]["id"] . "'>" . $tabGroups[$i]["name"] . "</option>";
+            $res .= "<option ".$tabSelected[$tabGroups[$i]["id"]]."style='margin-left:40px' value='".$tabGroups[$i]["id"]."'>".$tabGroups[$i]["name"]."</option>";
         }
         $res .= "</select>";
         return $res;
@@ -3657,14 +3657,14 @@ 
                 if ($show_results) {
                     $comnt = Event::get_comments($exe_id, $questionId);
                     if (!empty($comnt)) {
-                        echo '<b>' . get_lang('Feedback') . '</b>';
-                        echo '<div id="question_feedback">' . $comnt . '</div>';
+                        echo '<b>'.get_lang('Feedback').'</b>';
+                        echo '<div id="question_feedback">'.$comnt.'</div>';
                     }
                 }
 
                 if ($show_results) {
                     $score = array(
-                        'result' => get_lang('Score') . " : " . self::show_score(
+                        'result' => get_lang('Score')." : ".self::show_score(
                                 $my_total_score,
                                 $my_total_weight,
                                 false,
@@ -3732,9 +3732,9 @@ 
         }
 
         if ($show_all_but_expected_answer) {
-            $exercise_content .= "<div class='normal-message'>" . get_lang(
+            $exercise_content .= "<div class='normal-message'>".get_lang(
                     "ExerciseWithFeedbackWithoutCorrectionComment"
-                ) . "</div>";
+                )."</div>";
         }
         // Remove audio auto play from questions on results page - refs BT#7939
         $exercise_content = preg_replace(
@@ -3834,11 +3834,11 @@ 
                     $ribbon_total_success_or_error = ' ribbon-total-error';
                 }
             }
-            $ribbon .= '<div class="total ' . $ribbon_total_success_or_error . '">';
+            $ribbon .= '<div class="total '.$ribbon_total_success_or_error.'">';
         } else {
             $ribbon .= '<div class="total">';
         }
-        $ribbon .= '<h3>' . get_lang('YourTotalScore') . ":&nbsp;";
+        $ribbon .= '<h3>'.get_lang('YourTotalScore').":&nbsp;";
         $ribbon .= self::show_score($score, $weight, false, true);
         $ribbon .= '</h3>';
         $ribbon .= '</div>';

main/inc/lib/export.lib.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
      * @param string Name of common tag to place each line in
      * @param string Name of the root element. A root element should always be given.
      * @param string Encoding in which the data is provided
-     * @return void  Prompts the user for a file download
+     * @return boolean  Prompts the user for a file download
      */
     public static function export_complex_table_xml(
         $data,
@@ -283,7 +283,7 @@ 
      * @param string $name
      * @param string $format
      *
-     * @return bool
+     * @return false|null
      */
     public static function htmlToOdt($html, $name, $format = 'odt')
     {

Indentation +11 added lines, -11 removed lines

@@ -56,7 +56,7 @@ 
 
         DocumentManager::file_send_for_download($filePath, true, $filename.'.csv');
         exit;
-	}
+    }
 
     /**
      * Export tabular data to XLS-file
@@ -79,7 +79,7 @@ 
 
         DocumentManager::file_send_for_download($filePath, true, $filename.'.xlsx');
         exit;
-	}
+    }
 
     /**
      * Export tabular data to XLS-file (as html table)
@@ -112,13 +112,13 @@ 
     }
 
     /**
-    * Export tabular data to XML-file
-    * @param array  Simple array of data to put in XML
-    * @param string Name of file to be given to the user
-    * @param string Name of common tag to place each line in
-    * @param string Name of the root element. A root element should always be given.
-    * @param string Encoding in which the data is provided
-    */
+     * Export tabular data to XML-file
+     * @param array  Simple array of data to put in XML
+     * @param string Name of file to be given to the user
+     * @param string Name of common tag to place each line in
+     * @param string Name of the root element. A root element should always be given.
+     * @param string Encoding in which the data is provided
+     */
     public static function arrayToXml(
         $data,
         $filename = 'export',
@@ -148,7 +148,7 @@ 
         fclose($handle);
         DocumentManager :: file_send_for_download($file, true, $filename.'.xml');
         exit;
-	}
+    }
 
     /**
      * Export hierarchical tabular data to XML-file
@@ -197,7 +197,7 @@ 
         foreach ($data as $row) {
             $string .= "\n".str_repeat("\t",$level).'<'.$row['name'].'>';
             if (is_array($row['value'])) {
-            	$string .= self::_export_complex_table_xml_helper($row['value'],$level+1)."\n";
+                $string .= self::_export_complex_table_xml_helper($row['value'],$level+1)."\n";
                 $string .= str_repeat("\t",$level).'</'.$row['name'].'>';
             } else {
                 $string .= $row['value'];

Spacing +5 added lines, -5 removed lines

@@ -99,7 +99,7 @@ 
         }
         foreach ($data as $row) {
             $string = implode("</td><td>", $row);
-            $string = '<tr><td>' . $string . '</td></tr>';
+            $string = '<tr><td>'.$string.'</td></tr>';
             if ($encoding != 'utf-8') {
                 $string = api_convert_encoding($string, $encoding, $systemEncoding);
             }
@@ -173,7 +173,7 @@ 
             fwrite($handle, '<'.$wrapper_tagname.'>');
         }
         $s = self::_export_complex_table_xml_helper($data);
-        fwrite($handle,$s);
+        fwrite($handle, $s);
         if (!is_null($wrapper_tagname)) {
             fwrite($handle, '</'.$wrapper_tagname.'>'."\n");
         }
@@ -195,10 +195,10 @@ 
         }
         $string = '';
         foreach ($data as $row) {
-            $string .= "\n".str_repeat("\t",$level).'<'.$row['name'].'>';
+            $string .= "\n".str_repeat("\t", $level).'<'.$row['name'].'>';
             if (is_array($row['value'])) {
-            	$string .= self::_export_complex_table_xml_helper($row['value'],$level+1)."\n";
-                $string .= str_repeat("\t",$level).'</'.$row['name'].'>';
+            	$string .= self::_export_complex_table_xml_helper($row['value'], $level + 1)."\n";
+                $string .= str_repeat("\t", $level).'</'.$row['name'].'>';
             } else {
                 $string .= $row['value'];
                 $string .= '</'.$row['name'].'>';

main/inc/lib/extra_field.lib.php

Doc Comments +8 added lines, -9 removed lines

@@ -123,7 +123,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getValidExtraFieldTypes()
     {
@@ -199,7 +199,7 @@ 
 
     /**
      * @param array $conditions
-     * @param null  $order_field_options_by
+     * @param string  $order_field_options_by
      *
      * @return array
      */
@@ -237,7 +237,7 @@ 
     /**
      * @param string $variable
      *
-     * @return array|bool
+     * @return integer
      */
     public function get_handler_field_info_by_field_variable($variable)
     {
@@ -319,7 +319,7 @@ 
     /**
      * @param string $handler
      *
-     * @return array
+     * @return string[]
      */
     public static function get_extra_fields_by_handler($handler)
     {
@@ -496,7 +496,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_field_types()
     {
@@ -506,7 +506,7 @@ 
     /**
      * @param int $id
      *
-     * @return null
+     * @return string|null
      */
     public function get_field_type_by_id($id)
     {
@@ -691,7 +691,6 @@ 
      * @param FormValidator $form
      * @param array $extraData
      * @param bool $admin_permissions
-     * @param int $user_id
      * @param array $extra
      * @param int $itemId
      * @param array $exclude variables of extra field to exclude
@@ -1592,7 +1591,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getJqgridColumnNames()
     {
@@ -1832,7 +1831,7 @@ 
     }
 
     /**
-     * @param array $columns
+     * @param string[] $columns
      * @param array  $column_model
      * @param array  $extraFields
      * @return array

Indentation +3 added lines, -3 removed lines

@@ -19,7 +19,7 @@ 
         'changeable',
         'filter',
         'extra_field_type',
-         /* Enable this when field_loggeable is introduced as a table field (2.0)
+            /* Enable this when field_loggeable is introduced as a table field (2.0)
         'field_loggeable',
          */
         'created_at'
@@ -523,7 +523,7 @@ 
      * France:Paris;Bretagne;Marseilles;Lyon|Belgique:Bruxelles;Namur;Liège;Bruges|Peru:Lima;Piura;
      * into
      * array(
- *      'France' =>
+     *      'France' =>
      *      array('Paris', 'Bregtane', 'Marseilles'),
      *  'Belgique' =>
      *      array('Namur', 'Liège')
@@ -1184,7 +1184,7 @@ 
 
                         if ($this->type == 'user') {
 
-                           /* //the magic should be here
+                            /* //the magic should be here
                             $user_tags = UserManager::get_user_tags($user_id, $field_details[0]);
 
                             $tag_list = '';

Spacing +33 added lines, -33 removed lines

@@ -26,19 +26,19 @@ 
     );
 
     public $ops = array(
-        'eq' => '=',        //equal
-        'ne' => '<>',       //not equal
-        'lt' => '<',        //less than
-        'le' => '<=',       //less than or equal
-        'gt' => '>',        //greater than
-        'ge' => '>=',       //greater than or equal
-        'bw' => 'LIKE',     //begins with
+        'eq' => '=', //equal
+        'ne' => '<>', //not equal
+        'lt' => '<', //less than
+        'le' => '<=', //less than or equal
+        'gt' => '>', //greater than
+        'ge' => '>=', //greater than or equal
+        'bw' => 'LIKE', //begins with
         'bn' => 'NOT LIKE', //doesn't begin with
-        'in' => 'LIKE',     //is in
+        'in' => 'LIKE', //is in
         'ni' => 'NOT LIKE', //is not in
-        'ew' => 'LIKE',     //ends with
+        'ew' => 'LIKE', //ends with
         'en' => 'NOT LIKE', //doesn't end with
-        'cn' => 'LIKE',     //contains
+        'cn' => 'LIKE', //contains
         'nc' => 'NOT LIKE'  //doesn't contain
     );
 
@@ -323,7 +323,7 @@ 
      */
     public static function get_extra_fields_by_handler($handler)
     {
-        $types= array();
+        $types = array();
         $types[self::FIELD_TYPE_TEXT] = get_lang('FieldTypeText');
         $types[self::FIELD_TYPE_TEXTAREA] = get_lang('FieldTypeTextarea');
         $types[self::FIELD_TYPE_RADIO] = get_lang('FieldTypeRadio');
@@ -962,7 +962,7 @@ 
                         // chzn-select doesn't work for sessions??
                         $form->addElement(
                             'select',
-                            'extra_' . $field_details['variable'],
+                            'extra_'.$field_details['variable'],
                             $field_details['display_text'],
                             $options,
                             array('id' => 'extra_'.$field_details['variable'])
@@ -1021,7 +1021,7 @@ 
 
                         if (!$admin_permissions) {
                             if ($field_details['visible'] == 0) {
-                                $form->freeze('extra_' . $field_details['variable']);
+                                $form->freeze('extra_'.$field_details['variable']);
                             }
                         }
                         break;
@@ -1369,9 +1369,9 @@ 
 
                         if (is_array($extraData) && array_key_exists($fieldVariable, $extraData)) {
 
-                            if (file_exists(api_get_path(SYS_UPLOAD_PATH) . $extraData[$fieldVariable])) {
+                            if (file_exists(api_get_path(SYS_UPLOAD_PATH).$extraData[$fieldVariable])) {
                                 $fieldTexts[] = Display::img(
-                                    api_get_path(WEB_UPLOAD_PATH) . $extraData[$fieldVariable],
+                                    api_get_path(WEB_UPLOAD_PATH).$extraData[$fieldVariable],
                                     $field_details['display_text'],
                                     array('width' => '300')
                                 );
@@ -1388,10 +1388,10 @@ 
                         $form->applyFilter('extra_'.$field_details['variable'], 'stripslashes');
                         $form->applyFilter('extra_'.$field_details['variable'], 'trim');
 
-                        $allowed_picture_types = array ('jpg', 'jpeg', 'png', 'gif');
+                        $allowed_picture_types = array('jpg', 'jpeg', 'png', 'gif');
                         $form->addRule(
                             'extra_'.$field_details['variable'],
-                            get_lang('OnlyImagesAllowed') . ' ('.implode(',', $allowed_picture_types).')',
+                            get_lang('OnlyImagesAllowed').' ('.implode(',', $allowed_picture_types).')',
                             'filetype',
                             $allowed_picture_types
                         );
@@ -1433,10 +1433,10 @@ 
                         if (is_array($extraData) &&
                             array_key_exists($fieldVariable, $extraData)
                         ) {
-                            if (file_exists(api_get_path(SYS_UPLOAD_PATH) . $extraData[$fieldVariable])) {
+                            if (file_exists(api_get_path(SYS_UPLOAD_PATH).$extraData[$fieldVariable])) {
                                 $fieldTexts[] = Display::url(
-                                    api_get_path(WEB_UPLOAD_PATH) . $extraData[$fieldVariable],
-                                    api_get_path(WEB_UPLOAD_PATH) . $extraData[$fieldVariable],
+                                    api_get_path(WEB_UPLOAD_PATH).$extraData[$fieldVariable],
+                                    api_get_path(WEB_UPLOAD_PATH).$extraData[$fieldVariable],
                                     array(
                                         'title' => $field_details['display_text'],
                                         'target' => '_blank'
@@ -1486,12 +1486,12 @@ 
                             "extra_{$field_details['variable']}",
                             $field_details['display_text']
                         );
-                        $form->applyFilter('extra_' . $field_details['variable'], 'stripslashes');
+                        $form->applyFilter('extra_'.$field_details['variable'], 'stripslashes');
 
                         if (!$admin_permissions) {
                             if ($field_details['visible'] == 0) {
                                 $form->freeze(
-                                    'extra_' . $field_details['variable']
+                                    'extra_'.$field_details['variable']
                                 );
                             }
                         }
@@ -1502,13 +1502,13 @@ 
                             $field_details['display_text']
                         );
                         $form->applyFilter(
-                            'extra_' . $field_details['variable'],
+                            'extra_'.$field_details['variable'],
                             'stripslashes'
                         );
                         if (!$admin_permissions) {
                             if ($field_details['visible'] == 0) {
                                 $form->freeze(
-                                    'extra_' . $field_details['variable']
+                                    'extra_'.$field_details['variable']
                                 );
                             }
                         }
@@ -1518,12 +1518,12 @@ 
                             "extra_{$field_details['variable']}",
                             $field_details['display_text']
                         );
-                        $form->applyFilter('extra_' . $field_details['variable'], 'stripslashes');
+                        $form->applyFilter('extra_'.$field_details['variable'], 'stripslashes');
 
                         if (!$admin_permissions) {
                             if ($field_details['visible'] == 0) {
                                 $form->freeze(
-                                    'extra_' . $field_details['variable']
+                                    'extra_'.$field_details['variable']
                                 );
                             }
                         }
@@ -1534,13 +1534,13 @@ 
                             $field_details['display_text']
                         );
                         $form->applyFilter(
-                            'extra_' . $field_details['variable'],
+                            'extra_'.$field_details['variable'],
                             'stripslashes'
                         );
                         if (!$admin_permissions) {
                             if ($field_details['visible'] == 0) {
                                 $form->freeze(
-                                    'extra_' . $field_details['variable']
+                                    'extra_'.$field_details['variable']
                                 );
                             }
                         }
@@ -2221,19 +2221,19 @@ 
                         break;
                     }
 
-                    if (!file_exists(api_get_path(SYS_UPLOAD_PATH) . $valueData['value'])) {
+                    if (!file_exists(api_get_path(SYS_UPLOAD_PATH).$valueData['value'])) {
                         break;
                     }
 
                     $image = Display::img(
-                        api_get_path(WEB_UPLOAD_PATH) . $valueData['value'],
+                        api_get_path(WEB_UPLOAD_PATH).$valueData['value'],
                         $field['display_text'],
                         array('width' => '300')
                     );
 
                     $displayedValue = Display::url(
                         $image,
-                        api_get_path(WEB_UPLOAD_PATH) . $valueData['value'],
+                        api_get_path(WEB_UPLOAD_PATH).$valueData['value'],
                         array('target' => '_blank')
                     );
                     break;
@@ -2242,13 +2242,13 @@ 
                         break;
                     }
 
-                    if (!file_exists(api_get_path(SYS_UPLOAD_PATH) . $valueData['value'])) {
+                    if (!file_exists(api_get_path(SYS_UPLOAD_PATH).$valueData['value'])) {
                         break;
                     }
 
                     $displayedValue = Display::url(
                         get_lang('Download'),
-                        api_get_path(WEB_UPLOAD_PATH) . $valueData['value'],
+                        api_get_path(WEB_UPLOAD_PATH).$valueData['value'],
                         array(
                             'title' => $field['display_text'],
                             'target' => '_blank'

main/inc/lib/extra_field_value.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -43,7 +43,7 @@ 
     }
 
     /**
-     * @return ExtraField
+     * @return string
      */
     public function getExtraField()
     {
@@ -72,7 +72,7 @@ 
      * This function is used with $extraField->addElements()
      * @param array $params array for the insertion into the *_field_values table
      *
-     * @return mixed false on empty params, void otherwise
+     * @return false|null false on empty params, void otherwise
      * @assert (array()) === false
      */
     public function saveFieldValues($params)
@@ -500,7 +500,7 @@ 
      * @param int $item_id Item ID (It could be a session_id, course_id or user_id)
      * @param int $field_id Field ID (the ID from the *_field table)
      * @param bool $transform Whether to transform the result to a human readable strings
-     * @return mixed A structured array with the field_id and field_value, or false on error
+     * @return string A structured array with the field_id and field_value, or false on error
      * @assert (-1,-1) === false
      */
     public function get_values_by_handler_and_field_id($item_id, $field_id, $transform = false)
@@ -593,7 +593,7 @@ 
      * @param int $item_id Item ID from the original table
      * @param string $field_variable The name of the field we are looking for
      * @param bool $transform
-     * @param bool $allVisibility
+     * @param bool $visibility
      *
      * @return mixed Array of results, or false on error or not found
      * @assert (-1,'') === false

Indentation +5 added lines, -6 removed lines

@@ -720,11 +720,11 @@ 
         return false;
     }
 
-     /**
-     * @param int $itemId
-     * @param int $fieldId
-     * @return array
-     */
+        /**
+         * @param int $itemId
+         * @param int $fieldId
+         * @return array
+         */
     public function getAllValuesByItemAndField($itemId, $fieldId)
     {
         $fieldId = intval($fieldId);
@@ -847,7 +847,6 @@ 
     /**
      * Deletes all values from an item
      * @param int $itemId (session id, course id, etc)
-
      * @assert (-1,-1) == null
      */
     public function deleteValuesByItem($itemId)

Spacing +8 added lines, -8 removed lines

@@ -209,7 +209,7 @@ 
                             break;
                     }
 
-                    $fileName = ExtraField::FIELD_TYPE_FILE_IMAGE . "_{$params['item_id']}.png";
+                    $fileName = ExtraField::FIELD_TYPE_FILE_IMAGE."_{$params['item_id']}.png";
 
                     if (!file_exists($fileDir)) {
                         mkdir($fileDir, $dirPermissions, true);
@@ -217,11 +217,11 @@ 
 
                     if ($value['error'] == 0) {
                         $imageExtraField = new Image($value['tmp_name']);
-                        $imageExtraField->send_image($fileDir . $fileName, -1, 'png');
+                        $imageExtraField->send_image($fileDir.$fileName, -1, 'png');
                         $newParams = array(
                             'item_id' => $params['item_id'],
                             'field_id' => $extraFieldInfo['id'],
-                            'value' => $fileDirStored . $fileName,
+                            'value' => $fileDirStored.$fileName,
                             'comment' => $comment
                         );
 
@@ -247,18 +247,18 @@ 
                     }
 
                     $cleanedName = api_replace_dangerous_char($value['name']);
-                    $fileName = ExtraField::FIELD_TYPE_FILE . "_{$params['item_id']}_$cleanedName";
+                    $fileName = ExtraField::FIELD_TYPE_FILE."_{$params['item_id']}_$cleanedName";
                     if (!file_exists($fileDir)) {
                         mkdir($fileDir, $dirPermissions, true);
                     }
 
                     if ($value['error'] == 0) {
-                        moveUploadedFile($value, $fileDir . $fileName);
+                        moveUploadedFile($value, $fileDir.$fileName);
 
                         $new_params = array(
                             'item_id' => $params['item_id'],
                             'field_id' => $extraFieldInfo['id'],
-                            'value' => $fileDirStored . $fileName
+                            'value' => $fileDirStored.$fileName
                         );
 
                         if ($this->type !== 'session' && $this->type !== 'course') {
@@ -380,7 +380,7 @@ 
                 */
                 if (false) {
                     global $app;
-                    switch($this->type) {
+                    switch ($this->type) {
                         case 'question':
                             $extraFieldValue = new ChamiloLMS\Entity\QuestionFieldValues();
                             $extraFieldValue->setUserId(api_get_user_id());
@@ -442,7 +442,7 @@ 
                 */
                 if (false) {
                     global $app;
-                    switch($this->type) {
+                    switch ($this->type) {
                         case 'question':
                             $extraFieldValue = $app['orm.ems']['db_write']->getRepository('ChamiloLMS\Entity\QuestionFieldValues')->find($field_values['id']);
                             $extraFieldValue->setUserId(api_get_user_id());

main/inc/lib/fileManage.lib.php

Doc Comments +7 added lines, -6 removed lines

@@ -13,6 +13,8 @@ 
  * @param  - action (string) - action type require : 'delete' or 'update'
  * @param  - old_path (string) - old path info stored to change
  * @param  - new_path (string) - new path info to substitute
+ * @param string $action
+ * @param string $old_path
  * @desc Update the file or directory path in the document db document table
  *
  */
@@ -76,8 +78,8 @@ 
  * Deletes a file or a directory
  *
  * @author - Hugues Peeters
- * @param  $file (String) - the path of file or directory to delete
- * @return boolean - true if the delete succeed, false otherwise.
+ * @param  string $file (String) - the path of file or directory to delete
+ * @return boolean|null - true if the delete succeed, false otherwise.
  * @see    - delete() uses check_name_exist() and removeDir() functions
  */
 function my_delete($file)
@@ -162,9 +164,9 @@ 
  * Renames a file or a directory
  *
  * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
- * @param  - $file_path (string) - complete path of the file or the directory
- * @param  - $new_file_name (string) - new name for the file or the directory
- * @return - boolean - true if succeed
+ * @param  string $file_path (string) - complete path of the file or the directory
+ * @param  string $new_file_name (string) - new name for the file or the directory
+ * @return string boolean - true if succeed
  *         - boolean - false otherwise
  * @see    - rename() uses the check_name_exist() and php2phps() functions
  */
@@ -327,7 +329,6 @@ 
  * Calculation size of a directory
  *
  * @returns integer size
- * @param 	string	$path path to size
  * @param 	boolean $recursive if true , include subdir in total
  */
 function dirsize($root, $recursive = true) {

Spacing +13 added lines, -13 removed lines

@@ -225,9 +225,9 @@ 
 		/* File case */
 		if (is_file($source)) {
 			if ($forceMove && !$isWindowsOS && $canExec) {
-				exec('mv ' . $source . ' ' . $target . '/' . $file_name);
+				exec('mv '.$source.' '.$target.'/'.$file_name);
 			} else {
-				copy($source, $target . '/' . $file_name);
+				copy($source, $target.'/'.$file_name);
 				unlink($source);
 			}
 			return true;
@@ -278,7 +278,7 @@ 
 		}
 		$destination_trail = $destination.'/'.$dir_name;
 		if (is_dir($destination)) {
-			chdir($orig_dir_path) ;
+			chdir($orig_dir_path);
 			$handle = opendir($orig_dir_path);
 
 			while ($element = readdir($handle)) {
@@ -288,14 +288,14 @@ 
 					copy($element, $destination_trail.'/'.$element);
 
 					if ($move) {
-						unlink($element) ;
+						unlink($element);
 					}
 				} elseif (is_dir($element)) {
 					$dir_to_copy[] = $orig_dir_path.'/'.$element;
 				}
 			}
 
-			closedir($handle) ;
+			closedir($handle);
 
 			if (sizeof($dir_to_copy) > 0) {
 				foreach ($dir_to_copy as $this_dir) {
@@ -304,7 +304,7 @@ 
 			}
 
 			if ($move) {
-				rmdir($orig_dir_path) ;
+				rmdir($orig_dir_path);
 			}
 			chdir($save_dir);
 		}
@@ -389,17 +389,17 @@ 
 			// Recursive operation if subdirectories exist
 			$dir_number = sizeof($dir_array);
 			if ($dir_number > 0) {
-				for ($i = 0 ; $i < $dir_number ; $i++) {
+				for ($i = 0; $i < $dir_number; $i++) {
 					$sub_dir_array = FileManager::list_all_directories($dir_array[$i]); // Function recursivity
 					if (is_array($dir_array) && is_array($sub_dir_array)) {
-						$dir_array  =  array_merge($dir_array, $sub_dir_array); // Data merge
+						$dir_array = array_merge($dir_array, $sub_dir_array); // Data merge
 					}
 				}
 			}
-			$result_array  =  $dir_array;
-			chdir($save_dir) ;
+			$result_array = $dir_array;
+			chdir($save_dir);
 		}
-		return $result_array ;
+		return $result_array;
 	}
 
 	/**
@@ -444,8 +444,8 @@ 
 		$buffer = '';
 		if (file_exists($file_name)) {
 			$fp = fopen($file_name, 'rb');
-			$buffer = fread ($fp, filesize($file_name));
-			fclose ($fp);
+			$buffer = fread($fp, filesize($file_name));
+			fclose($fp);
 		}
 		return $buffer;
 	}

Braces +12 added lines, -4 removed lines

@@ -33,7 +33,9 @@ 
             Database::query($query);
             break;
         case 'update':
-            if ($new_path[0] == '.') $new_path = substr($new_path, 1);
+            if ($new_path[0] == '.') {
+                $new_path = substr($new_path, 1);
+            }
             $new_path = str_replace('//', '/', $new_path);
 
             // Attempt to update	- tested & working for root	dir
@@ -379,7 +381,9 @@ 
 			chdir($path);
 			$handle = opendir($path);
 			while ($element = readdir($handle)) {
-				if ($element == '.' || $element == '..') continue;
+				if ($element == '.' || $element == '..') {
+				    continue;
+				}
                 // Skip the current and parent directories
 				if (is_dir($element)) {
 					$dir_array[] = $path.'/'.$element;
@@ -419,7 +423,9 @@ 
 				chdir($directory);
 				$handle = opendir($directory);
 			   	while ($element = readdir($handle)) {
-					if ($element == '.' || $element == '..' || $element == '.htaccess') continue;
+					if ($element == '.' || $element == '..' || $element == '.htaccess') {
+					    continue;
+					}
                     // Skip the current and parent directories
 					if (!is_dir($element)) {
 						$element_array[] = $directory.'/'.$element;
@@ -469,7 +475,9 @@ 
 	 */
 	function set_default_settings($upload_path, $filename, $filetype = 'file', $glued_table, $default_visibility = 'v')
     {
-		if (!$default_visibility) $default_visibility = 'v';
+		if (!$default_visibility) {
+		    $default_visibility = 'v';
+		}
 
 		// Make sure path is not wrongly formed
 		$upload_path = !empty($upload_path) ? "/$upload_path" : '';

Indentation +231 added lines, -232 removed lines

@@ -170,37 +170,37 @@ 
  */
 function my_rename($file_path, $new_file_name) {
 
-	$save_dir = getcwd();
-	$path = dirname($file_path);
-	$old_file_name = basename($file_path);
-	$new_file_name = api_replace_dangerous_char($new_file_name);
-
-	// If no extension, take the old one
-	if ((strpos($new_file_name, '.') === false) && ($dotpos = strrpos($old_file_name, '.'))) {
-		$new_file_name .= substr($old_file_name, $dotpos);
-	}
-
-	// Note: still possible: 'xx.yy' -rename-> '.yy' -rename-> 'zz'
-	// This is useful for folder names, where otherwise '.' would be sticky
-
-	// Extension PHP is not allowed, change to PHPS
-	$new_file_name = php2phps($new_file_name);
-
-	if ($new_file_name == $old_file_name) {
-		return $old_file_name;
-	}
-
-	if (strtolower($new_file_name) != strtolower($old_file_name) && check_name_exist($path.'/'.$new_file_name)) {
-		return false;
-	}
-	// On a Windows server, it would be better not to do the above check
-	// because it succeeds for some new names resembling the old name.
-	// But on Unix/Linux the check must be done because rename overwrites.
-
-	chdir($path);
-	$res = rename($old_file_name, $new_file_name) ? $new_file_name : false;
-	chdir($save_dir);
-	return $res;
+    $save_dir = getcwd();
+    $path = dirname($file_path);
+    $old_file_name = basename($file_path);
+    $new_file_name = api_replace_dangerous_char($new_file_name);
+
+    // If no extension, take the old one
+    if ((strpos($new_file_name, '.') === false) && ($dotpos = strrpos($old_file_name, '.'))) {
+        $new_file_name .= substr($old_file_name, $dotpos);
+    }
+
+    // Note: still possible: 'xx.yy' -rename-> '.yy' -rename-> 'zz'
+    // This is useful for folder names, where otherwise '.' would be sticky
+
+    // Extension PHP is not allowed, change to PHPS
+    $new_file_name = php2phps($new_file_name);
+
+    if ($new_file_name == $old_file_name) {
+        return $old_file_name;
+    }
+
+    if (strtolower($new_file_name) != strtolower($old_file_name) && check_name_exist($path.'/'.$new_file_name)) {
+        return false;
+    }
+    // On a Windows server, it would be better not to do the above check
+    // because it succeeds for some new names resembling the old name.
+    // But on Unix/Linux the check must be done because rename overwrites.
+
+    chdir($path);
+    $res = rename($old_file_name, $new_file_name) ? $new_file_name : false;
+    chdir($save_dir);
+    return $res;
 }
 
 /**
@@ -217,38 +217,38 @@ 
  */
 function move($source, $target, $forceMove = false, $moveContent = false)
 {
-	if (check_name_exist($source)) {
-		$file_name = basename($source);
+    if (check_name_exist($source)) {
+        $file_name = basename($source);
         $isWindowsOS = api_is_windows_os();
         $canExec = function_exists('exec');
 
-		/* File case */
-		if (is_file($source)) {
-			if ($forceMove && !$isWindowsOS && $canExec) {
-				exec('mv ' . $source . ' ' . $target . '/' . $file_name);
-			} else {
-				copy($source, $target . '/' . $file_name);
-				unlink($source);
-			}
-			return true;
-		} elseif (is_dir($source)) {
-			/* Directory */
-			if ($forceMove && !$isWindowsOS && $canExec) {
-				if ($moveContent) {
-					$base = basename($source);
-					exec('mv '.$source.'/* '.$target.$base.'/');
-					exec('rm -rf '.$source);
-				} else {
-					exec('mv $source $target');
-				}
-			} else {
-				copyDirTo($source, $target);
-			}
-			return true;
-		}
-	} else {
-		return false;
-	}
+        /* File case */
+        if (is_file($source)) {
+            if ($forceMove && !$isWindowsOS && $canExec) {
+                exec('mv ' . $source . ' ' . $target . '/' . $file_name);
+            } else {
+                copy($source, $target . '/' . $file_name);
+                unlink($source);
+            }
+            return true;
+        } elseif (is_dir($source)) {
+            /* Directory */
+            if ($forceMove && !$isWindowsOS && $canExec) {
+                if ($moveContent) {
+                    $base = basename($source);
+                    exec('mv '.$source.'/* '.$target.$base.'/');
+                    exec('rm -rf '.$source);
+                } else {
+                    exec('mv $source $target');
+                }
+            } else {
+                copyDirTo($source, $target);
+            }
+            return true;
+        }
+    } else {
+        return false;
+    }
 }
 
 /**
@@ -261,54 +261,54 @@ 
  */
 function copyDirTo($orig_dir_path, $destination, $move = true)
 {
-	if ($orig_dir_path == $destination) {
-		return false;
-	}
+    if ($orig_dir_path == $destination) {
+        return false;
+    }
 
-	$save_dir = getcwd();
-	// Extract directory name - create it at destination - update destination trail
-	$dir_name = basename($orig_dir_path);
+    $save_dir = getcwd();
+    // Extract directory name - create it at destination - update destination trail
+    $dir_name = basename($orig_dir_path);
     $dir_to_copy = array();
-	if (is_dir($orig_dir_path)) {
-		if (!is_dir($destination.'/'.$dir_name)) {
-			mkdir(
-				$destination.'/'.$dir_name,
-				api_get_permissions_for_new_directories()
-			);
-		}
-		$destination_trail = $destination.'/'.$dir_name;
-		if (is_dir($destination)) {
-			chdir($orig_dir_path) ;
-			$handle = opendir($orig_dir_path);
-
-			while ($element = readdir($handle)) {
-				if ($element == '.' || $element == '..') {
-					continue; // Skip the current and parent directories
-				} elseif (is_file($element)) {
-					copy($element, $destination_trail.'/'.$element);
-
-					if ($move) {
-						unlink($element) ;
-					}
-				} elseif (is_dir($element)) {
-					$dir_to_copy[] = $orig_dir_path.'/'.$element;
-				}
-			}
-
-			closedir($handle) ;
-
-			if (sizeof($dir_to_copy) > 0) {
-				foreach ($dir_to_copy as $this_dir) {
-					copyDirTo($this_dir, $destination_trail, $move); // Recursivity
-				}
-			}
-
-			if ($move) {
-				rmdir($orig_dir_path) ;
-			}
-			chdir($save_dir);
-		}
-	}
+    if (is_dir($orig_dir_path)) {
+        if (!is_dir($destination.'/'.$dir_name)) {
+            mkdir(
+                $destination.'/'.$dir_name,
+                api_get_permissions_for_new_directories()
+            );
+        }
+        $destination_trail = $destination.'/'.$dir_name;
+        if (is_dir($destination)) {
+            chdir($orig_dir_path) ;
+            $handle = opendir($orig_dir_path);
+
+            while ($element = readdir($handle)) {
+                if ($element == '.' || $element == '..') {
+                    continue; // Skip the current and parent directories
+                } elseif (is_file($element)) {
+                    copy($element, $destination_trail.'/'.$element);
+
+                    if ($move) {
+                        unlink($element) ;
+                    }
+                } elseif (is_dir($element)) {
+                    $dir_to_copy[] = $orig_dir_path.'/'.$element;
+                }
+            }
+
+            closedir($handle) ;
+
+            if (sizeof($dir_to_copy) > 0) {
+                foreach ($dir_to_copy as $this_dir) {
+                    copyDirTo($this_dir, $destination_trail, $move); // Recursivity
+                }
+            }
+
+            if ($move) {
+                rmdir($orig_dir_path) ;
+            }
+            chdir($save_dir);
+        }
+    }
 }
 
 
@@ -319,8 +319,8 @@ 
  * @param 	string	$filename 		filename
  */
 function getextension($filename) {
-	$bouts = explode('.', $filename);
-	return array(array_pop($bouts), implode('.', $bouts));
+    $bouts = explode('.', $filename);
+    return array(array_pop($bouts), implode('.', $bouts));
 }
 
 /**
@@ -331,19 +331,19 @@ 
  * @param 	boolean $recursive if true , include subdir in total
  */
 function dirsize($root, $recursive = true) {
-	$dir = @opendir($root);
-	$size = 0;
-	while ($file = @readdir($dir)) {
-		if (!in_array($file, array('.', '..'))) {
-			if (is_dir($root.'/'.$file)) {
-				$size += $recursive ? dirsize($root.'/'.$file) : 0;
-			} else {
-				$size += @filesize($root.'/'.$file);
-			}
-		}
-	}
-	@closedir($dir);
-	return $size;
+    $dir = @opendir($root);
+    $size = 0;
+    while ($file = @readdir($dir)) {
+        if (!in_array($file, array('.', '..'))) {
+            if (is_dir($root.'/'.$file)) {
+                $size += $recursive ? dirsize($root.'/'.$file) : 0;
+            } else {
+                $size += @filesize($root.'/'.$file);
+            }
+        }
+    }
+    @closedir($dir);
+    return $size;
 }
 
 /*	CLASS FileManager */
@@ -362,7 +362,7 @@ 
 */
 class FileManager
 {
-	/**
+    /**
 		Returns a list of all directories, except the base dir,
 		of the current course. This function uses recursion.
 
@@ -370,131 +370,130 @@ 
 
 		@author Roan Embrechts
 		@version 1.0.1
-	*/
-	function list_all_directories($path)
+     */
+    function list_all_directories($path)
     {
-		$result_array = array();
-		if (is_dir($path)) {
-			$save_dir = getcwd();
-			chdir($path);
-			$handle = opendir($path);
-			while ($element = readdir($handle)) {
-				if ($element == '.' || $element == '..') continue;
+        $result_array = array();
+        if (is_dir($path)) {
+            $save_dir = getcwd();
+            chdir($path);
+            $handle = opendir($path);
+            while ($element = readdir($handle)) {
+                if ($element == '.' || $element == '..') continue;
                 // Skip the current and parent directories
-				if (is_dir($element)) {
-					$dir_array[] = $path.'/'.$element;
-				}
-			}
-			closedir($handle);
-			// Recursive operation if subdirectories exist
-			$dir_number = sizeof($dir_array);
-			if ($dir_number > 0) {
-				for ($i = 0 ; $i < $dir_number ; $i++) {
-					$sub_dir_array = FileManager::list_all_directories($dir_array[$i]); // Function recursivity
-					if (is_array($dir_array) && is_array($sub_dir_array)) {
-						$dir_array  =  array_merge($dir_array, $sub_dir_array); // Data merge
-					}
-				}
-			}
-			$result_array  =  $dir_array;
-			chdir($save_dir) ;
-		}
-		return $result_array ;
-	}
-
-	/**
+                if (is_dir($element)) {
+                    $dir_array[] = $path.'/'.$element;
+                }
+            }
+            closedir($handle);
+            // Recursive operation if subdirectories exist
+            $dir_number = sizeof($dir_array);
+            if ($dir_number > 0) {
+                for ($i = 0 ; $i < $dir_number ; $i++) {
+                    $sub_dir_array = FileManager::list_all_directories($dir_array[$i]); // Function recursivity
+                    if (is_array($dir_array) && is_array($sub_dir_array)) {
+                        $dir_array  =  array_merge($dir_array, $sub_dir_array); // Data merge
+                    }
+                }
+            }
+            $result_array  =  $dir_array;
+            chdir($save_dir) ;
+        }
+        return $result_array ;
+    }
+
+    /**
 		This function receives a list of directories.
 		It returns a list of all files in these directories
 
 		@author Roan Embrechts
 		@version 1.0
-	*/
-	function list_all_files($dir_array)
+     */
+    function list_all_files($dir_array)
     {
-		$element_array = array();
-		if (is_dir($dir_array)) {
-
-			$save_dir = getcwd();
-			foreach ($dir_array as $directory) {
-				chdir($directory);
-				$handle = opendir($directory);
-			   	while ($element = readdir($handle)) {
-					if ($element == '.' || $element == '..' || $element == '.htaccess') continue;
+        $element_array = array();
+        if (is_dir($dir_array)) {
+
+            $save_dir = getcwd();
+            foreach ($dir_array as $directory) {
+                chdir($directory);
+                $handle = opendir($directory);
+                    while ($element = readdir($handle)) {
+                    if ($element == '.' || $element == '..' || $element == '.htaccess') continue;
                     // Skip the current and parent directories
-					if (!is_dir($element)) {
-						$element_array[] = $directory.'/'.$element;
-					}
-				}
-				closedir($handle);
-				chdir('..');
-				chdir($save_dir);
-			}
-		}
-
-		return $element_array;
-	}
-
-	/**
+                    if (!is_dir($element)) {
+                        $element_array[] = $directory.'/'.$element;
+                    }
+                }
+                closedir($handle);
+                chdir('..');
+                chdir($save_dir);
+            }
+        }
+
+        return $element_array;
+    }
+
+    /**
 		Loads contents of file $filename into memory and returns them as a string.
 		Function kept for compatibility with older PHP versions.
 		Function is binary safe (is needed on Windows)
-	*/
-	function compat_load_file($file_name)
+     */
+    function compat_load_file($file_name)
     {
-		$buffer = '';
-		if (file_exists($file_name)) {
-			$fp = fopen($file_name, 'rb');
-			$buffer = fread ($fp, filesize($file_name));
-			fclose ($fp);
-		}
-		return $buffer;
-	}
-
-	/**
-	 * Adds file/folder to document table in database
-	 * improvement from set_default_settings (see below):
-	 * take all info from function parameters
-	 * no global variables needed
-	 *
-	 * NOTE $glued_table should already have backticks around it
-	 * (get it from the database library, and it is done automatically)
-	 *
-	 * @param	path, filename, filetype,
-				$glued_table, default_visibility
+        $buffer = '';
+        if (file_exists($file_name)) {
+            $fp = fopen($file_name, 'rb');
+            $buffer = fread ($fp, filesize($file_name));
+            fclose ($fp);
+        }
+        return $buffer;
+    }
 
-	 * action:	Adds an entry to the document table with the default settings.
-	 * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
-	 * @author	Roan Embrechts
-	 * @version 1.2
-	 */
-	function set_default_settings($upload_path, $filename, $filetype = 'file', $glued_table, $default_visibility = 'v')
+    /**
+     * Adds file/folder to document table in database
+     * improvement from set_default_settings (see below):
+     * take all info from function parameters
+     * no global variables needed
+     *
+     * NOTE $glued_table should already have backticks around it
+     * (get it from the database library, and it is done automatically)
+     *
+     * @param	path, filename, filetype,
+				$glued_table, default_visibility
+     * action:	Adds an entry to the document table with the default settings.
+     * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
+     * @author	Roan Embrechts
+     * @version 1.2
+     */
+    function set_default_settings($upload_path, $filename, $filetype = 'file', $glued_table, $default_visibility = 'v')
     {
-		if (!$default_visibility) $default_visibility = 'v';
-
-		// Make sure path is not wrongly formed
-		$upload_path = !empty($upload_path) ? "/$upload_path" : '';
-
-		$endchar = substr($filename, strlen($filename) - 1, 1);
-		if ($endchar == "\\" || $endchar == '/') {
-			$filename = substr($filename, 0, strlen($filename) - 1);
-		}
-
-		$full_file_name = $upload_path.'/'.$filename;
-		$full_file_name = str_replace("//", '/', $full_file_name);
-
-		$sql_query = "SELECT count(*) as number_existing FROM $glued_table WHERE path='$full_file_name'";
-		$sql_result = Database::query($sql_query);
-		$result = Database::fetch_array($sql_result);
-		// Determine which query to execute
-		if ($result['number_existing'] > 0) {
-			// Entry exists, update
-			$query = "UPDATE $glued_table SET path='$full_file_name',visibility='$default_visibility', filetype='$filetype'
+        if (!$default_visibility) $default_visibility = 'v';
+
+        // Make sure path is not wrongly formed
+        $upload_path = !empty($upload_path) ? "/$upload_path" : '';
+
+        $endchar = substr($filename, strlen($filename) - 1, 1);
+        if ($endchar == "\\" || $endchar == '/') {
+            $filename = substr($filename, 0, strlen($filename) - 1);
+        }
+
+        $full_file_name = $upload_path.'/'.$filename;
+        $full_file_name = str_replace("//", '/', $full_file_name);
+
+        $sql_query = "SELECT count(*) as number_existing FROM $glued_table WHERE path='$full_file_name'";
+        $sql_result = Database::query($sql_query);
+        $result = Database::fetch_array($sql_result);
+        // Determine which query to execute
+        if ($result['number_existing'] > 0) {
+            // Entry exists, update
+            $query = "UPDATE $glued_table SET path='$full_file_name',visibility='$default_visibility', filetype='$filetype'
 			          WHERE path='$full_file_name'";
-		} else {
-			// No entry exists, create new one
-			$query = "INSERT INTO $glued_table (path,visibility,filetype)
+        } else {
+            // No entry exists, create new one
+            $query = "INSERT INTO $glued_table (path,visibility,filetype)
 			          VALUES ('$full_file_name','$default_visibility','$filetype')";
-		}
-		Database::query($query);
-	}
+        }
+        Database::query($query);
+    }
 }

main/inc/lib/fileUpload.lib.php

Doc Comments +10 added lines, -6 removed lines

@@ -17,6 +17,7 @@ 
  *
  * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
  * @param  - file_name (string) name of a file
+ * @param string $file_name
  * @return - the filenam phps'ized
  */
 function php2phps($file_name) {
@@ -73,7 +74,7 @@ 
  * Returns the name without extension, used for the title
  *
  * @param string $name
- * @return name without the extension
+ * @return string without the extension
  */
 function get_document_title($name) {
     // If they upload .htaccess...
@@ -86,7 +87,7 @@ 
  * This function checks if the upload succeeded
  *
  * @param array $uploaded_file ($_FILES)
- * @return true if upload succeeded
+ * @return boolean if upload succeeded
  */
 function process_uploaded_file($uploaded_file, $show_output = true)
 {
@@ -698,6 +699,8 @@ 
  * @param  - dir (string) - Path of the directory
  *           whe the file should be added
  * @param  - max_dir_space (int) - maximum size of the diretory in byte
+ * @param string $dir
+ * @param integer $max_dir_space
  * @return - boolean true if there is enough space,
  *				boolean false otherwise
  *
@@ -1022,7 +1025,7 @@ 
  * @param array  $courseInfo
  * @param array  $userInfo
  * @param array  $uploaded_file - follows the $_FILES Structure
- * @param string $upload_path   - destination of the upload.
+ * @param string $uploadPath   - destination of the upload.
  *                               This path is to append to $base_work_dir
  * @param string $base_work_dir  - base working directory of the module
  * @param int    $maxFilledSpace  - amount of bytes to not exceed in the base
@@ -1201,7 +1204,7 @@ 
  * @param bool $save_visibility
  * @param int $group_id
  * @param int $session_id Session ID, if any
- * @return int id if inserted document
+ * @return string|false id if inserted document
  */
 function add_document(
     $_course,
@@ -1337,7 +1340,7 @@ 
  *
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path+filename eg: /main/document/document.php
- * @return	The directory depth
+ * @return	integer directory depth
  */
 function get_levels($filename) {
     $levels = explode('/', $filename);
@@ -1354,6 +1357,7 @@ 
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path,filename
  * action:	Adds an entry to the document table with the default settings.
+ * @param string $upload_path
  */
 function set_default_settings($upload_path, $filename, $filetype = 'file')
 {
@@ -1778,6 +1782,7 @@ 
 
 @author Roan Embrechts
 @version 0.6
+ * @param string $buffer
  */
 function api_replace_links_in_string($upload_path, $buffer) {
     // Search for hyperlinks
@@ -2013,7 +2018,6 @@ 
  * @param int $groupId
  * @param bool $output
  * @param array $parent
- * @param string $uploadPath
  *
  */
 function add_all_documents_in_folder_to_database(

Braces +3 added lines, -1 removed lines

@@ -993,7 +993,9 @@
                     if ($file != '.' && $file != '..') {
 
                         $filetype = 'file';
-                        if (is_dir($base_work_dir.$upload_path.'/'.$file)) $filetype = 'folder';
+                        if (is_dir($base_work_dir.$upload_path.'/'.$file)) {
+                            $filetype = 'folder';
+                        }
 
                         $safe_file = api_replace_dangerous_char($file, 'strict');
                         @rename($base_work_dir.$upload_path.'/'.$file,$base_work_dir.$upload_path.'/'.$safe_file);

Spacing +92 added lines, -92 removed lines

@@ -63,10 +63,10 @@ 
     $name_no_ext = substr($name, 0, strlen($name) - strlen(strstr($name, $ext)));
     $n = 0;
     $unique = '';
-    while (file_exists($path . $name_no_ext . $unique . $ext)) {
-        $unique = '_' . ++$n;
+    while (file_exists($path.$name_no_ext.$unique.$ext)) {
+        $unique = '_'.++$n;
     }
-    return $name_no_ext . $unique . $ext;
+    return $name_no_ext.$unique.$ext;
 }
 
 /**
@@ -105,7 +105,7 @@ 
                 // Not used at the moment, but could be handy if we want to limit the size of an upload (e.g. image upload in html editor).
                 $max_file_size = intval($_POST['MAX_FILE_SIZE']);
                 if ($show_output) {
-                    Display::display_error_message(get_lang('UplExceedMaxPostSize'). format_file_size($max_file_size));
+                    Display::display_error_message(get_lang('UplExceedMaxPostSize').format_file_size($max_file_size));
                 }
 
                 return false;
@@ -119,7 +119,7 @@ 
             case 4:
                 // No file was uploaded.
                 if ($show_output) {
-                    Display::display_error_message(get_lang('UplNoFileUploaded').' '. get_lang('UplSelectFileFirst'));
+                    Display::display_error_message(get_lang('UplNoFileUploaded').' '.get_lang('UplSelectFileFirst'));
                 }
 
                 return false;
@@ -460,7 +460,7 @@ 
                             if ($output) {
                                 Display::addFlash(
                                     Display::return_message(
-                                        get_lang('UplUploadSucceeded') . '<br /> ' . $documentTitle . ' ' . get_lang('UplFileOverwritten'),
+                                        get_lang('UplUploadSucceeded').'<br /> '.$documentTitle.' '.get_lang('UplFileOverwritten'),
                                         'confirmation',
                                         false
                                     )
@@ -600,7 +600,7 @@ 
 
                             Display::addFlash(
                                 Display::return_message(
-                                    get_lang('UplUploadSucceeded') . '<br />' . get_lang('UplFileSavedAs') .' '.$documentTitle,
+                                    get_lang('UplUploadSucceeded').'<br />'.get_lang('UplFileSavedAs').' '.$documentTitle,
                                     'confirmation',
                                     false
                                 )
@@ -770,12 +770,12 @@ 
 function dir_total_space($dir_path)
 {
     $save_dir = getcwd();
-    chdir($dir_path) ;
+    chdir($dir_path);
     $handle = opendir($dir_path);
     $sumSize = 0;
     $dirList = array();
     while ($element = readdir($handle)) {
-        if ( $element == '.' || $element == '..') {
+        if ($element == '.' || $element == '..') {
             continue; // Skip the current and parent directories
         }
         if (is_file($element)) {
@@ -786,11 +786,11 @@ 
         }
     }
 
-    closedir($handle) ;
+    closedir($handle);
 
     if (sizeof($dirList) > 0) {
         foreach ($dirList as $j) {
-            $sizeDir = dir_total_space($j);	// Recursivity
+            $sizeDir = dir_total_space($j); // Recursivity
             $sumSize += $sizeDir;
         }
     }
@@ -824,63 +824,63 @@ 
 
         static $mime_type = array();
 
-        $mime_type[] = 'application/msword';             $extension[] = '.doc';
-        $mime_type[] = 'application/rtf';                $extension[] = '.rtf';
-        $mime_type[] = 'application/vnd.ms-powerpoint';  $extension[] = '.ppt';
-        $mime_type[] = 'application/vnd.ms-excel';       $extension[] = '.xls';
-        $mime_type[] = 'application/pdf';                $extension[] = '.pdf';
-        $mime_type[] = 'application/postscript';         $extension[] = '.ps';
-        $mime_type[] = 'application/mac-binhex40';       $extension[] = '.hqx';
-        $mime_type[] = 'application/x-gzip';             $extension[] = 'tar.gz';
-        $mime_type[] = 'application/x-shockwave-flash';  $extension[] = '.swf';
-        $mime_type[] = 'application/x-stuffit';          $extension[] = '.sit';
-        $mime_type[] = 'application/x-tar';              $extension[] = '.tar';
-        $mime_type[] = 'application/zip';                $extension[] = '.zip';
-        $mime_type[] = 'application/x-tar';              $extension[] = '.tar';
-        $mime_type[] = 'text/html';                      $extension[] = '.html';
-        $mime_type[] = 'text/plain';                     $extension[] = '.txt';
-        $mime_type[] = 'text/rtf';                       $extension[] = '.rtf';
-        $mime_type[] = 'img/gif';                        $extension[] = '.gif';
-        $mime_type[] = 'img/jpeg';                       $extension[] = '.jpg';
-        $mime_type[] = 'img/png';                        $extension[] = '.png';
-        $mime_type[] = 'audio/midi';                     $extension[] = '.mid';
-        $mime_type[] = 'audio/mpeg';                     $extension[] = '.mp3';
-        $mime_type[] = 'audio/x-aiff';                   $extension[] = '.aif';
-        $mime_type[] = 'audio/x-pn-realaudio';           $extension[] = '.rm';
-        $mime_type[] = 'audio/x-pn-realaudio-plugin';    $extension[] = '.rpm';
-        $mime_type[] = 'audio/x-wav';                    $extension[] = '.wav';
-        $mime_type[] = 'video/mpeg';                     $extension[] = '.mpg';
-        $mime_type[] = 'video/mpeg4-generic';            $extension[] = '.mp4';
-        $mime_type[] = 'video/quicktime';                $extension[] = '.mov';
-        $mime_type[] = 'video/x-msvideo';                $extension[] = '.avi';
-
-        $mime_type[] = 'video/x-ms-wmv';                 $extension[] = '.wmv';
-        $mime_type[] = 'video/x-flv';                    $extension[] = '.flv';
-        $mime_type[] = 'image/svg+xml';                  $extension[] = '.svg';
-        $mime_type[] = 'image/svg+xml';                  $extension[] = '.svgz';
-        $mime_type[] = 'video/ogg';                  	 $extension[] = '.ogv';
-        $mime_type[] = 'audio/ogg';                  	 $extension[] = '.oga';
-        $mime_type[] = 'application/ogg';                $extension[] = '.ogg';
-        $mime_type[] = 'application/ogg';                $extension[] = '.ogx';
-        $mime_type[] = 'application/x-freemind';         $extension[] = '.mm';
-
-        $mime_type[] = 'application/vnd.ms-word.document.macroEnabled.12';							$extension[] = '.docm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document';	$extension[] = '.docx';
-        $mime_type[] = 'application/vnd.ms-word.template.macroEnabled.12';							$extension[] = '.dotm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.wordprocessingml.template';	$extension[] = '.dotx';
-        $mime_type[] = 'application/vnd.ms-powerpoint.template.macroEnabled.12';					$extension[] = '.potm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.template';		$extension[] = '.potx';
-        $mime_type[] = 'application/vnd.ms-powerpoint.addin.macroEnabled.12';						$extension[] = '.ppam';
-        $mime_type[] = 'application/vnd.ms-powerpoint.slideshow.macroEnabled.12';					$extension[] = '.ppsm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.slideshow';	$extension[] = '.ppsx';
-        $mime_type[] = 'application/vnd.ms-powerpoint.presentation.macroEnabled.12';				$extension[] = '.pptm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.presentation';	$extension[] = '.pptx';
-        $mime_type[] = 'application/vnd.ms-excel.addin.macroEnabled.12';							$extension[] = '.xlam';
-        $mime_type[] = 'application/vnd.ms-excel.sheet.binary.macroEnabled.12';						$extension[] = '.xlsb';
-        $mime_type[] = 'application/vnd.ms-excel.sheet.macroEnabled.12';							$extension[] = '.xlsm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';			$extension[] = '.xlsx';
-        $mime_type[] = 'application/vnd.ms-excel.template.macroEnabled.12';							$extension[] = '.xltm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.template';		$extension[] = '.xltx';
+        $mime_type[] = 'application/msword'; $extension[] = '.doc';
+        $mime_type[] = 'application/rtf'; $extension[] = '.rtf';
+        $mime_type[] = 'application/vnd.ms-powerpoint'; $extension[] = '.ppt';
+        $mime_type[] = 'application/vnd.ms-excel'; $extension[] = '.xls';
+        $mime_type[] = 'application/pdf'; $extension[] = '.pdf';
+        $mime_type[] = 'application/postscript'; $extension[] = '.ps';
+        $mime_type[] = 'application/mac-binhex40'; $extension[] = '.hqx';
+        $mime_type[] = 'application/x-gzip'; $extension[] = 'tar.gz';
+        $mime_type[] = 'application/x-shockwave-flash'; $extension[] = '.swf';
+        $mime_type[] = 'application/x-stuffit'; $extension[] = '.sit';
+        $mime_type[] = 'application/x-tar'; $extension[] = '.tar';
+        $mime_type[] = 'application/zip'; $extension[] = '.zip';
+        $mime_type[] = 'application/x-tar'; $extension[] = '.tar';
+        $mime_type[] = 'text/html'; $extension[] = '.html';
+        $mime_type[] = 'text/plain'; $extension[] = '.txt';
+        $mime_type[] = 'text/rtf'; $extension[] = '.rtf';
+        $mime_type[] = 'img/gif'; $extension[] = '.gif';
+        $mime_type[] = 'img/jpeg'; $extension[] = '.jpg';
+        $mime_type[] = 'img/png'; $extension[] = '.png';
+        $mime_type[] = 'audio/midi'; $extension[] = '.mid';
+        $mime_type[] = 'audio/mpeg'; $extension[] = '.mp3';
+        $mime_type[] = 'audio/x-aiff'; $extension[] = '.aif';
+        $mime_type[] = 'audio/x-pn-realaudio'; $extension[] = '.rm';
+        $mime_type[] = 'audio/x-pn-realaudio-plugin'; $extension[] = '.rpm';
+        $mime_type[] = 'audio/x-wav'; $extension[] = '.wav';
+        $mime_type[] = 'video/mpeg'; $extension[] = '.mpg';
+        $mime_type[] = 'video/mpeg4-generic'; $extension[] = '.mp4';
+        $mime_type[] = 'video/quicktime'; $extension[] = '.mov';
+        $mime_type[] = 'video/x-msvideo'; $extension[] = '.avi';
+
+        $mime_type[] = 'video/x-ms-wmv'; $extension[] = '.wmv';
+        $mime_type[] = 'video/x-flv'; $extension[] = '.flv';
+        $mime_type[] = 'image/svg+xml'; $extension[] = '.svg';
+        $mime_type[] = 'image/svg+xml'; $extension[] = '.svgz';
+        $mime_type[] = 'video/ogg'; $extension[] = '.ogv';
+        $mime_type[] = 'audio/ogg'; $extension[] = '.oga';
+        $mime_type[] = 'application/ogg'; $extension[] = '.ogg';
+        $mime_type[] = 'application/ogg'; $extension[] = '.ogx';
+        $mime_type[] = 'application/x-freemind'; $extension[] = '.mm';
+
+        $mime_type[] = 'application/vnd.ms-word.document.macroEnabled.12'; $extension[] = '.docm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'; $extension[] = '.docx';
+        $mime_type[] = 'application/vnd.ms-word.template.macroEnabled.12'; $extension[] = '.dotm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.wordprocessingml.template'; $extension[] = '.dotx';
+        $mime_type[] = 'application/vnd.ms-powerpoint.template.macroEnabled.12'; $extension[] = '.potm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.template'; $extension[] = '.potx';
+        $mime_type[] = 'application/vnd.ms-powerpoint.addin.macroEnabled.12'; $extension[] = '.ppam';
+        $mime_type[] = 'application/vnd.ms-powerpoint.slideshow.macroEnabled.12'; $extension[] = '.ppsm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.slideshow'; $extension[] = '.ppsx';
+        $mime_type[] = 'application/vnd.ms-powerpoint.presentation.macroEnabled.12'; $extension[] = '.pptm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.presentation'; $extension[] = '.pptx';
+        $mime_type[] = 'application/vnd.ms-excel.addin.macroEnabled.12'; $extension[] = '.xlam';
+        $mime_type[] = 'application/vnd.ms-excel.sheet.binary.macroEnabled.12'; $extension[] = '.xlsb';
+        $mime_type[] = 'application/vnd.ms-excel.sheet.macroEnabled.12'; $extension[] = '.xlsm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'; $extension[] = '.xlsx';
+        $mime_type[] = 'application/vnd.ms-excel.template.macroEnabled.12'; $extension[] = '.xltm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.template'; $extension[] = '.xltx';
 
         // Test on PC (files with no extension get application/octet-stream)
         //$mime_type[] = 'application/octet-stream';      $extension[] = '.ext';
@@ -889,7 +889,7 @@ 
 
         foreach ($mime_type as $key => & $type) {
             if ($type == $file_type) {
-                $file_name .=  $extension[$key];
+                $file_name .= $extension[$key];
                 break;
             }
         }
@@ -997,12 +997,12 @@ 
         }
 
         // It happens on Linux that $upload_path sometimes doesn't start with '/'
-        if ($upload_path[0] != '/' && substr($base_work_dir,-1,1) != '/') {
+        if ($upload_path[0] != '/' && substr($base_work_dir, -1, 1) != '/') {
             $upload_path = '/'.$upload_path;
         }
 
         if ($upload_path[strlen($upload_path) - 1] == '/') {
-            $upload_path=substr($upload_path, 0, -1);
+            $upload_path = substr($upload_path, 0, -1);
         }
 
         /*	Uncompressing phase */
@@ -1014,15 +1014,15 @@ 
             - add it to the database
             - parse & change relative html links
         */
-        if (PHP_OS == 'Linux' && ! get_cfg_var('safe_mode') && false) { // *** UGent, changed by OC ***
+        if (PHP_OS == 'Linux' && !get_cfg_var('safe_mode') && false) { // *** UGent, changed by OC ***
             // Shell Method - if this is possible, it gains some speed
-            exec("unzip -d \"".$base_work_dir.$upload_path."/\"".$uploaded_file['name']." " .$uploaded_file['tmp_name']);
+            exec("unzip -d \"".$base_work_dir.$upload_path."/\"".$uploaded_file['name']." ".$uploaded_file['tmp_name']);
         } else {
             // PHP method - slower...
             $save_dir = getcwd();
             chdir($base_work_dir.$upload_path);
             $unzippingState = $zip_file->extract();
-            for ($j=0; $j < count($unzippingState); $j++) {
+            for ($j = 0; $j < count($unzippingState); $j++) {
                 $state = $unzippingState[$j];
 
                 // Fix relative links in html files
@@ -1036,8 +1036,8 @@ 
                         if (is_dir($base_work_dir.$upload_path.'/'.$file)) $filetype = 'folder';
 
                         $safe_file = api_replace_dangerous_char($file, 'strict');
-                        @rename($base_work_dir.$upload_path.'/'.$file,$base_work_dir.$upload_path.'/'.$safe_file);
-                        set_default_settings($upload_path, $safe_file,$filetype);
+                        @rename($base_work_dir.$upload_path.'/'.$file, $base_work_dir.$upload_path.'/'.$safe_file);
+                        set_default_settings($upload_path, $safe_file, $filetype);
                     }
                 }
 
@@ -1087,7 +1087,7 @@ 
     $zip = new PclZip($uploaded_file['tmp_name']);
 
     // Check the zip content (real size and file extension)
-    $zip_content_array = (array)$zip->listContent();
+    $zip_content_array = (array) $zip->listContent();
 
     $realSize = 0;
     foreach ($zip_content_array as & $this_content) {
@@ -1183,7 +1183,7 @@ 
 function filter_extension(&$filename)
 {
     if (substr($filename, -1) == '/') {
-        return 1;  // Authorize directories
+        return 1; // Authorize directories
     }
     $blacklist = api_get_setting('upload_extensions_list_type');
     if ($blacklist != 'whitelist') { // if = blacklist
@@ -1409,9 +1409,9 @@ 
     $upload_path = str_replace('//', '/', $upload_path);
 
     if ($upload_path == '/') {
-        $upload_path='';
+        $upload_path = '';
     } elseif (!empty($upload_path) && $upload_path[0] != '/') {
-        $upload_path="/$upload_path";
+        $upload_path = "/$upload_path";
     }
 
     $endchar = substr($filename, strlen($filename) - 1, 1);
@@ -1449,7 +1449,7 @@ 
     $img_path_list = array();
 
     if (!$fp = fopen($html_file, 'r')) {
-        return ;
+        return;
     }
 
     // Aearch and store occurences of the <img> tag in an array
@@ -1469,7 +1469,7 @@ 
         $img_tag_list = $matches[0];
     }
 
-    fclose ($fp);
+    fclose($fp);
     unset($buffer);
 
     // Search the image file path from all the <IMG> tag detected
@@ -1569,7 +1569,7 @@ 
 
     if (!is_dir($base_work_dir.$systemFolderName)) {
         $result = mkdir(
-            $base_work_dir . $systemFolderName,
+            $base_work_dir.$systemFolderName,
             api_get_permissions_for_new_directories(),
             true
         );
@@ -1582,7 +1582,7 @@ 
                     WHERE
                         c_id = $course_id AND
                         (
-                            path = '" . Database::escape_string($systemFolderName). "'
+                            path = '".Database::escape_string($systemFolderName)."'
                         )
             ";
 
@@ -1733,7 +1733,7 @@ 
 
     // Fix the image tags
 
-    for ($i = 0, $fileNb = count($original_img_path); $i < $fileNb ; $i++) {
+    for ($i = 0, $fileNb = count($original_img_path); $i < $fileNb; $i++) {
         $replace_what = $original_img_path[$i];
         // We only need the directory and the filename /path/to/file_html_files/missing_file.gif -> file_html_files/missing_file.gif
         $exploded_file_path = explode('/', $new_img_path[$i]);
@@ -1774,7 +1774,7 @@ 
         .'</body>'
         .'</html>';
     if (file_exists($file_path)) {
-        if (!($fp = fopen ($file_path, 'w'))) {
+        if (!($fp = fopen($file_path, 'w'))) {
             return false;
         }
         return fwrite($fp, $file_content);
@@ -1794,7 +1794,7 @@ 
     // Open the file
     if (file_exists($full_file_name)) {
         $fp = fopen($full_file_name, 'r');
-        $buffer = fread ($fp, filesize ($full_file_name));
+        $buffer = fread($fp, filesize($full_file_name));
 
         // Parse the contents
         $new_html_content = api_replace_links_in_string($upload_path, $buffer);
@@ -1937,7 +1937,7 @@ 
 
         foreach ($tag_list as & $this_tag) {
             //Display::display_normal_message(htmlentities($this_tag)); //debug
-            if ( preg_match("~".$param_name."[\s]*=[\s]*[\"]{1}([^\"]+)[\"]{1}~i", $this_tag, $matches)) {
+            if (preg_match("~".$param_name."[\s]*=[\s]*[\"]{1}([^\"]+)[\"]{1}~i", $this_tag, $matches)) {
                 $file_path_list[] = $matches[1]; // older
                 $href_list[] = $matches[0]; // to also add target="_self"
             }
@@ -1958,9 +1958,9 @@ 
 
                 // Fix the link to use download.php or showinframes.php
                 if (preg_match("/<a([\s]*[\"\/:'=a-z0-9]*){5}href[^<]*>/i", $tag_list[$count])) {
-                    $replace_by[$count] = " $param_name =\"showinframes.php?file=" . $upload_path.$file_path_list[$count]."\" target=\"_self\" ";
+                    $replace_by[$count] = " $param_name =\"showinframes.php?file=".$upload_path.$file_path_list[$count]."\" target=\"_self\" ";
                 } else {
-                    $replace_by[$count] = " $param_name =\"download.php?doc_url=" . $upload_path.$file_path_list[$count]."\" ";
+                    $replace_by[$count] = " $param_name =\"download.php?doc_url=".$upload_path.$file_path_list[$count]."\" ";
                 }
             } else {
                 // "mailto" or url already fixed, leave as is
@@ -1969,7 +1969,7 @@ 
             }
         } elseif ($is_absolute_hyperlink) {
             //$message .= "Absolute hyperlink, don't change, add target=_self: ";
-            $replace_by[$count] = " $param_name=\"" . $file_path_list[$count] . "\" target =\"_self\"";
+            $replace_by[$count] = " $param_name=\"".$file_path_list[$count]."\" target =\"_self\"";
         } else {
             // Don't change anything
             //$message .= "Local anchor, don't change: ";
@@ -2014,7 +2014,7 @@ 
 {
     // Do we need a / or not?
     $added_slash = ($upload_path == '/') ? '' : '/';
-    $folder_id      = DocumentManager::get_document_id(api_get_course_info(), $upload_path);
+    $folder_id = DocumentManager::get_document_id(api_get_course_info(), $upload_path);
     // Build the form
     $form = "<p><strong>".get_lang('MissingImagesDetected')."</strong></p>"
         ."<form method=\"post\" action=\"".api_get_self()."\" enctype=\"multipart/form-data\">"

Indentation +1 added lines, -1 removed lines

@@ -2110,7 +2110,7 @@
                         $newFolderData = DocumentManager::get_document_data_by_id($documentId, $courseInfo, false, $sessionId);
                     }
                 } else {
-                   $newFolderData = create_unexisting_directory(
+                    $newFolderData = create_unexisting_directory(
                         $courseInfo,
                         $userId,
                         $sessionId,