chamilo / chamilo-lms

main/inc/lib/course_home.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -218,7 +218,7 @@ 
     /**
      * Displays the tools of a certain category.
      *
-     * @return void
+     * @return string
      * @param string $course_tool_category	contains the category of tools to display:
      * "Public", "PublicButHide", "courseAdmin", "claroAdmin"
      */
@@ -1014,6 +1014,7 @@ 
      * Shows the general data for a particular meeting
      *
      * @param id	session id
+     * @param integer $id_session
      * @return string	session data
      */
     public static function show_session_data($id_session)
@@ -1517,7 +1518,7 @@ 
 
     /**
      * Available tools
-     * @return array
+     * @return string[]
      */
     public static function availableTools()
     {

main/inc/lib/display.lib.php

Doc Comments +27 added lines, -19 removed lines

@@ -34,7 +34,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function toolList()
     {
@@ -176,8 +176,7 @@ 
 
     /**
      * @param string $tool
-     * @param array $editor_config
-     * @return null
+     * @return string|null
      */
     public static function return_introduction_section($tool, $toolList = null)
     {
@@ -465,7 +464,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
@@ -506,7 +504,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
@@ -563,10 +560,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
      */
@@ -621,7 +619,7 @@ 
      *
      * @deprecated use Display::addFlash with Display::return_message($message, 'normal');
      *
-     * @return void
+     * @return string|null
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
@@ -653,7 +651,7 @@ 
      * Displays an confirmation message. Use this if something has been done successfully
      * @param bool	Filter (true) or not (false)
      * @deprecated use Display::addFlash with Display::return_message
-     * @return void
+     * @return string|null
      */
     public static function display_confirmation_message ($message, $filter = true, $returnValue = false)
     {
@@ -672,7 +670,7 @@ 
      * @param bool	Filter (true) or not (false)
      * @deprecated use Display::addFlash with Display::return_message
      *
-     * @return void
+     * @return string|null
      */
     public static function display_error_message ($message, $filter = true, $returnValue = false)
     {
@@ -853,6 +851,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(
@@ -1024,6 +1023,7 @@ 
     /**
      * Displays an HTML input tag
      *
+     * @param string $type
      */
     public static function input($type, $name, $value, $attributes = array())
     {
@@ -1040,8 +1040,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      * @param array $attributes
      * @return string
      */
@@ -1056,6 +1056,7 @@ 
     /**
      * Displays an HTML select tag
      *
+     * @param string $blank_item_text
      */
     public static function select(
         $name,
@@ -1122,8 +1123,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
@@ -1177,7 +1178,7 @@ 
 
     /**
      * @param $headers
-     * @param null $selected
+     * @param integer $selected
      *
      * @return string
      */
@@ -1215,6 +1216,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
      *
      */
@@ -1775,6 +1777,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)
@@ -1865,6 +1869,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');
@@ -2097,6 +2104,7 @@ 
 
     /**
      * @todo use twig
+     * @param string $title
      */
     public static function group_button($title, $elements)
     {
@@ -2467,9 +2475,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)
@@ -2553,10 +2561,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

Spacing +82 added lines, -82 removed lines

@@ -60,7 +60,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)
     {
         return '';
         $origin = api_get_origin();
@@ -225,15 +225,15 @@ 
                 $thematic->setCourseIntId(api_get_course_int_id());
                 if (api_get_course_setting('display_info_advance_inside_homecourse') == '1') {
                     $information_title = get_lang('InfoAboutLastDoneAdvance');
-                    $last_done_advance =  $thematic->get_last_done_thematic_advance();
+                    $last_done_advance = $thematic->get_last_done_thematic_advance();
                     $thematic_advance_info = $thematic->get_thematic_advance_list($last_done_advance);
-                } else if(api_get_course_setting('display_info_advance_inside_homecourse') == '2') {
+                } else if (api_get_course_setting('display_info_advance_inside_homecourse') == '2') {
                     $information_title = get_lang('InfoAboutNextAdvanceNotDone');
                     $next_advance_not_done = $thematic->get_next_thematic_advance_not_done();
                     $thematic_advance_info = $thematic->get_thematic_advance_list($next_advance_not_done);
-                } else if(api_get_course_setting('display_info_advance_inside_homecourse') == '3') {
+                } else if (api_get_course_setting('display_info_advance_inside_homecourse') == '3') {
                     $information_title = get_lang('InfoAboutLastDoneAdvanceAndNextAdvanceNotDone');
-                    $last_done_advance =  $thematic->get_last_done_thematic_advance();
+                    $last_done_advance = $thematic->get_last_done_thematic_advance();
                     $next_advance_not_done = $thematic->get_next_thematic_advance_not_done();
                     $thematic_advance_info = $thematic->get_thematic_advance_list($last_done_advance);
                     $thematic_advance_info2 = $thematic->get_thematic_advance_list($next_advance_not_done);
@@ -255,7 +255,7 @@ 
                     $thematicDescription .= '<div>'.$thematic_advance_info['content'].'</div>';
                     $thematicDescription .= '<div>'.get_lang('DurationInHours').' : '.$thematic_advance_info['duration'].'</div>';
 
-                    if (!empty($thematic_advance_info2)){
+                    if (!empty($thematic_advance_info2)) {
                         $thematic_info2 = $thematic->get_thematic_list($thematic_advance_info2['thematic_id']);
                         $thematic_advance_info2['start_date'] = api_get_local_time($thematic_advance_info2['start_date']);
                         $thematic_advance_info2['start_date'] = api_format_date($thematic_advance_info2['start_date'], DATE_TIME_FORMAT_LONG);
@@ -273,17 +273,17 @@ 
             }
 
             $introduction_section .= '<div id="introduction_block" class="row"><div class="col-md-12">';
-            $introduction_section .=  $thematicDescription;
+            $introduction_section .= $thematicDescription;
 
             if (!empty($introContent)) {
-                $introduction_section .=  $introContent;
+                $introduction_section .= $introContent;
             }
-            $introduction_section .=  '</div>';
+            $introduction_section .= '</div>';
 
             if ($displayIntro) {
                 if (empty($introContent)) {
                     // Displays "Add intro" commands
-                    $introduction_section .=  '<div id="introduction_block_action" class="col-md-2 col-md-offset-10">';
+                    $introduction_section .= '<div id="introduction_block_action" class="col-md-2 col-md-offset-10">';
 
                     $em = Database::getManager();
                     $criteria = [
@@ -313,15 +313,15 @@ 
                         );
                     }
 
-                    $introduction_section .=  "<a href=\"".$url."?".api_get_cidreq()."\">";
-                    $introduction_section .=  Display::return_icon('introduction_add.gif', get_lang('AddIntro')).' ';
-                    $introduction_section .=  "</a>";
+                    $introduction_section .= "<a href=\"".$url."?".api_get_cidreq()."\">";
+                    $introduction_section .= Display::return_icon('introduction_add.gif', get_lang('AddIntro')).' ';
+                    $introduction_section .= "</a>";
 
                     $introduction_section .= "</div>";
 
                 } else {
                     // Displays "edit intro && delete intro" commands
-                    $introduction_section .=  '<div id="introduction_block_action" class="col-md-2 col-md-offset-10">';
+                    $introduction_section .= '<div id="introduction_block_action" class="col-md-2 col-md-offset-10">';
                     $url = $urlGenerator->generate(
                         'chamilo_course_ctoolintro_update',
                         array(
@@ -331,22 +331,22 @@ 
                         )
                     );
 
-                    $introduction_section .=  "<a href=\"".$url."?".api_get_cidreq()."\">";
-                    $introduction_section .=  Display::return_icon('edit.png', get_lang('Modify')).' ';
-                    $introduction_section .=  "</a>";
+                    $introduction_section .= "<a href=\"".$url."?".api_get_cidreq()."\">";
+                    $introduction_section .= Display::return_icon('edit.png', get_lang('Modify')).' ';
+                    $introduction_section .= "</a>";
 
                     $url = $urlGenerator->generate(
                         'chamilo_course_ctoolintro_delete',
                         array('iid' => $toolId, 'course' => api_get_course_id())
                     );
 
-                    $introduction_section .=  "<a onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice')))."')) return false;\" href=\"".$url."?".api_get_cidreq()."\">";
-                    $introduction_section .=  Display::return_icon('delete.png', get_lang('AddIntro')).' ';
-                    $introduction_section .=  "</a>";
-                    $introduction_section .=  "</div>";
+                    $introduction_section .= "<a onclick=\"javascript:if(!confirm('".addslashes(api_htmlentities(get_lang('ConfirmYourChoice')))."')) return false;\" href=\"".$url."?".api_get_cidreq()."\">";
+                    $introduction_section .= Display::return_icon('delete.png', get_lang('AddIntro')).' ';
+                    $introduction_section .= "</a>";
+                    $introduction_section .= "</div>";
                 }
             }
-            $introduction_section .=  '</div>';
+            $introduction_section .= '</div>';
         }
 
         return $introduction_section;
@@ -526,7 +526,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);
@@ -655,7 +655,7 @@ 
      * @deprecated use Display::addFlash with Display::return_message
      * @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) {
@@ -674,7 +674,7 @@ 
      *
      * @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) {
@@ -689,7 +689,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);
@@ -756,14 +756,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 }).';';
             }
@@ -795,7 +795,7 @@ 
         }
         // Encrypt email
         $hmail = '';
-        for ($i = 0; $i < strlen($email); $i ++) {
+        for ($i = 0; $i < strlen($email); $i++) {
             $hmail .= '&#'.ord($email {
             $i }).';';
         }
@@ -815,7 +815,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) {
@@ -836,7 +836,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) {
@@ -903,7 +903,7 @@ 
         $image = trim($image);
         $size_extra = '';
         if (isset($size)) {
-            $size_extra = $size . '/';
+            $size_extra = $size.'/';
         }
 
         $icon = 'img/icons/'.$size_extra.$image;
@@ -975,7 +975,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.'>';
@@ -1028,13 +1028,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);
     }
