chamilo / chamilo-lms

main/inc/lib/gradebook.lib.php

Spacing +3 added lines, -3 removed lines

@@ -56,7 +56,7 @@ 
         }
 
         $c_id = $c_id ? intval($c_id) : api_get_course_int_id();
-        $table  = Database::get_course_table(TABLE_TOOL_LIST);
+        $table = Database::get_course_table(TABLE_TOOL_LIST);
         $sql = "SELECT * from $table
                 WHERE c_id = $c_id and name='$name'
                 LIMIT 1";
@@ -113,7 +113,7 @@ 
         $clean_gradebook = array();
 
         if (!empty($skill_gradebooks_source)) {
-            foreach($skill_gradebooks_source as $source) {
+            foreach ($skill_gradebooks_source as $source) {
                 $clean_gradebook[] = $source['skill_id'];
             }
         }
@@ -192,7 +192,7 @@ 
         $selected_skills = self::get_skills_by_gradebook($gradebook_id);
         $clean_selected_skills = array();
         if (!empty($selected_skills)) {
-            foreach($selected_skills as $skill) {
+            foreach ($selected_skills as $skill) {
                 $clean_selected_skills[] = $skill['id'];
             }
         }

main/inc/lib/database.lib.php

Spacing +18 added lines, -19 removed lines

@@ -115,8 +115,7 @@ 
      */
     public static function getUTCDateTimeTypeClass()
     {
-        return isset(self::$utcDateTimeClass) ? self::$utcDateTimeClass :
-        'Application\DoctrineExtensions\DBAL\Types\UTCDateTimeType';
+        return isset(self::$utcDateTimeClass) ? self::$utcDateTimeClass : 'Application\DoctrineExtensions\DBAL\Types\UTCDateTimeType';
     }
 
     /**
@@ -393,7 +392,7 @@ 
 
         if (!empty($params)) {
             $sql = 'INSERT INTO '.$table_name.' ('.implode(',', $params).')
-                    VALUES (:'.implode(', :' ,$params).')';
+                    VALUES (:'.implode(', :', $params).')';
 
             $statement = self::getManager()->getConnection()->prepare($sql);
             $result = $statement->execute($attributes);
@@ -434,7 +433,7 @@ 
             foreach ($attributes as $key => $value) {
                 $update_sql .= "$key = :$key ";
                 if ($count < count($attributes)) {
-                    $update_sql.=', ';
+                    $update_sql .= ', ';
                 }
                 $count++;
             }
@@ -481,7 +480,7 @@ 
             if ($columns == '*') {
                 $clean_columns = '*';
             } else {
-                $clean_columns = (string)$columns;
+                $clean_columns = (string) $columns;
             }
         }
 
@@ -527,9 +526,9 @@ 
                     foreach ($condition_data as $condition => $value_array) {
                         if (is_array($value_array)) {
                             $clean_values = array();
-                            foreach($value_array as $item) {
+                            foreach ($value_array as $item) {
                                 $item = Database::escape_string($item);
-                                $clean_values[]= $item;
+                                $clean_values[] = $item;
                             }
                         } else {
                             $value_array = Database::escape_string($value_array);
@@ -537,23 +536,23 @@ 
                         }
 
                         if (!empty($condition) && $clean_values != '') {
-                            $condition = str_replace('%',"'@percentage@'", $condition); //replace "%"
-                            $condition = str_replace("'?'","%s", $condition);
-                            $condition = str_replace("?","%s", $condition);
+                            $condition = str_replace('%', "'@percentage@'", $condition); //replace "%"
+                            $condition = str_replace("'?'", "%s", $condition);
+                            $condition = str_replace("?", "%s", $condition);
 
-                            $condition = str_replace("@%s@","@-@", $condition);
-                            $condition = str_replace("%s","'%s'", $condition);
-                            $condition = str_replace("@-@","@%s@", $condition);
+                            $condition = str_replace("@%s@", "@-@", $condition);
+                            $condition = str_replace("%s", "'%s'", $condition);
+                            $condition = str_replace("@-@", "@%s@", $condition);
 
                             // Treat conditions as string
                             $condition = vsprintf($condition, $clean_values);
-                            $condition = str_replace('@percentage@','%', $condition); //replace "%"
+                            $condition = str_replace('@percentage@', '%', $condition); //replace "%"
                             $where_return .= $condition;
                         }
                     }
 
                     if (!empty($where_return)) {
-                        $return_value = " WHERE $where_return" ;
+                        $return_value = " WHERE $where_return";
                     }
                     break;
                 case 'order':
@@ -565,7 +564,7 @@ 
                         $new_order_array = explode(',', $order_array);
                         $temp_value = array();
 
-                        foreach($new_order_array as $element) {
+                        foreach ($new_order_array as $element) {
                             $element = explode(' ', $element);
                             $element = array_filter($element);
                             $element = array_values($element);
@@ -576,10 +575,10 @@ 
                                 if (in_array($element[1], array('desc', 'asc'))) {
                                     $order = $element[1];
                                 }
-                                $temp_value[]= $element[0].' '.$order.' ';
+                                $temp_value[] = $element[0].' '.$order.' ';
                             } else {
                                 //by default DESC
-                                $temp_value[]= $element[0].' DESC ';
+                                $temp_value[] = $element[0].' DESC ';
                             }
                         }
                         if (!empty($temp_value)) {
@@ -594,7 +593,7 @@ 
                     if (!empty($limit_array)) {
                         if (count($limit_array) > 1) {
                             $return_value .= ' LIMIT '.intval($limit_array[0]).' , '.intval($limit_array[1]);
-                        }  else {
+                        } else {
                             $return_value .= ' LIMIT '.intval($limit_array[0]);
                         }
                     }

Braces +1 added lines, -1 removed lines

@@ -594,7 +594,7 @@
                     if (!empty($limit_array)) {
                         if (count($limit_array) > 1) {
                             $return_value .= ' LIMIT '.intval($limit_array[0]).' , '.intval($limit_array[1]);
-                        }  else {
+                        } else {
                             $return_value .= ' LIMIT '.intval($limit_array[0]);
                         }
                     }

main/inc/lib/extra_field_value.lib.php

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());

Doc Comments +3 added lines, -3 removed lines

@@ -73,7 +73,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)
@@ -530,7 +530,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)
@@ -623,7 +623,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

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

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'].'>';

Doc Comments +3 added lines, -3 removed lines

@@ -38,7 +38,7 @@ 
      * @param array $data
      * @param string $filename
      *
-     * @return mixed csv file | false if no data to export
+     * @return false|null csv file | false if no data to export
      */
     public static function arrayToCsv($data, $filename = 'export')
     {
@@ -160,7 +160,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,
@@ -286,7 +286,7 @@ 
      * @param string $name
      * @param string $format
      *
-     * @return bool
+     * @return false|null
      */
     public static function htmlToOdt($html, $name, $format = 'odt')
     {

Indentation +8 added lines, -8 removed lines

@@ -115,13 +115,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',
@@ -200,7 +200,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'];

main/inc/lib/array.lib.php

Indentation +16 added lines, -16 removed lines

@@ -108,24 +108,24 @@
  */
 function utf8_sort($array)
 {
-	$old_locale = setlocale(LC_ALL, null);
-	$code = api_get_language_isocode();
-	$locale_list = array($code.'.utf8', 'en.utf8','en_US.utf8','en_GB.utf8');
-	$try_sort = false;
+    $old_locale = setlocale(LC_ALL, null);
+    $code = api_get_language_isocode();
+    $locale_list = array($code.'.utf8', 'en.utf8','en_US.utf8','en_GB.utf8');
+    $try_sort = false;
 
-	foreach($locale_list as $locale) {
-		$my_local = setlocale(LC_COLLATE, $locale);
-		if ($my_local) {
-			$try_sort = true;
-			break;
-		}
-	}
+    foreach($locale_list as $locale) {
+        $my_local = setlocale(LC_COLLATE, $locale);
+        if ($my_local) {
+            $try_sort = true;
+            break;
+        }
+    }
 
-	if ($try_sort) {
-		uasort($array, 'strcoll');
-	}
-	setlocale(LC_COLLATE, $old_locale);
-	return $array;
+    if ($try_sort) {
+        uasort($array, 'strcoll');
+    }
+    setlocale(LC_COLLATE, $old_locale);
+    return $array;
 }
 
 /**

Spacing +3 added lines, -3 removed lines

@@ -110,10 +110,10 @@ 
 {
 	$old_locale = setlocale(LC_ALL, null);
 	$code = api_get_language_isocode();
-	$locale_list = array($code.'.utf8', 'en.utf8','en_US.utf8','en_GB.utf8');
+	$locale_list = array($code.'.utf8', 'en.utf8', 'en_US.utf8', 'en_GB.utf8');
 	$try_sort = false;
 
-	foreach($locale_list as $locale) {
+	foreach ($locale_list as $locale) {
 		$my_local = setlocale(LC_COLLATE, $locale);
 		if ($my_local) {
 			$try_sort = true;
@@ -151,7 +151,7 @@ 
     $flatten = array();
     array_walk_recursive(
         $array,
-        function ($value) use (&$flatten) {
+        function($value) use (&$flatten) {
             $flatten[] = $value;
         }
     );

main/inc/lib/notebook.lib.php

Braces +3 added lines, -3 removed lines

@@ -219,10 +219,10 @@
         // action links
         echo '<div class="actions">';
         if (!api_is_anonymous()) {
-            if (api_get_session_id() == 0)
-                echo '<a href="index.php?' . api_get_cidreq() . '&action=addnote">' .
+            if (api_get_session_id() == 0) {
+                            echo '<a href="index.php?' . api_get_cidreq() . '&action=addnote">' .
                     Display::return_icon('new_note.png', get_lang('NoteAddNew'), '', '32') . '</a>';
-            elseif (api_is_allowed_to_session_edit(false, true)) {
+            } elseif (api_is_allowed_to_session_edit(false, true)) {
                 echo '<a href="index.php?' . api_get_cidreq() . '&action=addnote">' .
                     Display::return_icon('new_note.png', get_lang('NoteAddNew'), '', '32') . '</a>';
             }

Spacing +25 added lines, -25 removed lines

@@ -29,7 +29,7 @@ 
         return "<script>
 				function confirmation (name)
 				{
-					if (confirm(\" " . get_lang("NoteConfirmDelete") . " \"+ name + \" ?\"))
+					if (confirm(\" " . get_lang("NoteConfirmDelete")." \"+ name + \" ?\"))
 						{return true;}
 					else
 						{return false;}
@@ -107,7 +107,7 @@ 
                 description 		AS note_comment,
                 session_id			AS session_id
                FROM $t_notebook
-               WHERE c_id = $course_id AND notebook_id = '" . intval($notebook_id) . "' ";
+               WHERE c_id = $course_id AND notebook_id = '".intval($notebook_id)."' ";
         $result = Database::query($sql);
         if (Database::num_rows($result) != 1) {
             return array();
@@ -181,8 +181,8 @@ 
         $sql = "DELETE FROM $t_notebook
                 WHERE
                     c_id = $course_id AND
-                    notebook_id='" . intval($notebook_id) . "' AND
-                    user_id = '" . api_get_user_id() . "'";
+                    notebook_id='".intval($notebook_id)."' AND
+                    user_id = '" . api_get_user_id()."'";
         $result = Database::query($sql);
         $affected_rows = Database::affected_rows($result);
         if ($affected_rows != 1) {
@@ -220,22 +220,22 @@ 
         echo '<div class="actions">';
         if (!api_is_anonymous()) {
             if (api_get_session_id() == 0)
-                echo '<a href="index.php?' . api_get_cidreq() . '&action=addnote">' .
-                    Display::return_icon('new_note.png', get_lang('NoteAddNew'), '', '32') . '</a>';
+                echo '<a href="index.php?'.api_get_cidreq().'&action=addnote">'.
+                    Display::return_icon('new_note.png', get_lang('NoteAddNew'), '', '32').'</a>';
             elseif (api_is_allowed_to_session_edit(false, true)) {
-                echo '<a href="index.php?' . api_get_cidreq() . '&action=addnote">' .
-                    Display::return_icon('new_note.png', get_lang('NoteAddNew'), '', '32') . '</a>';
+                echo '<a href="index.php?'.api_get_cidreq().'&action=addnote">'.
+                    Display::return_icon('new_note.png', get_lang('NoteAddNew'), '', '32').'</a>';
             }
         } else {
-            echo '<a href="javascript:void(0)">' . Display::return_icon('new_note.png', get_lang('NoteAddNew'), '', '32') . '</a>';
+            echo '<a href="javascript:void(0)">'.Display::return_icon('new_note.png', get_lang('NoteAddNew'), '', '32').'</a>';
         }
 
-        echo '<a href="index.php?' . api_get_cidreq() . '&action=changeview&view=creation_date&direction=' . $link_sort_direction . '">' .
-            Display::return_icon('notes_order_by_date_new.png', get_lang('OrderByCreationDate'), '', '32') . '</a>';
-        echo '<a href="index.php?' . api_get_cidreq() . '&action=changeview&view=update_date&direction=' . $link_sort_direction . '">' .
-            Display::return_icon('notes_order_by_date_mod.png', get_lang('OrderByModificationDate'), '', '32') . '</a>';
-        echo '<a href="index.php?' . api_get_cidreq() . '&action=changeview&view=title&direction=' . $link_sort_direction . '">' .
-            Display::return_icon('notes_order_by_title.png', get_lang('OrderByTitle'), '', '32') . '</a>';
+        echo '<a href="index.php?'.api_get_cidreq().'&action=changeview&view=creation_date&direction='.$link_sort_direction.'">'.
+            Display::return_icon('notes_order_by_date_new.png', get_lang('OrderByCreationDate'), '', '32').'</a>';
+        echo '<a href="index.php?'.api_get_cidreq().'&action=changeview&view=update_date&direction='.$link_sort_direction.'">'.
+            Display::return_icon('notes_order_by_date_mod.png', get_lang('OrderByModificationDate'), '', '32').'</a>';
+        echo '<a href="index.php?'.api_get_cidreq().'&action=changeview&view=title&direction='.$link_sort_direction.'">'.
+            Display::return_icon('notes_order_by_title.png', get_lang('OrderByTitle'), '', '32').'</a>';
         echo '</div>';
 
         if (!isset($_SESSION['notebook_view']) || !in_array($_SESSION['notebook_view'], array('creation_date', 'update_date', 'title'))) {
@@ -246,9 +246,9 @@ 
         $t_notebook = Database :: get_course_table(TABLE_NOTEBOOK);
         $order_by = "";
         if ($_SESSION['notebook_view'] == 'creation_date' || $_SESSION['notebook_view'] == 'update_date') {
-            $order_by = " ORDER BY " . $_SESSION['notebook_view'] . " $sort_direction ";
+            $order_by = " ORDER BY ".$_SESSION['notebook_view']." $sort_direction ";
         } else {
-            $order_by = " ORDER BY " . $_SESSION['notebook_view'] . " $sort_direction ";
+            $order_by = " ORDER BY ".$_SESSION['notebook_view']." $sort_direction ";
         }
 
         //condition for the session
@@ -261,7 +261,7 @@ 
         $sql = "SELECT * FROM $t_notebook
                 WHERE
                     c_id = $course_id AND
-                    user_id = '" . api_get_user_id() . "'
+                    user_id = '".api_get_user_id()."'
                     $condition_session
                     $cond_extra $order_by
                 ";
@@ -274,18 +274,18 @@ 
 
             $updateValue = '';
             if ($row['update_date'] <> $row['creation_date']) {
-                $updateValue = ', ' . get_lang('UpdateDate') . ': ' . date_to_str_ago($row['update_date']) . '&nbsp;&nbsp;<span class="dropbox_date">' . $update_date . '</span>';
+                $updateValue = ', '.get_lang('UpdateDate').': '.date_to_str_ago($row['update_date']).'&nbsp;&nbsp;<span class="dropbox_date">'.$update_date.'</span>';
             }
 
-            $actions = '<a href="' . api_get_self() . '?action=editnote&notebook_id=' . $row['notebook_id'] . '">' .
-                Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL) . '</a>';
-            $actions .= '<a href="' . api_get_self() . '?action=deletenote&notebook_id=' . $row['notebook_id'] . '" onclick="return confirmation(\'' . $row['title'] . '\');">' .
-                Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL) . '</a>';
+            $actions = '<a href="'.api_get_self().'?action=editnote&notebook_id='.$row['notebook_id'].'">'.
+                Display::return_icon('edit.png', get_lang('Edit'), '', ICON_SIZE_SMALL).'</a>';
+            $actions .= '<a href="'.api_get_self().'?action=deletenote&notebook_id='.$row['notebook_id'].'" onclick="return confirmation(\''.$row['title'].'\');">'.
+                Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).'</a>';
 
             echo Display::panel(
                 $row['description'],
-                $row['title'] . $session_img.' <div class="pull-right">'.$actions.'</div>',
-                get_lang('CreationDate') . ': ' . date_to_str_ago($row['creation_date']) . '&nbsp;&nbsp;<span class="dropbox_date">' . $creation_date . $updateValue."</span>"
+                $row['title'].$session_img.' <div class="pull-right">'.$actions.'</div>',
+                get_lang('CreationDate').': '.date_to_str_ago($row['creation_date']).'&nbsp;&nbsp;<span class="dropbox_date">'.$creation_date.$updateValue."</span>"
             );
         }
     }

main/inc/lib/display.lib.php

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>';
         }

Doc Comments +26 added lines, -17 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(
@@ -886,6 +886,7 @@ 
     /**
      * Displays an HTML input tag
      *
+     * @param string $type
      */
     public static function input($type, $name, $value, $attributes = array())
     {
@@ -902,8 +903,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      * @param array $attributes
      * @return string
      */
@@ -918,6 +919,7 @@ 
     /**
      * Displays an HTML select tag
      *
+     * @param string $blank_item_text
      */
     public static function select(
         $name,
@@ -984,8 +986,8 @@ 
                         $( "#tabs" ).tabs();
                     });
                 </script>
-     * @param   array   $headers list of the tab titles
-     * @param   array   $items
+     * @param   string[]   $headers list of the tab titles
+     * @param   string[]   $items
      * @param   string  $id id of the container of the tab in the example "tabs"
      * @param   array   $attributes for the ul
      * @param array $ul_attributes
@@ -1039,7 +1041,7 @@ 
 
     /**
      * @param $headers
-     * @param null $selected
+     * @param integer $selected
      *
      * @return string
      */
@@ -1077,6 +1079,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
      *
      */
@@ -1632,6 +1635,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)
@@ -1727,6 +1732,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');
@@ -1957,6 +1965,7 @@ 
 
     /**
      * @todo use twig
+     * @param string $title
      */
     public static function group_button($title, $elements)
     {
@@ -2174,9 +2183,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)
@@ -2258,10 +2267,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 +67 added lines, -67 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 {
@@ -528,22 +528,22 @@ 
         }
 
         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';
@@ -686,7 +686,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 = '',
@@ -722,7 +722,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 = '',
@@ -911,14 +911,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);
     }
@@ -931,10 +931,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);
     }
 
     /**
@@ -1001,7 +1001,7 @@ 
      * in the $htmlHeadXtra variable before the display_header
      * Add this script
      * @example
-             * <script>
+     * <script>
                     $(function() {
                         $( "#tabs" ).tabs();
                     });
@@ -1067,20 +1067,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'));
@@ -1292,8 +1292,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;
@@ -1301,17 +1301,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++;
             }
         }
@@ -1417,7 +1417,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'
@@ -1433,7 +1433,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.
@@ -1651,21 +1651,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>
@@ -1676,26 +1676,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[]= $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;
     }
@@ -1733,8 +1733,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);
     }

Spacing +72 added lines, -72 removed lines

@@ -56,7 +56,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;
@@ -353,7 +353,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);
@@ -478,7 +478,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) {
@@ -495,7 +495,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) {
@@ -510,7 +510,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);
@@ -577,14 +577,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 }).';';
             }
@@ -616,7 +616,7 @@ 
         }
         // Encrypt email
         $hmail = '';
-        for ($i = 0; $i < strlen($email); $i ++) {
+        for ($i = 0; $i < strlen($email); $i++) {
             $hmail .= '&#'.ord($email {
             $i }).';';
         }
@@ -649,7 +649,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) {
@@ -670,7 +670,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) {
@@ -740,8 +740,8 @@ 
         // important to use the public path (i.e. web/css/) rather than the
         // internal path (/app/Resource/public/css/) because the path used
         // in the end must be the public path
-        $alternateCssPath = api_get_path(SYS_PUBLIC_PATH) . 'css/';
-        $alternateWebCssPath = api_get_path(WEB_PUBLIC_PATH) . 'css/';
+        $alternateCssPath = api_get_path(SYS_PUBLIC_PATH).'css/';
+        $alternateWebCssPath = api_get_path(WEB_PUBLIC_PATH).'css/';
 
         $image = trim($image);
 
@@ -751,7 +751,7 @@ 
             $size = ICON_SIZE_SMALL;
         }
 
-        $size_extra = $size . '/';
+        $size_extra = $size.'/';
 
         // Checking the img/ folder
         $icon = $w_code_path.'img/'.$image;
@@ -759,7 +759,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;
@@ -781,11 +781,11 @@ 
         // ask for the SVG version directly
         $svgIcons = api_get_setting('icons_mode_svg');
         if ($svgIcons == 'true' && $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'])) {
@@ -874,7 +874,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.'>';
@@ -927,13 +927,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);
     }
@@ -966,14 +966,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)) {
@@ -981,14 +981,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) {
@@ -1003,7 +1003,7 @@ 
                     }
                 }
 
-                $html .= '>' . $value . '</option>';
+                $html .= '>'.$value.'</option>';
             }
         }
         $html .= '</select>';
@@ -1031,7 +1031,7 @@ 
      */
     public static function tabs($headers, $items, $id = 'tabs', $attributes = array(), $ul_attributes = array())
     {
-        if (empty($headers) || count($headers) == 0 ) {
+        if (empty($headers) || count($headers) == 0) {
             return '';
         }
 
@@ -1042,7 +1042,7 @@ 
             if ($i == 1) {
                 $active = ' active';
             }
-            $item = self::tag('a', $item, array('href'=>'#'.$id.'-'.$i, 'role'=> 'tab', 'data-toggle' => 'tab', 'id' => $id . $i));
+            $item = self::tag('a', $item, array('href'=>'#'.$id.'-'.$i, 'role'=> 'tab', 'data-toggle' => 'tab', 'id' => $id.$i));
             $ul_attributes['role'] = 'presentation';
             $ul_attributes['class'] = $active;
             $lis .= self::tag('li', $item, $ul_attributes);
@@ -1071,7 +1071,7 @@ 
 
         $main_div = self::tag('div', $ul.self::tag('div', $divs, ['class' => 'tab-content']), $attributes);
 
-        return $main_div ;
+        return $main_div;
     }
 
     /**
@@ -1119,8 +1119,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;
     }
 
@@ -1181,7 +1181,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;
@@ -1242,10 +1242,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';
@@ -1259,12 +1259,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({';
@@ -1279,22 +1279,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;
     }
@@ -1325,7 +1325,7 @@ 
         }
 
         if (!empty($rows)) {
-	        foreach($rows as $content) {
+	        foreach ($rows as $content) {
 	            $table->setCellContents($row, $column, $content);
                 $row++;
             }
@@ -1487,7 +1487,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)";
@@ -1531,9 +1531,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);
@@ -1545,7 +1545,7 @@ 
             $session['title'] = $session_info['name'];
             $session['id_coach'] = $session_info['id_coach'];
             $session['coach'] = '';
-            $session['dates'] =  '';
+            $session['dates'] = '';
 
             if (
                 (
@@ -1618,11 +1618,11 @@ 
                         );
                     }
 
-                    $session['dates'] = $start_buffer . " " . $stop_buffer;
+                    $session['dates'] = $start_buffer." ".$stop_buffer;
 
                 }
 
-                if ( api_get_setting('show_session_coach') === 'true' ) {
+                if (api_get_setting('show_session_coach') === 'true') {
                     $session['coach'] = api_get_person_name(
                         $session_info['firstname'],
                         $session_info['lastname']
@@ -1677,9 +1677,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']);
 
@@ -1694,19 +1694,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[]= $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) {
@@ -1784,8 +1784,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>';
         }
@@ -1827,7 +1827,7 @@ 
      * @param string $type
      * @return null|string
      */
-    public static function badge($count, $type ="warning")
+    public static function badge($count, $type = "warning")
     {
         $class = '';
 
@@ -1903,7 +1903,7 @@ 
         if (!empty($content)) {
             $html = '<span class="label '.$class.'">';
             $html .= $content;
-            $html .='</span>';
+            $html .= '</span>';
         }
 
         return $html;
@@ -1924,7 +1924,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 >";
@@ -2178,7 +2178,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);
@@ -2290,7 +2290,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;
     }
