chamilo / chamilo-lms

main/admin/settings.lib.php

Doc Comments +4 added lines, -3 removed lines

@@ -1154,7 +1154,7 @@ 
 /**
  * Returns an array containing the list of options used to populate the gradebook_number_decimals variable
  * This function is called through a call_user_func() in the generate_settings_form function.
- * @return array List of gradebook_number_decimals options
+ * @return string[] List of gradebook_number_decimals options
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
  */
@@ -1575,8 +1575,9 @@ 
 }
 /**
  * Helper function to generates a form elements group
- * @param object $form The form where the elements group has to be added
+ * @param FormValidator $form The form where the elements group has to be added
  * @param array $values Values to browse through
+ * @param string $elementName
  * @return array
  */
 function formGenerateElementsGroup($form, $values = array(), $elementName)
@@ -1592,7 +1593,7 @@ 
 }
 /**
  * Helper function with allowed file types for CSS
- * @return  array Array of file types (no indexes)
+ * @return  string[] Array of file types (no indexes)
  */
 function getAllowedFileTypes()
 {

Spacing +40 added lines, -40 removed lines

@@ -138,7 +138,7 @@ 
 
     // Plugins NOT installed
     echo Display::page_subheader(get_lang('Plugins'));
-    echo '<form class="form-horizontal" name="plugins" method="post" action="'.api_get_self().'?category='.Security::remove_XSS($_GET['category']).'&sec_token=' . $token . '">';
+    echo '<form class="form-horizontal" name="plugins" method="post" action="'.api_get_self().'?category='.Security::remove_XSS($_GET['category']).'&sec_token='.$token.'">';
     echo '<table class="data_table">';
     echo '<tr>';
     echo '<th width="20px">';
@@ -187,7 +187,7 @@ 
             if (file_exists(api_get_path(SYS_PLUGIN_PATH).$pluginName.'/readme.txt')) {
                 echo Display::url(
                     "<em class='fa fa-file-text-o'></em> readme.txt",
-                    api_get_path(WEB_PLUGIN_PATH) . $pluginName . "/readme.txt",
+                    api_get_path(WEB_PLUGIN_PATH).$pluginName."/readme.txt",
                     [
                         'class' => 'btn btn-default ajax',
                         'data-title' => $plugin_info['title'],
@@ -250,7 +250,7 @@ 
     $form->addElement('file', 'new_stylesheet', get_lang('UploadNewStylesheet'));
     $allowed_file_types = getAllowedFileTypes();
 
-    $form->addRule('new_stylesheet', get_lang('InvalidExtension') . ' (' . implode(',', $allowed_file_types) . ')',
+    $form->addRule('new_stylesheet', get_lang('InvalidExtension').' ('.implode(',', $allowed_file_types).')',
         'filetype', $allowed_file_types);
     $form->addRule('new_stylesheet', get_lang('ThisFieldIsRequired'), 'required');
     $form->addButtonUpload(get_lang('Upload'), 'stylesheet_upload');
@@ -337,7 +337,7 @@ 
                     $show_name = ucwords(str_replace('_', ' ', $style_dir));
 
                     if ($is_style_changeable) {
-                        $list_of_names[$style_dir]  = $show_name;
+                        $list_of_names[$style_dir] = $show_name;
                     }
                     $counter++;
                 }
@@ -377,16 +377,16 @@ 
         Display::return_message(sprintf(get_lang('TheLogoMustBeSizeXAndFormatY'), '250 x 70', 'PNG'), 'info')
     );
 
-    $dir = api_get_path(SYS_PUBLIC_PATH).'css/themes/' . $selected . '/images/';
-    $url = api_get_path(WEB_CSS_PATH).'themes/' . $selected . '/images/';
+    $dir = api_get_path(SYS_PUBLIC_PATH).'css/themes/'.$selected.'/images/';
+    $url = api_get_path(WEB_CSS_PATH).'themes/'.$selected.'/images/';
     $logoFileName = 'header-logo.png';
-    $newLogoFileName = 'header-logo-custom' . api_get_current_access_url_id() . '.png';
+    $newLogoFileName = 'header-logo-custom'.api_get_current_access_url_id().'.png';
     $webPlatformLogoPath = ChamiloApi::getWebPlatformLogoPath();
 
     if ($webPlatformLogoPath !== null) {
         $logoForm->addLabel(
             get_lang('CurrentLogo'),
-            '<img id="header-logo-custom" src="' . $webPlatformLogoPath . '?' . time() . '">'
+            '<img id="header-logo-custom" src="'.$webPlatformLogoPath.'?'.time().'">'
         );
     }
 
@@ -453,7 +453,7 @@ 
             });
             </script>';
             echo Display::tabs(
-                array(get_lang('Update'),get_lang('UpdateLogo'), get_lang('UploadNewStylesheet')),
+                array(get_lang('Update'), get_lang('UpdateLogo'), get_lang('UploadNewStylesheet')),
                 array($form_change->return_form(), $logoForm->returnForm(), $form->returnForm())
             );
         } else {
@@ -618,7 +618,7 @@ 
             if (!empty($areas_to_installed)) {
                 $plugin_obj->remove_all_regions($plugin);
                 foreach ($areas_to_installed as $region) {
-                    if (!empty($region) && $region != '-1' ) {
+                    if (!empty($region) && $region != '-1') {
                         $plugin_obj->add_to_region($plugin, $region);
                     }
                 }
@@ -729,14 +729,14 @@ 
         $values = api_get_settings_options('search_show_unlinked_results');
 
         $group = formGenerateElementsGroup($form, $values, 'search_show_unlinked_results');
-        $form->addGroup($group, 'search_show_unlinked_results', array(get_lang('SearchShowUnlinkedResultsTitle'),get_lang('SearchShowUnlinkedResultsComment')), null, false);
+        $form->addGroup($group, 'search_show_unlinked_results', array(get_lang('SearchShowUnlinkedResultsTitle'), get_lang('SearchShowUnlinkedResultsComment')), null, false);
         $default_values['search_show_unlinked_results'] = api_get_setting('search_show_unlinked_results');
 
         $sf_values = array();
         foreach ($specific_fields as $sf) {
             $sf_values[$sf['code']] = $sf['name'];
         }
-        $url =  Display::div(Display::url(get_lang('AddSpecificSearchField'), 'specific_fields.php'), array('class'=>'sectioncomment'));
+        $url = Display::div(Display::url(get_lang('AddSpecificSearchField'), 'specific_fields.php'), array('class'=>'sectioncomment'));
         if (empty($sf_values)) {
             $form->addElement('label', [get_lang('SearchPrefilterPrefix'), $url]);
         } else {
@@ -831,7 +831,7 @@ 
     if ($action != 'add') {
         echo '<div class="actions" style="margin-left: 1px;">';
         echo '<a href="settings.php?category=Templates&action=add">'.
-                Display::return_icon('new_template.png', get_lang('AddTemplate'),'',ICON_SIZE_MEDIUM).'</a>';
+                Display::return_icon('new_template.png', get_lang('AddTemplate'), '', ICON_SIZE_MEDIUM).'</a>';
         echo '</div>';
     }
 
@@ -952,8 +952,8 @@ 
  * @since v1.8.6
  */
 function actionsFilter($id) {
-    $return = '<a href="settings.php?category=Templates&action=edit&id='.Security::remove_XSS($id).'">'.Display::return_icon('edit.png', get_lang('Edit'),'',ICON_SIZE_SMALL).'</a>';
-    $return .= '<a href="settings.php?category=Templates&action=delete&id='.Security::remove_XSS($id).'" onClick="javascript:if(!confirm('."'".get_lang('ConfirmYourChoice')."'".')) return false;">'.Display::return_icon('delete.png', get_lang('Delete'),'',ICON_SIZE_SMALL).'</a>';
+    $return = '<a href="settings.php?category=Templates&action=edit&id='.Security::remove_XSS($id).'">'.Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL).'</a>';
+    $return .= '<a href="settings.php?category=Templates&action=delete&id='.Security::remove_XSS($id).'" onClick="javascript:if(!confirm('."'".get_lang('ConfirmYourChoice')."'".')) return false;">'.Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).'</a>';
     return $return;
 }
 
@@ -1005,7 +1005,7 @@ 
     $form->addElement('html_editor', 'template_text', get_lang('Text'), null, array('ToolbarSet' => 'AdminTemplates', 'Width' => '100%', 'Height' => '400'));
 
     // Setting the form elements: the form to upload an image to be used with the template.
-    $form->addElement('file','template_image',get_lang('Image'),'');
+    $form->addElement('file', 'template_image', get_lang('Image'), '');
 
     // Setting the form elements: a little bit information about the template image.
     $form->addElement('static', 'file_comment', '', get_lang('TemplateImageComment100x70'));
@@ -1029,10 +1029,10 @@ 
         // Adding an extra field: a preview of the image that is currently used.
         if (!empty($row['image'])) {
             $form->addElement('static', 'template_image_preview', '',
-                '<img src="' . api_get_path(WEB_APP_PATH) . 'home/default_platform_document/template_thumb/' . $row['image'] . '" alt="' . get_lang('TemplatePreview') . '"/>');
+                '<img src="'.api_get_path(WEB_APP_PATH).'home/default_platform_document/template_thumb/'.$row['image'].'" alt="'.get_lang('TemplatePreview').'"/>');
         } else {
             $form->addElement('static', 'template_image_preview', '',
-                '<img src="' . api_get_path(WEB_APP_PATH) . 'home/default_platform_document/template_thumb/noimage.gif" alt="' . get_lang('NoTemplatePreview') . '"/>');
+                '<img src="'.api_get_path(WEB_APP_PATH).'home/default_platform_document/template_thumb/noimage.gif" alt="'.get_lang('NoTemplatePreview').'"/>');
         }
 
         // Setting the information of the template that we are editing.