@@ -1067,14 +1067,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)) {
@@ -1082,14 +1082,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) {
@@ -1104,7 +1104,7 @@ 
                     }
                 }
 
-                $html .= '>' . $value . '</option>';
+                $html .= '>'.$value.'</option>';
             }
         }
         $html .= '</select>';
@@ -1132,7 +1132,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 '';
         }
 
@@ -1143,7 +1143,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);
@@ -1172,7 +1172,7 @@ 
 
         $main_div = self::tag('div', $ul.self::tag('div', $divs, ['class' => 'tab-content']), $attributes);
 
-        return $main_div ;
+        return $main_div;
     }
 
     /**
@@ -1220,8 +1220,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;
     }
 
@@ -1282,7 +1282,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;
@@ -1343,10 +1343,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';
@@ -1360,12 +1360,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({';
@@ -1380,22 +1380,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;
     }
@@ -1426,7 +1426,7 @@ 
         }
 
         if (!empty($rows)) {
-	        foreach($rows as $content) {
+	        foreach ($rows as $content) {
 	            $table->setCellContents($row, $column, $content);
                 $row++;
             }
@@ -1600,7 +1600,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)";
@@ -1643,9 +1643,9 @@ 
             $main_user_table = Database :: get_main_table(TABLE_MAIN_USER);
             $tbl_session = Database :: get_main_table(TABLE_MAIN_SESSION);
             // 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);
@@ -1657,7 +1657,7 @@ 
             $session['title'] = $session_info['name'];
             $session['id_coach'] = $session_info['id_coach'];
             $session['coach'] = '';
-            $session['dates'] =  '';
+            $session['dates'] = '';
 
             if (($session_info['access_end_date'] == '0000-00-00 00:00:00' && $session_info['access_start_date'] == '0000-00-00 00:00:00') ||
                 ($session_info['access_end_date'] == '0000-00-00 00:00:00' && $session_info['access_start_date'] == '0000-00-00 00:00:00') ||
@@ -1729,7 +1729,7 @@ 
                 $session['dates'] = $dates['access'];
 
 
-                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']
@@ -1783,9 +1783,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']);
 
@@ -1800,19 +1800,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) {
@@ -1885,8 +1885,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>';
         }
@@ -1928,7 +1928,7 @@ 
      * @param string $type
      * @return null|string
      */