@@ -2308,7 +2308,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 '
@@ -2353,7 +2353,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);
@@ -2368,9 +2368,9 @@ 
      */
     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">
@@ -2378,7 +2378,7 @@ 
             </div>';
         } else {
             for ($i = 0; $i < $col; $i++) {
-                $html .= '<div class="col-md-' . $columns . '">';
+                $html .= '<div class="col-md-'.$columns.'">';
                 if ($col == 2 && $i == 1) {
                     if ($right === true) {
                         $html .= '<div class="pull-right">';
@@ -2494,9 +2494,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/events.lib.php

Spacing +10 added lines, -12 removed lines

@@ -78,9 +78,7 @@ 
         Database::query($sql);
 
         // Auto subscribe
-        $user_status = $userInfo['status']  == SESSIONADMIN ? 'sessionadmin' :
-            $userInfo['status'] == COURSEMANAGER ? 'teacher' :
-                $userInfo['status'] == DRH ? 'DRH' : 'student';
+        $user_status = $userInfo['status'] == SESSIONADMIN ? 'sessionadmin' : $userInfo['status'] == COURSEMANAGER ? 'teacher' : $userInfo['status'] == DRH ? 'DRH' : 'student';
         $autoSubscribe = api_get_setting($user_status.'_autosubscribe');
         if ($autoSubscribe) {
             $autoSubscribe = explode('|', $autoSubscribe);
@@ -334,7 +332,7 @@ 
         global $debug;
 
         if ($debug) error_log('Called to update_event_exercice');
-        if ($debug) error_log('duration:' . $duration);
+        if ($debug) error_log('duration:'.$duration);
 
         if ($exeid != '') {
             /*
@@ -382,7 +380,7 @@ 
         		   status = '".$status."',
         		   questions_to_check = '".$remind_list."',
         		   data_tracking = '".implode(',', $question_list)."',
-                   user_ip = '" . Database::escape_string(api_get_real_ip()) . "'
+                   user_ip = '" . Database::escape_string(api_get_real_ip())."'
         		 WHERE exe_id = '".Database::escape_string($exeid)."'";
             $res = Database::query($sql);
 
@@ -1036,15 +1034,15 @@ 
 
         if (!empty($exe_list) && is_array($exe_list) && count($exe_list) > 0) {
             $sql = "DELETE FROM $track_e_exercises
-                WHERE exe_id IN (" . implode(',', $exe_list) . ")";
+                WHERE exe_id IN (".implode(',', $exe_list).")";
             Database::query($sql);
 
             $sql = "DELETE FROM $track_attempts
-                WHERE exe_id IN (" . implode(',', $exe_list) . ")";
+                WHERE exe_id IN (".implode(',', $exe_list).")";
             Database::query($sql);
 
             $sql = "DELETE FROM $recording_table
-                WHERE exe_id IN (" . implode(',', $exe_list) . ")";
+                WHERE exe_id IN (".implode(',', $exe_list).")";
             Database::query($sql);
         }
 
@@ -1086,7 +1084,7 @@ 
             Event::addEvent(
                 LOG_EXERCISE_RESULT_DELETE,
                 LOG_EXERCISE_AND_USER_ID,
-                $exercise_id . '-' . $user_id,
+                $exercise_id.'-'.$user_id,
                 null,
                 null,
                 $course_id,
@@ -1458,7 +1456,7 @@ 
         $res = Database::query($sql);
         $list = array();
         while ($row = Database::fetch_array($res, 'ASSOC')) {
-            $list[$row['exe_id']] = $row;  /*
+            $list[$row['exe_id']] = $row; /*
               $sql = "SELECT * FROM $table_track_attempt WHERE exe_id = {$row['exe_id']}";
               $res_question = Database::query($sql);
               while($row_q = Database::fetch_array($res_question,'ASSOC')) {
@@ -1684,7 +1682,7 @@ 
         Event::addEvent(
             LOG_QUESTION_RESULT_DELETE,
             LOG_EXERCISE_ATTEMPT_QUESTION_ID,
-            $exe_id . '-' . $question_id,
+            $exe_id.'-'.$question_id,
             null,
             null,
             $courseId,
@@ -1720,7 +1718,7 @@ 
         Event::addEvent(
             LOG_QUESTION_RESULT_DELETE,
             LOG_EXERCISE_ATTEMPT_QUESTION_ID,
-            $exe_id . '-' . $question_id,
+            $exe_id.'-'.$question_id,
             null,
             null,
             $courseId,

Braces +12 added lines, -4 removed lines

@@ -333,8 +333,12 @@ 
     ) {
         global $debug;
 
-        if ($debug) error_log('Called to update_event_exercice');
-        if ($debug) error_log('duration:' . $duration);
+        if ($debug) {
+            error_log('Called to update_event_exercice');
+        }
+        if ($debug) {
+            error_log('duration:' . $duration);
+        }
 
         if ($exeid != '') {
             /*
@@ -386,8 +390,12 @@ 
         		 WHERE exe_id = '".Database::escape_string($exeid)."'";
             $res = Database::query($sql);
 
-            if ($debug) error_log('update_event_exercice called');
-            if ($debug) error_log("$sql");
+            if ($debug) {
+                error_log('update_event_exercice called');
+            }
+            if ($debug) {
+                error_log("$sql");
+            }
 
             //Deleting control time session track
             //ExerciseLib::exercise_time_control_delete($exo_id);

Doc Comments +20 added lines, -10 removed lines

@@ -239,7 +239,7 @@ 
     }
 
     /**
-     * @param doc_id id of document (id in mainDb.document table)
+     * @param doc_id string of document (id in mainDb.document table)
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @desc Record information for upload event
      * used in the works tool to record informations when
@@ -313,6 +313,9 @@ 
      * @param   int     session_id
      * @param   int     learnpath_id (id of the learnpath)
      * @param   int     learnpath_item_id (id of the learnpath_item)
+     * @param integer $score
+     * @param integer $weighting
+     * @param integer $session_id
      *
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @author Julio Montoya Armas <gugli100@gmail.com> Reworked 2010
@@ -414,7 +417,9 @@ 
      * @param	integer	Session ID (from the session table). Default value of null means "get from context".
      * @param	integer	Learnpath ID (from c_lp table). Default value of null means "get from context".
      * @param	integer	Learnpath item ID (from the c_lp_item table). Default value of null means "get from context".
-     * @return	boolean	Result of the insert query
+     * @param integer $exe_id
+     * @param integer $position
+     * @return	false|string	Result of the insert query
      */
     public static function saveQuestionAttempt(
         $score,
@@ -581,6 +586,7 @@ 
      * @param	int		Whether this answer is correct (1) or not (0)
      * @param	string	Coordinates of this point (e.g. 123;324)
      * @param	bool update results?
+     * @param integer $exe_id
      * @return	boolean	Result of the insert query
      * @uses Course code and user_id from global scope $_cid and $_user
      */
@@ -720,7 +726,6 @@ 
     /**
      * Get every email stored in the database
      *
-     * @param int $etId
      * @return type
      * @assert () !== false
      */
@@ -788,11 +793,11 @@ 
     /**
      * Save the new message for one event and for one language
      *
-     * @param string $eventName
+     * @param string $event_name
      * @param array $users
      * @param string $message
      * @param string $subject
-     * @param string $eventMessageLanguage
+     * @param string $event_message_language
      * @param int $activated
      */
     public static function save_event_type_message($event_name, $users, $message, $subject, $event_message_language, $activated)
@@ -926,10 +931,10 @@ 
     }
 
     /**
-     * @param $user_id
+     * @param integer $user_id
      * @param $exerciseId
-     * @param $lp_id
-     * @param $lp_item_id
+     * @param integer $lp_id
+     * @param integer $lp_item_id
      * @return int
      */
     public static function get_attempt_count_not_finished($user_id, $exerciseId, $lp_id, $lp_item_id)
@@ -1106,6 +1111,7 @@ 
      * @param   int     exercise id
      * @param   int $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1201,6 +1207,7 @@ 
      * @param   int     exercise id
      * @param   int  $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1241,6 +1248,7 @@ 
      * @param   int     exercise id
      * @param   string  course code
      * @param   int     session id
+     * @param integer $exe_id
      * @return  array   with the results
      *
      */
@@ -1290,6 +1298,8 @@ 
      * @param   int     lp id
      * @param   int     lp item id
      * @param   string 	order asc or desc
+     * @param integer $courseId
+     * @param string $order
      * @return  array   with the results
      *
      */
@@ -1349,7 +1359,7 @@ 
      * @param   int     exercise id
      * @param   int     $courseId
      * @param   int     session id
-     * @return  array   with the results
+     * @return  string   with the results
      *
      */
     public static function count_exercise_attempts_by_user($user_id, $exercise_id, $courseId, $session_id = 0)
@@ -1525,7 +1535,7 @@ 
      * @param   int     exercise id
      * @param   int   course id
      * @param   int     session id
-     * @return  array   with the results
+     * @return  integer   with the results
      *
      */
     public static function get_count_exercises_attempted_by_course($courseId, $session_id = 0)

main/inc/lib/course_description.lib.php

Spacing +5 added lines, -5 removed lines

@@ -176,7 +176,7 @@ 
 
         $sql = "SELECT MAX(description_type) as MAX
                 FROM $tbl_course_description
-		        WHERE c_id = $course_id AND session_id='" . $this->session_id . "'";
+		        WHERE c_id = $course_id AND session_id='".$this->session_id."'";
         $rs = Database::query($sql);
         $max = Database::fetch_array($rs);
         $description_type = $max['MAX'] + 1;
@@ -211,7 +211,7 @@ 
             'session_id' => $this->session_id
         ];
 
-        $last_id  = Database::insert($table, $params);
+        $last_id = Database::insert($table, $params);
 
         if ($last_id > 0) {
             $sql = "UPDATE $table SET id = iid WHERE iid = $last_id";
@@ -319,8 +319,8 @@ 
         $sql = "DELETE FROM $tbl_course_description
 			 	WHERE
 			 	    c_id = $course_id AND
-			 	    id = '" . intval($this->id) . "' AND
-			 	    session_id = '" . intval($this->session_id) . "'";
+			 	    id = '".intval($this->id)."' AND
+			 	    session_id = '" . intval($this->session_id)."'";
         $result = Database::query($sql);
         $affected_rows = Database::affected_rows($result);
         if ($this->id > 0) {
@@ -349,7 +349,7 @@ 
         $course_id = api_get_course_int_id();
 
         $sql = "SELECT id FROM $tbl_course_description
-		        WHERE c_id = $course_id AND description_type = '" . intval($description_type) . "'";
+		        WHERE c_id = $course_id AND description_type = '".intval($description_type)."'";
         $rs = Database::query($sql);
         $row = Database::fetch_array($rs);
         $description_id = $row['id'];

Doc Comments +6 added lines, -6 removed lines

@@ -359,7 +359,7 @@ 
 
     /**
      * Get description titles by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_title()
     {
@@ -378,7 +378,7 @@ 
 
     /**
      * Get description titles editable by default
-     * @return array
+     * @return boolean[]
      */
     public function get_default_description_title_editable()
     {
@@ -397,7 +397,7 @@ 
 
     /**
      * Get description icons by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_icon()
     {
@@ -417,7 +417,7 @@ 
 
     /**
      * Get questions by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_question()
     {
@@ -436,7 +436,7 @@ 
 
     /**
      * Get informations by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_information()
     {
@@ -574,7 +574,7 @@ 
     /**
      * get progress of a description
      *
-     * @return int
+     * @return string
      */
     public function get_progress()
     {