@@ -1085,7 +1085,7 @@ 
             // Store the information in the database (as insert or as update).
             $table_system_template = Database :: get_main_table('system_template');
             if ($_GET['action'] == 'add') {
-                $content_template =  Security::remove_XSS($values['template_text'], COURSEMANAGERLOWSECURITY);
+                $content_template = Security::remove_XSS($values['template_text'], COURSEMANAGERLOWSECURITY);
                 $params = [
                     'title' =>  $values['title'],
                     'content' => $content_template,
@@ -1095,7 +1095,7 @@ 
 
                 // Display a feedback message.
                 Display::display_confirmation_message(get_lang('TemplateAdded'));
-                echo '<a href="settings.php?category=Templates&action=add">'.Display::return_icon('new_template.png', get_lang('AddTemplate'),'',ICON_SIZE_MEDIUM).'</a>';
+                echo '<a href="settings.php?category=Templates&action=add">'.Display::return_icon('new_template.png', get_lang('AddTemplate'), '', ICON_SIZE_MEDIUM).'</a>';
             } else {
                 $content_template = '<head>{CSS}<style type="text/css">.text{font-weight: normal;}</style></head><body>'.Database::escape_string($values['template_text']).'</body>';
                 $sql = "UPDATE $table_system_template set title = '".Database::escape_string($values['title'])."', content = '".$content_template."'";
@@ -1113,7 +1113,7 @@ 
         displayTemplates();
     } else {
         $token = Security::get_token();
-        $form->addElement('hidden','sec_token');
+        $form->addElement('hidden', 'sec_token');
         $form->setConstants(array('sec_token' => $token));
         // Display the form.
         $form->display();
@@ -1248,13 +1248,13 @@ 
                             $form->addElement(
                                 'html',
                                 '<div class="pull-right"><a class="share_this_setting" data_status = "0"  data_to_send = "'.$row['variable'].'" href="javascript:void(0);">'.
-                                Display::return_icon('shared_setting.png', get_lang('ChangeSharedSetting') , null, ICON_SIZE_MEDIUM).'</a></div>'
+                                Display::return_icon('shared_setting.png', get_lang('ChangeSharedSetting'), null, ICON_SIZE_MEDIUM).'</a></div>'
                             );
                         } else {
                             $form->addElement(
                                 'html',
                                 '<div class="pull-right"><a class="share_this_setting" data_status = "1" data_to_send = "'.$row['variable'].'" href="javascript:void(0);">'.
-                                Display::return_icon('shared_setting_na.png', get_lang('ChangeSharedSetting'), null, ICON_SIZE_MEDIUM ).'</a></div>'
+                                Display::return_icon('shared_setting_na.png', get_lang('ChangeSharedSetting'), null, ICON_SIZE_MEDIUM).'</a></div>'
                             );
                         }
                     } else {
@@ -1262,13 +1262,13 @@ 
                             $form->addElement(
                                 'html',
                                 '<div class="pull-right">'.
-                                Display::return_icon('shared_setting.png', get_lang('ChangeSharedSetting'), null, ICON_SIZE_MEDIUM ).'</div>'
+                                Display::return_icon('shared_setting.png', get_lang('ChangeSharedSetting'), null, ICON_SIZE_MEDIUM).'</div>'
                             );
                         } else {
                             $form->addElement(
                                 'html',
                                 '<div class="pull-right">'.
-                                Display::return_icon('shared_setting_na.png', get_lang('ChangeSharedSetting'), null, ICON_SIZE_MEDIUM ).'</div>'
+                                Display::return_icon('shared_setting_na.png', get_lang('ChangeSharedSetting'), null, ICON_SIZE_MEDIUM).'</div>'
                             );
                         }
                     }
@@ -1320,7 +1320,7 @@ 
                         array('maxlength' => '8')
                     );
                     $form->applyFilter($row['variable'], 'html_filter');
-                    $default_values[$row['variable']] = round($row['selected_value']/1024/1024, 1);
+                    $default_values[$row['variable']] = round($row['selected_value'] / 1024 / 1024, 1);
                 } elseif ($row['variable'] == 'account_valid_duration') {
                     $form->addElement(
                         'text',
@@ -1348,7 +1348,7 @@ 
                         ),
                         $hideme
                     );
-                    $form->applyFilter($row['variable'],'html_filter');
+                    $form->applyFilter($row['variable'], 'html_filter');
                     $default_values[$row['variable']] = $row['selected_value'];
                 }
                 break;
@@ -1359,7 +1359,7 @@ 
                     if (file_exists($file)) {
                         $value = file_get_contents($file);
                     }
-                    $form->addElement('textarea', $row['variable'], array(get_lang($row['title']), get_lang($row['comment'])) , array('rows'=>'10'), $hideme);
+                    $form->addElement('textarea', $row['variable'], array(get_lang($row['title']), get_lang($row['comment'])), array('rows'=>'10'), $hideme);
                     $default_values[$row['variable']] = $value;
                 } elseif ($row['variable'] == 'footer_extra_content') {
                     $file = api_get_path(SYS_PATH).api_get_home_path().'footer_extra_content.txt';
@@ -1367,16 +1367,16 @@ 
                     if (file_exists($file)) {
                         $value = file_get_contents($file);
                     }
-                    $form->addElement('textarea', $row['variable'], array(get_lang($row['title']), get_lang($row['comment'])) , array('rows'=>'10'), $hideme);
+                    $form->addElement('textarea', $row['variable'], array(get_lang($row['title']), get_lang($row['comment'])), array('rows'=>'10'), $hideme);
                     $default_values[$row['variable']] = $value;
                 } else {
-                    $form->addElement('textarea', $row['variable'], array(get_lang($row['title']), get_lang($row['comment'])) , array('rows'=>'10'), $hideme);
+                    $form->addElement('textarea', $row['variable'], array(get_lang($row['title']), get_lang($row['comment'])), array('rows'=>'10'), $hideme);
                     $default_values[$row['variable']] = $row['selected_value'];
                 }
                 break;
             case 'radio':
                 $values = api_get_settings_options($row['variable']);