-    public static function badge($count, $type ="warning")
+    public static function badge($count, $type = "warning")
     {
         $class = '';
 
@@ -2004,7 +2004,7 @@ 
         if (!empty($content)) {
             $html = '<span class="label '.$class.'">';
             $html .= $content;
-            $html .='</span>';
+            $html .= '</span>';
         }
 
         return $html;
@@ -2025,7 +2025,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 >";
@@ -2279,7 +2279,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);
@@ -2459,7 +2459,7 @@ 
         $attributes['title'] = isset($attributes['title']) ? $attributes['title'] : $text;
 
         if (!$includeText) {
-            $text = '<span class="sr-only">' . $text . '</span>';
+            $text = '<span class="sr-only">'.$text.'</span>';
         }
 
         return self::url("$icon $text", $url, $attributes);
@@ -2474,9 +2474,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">
@@ -2484,7 +2484,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">';
@@ -2600,9 +2600,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/thematic.lib.php

Doc Comments +13 added lines, -4 removed lines

@@ -34,6 +34,9 @@ 
         $this->course_int_id = api_get_course_int_id();
     }
 
+    /**
+     * @param integer $course_id
+     */
     public function setCourseIntId($course_id)
     {
         $this->course_int_id = intval($course_id);
@@ -248,6 +251,8 @@ 
     /**
      * get thematic list
      * @param	int		Thematic id (optional), get list by id
+     * @param string $course_code
+     * @param integer $session_id
      * @return	array	Thematic data
      */
     public static function get_thematic_list(
@@ -805,6 +810,7 @@ 
     /**
      * delete  thematic advance
      * @param	int		Thematic advance id
+     * @param integer $thematic_advance_id
      * @return	int		Affected rows
      */
     public function thematic_advance_destroy($thematic_advance_id)
@@ -1122,6 +1128,7 @@ 
     /**
      * update done thematic advances from thematic details interface
      * @param 	int		Thematic id
+     * @param integer $thematic_advance_id
      * @return	int		Affected rows
      */
     public function update_done_thematic_advances($thematic_advance_id)
@@ -1349,6 +1356,7 @@ 
      * Get average of advances by thematic
      * @param	int		Thematic id
      * @param	string	Course code (optional)
+     * @param string $course_code
      * @return 	float	Average of thematic advances
      */
     public function get_average_of_advances_by_thematic($thematic_id, $course_code = null)
@@ -1413,6 +1421,7 @@ 
      * @param	string	Content
      * @param	string	Date and time
      * @param	int		Duration in hours
+     * @param integer $id
      * @return void
      */
     public function set_thematic_advance_attributes(
@@ -1443,7 +1452,7 @@ 
 
     /**
      * get thematic id
-     * @return void
+     * @return integer
      */
     public function get_thematic_id()
     {
@@ -1452,7 +1461,7 @@ 
 
     /**
      * Get thematic plan titles by default
-     * @return array
+     * @return string[]
      */
     public function get_default_thematic_plan_title()
     {
@@ -1469,7 +1478,7 @@ 
 
     /**
      * Get thematic plan icons by default
-     * @return array
+     * @return string[]
      */
     public function get_default_thematic_plan_icon()
     {
@@ -1486,7 +1495,7 @@ 
 
     /**
      * Get questions by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_question()
     {

src/Chamilo/CourseBundle/Entity/CToolIntro.php

Indentation +3 added lines, -3 removed lines

@@ -43,9 +43,9 @@
         return $this->proxyCurrentLocaleTranslation($method, $arguments);
     }
 
-     /**
-     * @return string
-     */
+        /**
+         * @return string
+         */
     public function __toString()
     {
         return (string) $this->getName();