-                $group = array ();
+                $group = array();
                 if (is_array($values)) {
                     foreach ($values as $key => $value) {
                         $element = &$form->createElement(
@@ -1407,7 +1407,7 @@ 
                         WHERE variable='".$row['variable']."' AND access_url =  1";
 
                 $result = Database::query($sql);
-                $group = array ();
+                $group = array();
                 while ($rowkeys = Database::fetch_array($result)) {
                     // Profile tab option should be hidden when the social tool is enabled.
                     if (api_get_setting('allow_social_tool') == 'true') {
@@ -1464,7 +1464,7 @@ 
                 break;
             case 'link':
                 $form->addElement('static', null, array(get_lang($row['title']), get_lang($row['comment'])),
-                    get_lang('CurrentValue') . ' : ' . $row['selected_value'], $hideme);
+                    get_lang('CurrentValue').' : '.$row['selected_value'], $hideme);
                 break;
             case 'select':
                 /*
@@ -1496,7 +1496,7 @@ 
                     $row['variable'],
                     [get_lang($row['title']), get_lang($row['comment'])],
                     $courseSelectOptions,
-                    ['url' => api_get_path(WEB_AJAX_PATH) . 'course.ajax.php?a=search_course']
+                    ['url' => api_get_path(WEB_AJAX_PATH).'course.ajax.php?a=search_course']
                 );
                 $default_values[$row['variable']] = $row['selected_value'];
                 break;
@@ -1504,10 +1504,10 @@ 
 
         switch ($row['variable']) {
             case 'pdf_export_watermark_enable':
-                $url =  PDF::get_watermark(null);
+                $url = PDF::get_watermark(null);
 
                 if ($url != false) {
-                    $delete_url = '<a href="?delete_watermark">'.get_lang('DelImage').' '.Display::return_icon('delete.png',get_lang('DelImage')).'</a>';
+                    $delete_url = '<a href="?delete_watermark">'.get_lang('DelImage').' '.Display::return_icon('delete.png', get_lang('DelImage')).'</a>';
                     $form->addElement('html', '<div style="max-height:100px; max-width:100px; margin-left:162px; margin-bottom:10px; clear:both;"><img src="'.$url.'" style="margin-bottom:10px;" />'.$delete_url.'</div>');
                 }
 
@@ -1661,7 +1661,7 @@ 
     if (api_is_windows_os() == false) {
         $list_of_programs = array('pdftotext', 'ps2pdf', 'catdoc', 'html2text', 'unrtf', 'catppt', 'xls2csv');
 
-        foreach($list_of_programs as $program) {
+        foreach ($list_of_programs as $program) {
             $output = [];
             $ret_val = null;
             exec("which $program", $output, $ret_val);
@@ -1674,7 +1674,7 @@ 
             if (!empty($output[0])) {
                 $icon = Display::return_icon('bullet_green.png', get_lang('Installed'));
             }
-            $data2[]= array($program, $output[0], $icon);
+            $data2[] = array($program, $output[0], $icon);
         }
         echo Display::tag('h3', get_lang('ProgramsNeededToConvertFiles'));
         $table = new SortableTableFromArray($data2);
@@ -1700,9 +1700,9 @@ 
     if (is_dir($dir)) {
         $zip = new PclZip($arch);
         // Remove path prefix except the style name and put file on disk
-        $zip->create($dir, PCLZIP_OPT_REMOVE_PATH, substr($dir,0,-strlen($style)));
+        $zip->create($dir, PCLZIP_OPT_REMOVE_PATH, substr($dir, 0, -strlen($style)));
         //@TODO: use more generic script to download.
-        $str = '<a class="btn btn-primary btn-large" href="' . api_get_path(WEB_CODE_PATH) . 'course_info/download.php?archive=' . str_replace(api_get_path(SYS_ARCHIVE_PATH), '', $arch) . '">'.get_lang('ClickHereToDownloadTheFile').'</a>';
+        $str = '<a class="btn btn-primary btn-large" href="'.api_get_path(WEB_CODE_PATH).'course_info/download.php?archive='.str_replace(api_get_path(SYS_ARCHIVE_PATH), '', $arch).'">'.get_lang('ClickHereToDownloadTheFile').'</a>';
         Display::display_normal_message($str, false);
     } else {
         Display::addFlash(Display::return_message(get_lang('FileNotFound'), 'warning'));

main/inc/lib/attendance.lib.php

Doc Comments +23 added lines, -5 removed lines

@@ -277,7 +277,7 @@ 
      * Add attendances sheet inside table. This is the *list of* dates, not
      * a specific date in itself.
      * @param  bool   true for adding link in gradebook or false otherwise (optional)
-     * @return int    last attendance id
+     * @return false|string    last attendance id
      */
     public function attendance_add($link_to_gradebook = false)
     {
@@ -354,6 +354,7 @@ 
      * edit attendances inside table
      * @param 	int	   attendance id
      * @param  	bool   true for adding link in gradebook or false otherwise (optional)
+     * @param integer $attendance_id
      * @return 	int    last id
      */
     public function attendance_edit($attendance_id, $link_to_gradebook = false)
@@ -429,6 +430,7 @@ 
     /**
      * Restore attendance
      * @param 	int|array	   one or many attendances id
+     * @param integer $attendance_id
      * @return 	int    		   affected rows
      */
     public function attendance_restore($attendance_id)
@@ -530,7 +532,7 @@ 
 
     /**
      * Changes visibility
-     * @param int|array	$attendanceId   one or many attendances id
+     * @param integer	$attendanceId   one or many attendances id
      * @param int status
      *
      * @return 	int affected rows
@@ -585,6 +587,7 @@ 
      * Lock or unlock an attendance
      * @param   int     attendance id
      * @param   bool    True to lock or false otherwise
+     * @param integer $attendance_id
      */
     public function lock_attendance($attendance_id, $lock = true)
     {
@@ -917,7 +920,11 @@ 
      * @param   string  Event type ('locked_attendance', 'done_attendance_sheet' ...)
      * @param   int     Last edit user id
      * @param   string  Calendar datetime value (optional, when event type is 'done_attendance_sheet')
-     * @return  int     Affected rows
+     * @param integer $attendance_id
+     * @param string $lastedit_date
+     * @param string $lastedit_type
+     * @param integer $lastedit_user_id
+     * @return  false|string     Affected rows
      */
     public function save_attendance_sheet_log(
         $attendance_id,
@@ -962,6 +969,7 @@ 
     /**
      * Get number of done attendances inside current sheet
      * @param	int	   attendance id
+     * @param integer $attendance_id
      * @return 	int	   number of done attendances
      */
     public static function get_done_attendance_calendar($attendance_id)
@@ -1197,6 +1205,7 @@ 
     /**
      * Get next attendance calendar without presences (done attendances)
      * @param	int	attendance id
+     * @param integer $attendance_id
      * @return 	int attendance calendar id
      */
     public function get_next_attendance_calendar_id($attendance_id)
@@ -1225,6 +1234,7 @@ 
     /**
      * Get next attendance calendar datetime without presences (done attendances)
      * @param	int	attendance id
+     * @param integer $attendance_id
      * @return 	int UNIX time format datetime
      */
     public function get_next_attendance_calendar_datetime($attendance_id)
@@ -1253,6 +1263,7 @@ 
      * Get user' score from current attendance
      * @param	int	$user_id
      * @param	int $attendance_id
+     * @param integer $groupId
      * @return	int score
      */
     public function get_user_score($user_id, $attendance_id, $groupId = null)
@@ -1300,6 +1311,7 @@ 
     /**
      * Get attendance calendar data by id
      * @param	int	attendance calendar id
+     * @param integer $calendar_id
      * @return	array attendance calendar data
      */
     public function get_attendance_calendar_by_id($calendar_id)
@@ -1422,6 +1434,7 @@ 
      * Get number of attendance calendar inside current attendance
      * @param	int	$attendance_id
      * @param	int	$groupId
+     * @param boolean $done_attendance
      * @return	int number of dates in attendance calendar
      */
     public static function get_number_of_attendance_calendar($attendance_id, $groupId = 0, $done_attendance = NULL, $userId = 0)
@@ -1647,7 +1660,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      * @return array
      */
     public function getGroupListByAttendanceCalendar($calendarId, $courseId)
@@ -1687,7 +1699,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      *
      * @return array
      */
@@ -1788,6 +1799,8 @@ 
      * edit a datetime inside attendance calendar table
      * @param	int	attendance calendar id
      * @param	int	attendance id
+     * @param integer $calendar_id
+     * @param integer $attendance_id
      * @return	int affected rows
      */
     public function attendance_calendar_edit($calendar_id, $attendance_id)
@@ -1827,6 +1840,8 @@ 
      * @param	int		attendance calendar id
      * @param	int		attendance id
      * @param	bool	true for removing all calendar inside current attendance, false for removing by calendar id
+     * @param integer $calendar_id
+     * @param integer $attendance_id
      * @return	int affected rows
      */
     public function attendance_calendar_delete($calendar_id, $attendance_id , $all_delete = false)
@@ -1889,6 +1904,9 @@ 
         $this->course_id = $course_id;
     }
 
+    /**
+     * @param string $datetime
+     */
     public function set_date_time($datetime)
     {
         $this->date_time = $datetime;

Spacing +58 added lines, -58 removed lines

@@ -73,7 +73,7 @@ 
             $course_id = intval($course_id);
         }
 
-        $session_id = isset($session_id)?intval($session_id):api_get_session_id();
+        $session_id = isset($session_id) ? intval($session_id) : api_get_session_id();
         $condition_session = api_get_session_condition($session_id);
 
         // Get attendance data
@@ -108,7 +108,7 @@ 
         $from = intval($from);
         $number_of_items = intval($number_of_items);
 
-        if (!in_array($direction, array('ASC','DESC'))) {
+        if (!in_array($direction, array('ASC', 'DESC'))) {
             $direction = 'ASC';
         }
 
@@ -135,7 +135,7 @@ 
                 LIMIT $from,$number_of_items ";
 
         $res = Database::query($sql);
-        $attendances = array ();
+        $attendances = array();
         $user_info = api_get_user_info();
         $allowDelete = api_get_setting('allow_delete_attendance');
 
@@ -190,8 +190,8 @@ 
                         $attendance[2] = '<span class="muted">'.$attendance[2].'</span>';
                     }
                     if ($allowDelete === 'true') {
-                        $actions .= '<a href="index.php?' . api_get_cidreq() . '&action=attendance_delete&attendance_id=' . $attendance[0]. '">' .
-                            Display::return_icon('delete.png', get_lang('Delete'), array(), ICON_SIZE_SMALL) . '</a>';
+                        $actions .= '<a href="index.php?'.api_get_cidreq().'&action=attendance_delete&attendance_id='.$attendance[0].'">'.
+                            Display::return_icon('delete.png', get_lang('Delete'), array(), ICON_SIZE_SMALL).'</a>';
                     }
                 } else {
                     $is_locked_attendance = self::is_locked_attendance($attendance[0]);
@@ -211,8 +211,8 @@ 
                             $attendance[2] = '<span class="muted">'.$attendance[2].'</span>';
                         }
                         if ($allowDelete === 'true') {
-                            $actions .= ' <a href="index.php?' . api_get_cidreq() . '&action=attendance_delete&attendance_id=' . $attendance[0].'">' .
-                                Display::return_icon('delete.png', get_lang('Delete'), array(), ICON_SIZE_SMALL) . '</a>';
+                            $actions .= ' <a href="index.php?'.api_get_cidreq().'&action=attendance_delete&attendance_id='.$attendance[0].'">'.
+                                Display::return_icon('delete.png', get_lang('Delete'), array(), ICON_SIZE_SMALL).'</a>';
                         }
                     }
                 }
@@ -221,7 +221,7 @@ 
                 $is_done_all_calendar = self::is_all_attendance_calendar_done($attendance[0]);
 
                 if ($is_done_all_calendar) {
-                    $locked   = $attendance[4];
+                    $locked = $attendance[4];
                     if ($locked == 0) {
                         if (api_is_platform_admin()) {
                             $message_alert = get_lang('AreYouSureToLockTheAttendance');
@@ -241,7 +241,7 @@ 
                 }
                 $actions .= '</center>';
 
-                $attendances[] = array($attendance[0], $attendance[1], $attendance[2], $attendance[3],$actions);
+                $attendances[] = array($attendance[0], $attendance[1], $attendance[2], $attendance[3], $actions);
             } else {
                 $attendance[0] = '&nbsp;';
                 $attendances[] = array($attendance[0], $attendance[1], $attendance[2], $attendance[3]);
@@ -282,13 +282,13 @@ 
     public function attendance_add($link_to_gradebook = false)
     {
         $_course = api_get_course_info();
-        $tbl_attendance	= Database :: get_course_table(TABLE_ATTENDANCE);
+        $tbl_attendance = Database :: get_course_table(TABLE_ATTENDANCE);
         $table_link = Database:: get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
         $session_id = api_get_session_id();
         $user_id = api_get_user_id();
         $course_code = $_course['code'];
         $course_id = $_course['real_id'];
-        $title_gradebook= $this->attendance_qualify_title;
+        $title_gradebook = $this->attendance_qualify_title;
         $value_calification = 0;
         $weight_calification = floatval($this->attendance_weight);
 
@@ -434,12 +434,12 @@ 
     public function attendance_restore($attendance_id)
     {
         $_course = api_get_course_info();
-        $tbl_attendance	= Database :: get_course_table(TABLE_ATTENDANCE);
+        $tbl_attendance = Database :: get_course_table(TABLE_ATTENDANCE);
         $user_id = api_get_user_id();
         $course_id = $_course['real_id'];
         if (is_array($attendance_id)) {
             foreach ($attendance_id as $id) {
-                $id	= intval($id);
+                $id = intval($id);
                 $sql = "UPDATE $tbl_attendance SET active = 1
                         WHERE c_id = $course_id AND id = '$id'";
                 $result = Database::query($sql);
@@ -455,8 +455,8 @@ 
                     );
                 }
             }
-        } else  {
-            $attendance_id	= intval($attendance_id);
+        } else {
+            $attendance_id = intval($attendance_id);
             $sql = "UPDATE $tbl_attendance SET active = 1
                     WHERE c_id = $course_id AND id = '$attendance_id'";
             $result = Database::query($sql);
@@ -484,13 +484,13 @@ 
     public function attendance_delete($attendance_id)
     {
         $_course = api_get_course_info();
-        $tbl_attendance	= Database :: get_course_table(TABLE_ATTENDANCE);
+        $tbl_attendance = Database :: get_course_table(TABLE_ATTENDANCE);
         $user_id = api_get_user_id();
         $course_id = $_course['real_id'];
 
         if (is_array($attendance_id)) {
             foreach ($attendance_id as $id) {
-                $id	= intval($id);
+                $id = intval($id);
                 $sql = "UPDATE $tbl_attendance SET active = 2
                         WHERE c_id = $course_id AND id = '$id'";
                 $result = Database::query($sql);
@@ -506,8 +506,8 @@ 
                     );
                 }
             }
-        } else  {
-            $attendance_id= intval($attendance_id);
+        } else {
+            $attendance_id = intval($attendance_id);
             $sql = "UPDATE $tbl_attendance SET active = 2
                     WHERE c_id = $course_id AND id = '$attendance_id'";
 
@@ -538,7 +538,7 @@ 
     public function changeVisibility($attendanceId, $status = 1)
     {
         $_course = api_get_course_info();
-        $tbl_attendance	= Database :: get_course_table(TABLE_ATTENDANCE);
+        $tbl_attendance = Database :: get_course_table(TABLE_ATTENDANCE);
         $user_id = api_get_user_id();
         $course_id = $_course['real_id'];
         $status = intval($status);
@@ -550,7 +550,7 @@ 
 
         if (is_array($attendanceId)) {
             foreach ($attendanceId as $id) {
-                $id	= intval($id);
+                $id = intval($id);
                 $sql = "UPDATE $tbl_attendance SET active = $status
                         WHERE c_id = $course_id AND id = '$id'";
                 $result = Database::query($sql);
@@ -560,8 +560,8 @@ 
                     api_item_property_update($_course, TOOL_ATTENDANCE, $id, $action, $user_id);
                 }
             }
-        } else  {
-            $attendanceId	= intval($attendanceId);
+        } else {
+            $attendanceId = intval($attendanceId);
             $sql = "UPDATE $tbl_attendance SET active = $status
                     WHERE c_id = $course_id AND id = '$attendanceId'";
             $result = Database::query($sql);
@@ -591,7 +591,7 @@ 
         $tbl_attendance = Database::get_course_table(TABLE_ATTENDANCE);
         $course_id = api_get_course_int_id();
         $attendance_id = intval($attendance_id);
-        $locked = ($lock)?1:0;
+        $locked = ($lock) ? 1 : 0;
         $upd = "UPDATE $tbl_attendance SET locked = $locked
                 WHERE c_id = $course_id AND id = $attendance_id";
         $result = Database::query($upd);
@@ -720,8 +720,8 @@ 
      */
     public function attendance_sheet_add($calendar_id, $users_present, $attendance_id)
     {
-        $tbl_attendance_sheet 	= Database::get_course_table(TABLE_ATTENDANCE_SHEET);
-        $tbl_attendance_calendar= Database::get_course_table(TABLE_ATTENDANCE_CALENDAR);
+        $tbl_attendance_sheet = Database::get_course_table(TABLE_ATTENDANCE_SHEET);
+        $tbl_attendance_calendar = Database::get_course_table(TABLE_ATTENDANCE_CALENDAR);
 
         $calendar_id = intval($calendar_id);
         $attendance_id = intval($attendance_id);
@@ -729,7 +729,7 @@ 
         $course_id = api_get_course_int_id();
 
         $user_ids = array_keys($users);
-        $users_absent = array_diff($user_ids,$users_present);
+        $users_absent = array_diff($user_ids, $users_present);
         $affected_rows = 0;
 
         // get last edit type
@@ -1012,7 +1012,7 @@ 
         }
 
         $faults = $faults > 0 ? $faults : 0;
-        $faults_porcent = $calendar_count > 0 ?round(($faults*100)/$calendar_count,0):0;
+        $faults_porcent = $calendar_count > 0 ? round(($faults * 100) / $calendar_count, 0) : 0;
         $results['faults'] = $faults;
         $results['total'] = $calendar_count;
         $results['faults_porcent'] = $faults_porcent;
@@ -1046,13 +1046,13 @@ 
             //$course_code = $course['code'];
             //$course_info = api_get_course_info($course_code);
             $course_id = $course['real_id'];
-            $tbl_attendance_result 	= Database::get_course_table(TABLE_ATTENDANCE_RESULT);
+            $tbl_attendance_result = Database::get_course_table(TABLE_ATTENDANCE_RESULT);
 
             $attendances_by_course = $this->get_attendances_list($course_id);
 
             foreach ($attendances_by_course as $attendance) {
                 // get total faults and total weight
-                $total_done_attendance 	= $attendance['attendance_qualify_max'];
+                $total_done_attendance = $attendance['attendance_qualify_max'];
                 $sql = "SELECT score
                         FROM $tbl_attendance_result
                         WHERE
@@ -1065,16 +1065,16 @@ 
                     $row = Database::fetch_array($rs);
                     $score = $row['score'];
                 }
-                $faults = $total_done_attendance-$score;
-                $faults = $faults > 0 ? $faults:0;
+                $faults = $total_done_attendance - $score;
+                $faults = $faults > 0 ? $faults : 0;
                 $total_faults += $faults;
                 $total_weight += $total_done_attendance;
             }
         }
 
-        $porcent = $total_weight > 0 ?round(($total_faults*100)/$total_weight,0):0;
+        $porcent = $total_weight > 0 ? round(($total_faults * 100) / $total_weight, 0) : 0;
         $results['faults'] 	= $total_faults;
-        $results['total']	= $total_weight;
+        $results['total'] = $total_weight;
         $results['porcent'] = $porcent;
 
         return $results;
@@ -1092,7 +1092,7 @@ 
     {
         // Database tables and variables
         $course_info = api_get_course_info($course_code);
-        $tbl_attendance_result 	= Database::get_course_table(TABLE_ATTENDANCE_RESULT);
+        $tbl_attendance_result = Database::get_course_table(TABLE_ATTENDANCE_RESULT);
         $user_id = intval($user_id);
         $results = array();
         $total_faults = $total_weight = $porcent = 0;
@@ -1100,7 +1100,7 @@ 
 
         foreach ($attendances_by_course as $attendance) {
             // Get total faults and total weight
-            $total_done_attendance 	= $attendance['attendance_qualify_max'];
+            $total_done_attendance = $attendance['attendance_qualify_max'];
             $sql = "SELECT score FROM $tbl_attendance_result
                     WHERE
                         c_id = {$course_info['real_id']} AND
@@ -1112,15 +1112,15 @@ 
                 $row = Database::fetch_array($rs);
                 $score = $row['score'];
             }
-            $faults = $total_done_attendance-$score;
-            $faults = $faults > 0 ? $faults:0;
+            $faults = $total_done_attendance - $score;
+            $faults = $faults > 0 ? $faults : 0;
             $total_faults += $faults;
             $total_weight += $total_done_attendance;
         }
 
-        $porcent = $total_weight > 0 ?round(($total_faults*100)/$total_weight,0):0;
+        $porcent = $total_weight > 0 ? round(($total_faults * 100) / $total_weight, 0) : 0;
         $results['faults'] 	= $total_faults;
-        $results['total']	= $total_weight;
+        $results['total'] = $total_weight;
         $results['porcent'] = $porcent;
 
         return $results;
@@ -1134,8 +1134,8 @@ 
      */
     public function get_users_attendance_sheet($attendance_id, $user_id = 0, $groupId = null)
     {
-        $tbl_attendance_sheet 	= Database::get_course_table(TABLE_ATTENDANCE_SHEET);
-        $tbl_attendance_calendar= Database::get_course_table(TABLE_ATTENDANCE_CALENDAR);
+        $tbl_attendance_sheet = Database::get_course_table(TABLE_ATTENDANCE_SHEET);
+        $tbl_attendance_calendar = Database::get_course_table(TABLE_ATTENDANCE_CALENDAR);
 
         $attendance_calendar = $this->get_attendance_calendar($attendance_id, 'all', null, $groupId);
         $calendar_ids = array();
@@ -1157,7 +1157,7 @@ 
                             WHERE
                                 c_id = $course_id AND
                                 user_id = '$uid' AND
-                                attendance_calendar_id IN(".implode(',',$calendar_ids).")
+                                attendance_calendar_id IN(".implode(',', $calendar_ids).")
                             ";
                     $res = Database::query($sql);
                     if (Database::num_rows($res) > 0) {
@@ -1179,7 +1179,7 @@ 
                             att.c_id = $course_id AND
                             cal.c_id =  $course_id AND
                             att.user_id = '$user_id' AND
-                            att.attendance_calendar_id IN (".implode(',',$calendar_ids).")
+                            att.attendance_calendar_id IN (".implode(',', $calendar_ids).")
                         ORDER BY date_time";
                 $res = Database::query($sql);
                 if (Database::num_rows($res) > 0) {
@@ -1257,7 +1257,7 @@ 
      */
     public function get_user_score($user_id, $attendance_id, $groupId = null)
     {
-        $tbl_attendance_result 	= Database::get_course_table(TABLE_ATTENDANCE_RESULT);
+        $tbl_attendance_result = Database::get_course_table(TABLE_ATTENDANCE_RESULT);
         $tbl_attendance_sheet = Database::get_course_table(TABLE_ATTENDANCE_SHEET);
         $tbl_attendance_cal_rel_group = Database::get_course_table(TABLE_ATTENDANCE_CALENDAR_REL_GROUP);
         $tbl_attendance_cal = Database::get_course_table(TABLE_ATTENDANCE_CALENDAR);
@@ -1370,7 +1370,7 @@ 
                    ";
         }
 
-        if (!in_array($type, array('today', 'all', 'all_done', 'all_not_done','calendar_id'))) {
+        if (!in_array($type, array('today', 'all', 'all_done', 'all_not_done', 'calendar_id'))) {
             $type = 'all';
         }
 
@@ -1378,7 +1378,7 @@ 
             case 'calendar_id':
                 $calendar_id = intval($calendar_id);
                 if (!empty($calendar_id)) {
-                    $sql.= " AND c.id = $calendar_id";
+                    $sql .= " AND c.id = $calendar_id";
                 }
                 break;
             case 'today':
@@ -1399,7 +1399,7 @@ 
         $rs = Database::query($sql);
         $data = array();
         if (Database::num_rows($rs) > 0) {
-            while ($row = Database::fetch_array($rs,'ASSOC')) {
+            while ($row = Database::fetch_array($rs, 'ASSOC')) {
                 $row['db_date_time'] = $row['date_time'];
                 $row['date_time'] = api_get_local_time($row['date_time']);
                 $row['date'] = api_format_date($row['date_time'], DATE_FORMAT_SHORT);
@@ -1764,14 +1764,14 @@ 
      * @param   int     The number of years to add
      * @return  int     The new timestamp
      */
-    private function add_month($timestamp, $num=1)
+    private function add_month($timestamp, $num = 1)
     {
         $values = api_get_utc_datetime($timestamp);
-        $values = str_replace(array(':','-',' '), '/', $values);
-        list($y, $m, $d, $h, $n, $s) = split('/',$values);
-        if($m+$num>12) {
-            $y += floor($num/12);
-            $m += $num%12;
+        $values = str_replace(array(':', '-', ' '), '/', $values);
+        list($y, $m, $d, $h, $n, $s) = split('/', $values);
+        if ($m + $num > 12) {
+            $y += floor($num / 12);
+            $m += $num % 12;
         } else {
             $m += $num;
         }
@@ -1829,7 +1829,7 @@ 
      * @param	bool	true for removing all calendar inside current attendance, false for removing by calendar id
      * @return	int affected rows
      */
-    public function attendance_calendar_delete($calendar_id, $attendance_id , $all_delete = false)
+    public function attendance_calendar_delete($calendar_id, $attendance_id, $all_delete = false)
     {
         $tbl_attendance_calendar = Database::get_course_table(TABLE_ATTENDANCE_CALENDAR);
         $tbl_attendance_sheet = Database::get_course_table(TABLE_ATTENDANCE_SHEET);
@@ -1986,7 +1986,7 @@ 
 
         $dateTimeStartOriginal = new DateTime($startDate);
         $dateTimeStart = new DateTime($startDate);
-        $dateTimeEnd= new DateTime($endDate);
+        $dateTimeEnd = new DateTime($endDate);
         $interval = $dateTimeStart->diff($dateTimeEnd);
         $days = intval($interval->format('%a'));
 
@@ -2059,7 +2059,7 @@ 
                 0,
                 $user['lastname'].' '.$user['firstname'].' ('.$user['username'].')'
             );
-            $row ++;
+            $row++;
         }
 
         $column = 1;
@@ -2136,7 +2136,7 @@ 
         $tableToString = $table->toHtml();
 
         $params = array(
-            'filename' => get_lang('Attendance') . '_' . api_get_utc_datetime(),
+            'filename' => get_lang('Attendance').'_'.api_get_utc_datetime(),
             'pdf_title' => get_lang('Attendance'),
             'course_code' => api_get_course_id(),
             'show_real_course_teachers' => true

main/inc/lib/extra_field_option.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -412,7 +412,7 @@ 
      * Gets an array of options for a specific field
      * @param int $field_id The field ID
      * @param bool $add_id_in_array Whether to add the row ID in the result
-     * @param null $ordered_by Extra ordering query bit
+     * @param null|string $ordered_by Extra ordering query bit
      * @return array The options if they exists. Otherwise return false
      */
     public function get_field_options_by_field($field_id, $add_id_in_array = false, $ordered_by = null)
@@ -782,8 +782,8 @@ 
     }
 
     /**
-     * @param $defaultDisplayText
-     * @return mixed|string
+     * @param string $defaultDisplayText
+     * @return string
      */
     public static function getLanguageVariable($defaultDisplayText)
     {

Spacing +2 added lines, -2 removed lines

@@ -216,7 +216,7 @@ 
 
                         foreach ($sub_options as $sub_option) {
                             if (!empty($sub_option)) {
-                                $new_params  = array(
+                                $new_params = array(
                                     'field_id' => $field_id,
                                     'option_value' => $sub_id,
                                     'display_text' => $sub_option,
@@ -660,7 +660,7 @@ 
         $form->addElement('hidden', 'field_id', $this->field_id);
 
         if ($action == 'edit') {
-            $translateUrl = api_get_path(WEB_CODE_PATH) . 'extrafield/translate.php?' . http_build_query([
+            $translateUrl = api_get_path(WEB_CODE_PATH).'extrafield/translate.php?'.http_build_query([
                 'extra_field_option' => $id
             ]);
             $translateButton = Display::toolbarButton(get_lang('TranslateThisTerm'), $translateUrl, 'language', 'link');

main/inc/lib/formvalidator/FormValidator.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -954,7 +954,7 @@
     /**
      * This function has been created for avoiding changes directly within QuickForm class.
      * When we use it, the element is threated as 'required' to be dealt during validation.
-     * @param array $element The array of elements
+     * @param array $elements The array of elements
      * @param string $message The message displayed
      */
     public function add_multiple_required_rule($elements, $message)

Spacing +5 added lines, -5 removed lines

@@ -99,7 +99,7 @@ 
         $renderer->setHeaderTemplate('<legend>{header}</legend>');
 
         //Set required field template
-        $this->setRequiredNote('<span class="form_required">*</span> <small>' . get_lang('ThisFieldIsRequired') . '</small>');
+        $this->setRequiredNote('<span class="form_required">*</span> <small>'.get_lang('ThisFieldIsRequired').'</small>');
         $noteTemplate = <<<EOT
 	<div class="form-group">
 		<div class="col-sm-offset-2 col-sm-10">{requiredNote}</div>
@@ -902,8 +902,8 @@ 
         $this->with_progress_bar = true;
         $id = $this->getAttribute('id');
 
-        $this->updateAttributes("onsubmit=\"javascript: addProgress('" . $id . "')\"");
-        $this->addHtml('<script language="javascript" src="' . api_get_path(WEB_LIBRARY_PATH) . 'javascript/upload.js" type="text/javascript"></script>');
+        $this->updateAttributes("onsubmit=\"javascript: addProgress('".$id."')\"");
+        $this->addHtml('<script language="javascript" src="'.api_get_path(WEB_LIBRARY_PATH).'javascript/upload.js" type="text/javascript"></script>');
     }
 
     /**
@@ -1402,7 +1402,7 @@ 
                             .prop('href', file.url);
                         $(data.context.children()[index]).parent().wrap(link);
                         
-                        var successMessage = $('<div class=\"col-sm-3\">').html($('<span class=\"alert alert-success\"/>').text('" . addslashes(get_lang('UplUploadSucceeded')) . "'));
+                        var successMessage = $('<div class=\"col-sm-3\">').html($('<span class=\"alert alert-success\"/>').text('" . addslashes(get_lang('UplUploadSucceeded'))."'));
                         $(data.context.children()[index]).parent().append(successMessage);
                     } else if (file.error) {
                         var error = $('<div class=\"col-sm-3\">').html($('<span class=\"alert alert-danger\"/>').text(file.error));
@@ -1411,7 +1411,7 @@ 
                 });
             }).on('fileuploadfail', function (e, data) {
                 $.each(data.files, function (index) {
-                    var failedMessage = '" . addslashes(get_lang('UplUploadFailed')) . "';
+                    var failedMessage = '" . addslashes(get_lang('UplUploadFailed'))."';
                     var error = $('<div class=\"col-sm-3\">').html($('<span class=\"alert alert-danger\"/>').text(failedMessage));
                     $(data.context.children()[index]).parent().append(error);
                 });

main/course_info/download.php

Indentation +7 added lines, -7 removed lines

@@ -10,11 +10,11 @@ 
 $this_section = SECTION_COURSES;
 
 if (isset($_GET['session']) && $_GET['session']) {
-	$archive_path = api_get_path(SYS_ARCHIVE_PATH).'temp/';
-	$_cid = true;
-	$is_courseAdmin = true;
+    $archive_path = api_get_path(SYS_ARCHIVE_PATH).'temp/';
+    $_cid = true;
+    $is_courseAdmin = true;
 } else {
-	$archive_path = api_get_path(SYS_ARCHIVE_PATH);
+    $archive_path = api_get_path(SYS_ARCHIVE_PATH);
 }
 
 $archive_file = isset($_GET['archive']) ? $_GET['archive'] : null;
@@ -23,16 +23,16 @@ 
 list($extension) = getextension($archive_file);
 
 if (empty($extension) || !file_exists($archive_path.$archive_file)) {
-	exit;
+    exit;
 }
 
 $extension = strtolower($extension);
 $content_type = '';
 
 if (in_array($extension, array('xml', 'csv')) && (api_is_platform_admin(true) || api_is_drh())) {
-	$content_type = 'application/force-download';
+    $content_type = 'application/force-download';
 } elseif ($extension === 'zip' && $_cid && (api_is_platform_admin(true) || $is_courseAdmin)) {
-	$content_type = 'application/force-download';
+    $content_type = 'application/force-download';
 }
 
 if (empty($content_type)) {

main/course_home/3column.php

Spacing +12 added lines, -12 removed lines

@@ -126,14 +126,14 @@ 
         "</td>\n".
         "<td>\n".
         "<select name=\"image\">\n".
-        "<option selected>". $image. "</option>\n";
+        "<option selected>".$image."</option>\n";
 
     if ($dir = @opendir($chemin)) {
         while ($file = readdir($dir)) {
             if ($file == '..' || $file == '.') {
                 unset($file);
             }
-            $content .= "<option>". $file. "</option>\n";
+            $content .= "<option>".$file."</option>\n";
         }
         closedir($dir);
     }
@@ -142,15 +142,15 @@ 
         "</td>\n".
         "</tr>\n".
         "<tr>\n".
-        "<td>". get_lang('NameOfTheLink'). " : </td>\n".
-        "<td><input type=\"text\" name=\"name\" value=\"". $name. "\"></td>\n".
+        "<td>".get_lang('NameOfTheLink')." : </td>\n".
+        "<td><input type=\"text\" name=\"name\" value=\"".$name."\"></td>\n".
         "</tr>\n".
         "<tr>\n".
         "<td>Lien :</td>\n".
-        "<td><input type=\"text\" name=\"link\" value=\"". $link. "\"></td>\n".
+        "<td><input type=\"text\" name=\"link\" value=\"".$link."\"></td>\n".
         "</tr>\n".
         "<tr>\n".
-        "<td colspan=\"2\"><input type=\"submit\" name=\"submit\" value=\"". get_lang('Ok'). "\"></td>\n".
+        "<td colspan=\"2\"><input type=\"submit\" name=\"submit\" value=\"".get_lang('Ok')."\"></td>\n".
         "</tr>\n".
         "</form>\n".
         "</table>\n".
@@ -203,21 +203,21 @@ 
         "<tr><td colspan=\"6\"><font color=\"#F66105\">\n".get_lang('CourseAdminOnly')."</font>
         </td></tr>\n";
     $content .= "<tr>\n<td colspan=\"6\">";
-    $content .=CourseHome::show_tool_3column('courseAdmin');
+    $content .= CourseHome::show_tool_3column('courseAdmin');
     $content .= "</td>\n</tr>\n";
 }
 
 /*	TOOLS FOR PLATFORM ADMIN ONLY */
 if (api_is_platform_admin() && api_is_allowed_to_edit(null, true) && !api_is_coach()) {
-    $content .=  "<tr>"."<td colspan=\"6\">".
+    $content .= "<tr>"."<td colspan=\"6\">".
         "<hr noshade size=\"1\" />".
         "</td>"."</tr>\n".
         "<tr>\n"."<td colspan=\"6\">\n".
-        "<font color=\"#F66105\" >". get_lang('PlatformAdminOnly'). "</font>\n".
+        "<font color=\"#F66105\" >".get_lang('PlatformAdminOnly')."</font>\n".
         "</td>\n"."</tr>\n";
-    $content .=  "<tr>\n<td colspan=\"6\">";
+    $content .= "<tr>\n<td colspan=\"6\">";
     $content .= CourseHome::show_tool_3column('platformAdmin');
-    $content .=  "</td>\n</tr>\n";
+    $content .= "</td>\n</tr>\n";
 }
 
-$content .=  "</table>\n";
+$content .= "</table>\n";

main/course_home/2column.php

Spacing +5 added lines, -5 removed lines

@@ -56,7 +56,7 @@ 
     // Show message to confirm that a tool it to be hidden from available tools
     // visibility 0,1->2
     if (!empty($_GET['askDelete'])) {
-        $content .='<div id="toolhide">'.get_lang('DelLk').'<br />&nbsp;&nbsp;&nbsp;
+        $content .= '<div id="toolhide">'.get_lang('DelLk').'<br />&nbsp;&nbsp;&nbsp;
             <a href="'.api_get_self().'">'.get_lang('No').'</a>&nbsp;|&nbsp;
             <a href="'.api_get_self().'?delete=yes&id='.intval($_GET['id']).'">'.get_lang('Yes').'</a>
         </div>';
@@ -92,7 +92,7 @@ 
 
     /*	INACTIVE TOOLS - HIDDEN (GREY) LINKS */
 
-    $content .=	"<tr><td colspan=\"4\"><hr style='color:\"#4171B5\"' noshade=\"noshade\" size=\"1\" /></td></tr>\n".
+    $content .= "<tr><td colspan=\"4\"><hr style='color:\"#4171B5\"' noshade=\"noshade\" size=\"1\" /></td></tr>\n".
             "<tr>\n".
             "<td colspan=\"4\">\n".
             "<div style=\"margin-bottom: 10px;\"><font color=\"#808080\">\n".get_lang('InLnk')."</font></div>".
@@ -101,14 +101,14 @@ 
 
     $content .= CourseHome::show_tool_2column(TOOL_PUBLIC_BUT_HIDDEN);
 
-    $content .=	"</table>";
-    $content .=	"</div> ";
+    $content .= "</table>";
+    $content .= "</div> ";
 }
 
 /*	Tools for platform admin only */
 
 if (api_is_platform_admin() && api_is_allowed_to_edit(null, true) && !api_is_coach()) {
-    $content .='<div class="platformadminview">
+    $content .= '<div class="platformadminview">
     <span class="viewcaption">'.get_lang('PlatformAdminOnly').'</span>
     <table width="100%">
         '.CourseHome::show_tool_2column(TOOL_PLATFORM_ADMIN).'

main/inc/lib/app_view.php

Spacing +4 added lines, -4 removed lines

@@ -16,7 +16,7 @@ 
      * @param string  tool name (optional)
      * @param string $template_path
      */
-    public function __construct($toolname = '', $template_path=null)
+    public function __construct($toolname = '', $template_path = null)
     {
         if (!empty($toolname)) {
             if (isset($template_path)) {
@@ -27,7 +27,7 @@ 
             if (is_dir($path)) {
                 $this->tool_path = $path;
             } else {
-                throw new Exception('View::__construct() $path directory does not exist ' . $path);
+                throw new Exception('View::__construct() $path directory does not exist '.$path);
             }
         }
     }
@@ -39,7 +39,7 @@ 
     public function set_data($data)
     {
         if (!is_array($data)) {
-            throw new Exception('View::set_data() $data must to be an array, you have sent a' . gettype( $data ));
+            throw new Exception('View::set_data() $data must to be an array, you have sent a'.gettype($data));
         }
         $this->data = $data;
     }
@@ -49,7 +49,7 @@ 
      * @param string layout view
      * @param string $layout
      */
-    public function set_layout( $layout )
+    public function set_layout($layout)
     {
         $this->layout = $layout;
     }

main/inc/lib/auth.lib.php

Spacing +48 added lines, -48 removed lines

@@ -48,12 +48,12 @@ 
         $special_course_list = array();
         if (Database::num_rows($result) > 0) {
             while ($result_row = Database::fetch_array($result)) {
-                $special_course_list[] = '"' . $result_row['item_id'] . '"';
+                $special_course_list[] = '"'.$result_row['item_id'].'"';
             }
         }
         $without_special_courses = '';
         if (!empty($special_course_list)) {
-            $without_special_courses = ' AND course.id NOT IN (' . implode(',', $special_course_list) . ')';
+            $without_special_courses = ' AND course.id NOT IN ('.implode(',', $special_course_list).')';
         }
 
         // Secondly we select the courses that are in a category (user_course_cat<>0) and sort these according to the sort of the category
@@ -73,8 +73,8 @@ 
                 FROM $TABLECOURS course, $TABLECOURSUSER  course_rel_user
                 WHERE
                     course.id = course_rel_user.c_id AND
-                    course_rel_user.relation_type<>" . COURSE_RELATION_TYPE_RRHH . " AND
-                    course_rel_user.user_id = '" . $user_id . "' $without_special_courses
+                    course_rel_user.relation_type<>".COURSE_RELATION_TYPE_RRHH." AND
+                    course_rel_user.user_id = '" . $user_id."' $without_special_courses
                 ORDER BY course_rel_user.sort ASC";
         $result = Database::query($sql);
         $courses = array();
@@ -106,7 +106,7 @@ 
     {
         $user_id = api_get_user_id();
         $table_category = Database::get_main_table(TABLE_USER_COURSE_CATEGORY);
-        $sql = "SELECT * FROM " . $table_category . "
+        $sql = "SELECT * FROM ".$table_category."
                 WHERE user_id=$user_id
                 ORDER BY sort ASC";
         $result = Database::query($sql);
@@ -148,13 +148,13 @@ 
         $special_course_list = array();
         if (Database::num_rows($result) > 0) {
             while ($result_row = Database::fetch_array($result)) {
-                $special_course_list[] = '"' . $result_row['item_id'] . '"';
+                $special_course_list[] = '"'.$result_row['item_id'].'"';
             }
         }
 
         $without_special_courses = '';
         if (!empty($special_course_list)) {
-            $without_special_courses = ' AND course.id NOT IN (' . implode(',', $special_course_list) . ')';
+            $without_special_courses = ' AND course.id NOT IN ('.implode(',', $special_course_list).')';
         }
 
         $sql = "SELECT
@@ -165,8 +165,8 @@ 
                 $TABLECOURSUSER  course_rel_user
                 WHERE
                     course.id = course_rel_user.c_id AND
-                    course_rel_user.user_id = '" . $user_id . "' AND
-                    course_rel_user.relation_type <> " . COURSE_RELATION_TYPE_RRHH . "
+                    course_rel_user.user_id = '".$user_id."' AND
+                    course_rel_user.relation_type <> " . COURSE_RELATION_TYPE_RRHH."
                     $without_special_courses
                 ORDER BY course_rel_user.user_course_cat, course_rel_user.sort ASC";
         $result = Database::query($sql);
@@ -194,11 +194,11 @@ 
         $TABLECOURSUSER = Database::get_main_table(TABLE_MAIN_COURSE_USER);
         $max_sort_value = api_max_sort_value($newcategory, $current_user);
         $sql = "UPDATE $TABLECOURSUSER SET
-                    user_course_cat='" . $newcategory . "',
-                    sort='" . ($max_sort_value + 1) . "'
+                    user_course_cat='".$newcategory."',
+                    sort='" . ($max_sort_value + 1)."'
                 WHERE
-                    c_id ='" . $courseId . "' AND
-                    user_id='" . $current_user . "' AND
+                    c_id ='" . $courseId."' AND
+                    user_id='" . $current_user."' AND
                     relation_type<>" . COURSE_RELATION_TYPE_RRHH;
         $resultQuery = Database::query($sql);
 
@@ -257,18 +257,18 @@ 
             $targetCourseId = $targetCourseInfo['real_id'];
 
             $sql = "UPDATE $table
-                    SET sort='" . $target_course['sort'] . "'
+                    SET sort='".$target_course['sort']."'
                     WHERE
-                        c_id = '" . $courseId . "' AND
-                        user_id = '" . $current_user_id . "' AND
+                        c_id = '" . $courseId."' AND
+                        user_id = '" . $current_user_id."' AND
                         relation_type<>" . COURSE_RELATION_TYPE_RRHH;
 
             $result1 = Database::query($sql);
 
-            $sql = "UPDATE $table SET sort='" . $source_course['sort'] . "'
+            $sql = "UPDATE $table SET sort='".$source_course['sort']."'
                     WHERE
-                        c_id ='" . $targetCourseId . "' AND
-                        user_id='" . $current_user_id . "' AND
+                        c_id ='" . $targetCourseId."' AND
+                        user_id='" . $current_user_id."' AND
                         relation_type<>" . COURSE_RELATION_TYPE_RRHH;
 
             $result2 = Database::query($sql);
@@ -312,10 +312,10 @@ 
         }
 
         if (count($target_category) > 0 && count($source_category) > 0) {
-            $sql_update1 = "UPDATE $table_user_defined_category SET sort='" . Database::escape_string($target_category['sort']) . "'
-                            WHERE id='" . intval($source_category['id']) . "' AND user_id='" . $current_user_id . "'";
-            $sql_update2 = "UPDATE $table_user_defined_category SET sort='" . Database::escape_string($source_category['sort']) . "'
-                            WHERE id='" . intval($target_category['id']) . "' AND user_id='" . $current_user_id . "'";
+            $sql_update1 = "UPDATE $table_user_defined_category SET sort='".Database::escape_string($target_category['sort'])."'
+                            WHERE id='" . intval($source_category['id'])."' AND user_id='".$current_user_id."'";
+            $sql_update2 = "UPDATE $table_user_defined_category SET sort='".Database::escape_string($source_category['sort'])."'
+                            WHERE id='" . intval($target_category['id'])."' AND user_id='".$current_user_id."'";
 
             $result1 = Database::query($sql_update2);
             $result2 = Database::query($sql_update1);
@@ -334,8 +334,8 @@ 
     {
         $current_user_id = api_get_user_id();
         $table_category = Database::get_main_table(TABLE_USER_COURSE_CATEGORY);
-        $sql = "SELECT * FROM " . $table_category . "
-                WHERE user_id='" . $current_user_id . "'
+        $sql = "SELECT * FROM ".$table_category."
+                WHERE user_id='" . $current_user_id."'
                 ORDER BY sort ASC";
         $result = Database::query($sql);
         while ($row = Database::fetch_array($result)) {
@@ -358,8 +358,8 @@ 
         $result = false;
         $tucc = Database::get_main_table(TABLE_USER_COURSE_CATEGORY);
         $sql = "UPDATE $tucc
-                SET title='" . api_htmlentities($title, ENT_QUOTES, api_get_system_encoding()) . "'
-                WHERE id='" . $category_id . "'";
+                SET title='".api_htmlentities($title, ENT_QUOTES, api_get_system_encoding())."'
+                WHERE id='" . $category_id."'";
         $resultQuery = Database::query($sql);
         if (Database::affected_rows($resultQuery)) {
             $result = true;
@@ -381,8 +381,8 @@ 
         $result = false;
         $sql = "DELETE FROM $tucc
                 WHERE 
-                    id='" . $category_id . "' AND 
-                    user_id='" . $current_user_id . "'";
+                    id='".$category_id."' AND 
+                    user_id='" . $current_user_id."'";
         $resultQuery = Database::query($sql);
         if (Database::affected_rows($resultQuery)) {
             $result = true;
@@ -390,9 +390,9 @@ 
         $sql = "UPDATE $TABLECOURSUSER
                 SET user_course_cat='0'
                 WHERE
-                    user_course_cat='" . $category_id . "' AND
-                    user_id='" . $current_user_id . "' AND
-                    relation_type<>" . COURSE_RELATION_TYPE_RRHH . " ";
+                    user_course_cat='".$category_id."' AND
+                    user_id='" . $current_user_id."' AND
+                    relation_type<>" . COURSE_RELATION_TYPE_RRHH." ";
         Database::query($sql);
 
         return $result;
@@ -425,20 +425,20 @@ 
         if (Database::num_rows($special_course_result) > 0) {
             $special_course_list = array();
             while ($result_row = Database::fetch_array($special_course_result)) {
-                $special_course_list[] = '"' . $result_row['item_id'] . '"';
+                $special_course_list[] = '"'.$result_row['item_id'].'"';
             }
         }
         $without_special_courses = '';
         if (!empty($special_course_list)) {
-            $without_special_courses = ' AND course.code NOT IN (' . implode(',', $special_course_list) . ')';
+            $without_special_courses = ' AND course.code NOT IN ('.implode(',', $special_course_list).')';
         }
 
         $search_term_safe = Database::escape_string($search_term);
         $sql_find = "SELECT * FROM $courseTable
                     WHERE (
-                            code LIKE '%" . $search_term_safe . "%' OR
-                            title LIKE '%" . $search_term_safe . "%' OR
-                            tutor_name LIKE '%" . $search_term_safe . "%'
+                            code LIKE '%".$search_term_safe."%' OR
+                            title LIKE '%" . $search_term_safe."%' OR
+                            tutor_name LIKE '%" . $search_term_safe."%'
                         )
                         $without_special_courses
                     ORDER BY title, visual_code ASC
@@ -455,9 +455,9 @@ 
                             ON (url_rel_course.c_id = course.id)
                             WHERE
                                 access_url_id = $url_access_id AND (
-                                    code LIKE '%" . $search_term_safe . "%' OR
-                                    title LIKE '%" . $search_term_safe . "%' OR
-                                    tutor_name LIKE '%" . $search_term_safe . "%'
+                                    code LIKE '%".$search_term_safe."%' OR
+                                    title LIKE '%" . $search_term_safe."%' OR
+                                    tutor_name LIKE '%" . $search_term_safe."%'
                                 )
                                 $without_special_courses
                             ORDER BY title, visual_code ASC
@@ -518,8 +518,8 @@ 
         // (s)he can only delete the course
         $sql = "SELECT * FROM $tbl_course_user
                 WHERE
-                    user_id='" . $current_user_id . "' AND
-                    c_id ='" . $courseId . "' AND
+                    user_id='".$current_user_id."' AND
+                    c_id ='" . $courseId."' AND
                     status='1' ";
         $result_check = Database::query($sql);
         $number_of_rows = Database::num_rows($result_check);
@@ -548,7 +548,7 @@ 
 
         // step 1: we determine the max value of the user defined course categories
         $sql = "SELECT sort FROM $tucc 
-                WHERE user_id='" . $current_user_id . "' 
+                WHERE user_id='".$current_user_id."' 
                 ORDER BY sort DESC";
         $rs_sort = Database::query($sql);
         $maxsort = Database::fetch_array($rs_sort);
@@ -557,13 +557,13 @@ 
         // step 2: we check if there is already a category with this name, if not we store it, else we give an error.
         $sql = "SELECT * FROM $tucc 
                 WHERE 
-                    user_id='" . $current_user_id . "' AND 
-                    title='" . $category_title . "'
+                    user_id='".$current_user_id."' AND 
+                    title='" . $category_title."'
                 ORDER BY sort DESC";
         $rs = Database::query($sql);
         if (Database::num_rows($rs) == 0) {
             $sql = "INSERT INTO $tucc (user_id, title,sort)
-                    VALUES ('" . $current_user_id . "', '" . api_htmlentities($category_title, ENT_QUOTES, api_get_system_encoding()) . "', '" . $nextsort . "')";
+                    VALUES ('".$current_user_id."', '".api_htmlentities($category_title, ENT_QUOTES, api_get_system_encoding())."', '".$nextsort."')";
             $resultQuery = Database::query($sql);
             if (Database::affected_rows($resultQuery)) {
                 $result = true;
@@ -647,10 +647,10 @@ 
             if (isset($_POST['course_registration_code']) && $_POST['course_registration_code'] != $all_course_information['registration_code']) {
                 return false;
             }
-            $message = get_lang('CourseRequiresPassword') . '<br />';
+            $message = get_lang('CourseRequiresPassword').'<br />';
             $message .= $all_course_information['title'].' ('.$all_course_information['visual_code'].') ';
 
-            $action  = api_get_path(WEB_CODE_PATH) . "auth/courses.php?action=subscribe_user_with_password&sec_token=" . $_SESSION['sec_token'];
+            $action  = api_get_path(WEB_CODE_PATH)."auth/courses.php?action=subscribe_user_with_password&sec_token=".$_SESSION['sec_token'];
             $form = new FormValidator('subscribe_user_with_password', 'post', $action);
             $form->addElement('hidden', 'sec_token', $_SESSION['sec_token']);
             $form->addElement('hidden', 'subscribe_user_with_password', $all_course_information['code']);

Doc Comments +8 added lines

@@ -183,6 +183,7 @@ 
      * (moving a course to a different course category)
      * @param  int    $courseId
      * @param  int       Category id
+     * @param integer $newcategory
      * @return bool      True if it success
      */
     public function updateCourseCategory($courseId, $newcategory)
@@ -215,6 +216,9 @@ 
      * @param   string    Direction (up/down)
      * @param   string    Course code
      * @param   int       Category id
+     * @param string $direction
+     * @param string $course2move
+     * @param integer $category
      * @return  bool      True if it success
      */
     public function move_course($direction, $course2move, $category)
@@ -285,6 +289,8 @@ 
      * Moves the course one place up or down
      * @param string    Direction up/down
      * @param string    Category id
+     * @param string $direction
+     * @param integer $category2move
      * @return bool     True If it success
      */
     public function move_category($direction, $category2move)
@@ -348,6 +354,8 @@ 
      * Updates the user course category in the chamilo_user database
      * @param   string  Category title
      * @param   int     Category id
+     * @param string $title
+     * @param integer $category_id
      * @return  bool    True if it success
      */
     public function store_edit_course_category($title, $category_id)