chamilo / chamilo-lms

main/inc/lib/search/search_widget.php

Doc Comments +2 added lines

@@ -273,6 +273,8 @@
 
 /**
  * Show search form
+ * @param string $action
+ * @param boolean $show_thesaurus
  */
 function display_search_form($action, $show_thesaurus, $sf_terms, $op) {
     $type = (!empty($_REQUEST['type'])? htmlentities($_REQUEST['type']): 'normal');

Braces +12 added lines, -5 removed lines

@@ -48,7 +48,9 @@ 
 
     foreach ($sf_term_array as $raw_term) {
         $term = substr($raw_term, 1);
-        if (empty($term)) continue;
+        if (empty($term)) {
+            continue;
+        }
         $html_term = htmlspecialchars($term, ENT_QUOTES, $charset);
         $selected = '';
         if (!empty($_REQUEST['sf_'.$prefix]) && is_array($_REQUEST['sf_'.$prefix]) && in_array($term,$_REQUEST['sf_'.$prefix])) {
@@ -69,7 +71,9 @@ 
     $max = count($sf_terms);
     $multiple_selects .='';
     foreach ($sf_terms as $prefix => $sf_term_array) {
-        if ($prefix == $prefilter_prefix) continue;
+        if ($prefix == $prefilter_prefix) {
+            continue;
+        }
         $multiple_select = '';
         if ($i>0) {
             //print "+" image
@@ -342,9 +346,10 @@ 
 
 	// Tool introduction
     // TODO: Settings for the online editor to be checked (insert an image for example). Probably this is a special case here.
-    if (api_get_course_id() !== -1)
-    if (!empty($groupId)) {
+    if (api_get_course_id() !== -1) {
+        if (!empty($groupId)) {
         Display::display_introduction_section(TOOL_SEARCH.$groupId);
+    }
     } else {
         Display::display_introduction_section(TOOL_SEARCH);
     }
@@ -366,7 +371,9 @@ 
                     break;
                 }
             }
-            if ($thesaurus_decided) break;
+            if ($thesaurus_decided) {
+                break;
+            }
         }
     }
 

Indentation +21 added lines, -21 removed lines

@@ -30,7 +30,7 @@ 
  * Get one term html select
  */
 function format_one_specific_field_select($prefix, $sf_term_array, $op, $extra_select_attr='size="7" class="sf-select-multiple"') {
-	global $charset;
+    global $charset;
     $multiple_select = '<select '. $extra_select_attr .' title="'. $prefix .'" id="sf-'. $prefix .'" name="sf_'. $prefix .'[]">';
 
     $all_selected = '';
@@ -119,20 +119,20 @@ 
      * could not send a form in pagination
      */
 
-	if (isset($_GET['action']) && strcmp(trim($_GET['action']),'search')===0) {
-		$action='index.php';
-	}
-	$navigator_info = api_get_navigator();
+    if (isset($_GET['action']) && strcmp(trim($_GET['action']),'search')===0) {
+        $action='index.php';
+    }
+    $navigator_info = api_get_navigator();
 
-	if ($navigator_info['name']=='Internet Explorer' &&  $navigator_info['version']=='6') {
-		$submit_button1	= '<input type="submit" id="submit" value="'. get_lang('Search') .'" />';
-		$submit_button2 = '<input class="lower-submit" type="submit" value="'. get_lang('Search') .'" />';
+    if ($navigator_info['name']=='Internet Explorer' &&  $navigator_info['version']=='6') {
+        $submit_button1	= '<input type="submit" id="submit" value="'. get_lang('Search') .'" />';
+        $submit_button2 = '<input class="lower-submit" type="submit" value="'. get_lang('Search') .'" />';
         $reset_button 	= '<input type="submit" id="tags-clean" value="'. get_lang('SearchResetKeywords') .'" />';
-	} else {
-		$submit_button1 = '<button class="search" type="submit" id="submit" value="'. get_lang("Search") .'" /> '. get_lang('Search') .'</button>';
-		$submit_button2 = '<button class="search" type="submit" value="'. get_lang('Search') .'" />'. get_lang('Search') .'</button>';
+    } else {
+        $submit_button1 = '<button class="search" type="submit" id="submit" value="'. get_lang("Search") .'" /> '. get_lang('Search') .'</button>';
+        $submit_button2 = '<button class="search" type="submit" value="'. get_lang('Search') .'" />'. get_lang('Search') .'</button>';
         $reset_button 	= '<button class="save"   type="submit" id="tags-clean" value="'. get_lang('SearchResetKeywords') .'" />'. get_lang('SearchResetKeywords') .'</button> ';
-	}
+    }
 
     $form = '<form id="chamilo_search" action="'. $action .'" method="GET">
             <input type="text" id="query" name="query" size="40" value="'.stripslashes(Security::remove_XSS($_REQUEST['query'])).'" />
@@ -197,9 +197,9 @@ 
      * SortableTableFromArray pagination is done with simple links, so now we
      * could not send a form in pagination
      */
-	if (isset($_GET['action']) && strcmp(trim($_GET['action']),'search')===0) {
-		$action='index.php';
-	}
+    if (isset($_GET['action']) && strcmp(trim($_GET['action']),'search')===0) {
+        $action='index.php';
+    }
 
     $form = '
         <form id="chamilo_search" action="'. $action .'" method="GET">
@@ -264,7 +264,7 @@ 
                         </table>
                     </div>';
         }
-       $form .= '
+        $form .= '
         </form>
         <br style="clear: both;"/>';
 
@@ -322,10 +322,10 @@ 
         foreach ($specific_fields as $specific_field) {
             $temp = array();
             if (is_array($dkterms) && count($dkterms)>0) {
-            	foreach($dkterms[1] as $obj) {
-                	$temp = array_merge($obj['sf-'.$specific_field['code']], $temp);
-            	}
-        	}
+                foreach($dkterms[1] as $obj) {
+                    $temp = array_merge($obj['sf-'.$specific_field['code']], $temp);
+                }
+            }
             $sf_terms[$specific_field['code']] = $temp;
             $url_params[] = 'sf_'.$specific_field['code'];
             unset($temp);
@@ -340,7 +340,7 @@ 
     }
     echo '<h2>'.get_lang('Search').'</h2>';
 
-	// Tool introduction
+    // Tool introduction
     // TODO: Settings for the online editor to be checked (insert an image for example). Probably this is a special case here.
     if (api_get_course_id() !== -1)
     if (!empty($groupId)) {

Spacing +68 added lines, -68 removed lines

@@ -7,7 +7,7 @@ 
 /**
  * Code
  */
-require_once dirname(__FILE__) . '/IndexableChunk.class.php';
+require_once dirname(__FILE__).'/IndexableChunk.class.php';
 require_once api_get_path(LIBRARY_PATH).'specific_fields_manager.lib.php';
 
 /**
@@ -29,13 +29,13 @@ 
 /**
  * Get one term html select
  */
-function format_one_specific_field_select($prefix, $sf_term_array, $op, $extra_select_attr='size="7" class="sf-select-multiple"') {
+function format_one_specific_field_select($prefix, $sf_term_array, $op, $extra_select_attr = 'size="7" class="sf-select-multiple"') {
 	global $charset;
-    $multiple_select = '<select '. $extra_select_attr .' title="'. $prefix .'" id="sf-'. $prefix .'" name="sf_'. $prefix .'[]">';
+    $multiple_select = '<select '.$extra_select_attr.' title="'.$prefix.'" id="sf-'.$prefix.'" name="sf_'.$prefix.'[]">';
 
     $all_selected = '';
-    if (!empty($_REQUEST['sf_'. $prefix]) ) {
-        if (in_array('__all__', $_REQUEST['sf_'. $prefix])) {
+    if (!empty($_REQUEST['sf_'.$prefix])) {
+        if (in_array('__all__', $_REQUEST['sf_'.$prefix])) {
             $all_selected = 'selected="selected"';
         }
     }
@@ -44,17 +44,17 @@ 
     } else if ($op == 'or') {
         $all_selected_name = get_lang('Any');
     }
-    $multiple_select .= '<option value="__all__" '. $all_selected .' >-- '. $all_selected_name .' --</option>';
+    $multiple_select .= '<option value="__all__" '.$all_selected.' >-- '.$all_selected_name.' --</option>';
 
     foreach ($sf_term_array as $raw_term) {
         $term = substr($raw_term, 1);
         if (empty($term)) continue;
         $html_term = htmlspecialchars($term, ENT_QUOTES, $charset);
         $selected = '';
-        if (!empty($_REQUEST['sf_'.$prefix]) && is_array($_REQUEST['sf_'.$prefix]) && in_array($term,$_REQUEST['sf_'.$prefix])) {
+        if (!empty($_REQUEST['sf_'.$prefix]) && is_array($_REQUEST['sf_'.$prefix]) && in_array($term, $_REQUEST['sf_'.$prefix])) {
             $selected = 'selected="selected"';
         }
-        $multiple_select .= '<option value="'. $html_term .'" '.$selected.'>'. $html_term .'</option>';
+        $multiple_select .= '<option value="'.$html_term.'" '.$selected.'>'.$html_term.'</option>';
     }
     $multiple_select .= '</select>';
     return $multiple_select;
@@ -63,15 +63,15 @@ 
 /**
  * Get terms html selects
  */
-function format_specific_fields_selects($sf_terms, $op, $prefilter_prefix='') {
+function format_specific_fields_selects($sf_terms, $op, $prefilter_prefix = '') {
     // Process each prefix type term
     $i = 0;
     $max = count($sf_terms);
-    $multiple_selects ='';
+    $multiple_selects = '';
     foreach ($sf_terms as $prefix => $sf_term_array) {
         if ($prefix == $prefilter_prefix) continue;
         $multiple_select = '';
-        if ($i>0) {
+        if ($i > 0) {
             //print "+" image
             $multiple_select .= '<td><img class="sf-select-splitter" src="../img/search-big-plus.gif" alt="plus-sign-decoration"/></td>';
         }
@@ -89,9 +89,9 @@ 
 
         $sf_copy = $sf_term_array;
         // get specific field name
-        $sf_value = get_specific_field_list(array( 'code' => "'$prefix'" ));
+        $sf_value = get_specific_field_list(array('code' => "'$prefix'"));
         $sf_value = array_shift($sf_value);
-        $multiple_select .= '<td><label class="sf-select-multiple-title" for="sf_'. $prefix .'[]">' . $sf_value['name'].'</label><br />';
+        $multiple_select .= '<td><label class="sf-select-multiple-title" for="sf_'.$prefix.'[]">'.$sf_value['name'].'</label><br />';
         $multiple_select .= format_one_specific_field_select($prefix, $sf_term_array, $op, 'multiple="multiple" size="7" class="sf-select-multiple"');
         $multiple_select .= '</td>';
         $multiple_selects .= $multiple_select;
@@ -107,11 +107,11 @@ 
  */
 function search_widget_normal_form($action, $show_thesaurus, $sf_terms, $op) {
     $thesaurus_icon = Display::return_icon('thesaurus.gif', get_lang('SearchAdvancedOptions'), array('id'=>'thesaurus-icon'));
-    $advanced_options = '<a id="tags-toggle" href="#">'.  get_lang('SearchAdvancedOptions') .'</a>';
-    $display_thesaurus = ($show_thesaurus==true? 'block': 'none');
-    $help = '<h3>'. get_lang('SearchKeywordsHelpTitle') .'</h3>'. get_lang('SearchKeywordsHelpComment');
-    $mode = (!empty($_REQUEST['mode'])? htmlentities($_REQUEST['mode']): 'gallery');
-    $type = (!empty($_REQUEST['type'])? htmlentities($_REQUEST['type']): 'normal');
+    $advanced_options = '<a id="tags-toggle" href="#">'.get_lang('SearchAdvancedOptions').'</a>';
+    $display_thesaurus = ($show_thesaurus == true ? 'block' : 'none');
+    $help = '<h3>'.get_lang('SearchKeywordsHelpTitle').'</h3>'.get_lang('SearchKeywordsHelpComment');
+    $mode = (!empty($_REQUEST['mode']) ? htmlentities($_REQUEST['mode']) : 'gallery');
+    $type = (!empty($_REQUEST['type']) ? htmlentities($_REQUEST['type']) : 'normal');
 
     /**
      * POST avoid long urls, but we are using GET because
@@ -119,36 +119,36 @@ 
      * could not send a form in pagination
      */
 
-	if (isset($_GET['action']) && strcmp(trim($_GET['action']),'search')===0) {
-		$action='index.php';
+	if (isset($_GET['action']) && strcmp(trim($_GET['action']), 'search') === 0) {
+		$action = 'index.php';
 	}
 	$navigator_info = api_get_navigator();
 
-	if ($navigator_info['name']=='Internet Explorer' &&  $navigator_info['version']=='6') {
-		$submit_button1	= '<input type="submit" id="submit" value="'. get_lang('Search') .'" />';
-		$submit_button2 = '<input class="lower-submit" type="submit" value="'. get_lang('Search') .'" />';
-        $reset_button 	= '<input type="submit" id="tags-clean" value="'. get_lang('SearchResetKeywords') .'" />';
+	if ($navigator_info['name'] == 'Internet Explorer' && $navigator_info['version'] == '6') {
+		$submit_button1	= '<input type="submit" id="submit" value="'.get_lang('Search').'" />';
+		$submit_button2 = '<input class="lower-submit" type="submit" value="'.get_lang('Search').'" />';
+        $reset_button = '<input type="submit" id="tags-clean" value="'.get_lang('SearchResetKeywords').'" />';
 	} else {
-		$submit_button1 = '<button class="search" type="submit" id="submit" value="'. get_lang("Search") .'" /> '. get_lang('Search') .'</button>';
-		$submit_button2 = '<button class="search" type="submit" value="'. get_lang('Search') .'" />'. get_lang('Search') .'</button>';
-        $reset_button 	= '<button class="save"   type="submit" id="tags-clean" value="'. get_lang('SearchResetKeywords') .'" />'. get_lang('SearchResetKeywords') .'</button> ';
+		$submit_button1 = '<button class="search" type="submit" id="submit" value="'.get_lang("Search").'" /> '.get_lang('Search').'</button>';
+		$submit_button2 = '<button class="search" type="submit" value="'.get_lang('Search').'" />'.get_lang('Search').'</button>';
+        $reset_button = '<button class="save"   type="submit" id="tags-clean" value="'.get_lang('SearchResetKeywords').'" />'.get_lang('SearchResetKeywords').'</button> ';
 	}
 
     $query = isset($_REQUEST['query']) ? Security::remove_XSS($_REQUEST['query']) : null;
 
-    $form = '<form id="chamilo_search" action="'. $action .'" method="GET">
-            <input type="text" id="query" name="query" size="40" value="' . $query . '" />
-            <input type="hidden" name="mode" value="'. $mode .'"/>
-            <input type="hidden" name="type" value="'. $type .'"/>
+    $form = '<form id="chamilo_search" action="'.$action.'" method="GET">
+            <input type="text" id="query" name="query" size="40" value="' . $query.'" />
+            <input type="hidden" name="mode" value="'. $mode.'"/>
+            <input type="hidden" name="type" value="'. $type.'"/>
             <input type="hidden" name="tablename_page_nr" value="1" />
           	'.$submit_button1.'
             <br /><br />';
     $list = get_specific_field_list();
 
-    if(!empty($list)) {
-        $form .= '<span class="search-links-box">'. $advanced_options .'&nbsp;</span>
-            <div id="tags" class="tags" style="display:'. $display_thesaurus .';">
-                <div class="search-help-box">'. $help .'</div>
+    if (!empty($list)) {
+        $form .= '<span class="search-links-box">'.$advanced_options.'&nbsp;</span>
+            <div id="tags" class="tags" style="display:'. $display_thesaurus.';">
+                <div class="search-help-box">'. $help.'</div>
                 <table>
                 <tr>';
         $form .= format_specific_fields_selects($sf_terms, $op);
@@ -162,9 +162,9 @@ 
         $form .= '</tr>
                     <tr>
                         <td id="operator-select">
-                            '. get_lang('SearchCombineSearchWith') .':<br />
-                            <input type="radio" class="search-operator" name="operator" value="or" '. $or_checked .'>'. api_strtoupper(get_lang('Or')) .'</input>
-                            <input type="radio" class="search-operator" name="operator" value="and" '. $and_checked .'>'. api_strtoupper(get_lang('And')) .'</input>
+                            '. get_lang('SearchCombineSearchWith').':<br />
+                            <input type="radio" class="search-operator" name="operator" value="or" '. $or_checked.'>'.api_strtoupper(get_lang('Or')).'</input>
+                            <input type="radio" class="search-operator" name="operator" value="and" '. $and_checked.'>'.api_strtoupper(get_lang('And')).'</input>
                         </td>
                         <td></td>
                         <td>
@@ -176,7 +176,7 @@ 
                     </table>
                 </div>';
     }
-    $form .='</form>
+    $form .= '</form>
     <br style="clear: both;"/>';
     return $form;
 }
@@ -186,36 +186,36 @@ 
  *
  * This type allow filter all other multiple select terms by one term in a dinamic way
  */
-function search_widget_prefilter_form($action, $show_thesaurus, $sf_terms, $op, $prefilter_prefix=NULL) {
+function search_widget_prefilter_form($action, $show_thesaurus, $sf_terms, $op, $prefilter_prefix = NULL) {
     $thesaurus_icon = Display::return_icon('thesaurus.gif', get_lang('SearchAdvancedOptions'), array('id'=>'thesaurus-icon'));
-    $advanced_options = '<a id="tags-toggle" href="#">'.  get_lang('SearchAdvancedOptions') .'</a>';
-    $display_thesaurus = ($show_thesaurus==true? 'block': 'none');
-    $help = '<h3>'. get_lang('SearchKeywordsHelpTitle') .'</h3>'. get_lang('SearchKeywordsHelpComment');
-    $mode = (!empty($_REQUEST['mode'])? htmlentities($_REQUEST['mode']): 'gallery');
-    $type = (!empty($_REQUEST['type'])? htmlentities($_REQUEST['type']): 'normal');
+    $advanced_options = '<a id="tags-toggle" href="#">'.get_lang('SearchAdvancedOptions').'</a>';
+    $display_thesaurus = ($show_thesaurus == true ? 'block' : 'none');
+    $help = '<h3>'.get_lang('SearchKeywordsHelpTitle').'</h3>'.get_lang('SearchKeywordsHelpComment');
+    $mode = (!empty($_REQUEST['mode']) ? htmlentities($_REQUEST['mode']) : 'gallery');
+    $type = (!empty($_REQUEST['type']) ? htmlentities($_REQUEST['type']) : 'normal');
 
     /**
      * POST avoid long urls, but we are using GET because
      * SortableTableFromArray pagination is done with simple links, so now we
      * could not send a form in pagination
      */
-	if (isset($_GET['action']) && strcmp(trim($_GET['action']),'search')===0) {
-		$action='index.php';
+	if (isset($_GET['action']) && strcmp(trim($_GET['action']), 'search') === 0) {
+		$action = 'index.php';
 	}
 
     $form = '
-        <form id="chamilo_search" action="'. $action .'" method="GET">
+        <form id="chamilo_search" action="'. $action.'" method="GET">
             <input type="text" id="query" name="query" size="40" />
-            <input type="hidden" name="mode" value="'. $mode .'"/>
-            <input type="hidden" name="type" value="'. $type .'"/>
+            <input type="hidden" name="mode" value="'. $mode.'"/>
+            <input type="hidden" name="type" value="'. $type.'"/>
             <input type="hidden" name="tablename_page_nr" value="1" />
-            <input type="submit" id="submit" value="'. get_lang("Search") .'" />
+            <input type="submit" id="submit" value="'. get_lang("Search").'" />
             <br /><br />';
         $list = get_specific_field_list();
-        if(!empty($list)) {
-            $form .=' <span class="search-links-box">'. $thesaurus_icon . $advanced_options .'&nbsp;</span>
-                    <div id="tags" class="tags" style="display:'. $display_thesaurus .';">
-                        <div class="search-help-box">'. $help .'</div>
+        if (!empty($list)) {
+            $form .= ' <span class="search-links-box">'.$thesaurus_icon.$advanced_options.'&nbsp;</span>
+                    <div id="tags" class="tags" style="display:'. $display_thesaurus.';">
+                        <div class="search-help-box">'. $help.'</div>
                         <table>
                         <tr>';
             if (!is_null($prefilter_prefix)) {
@@ -230,9 +230,9 @@ 
                 $sf_term_array = $temp;
 
                 // get specific field name
-                $sf_value = get_specific_field_list(array( 'code' => "'$prefilter_prefix'" ));
+                $sf_value = get_specific_field_list(array('code' => "'$prefilter_prefix'"));
                 $sf_value = array_shift($sf_value);
-                $form .= '<label class="sf-select-multiple-title" for="sf_'. $prefix .'[]">'.$icons_for_search_terms[$prefix].' '.$sf_value['name'].'</label><br />';
+                $form .= '<label class="sf-select-multiple-title" for="sf_'.$prefix.'[]">'.$icons_for_search_terms[$prefix].' '.$sf_value['name'].'</label><br />';
 
                 $form .= format_one_specific_field_select($prefilter_prefix, $sf_term_array, $op, 'id="prefilter"');
                 $form .= format_specific_fields_selects($sf_terms, $op, $prefilter_prefix);
@@ -252,15 +252,15 @@ 
                         </tr>
                         <tr>
                             <td id="operator-select">
-                                '. get_lang('SearchCombineSearchWith') .':<br />
-                                <input type="radio" class="search-operator" name="operator" value="or" '. $or_checked .'>'. api_strtoupper(get_lang('Or')) .'</input>
-                                <input type="radio" class="search-operator" name="operator" value="and" '. $and_checked .'>'. api_strtoupper(get_lang('And')) .'</input>
+                                '. get_lang('SearchCombineSearchWith').':<br />
+                                <input type="radio" class="search-operator" name="operator" value="or" '. $or_checked.'>'.api_strtoupper(get_lang('Or')).'</input>
+                                <input type="radio" class="search-operator" name="operator" value="and" '. $and_checked.'>'.api_strtoupper(get_lang('And')).'</input>
                             </td>
                             <td></td>
                             <td>
                                 <br />
-                                <input class="lower-submit" type="submit" value="'. get_lang('Search') .'" />
-                                <input type="submit" id="tags-clean" value="'. get_lang('SearchResetKeywords') .'" />
+                                <input class="lower-submit" type="submit" value="'. get_lang('Search').'" />
+                                <input type="submit" id="tags-clean" value="'. get_lang('SearchResetKeywords').'" />
                             </td>
                         </tr>
                         </table>
@@ -277,7 +277,7 @@ 
  * Show search form
  */
 function display_search_form($action, $show_thesaurus, $sf_terms, $op) {
-    $type = (!empty($_REQUEST['type'])? htmlentities($_REQUEST['type']): 'normal');
+    $type = (!empty($_REQUEST['type']) ? htmlentities($_REQUEST['type']) : 'normal');
 
     switch ($type) {
         case 'prefilter':
@@ -304,7 +304,7 @@ 
  * @param   string $action     Just in case your action is not
  * index.php
  */
-function search_widget_show($action='index.php')
+function search_widget_show($action = 'index.php')
 {
     require_once api_get_path(LIBRARY_PATH).'search/ChamiloQuery.php';
     // TODO: load images dinamically when they're avalaible from specific field ui to add
@@ -317,14 +317,14 @@ 
     if (($cid = api_get_course_id()) != -1) { // with cid
 
         // get search engine terms
-        $course_filter = chamilo_get_boolean_query(XAPIAN_PREFIX_COURSEID . $cid);
+        $course_filter = chamilo_get_boolean_query(XAPIAN_PREFIX_COURSEID.$cid);
         $dkterms = chamilo_query_simple_query('', 0, 1000, array($course_filter));
 
         //prepare specific fields names (and also get possible URL param names)
         foreach ($specific_fields as $specific_field) {
             $temp = array();
-            if (is_array($dkterms) && count($dkterms)>0) {
-            	foreach($dkterms[1] as $obj) {
+            if (is_array($dkterms) && count($dkterms) > 0) {
+            	foreach ($dkterms[1] as $obj) {
                 	$temp = array_merge($obj['sf-'.$specific_field['code']], $temp);
             	}
         	}
@@ -352,7 +352,7 @@ 
     }
 
     $op = 'or';
-    if (!empty($_REQUEST['operator']) && in_array($op,array('or','and'))) {
+    if (!empty($_REQUEST['operator']) && in_array($op, array('or', 'and'))) {
         $op = $_REQUEST['operator'];
     }
 

main/inc/lib/search/xapian/XapianIndexer.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -98,7 +98,7 @@ 
 
     /**
      * Simple getter for the db attribute
-     * @return  object  The db attribute
+     * @return  null|XapianWritableDatabase  The db attribute
      */
     function getDb()
     {
@@ -108,6 +108,7 @@ 
     /**
      * Add this chunk to the chunk array attribute
      * @param  string  Chunk of text
+     * @param IndexableChunk $chunk
      * @return  void
      */
     function addChunk($chunk)
@@ -179,7 +180,7 @@ 
      * Get document data on a xapian document
      *
      * @param XapianDocument $doc xapian document to push into the db
-     * @return mixed xapian document data or FALSE if error
+     * @return string xapian document data or FALSE if error
      */
     function get_document_data($doc)
     {
@@ -286,7 +287,7 @@ 
      * Replace a document in the actual db
      *
      * @param XapianDocument $doc xapian document to push into the db
-     * @param Xapian::docid $did xapian document id of the document to replace
+     * @param integer $did xapian document id of the document to replace
      */
     function replace_document($doc, $did)
     {

Spacing +3 added lines, -3 removed lines

@@ -6,7 +6,7 @@ 
  */
 
 require_once 'xapian.php';
-require_once dirname(__FILE__) . '/../IndexableChunk.class.php';
+require_once dirname(__FILE__).'/../IndexableChunk.class.php';
 
 /**
  * Abstract helper class
@@ -130,7 +130,7 @@ 
                     if (!empty($chunk->terms)) {
                         foreach ($chunk->terms as $term) {
                             /* FIXME: think of getting weight */
-                            $doc->add_term($term['flag'] . $term['name'], 1);
+                            $doc->add_term($term['flag'].$term['name'], 1);
                         }
                     }
 
@@ -215,7 +215,7 @@ 
         $doc->clear_terms();
         foreach ($terms as $term) {
             //add directly
-            $doc->add_term($prefix . $term, 1);
+            $doc->add_term($prefix.$term, 1);
         }
         $this->db->replace_document($did, $doc);
         $this->db->flush();

Braces +9 added lines, -6 removed lines

@@ -70,13 +70,16 @@
      */
     function connectDb($path = null, $dbMode = null, $lang = 'english')
     {
-        if ($this->db != null)
-            return $this->db;
-        if ($dbMode == null)
-            $dbMode = Xapian::DB_CREATE_OR_OPEN;
+        if ($this->db != null) {
+                    return $this->db;
+        }
+        if ($dbMode == null) {
+                    $dbMode = Xapian::DB_CREATE_OR_OPEN;
+        }
 
-        if ($path == null)
-            $path = api_get_path(SYS_UPLOAD_PATH).'plugins/xapian/searchdb/';
+        if ($path == null) {
+                    $path = api_get_path(SYS_UPLOAD_PATH).'plugins/xapian/searchdb/';
+        }
 
         try {
             $this->db = new XapianWritableDatabase($path, $dbMode);

main/inc/lib/security.lib.php

Doc Comments +4 added lines, -1 removed lines

@@ -45,6 +45,8 @@ 
      * checker path (directory)
      * @param	string	Absolute path to be checked (with trailing slash)
      * @param	string	Checker path under which the path should be (absolute path, with trailing slash, get it from api_get_path(SYS_COURSE_PATH))
+     * @param string $abs_path
+     * @param string $checker_path
      * @return	bool	True if the path is under the checker, false otherwise
      */
     public static function check_abs_path($abs_path, $checker_path)
@@ -300,6 +302,7 @@ 
      * @param string	The variable to filter for XSS, this params can be a string or an array (example : array(x,y))
      * @param int The user status,constant allowed (STUDENT, COURSEMANAGER, ANONYMOUS, COURSEMANAGERLOWSECURITY)
      * @param bool $filter_terms
+     * @param integer $user_status
      * @return	mixed	Filtered string or array
      */
     public static function remove_XSS($var, $user_status = null, $filter_terms = false)
@@ -453,7 +456,7 @@ 
      * This method provides specific protection (against XSS and other kinds of attacks) for static images (icons) used by the system.
      * Image paths are supposed to be given by programmers - people who know what they do, anyway, this method encourages
      * a safe practice for generating icon paths, without using heavy solutions based on HTMLPurifier for example.
-     * @param string $img_path          The input path of the image, it could be relative or absolute URL.
+     * @param string $image_path          The input path of the image, it could be relative or absolute URL.
      * @return string                   Returns sanitized image path or an empty string when the image path is not secure.
      * @author Ivan Tcholakov, March 2011
      */

Spacing +3 added lines, -3 removed lines

@@ -91,7 +91,7 @@ 
             $rel_path = '/'.$rel_path;
         }
         $abs_path = $current_path.$rel_path;
-        $true_path=str_replace("\\", '/', realpath($abs_path));
+        $true_path = str_replace("\\", '/', realpath($abs_path));
         $found = strpos($true_path.'/', $checker_path);
         if ($found === 0) {
             return true;
@@ -321,7 +321,7 @@ 
         }
 
         if ($user_status == COURSEMANAGERLOWSECURITY) {
-            return $var;  // No filtering.
+            return $var; // No filtering.
         }
 
         static $purifier = array();
@@ -344,7 +344,7 @@ 
             }
 
             // Shows _target attribute in anchors
-            $config->set('Attr.AllowedFrameTargets', array('_blank','_top','_self', '_parent'));
+            $config->set('Attr.AllowedFrameTargets', array('_blank', '_top', '_self', '_parent'));
 
             if ($user_status == STUDENT) {
                 global $allowed_html_student;

Indentation +11 added lines, -11 removed lines

@@ -304,9 +304,9 @@ 
      */
     public static function remove_XSS($var, $user_status = null, $filter_terms = false)
     {
-    	if ($filter_terms) {
-    		$var = self::filter_terms($var);
-    	}
+        if ($filter_terms) {
+            $var = self::filter_terms($var);
+        }
 
         if (empty($user_status)) {
             if (api_is_anonymous()) {
@@ -401,7 +401,7 @@ 
      */
     public static function filter_terms($text)
     {
-    	static $bad_terms = array();
+        static $bad_terms = array();
 
         if (empty($bad_terms)) {
             $list = api_get_setting('filter_terms');
@@ -422,14 +422,14 @@ 
             }
         }
 
-    	$replace = '***';
-    	if (!empty($bad_terms)) {
-    		// Fast way
-    		$new_text = str_ireplace($bad_terms, $replace, $text, $count);
-    		$text = $new_text;
-    	}
+        $replace = '***';
+        if (!empty($bad_terms)) {
+            // Fast way
+            $new_text = str_ireplace($bad_terms, $replace, $text, $count);
+            $text = $new_text;
+        }
         
-		return $text;
+        return $text;
     }
 
 

main/inc/lib/skill.visualizer.lib.php

Doc Comments +3 added lines

@@ -30,6 +30,9 @@
         $this->center_x = intval($offset_x + $this->canvas_x/2 - $this->block_size/2);
     }
 
+    /**
+     * @param string $class
+     */
     function prepare_skill_box($skill, $position, $class)
     {
         $block_id = $skill['id'];

Spacing +13 added lines, -13 removed lines

@@ -27,7 +27,7 @@ 
     {
         $this->skills   = $skills;
         $this->type     = $type;
-        $this->center_x = intval($offset_x + $this->canvas_x/2 - $this->block_size/2);
+        $this->center_x = intval($offset_x + $this->canvas_x / 2 - $this->block_size / 2);
     }
 
     function prepare_skill_box($skill, $position, $class)
@@ -39,9 +39,9 @@ 
             $extra_class = 'second_window';
         }
 
-        $this->html .= '<div id="block_'.$block_id.'" class = "open_block window '.$extra_class.'  '.$class.'" style = "top:' . $position['y'] . 'px; left:' . $position['x'] . 'px;">';
+        $this->html .= '<div id="block_'.$block_id.'" class = "open_block window '.$extra_class.'  '.$class.'" style = "top:'.$position['y'].'px; left:'.$position['x'].'px;">';
 
-        $content =  $skill['name'];
+        $content = $skill['name'];
         $content .= '<div class="btn-group">';
         $content .= Display::url(get_lang('Edit'), '#', array('id'=>'edit_block_'.$block_id, 'class'=>'edit_block btn'));
         $content .= Display::url('+', '#', array('id'=>'edit_block_'.$block_id, 'class'=>'edit_block btn'));
@@ -87,9 +87,9 @@ 
         }
         //default_arrow_color
 
-        $this->js .= 'var e'.$block_id.' = prepare("block_' . $block_id.'",  '.$end_point.');'."\n";
-        $this->js .= 'var e'.$skill['parent_id'].' = prepare("block_' . $skill['parent_id'].'",  '.$end_point.');'."\n";
-        $this->js .= 'jsPlumb.connect({source: e'.$block_id.', target:e'.$skill['parent_id'].'});'."\n";;
+        $this->js .= 'var e'.$block_id.' = prepare("block_'.$block_id.'",  '.$end_point.');'."\n";
+        $this->js .= 'var e'.$skill['parent_id'].' = prepare("block_'.$skill['parent_id'].'",  '.$end_point.');'."\n";
+        $this->js .= 'jsPlumb.connect({source: e'.$block_id.', target:e'.$skill['parent_id'].'});'."\n"; ;
     }
 
     /**
@@ -125,10 +125,10 @@ 
         $brothers = array();
 
         foreach ($this->skills as &$skill) {
-            if (!in_array($skill['parent_id'], array(0,1))) {
+            if (!in_array($skill['parent_id'], array(0, 1))) {
                 continue;
             }
-            $childs = isset($skill['children']) ? count($skill['children']) : 0 ;
+            $childs = isset($skill['children']) ? count($skill['children']) : 0;
 
             //$x = round($this->offsetX * sin(deg2rad($corner * $count)));
             //$y = round($this->offsetY * cos(deg2rad($corner * $count)));
@@ -144,10 +144,10 @@ 
             if ($skill['parent_id'] == 0) {
                 //$x = 130*$childs/2;
                 //$x = $this->space_between_blocks_x*$childs/2;
-                $x = $this->canvas_x/2  - $this->block_size/2;
+                $x = $this->canvas_x / 2 - $this->block_size / 2;
             } else {
                 $max = isset($this->skills[$skill['parent_id']]['children']) ? count($this->skills[$skill['parent_id']]['children']) : 0;
-                foreach($this->skills[$skill['parent_id']]['children'] as  $id => $sk) {
+                foreach ($this->skills[$skill['parent_id']]['children'] as  $id => $sk) {
                     if ($skill['id'] == $sk['id']) {
                         break;
                     }
@@ -155,17 +155,17 @@ 
                 }
                 $parent_x = isset($this->skills[$skill['parent_id']]['x']) ? $this->skills[$skill['parent_id']]['x'] : 0;
                 //$x = $my_count*$this->space_between_blocks_x + $parent_x  + $this->block_size - ($this->space_between_blocks_x*$max/2) ;
-                $x = $my_count*$this->space_between_blocks_x + $parent_x  + $this->block_size - ($this->canvas_x/2 ) ;
+                $x = $my_count * $this->space_between_blocks_x + $parent_x + $this->block_size - ($this->canvas_x / 2);
             }
 
-            $y = $skill['level']*$this->space_between_blocks_y;
+            $y = $skill['level'] * $this->space_between_blocks_y;
 
             $skill['x'] = $x;
             $skill['y'] = $y;
 
             //$skill['description']  = "{$brothers[$skill['parent_id']]} $x - $y";
             //$skill['name']  =  $skill['name']."  |  $x = $my_count * 150  +  $parent_x - (150* $max/2) - 10*$childs ";
-            $this->add_item($skill, array('x' => $this->offset_x + $x, 'y' => $this->offset_y +$y));
+            $this->add_item($skill, array('x' => $this->offset_x + $x, 'y' => $this->offset_y + $y));
         }
         return $this->get_html();
     }

main/inc/lib/social.lib.php

Doc Comments +14 added lines, -4 removed lines

@@ -63,6 +63,8 @@ 
      * @param int user id
      * @param int user friend id
      * @param string
+     * @param integer $user_id
+     * @param integer $user_friend
      * @author isaac flores paz
      */
     public static function get_relation_between_contacts($user_id, $user_friend)
@@ -94,6 +96,8 @@ 
      * @param int group id
      * @param string name to search
      * @param bool true will load firstname, lastname, and image name
+     * @param integer $user_id
+     * @param integer $id_group
      * @return array
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code, function renamed, $load_extra_info option added
      * @author isaac flores paz
@@ -170,6 +174,9 @@ 
      * @param int user friend id
      * @param string title of the message
      * @param string content of the message
+     * @param integer $user_id
+     * @param string $message_title
+     * @param string $message_content
      * @return boolean
      * @author isaac flores paz
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
@@ -241,6 +248,7 @@ 
      * Get number messages of the inbox
      * @author isaac flores paz
      * @param int user receiver id
+     * @param integer $user_receiver_id
      * @return int
      */
     public static function get_message_number_invitation_by_user_id($user_receiver_id)
@@ -283,6 +291,7 @@ 
      * Get invitation list sent by user
      * @author Julio Montoya <gugli100@gmail.com>
      * @param int user id
+     * @param integer $user_id
      * @return array()
      */
     public static function get_list_invitation_sent_by_user_id($user_id)
@@ -325,6 +334,7 @@ 
      * Denies invitation
      * @param int user sender id
      * @param int user receiver id
+     * @param integer $user_receiver_id
      * @author isaac flores paz
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
      */
@@ -360,7 +370,7 @@ 
      * @author Isaac Flores Paz <isaac.flores.paz@gmail.com>
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
      * @param void
-     * @return string message invitation
+     * @return false|null message invitation
      */
     public static function send_invitation_friend_user($userfriend_id, $subject_message = '', $content_message = '')
     {
@@ -1229,7 +1239,7 @@ 
      * @param string $messageContent of the message
      * @param int $messageId id parent
      * @param string $messageStatus status type of message
-     * @return boolean
+     * @return false|string
      * @author Yannick Warnier
      */
     public static function sendWallMessage($userId, $friendId, $messageContent, $messageId = 0, $messageStatus = '')
@@ -1318,7 +1328,7 @@ 
      * Gets all messages from someone's wall (within specific limits)
      * @param int $userId id of wall shown
      * @param string $messageStatus status wall message
-     * @param int|string $parentId id message (Post main)
+     * @param integer|null $parentId id message (Post main)
      * @param date $start Date from which we want to show the messages, in UTC time
      * @param int $limit Limit for the number of parent messages we want to show
      * @param int $offset Wall message query offset
@@ -1647,7 +1657,7 @@ 
     /**
     * Delete messages delete logic
     * @param int $id id message to delete.
-    * @return bool status query
+    * @return Statement|null status query
     */
     public static function deleteMessage($id)
     {

Indentation +6 added lines, -6 removed lines

@@ -510,7 +510,7 @@ 
         if ($course_visibility != COURSE_VISIBILITY_HIDDEN &&
             ($course_visibility != COURSE_VISIBILITY_CLOSED || $user_in_course_status == COURSEMANAGER)
         ) {
-           $result .= '<span class="title">' . $course_title . '<span>';
+            $result .= '<span class="title">' . $course_title . '<span>';
         } else {
             $result .= $course_title." "." ".get_lang('CourseClosed')."";
         }
@@ -1414,7 +1414,7 @@ 
             }
             $media .= '<div class="user-image">';
             $media .= '<a href="'.$url.'" ><img src="'. $users[$userIdLoop]['avatar'] .
-                       '" alt="'.$users[$userIdLoop]['complete_name'].'" class="avatar-thumb"></a>';
+                        '" alt="'.$users[$userIdLoop]['complete_name'].'" class="avatar-thumb"></a>';
             $media .= '</div>';
             $media .= '<div class="user-data">';
             $media .= '<div class="username">' . '<a href="'.$url.'">'.$nameComplete.'</a></div>';
@@ -1645,10 +1645,10 @@ 
         return $name;
     }
     /**
-    * Delete messages delete logic
-    * @param int $id id message to delete.
-    * @return bool status query
-    */
+     * Delete messages delete logic
+     * @param int $id id message to delete.
+     * @return bool status query
+     */
     public static function deleteMessage($id)
     {
         $id = intval($id);

Braces +6 added lines, -4 removed lines

@@ -1644,11 +1644,11 @@ 
 
             if ($size == IMAGE_WALL_SMALL) {
                 $name = IMAGE_WALL_SMALL. '_' . $array[2];
-            }else if($size == IMAGE_WALL_MEDIUM){
+            } else if($size == IMAGE_WALL_MEDIUM){
                 $name = IMAGE_WALL_MEDIUM. '_' . $array[2];
-            }else if($size == IMAGE_WALL_BIG){
+            } else if($size == IMAGE_WALL_BIG){
                 $name = IMAGE_WALL_BIG. '_' . $array[2];
-            }else {
+            } else {
                 $name = IMAGE_WALL_SMALL. '_' . $array[2];
             }
             $lessImage = str_replace($array[2], '', $path);
@@ -1772,7 +1772,9 @@ 
             $friendHtml.= '<ul class="nav nav-list">';
             $j = 1;
             for ($k=0; $k < $number_friends; $k++) {
-                if ($j > $number_of_images) break;
+                if ($j > $number_of_images) {
+                    break;
+                }
 
                 if (isset($friends[$k])) {
                     $friend = $friends[$k];

Spacing +112 added lines, -112 removed lines

@@ -112,12 +112,12 @@ 
                     friend_user_id<>'.((int) $user_id).' AND
                     user_id='.((int) $user_id);
         if (isset($id_group) && $id_group > 0) {
-            $sql.=' AND relation_type='.$id_group;
+            $sql .= ' AND relation_type='.$id_group;
         }
         if (isset($search_name)) {
             $search_name = trim($search_name);
             $search_name = str_replace(' ', '', $search_name);
-            $sql.=' AND friend_user_id IN (
+            $sql .= ' AND friend_user_id IN (
                 SELECT user_id FROM '.$tbl_my_user.'
                 WHERE
                     firstName LIKE "%'.Database::escape_string($search_name).'%" OR
@@ -374,7 +374,7 @@ 
 
         $user_info = api_get_user_info($userfriend_id);
         $succes = get_lang('MessageSentTo');
-        $succes.= ' : '.api_get_person_name($user_info['firstName'], $user_info['lastName']);
+        $succes .= ' : '.api_get_person_name($user_info['firstName'], $user_info['lastName']);
 
         if (isset($subject_message) && isset($content_message) && isset($userfriend_id)) {
             $send_message = MessageManager::send_message($userfriend_id, $subject_message, $content_message);
@@ -493,7 +493,7 @@ 
         $user_in_course_status = CourseManager :: get_user_in_course_status(api_get_user_id(), $course_code);
 
         //$valor = api_get_settings_params();
-        $course_path = api_get_path(SYS_COURSE_PATH).$course_directory;   // course path
+        $course_path = api_get_path(SYS_COURSE_PATH).$course_directory; // course path
         if (api_get_setting('course_images_in_courses_list') === 'true') {
             if (file_exists($course_path.'/course-pic85x85.png')) {
                 $image = $my_course['course_info']['course_image'];
@@ -518,7 +518,7 @@ 
         if ($course_visibility != COURSE_VISIBILITY_HIDDEN &&
             ($course_visibility != COURSE_VISIBILITY_CLOSED || $user_in_course_status == COURSEMANAGER)
         ) {
-           $result .= '<span class="title">' . $course_title . '<span>';
+           $result .= '<span class="title">'.$course_title.'<span>';
         } else {
             $result .= $course_title." "." ".get_lang('CourseClosed')."";
         }
@@ -737,57 +737,57 @@ 
             $links = '<ul class="nav nav-pills nav-stacked">';
             $active = $show == 'home' ? 'active' : null;
             $links .= '
-                <li class="home-icon ' . $active . '">
-                    <a href="' . api_get_path(WEB_CODE_PATH) . 'social/home.php">
-                        ' . $homeIcon . ' ' . get_lang('Home') . '
+                <li class="home-icon ' . $active.'">
+                    <a href="' . api_get_path(WEB_CODE_PATH).'social/home.php">
+                        ' . $homeIcon.' '.get_lang('Home').'
                     </a>
                 </li>';
             $active = $show == 'messages' ? 'active' : null;
             $links .= '
-                <li class="messages-icon ' . $active . '">
-                    <a href="' . api_get_path(WEB_CODE_PATH) . 'messages/inbox.php?f=social">
-                        ' . $messagesIcon . ' ' . get_lang('Messages') . $count_unread_message . '
+                <li class="messages-icon ' . $active.'">
+                    <a href="' . api_get_path(WEB_CODE_PATH).'messages/inbox.php?f=social">
+                        ' . $messagesIcon.' '.get_lang('Messages').$count_unread_message.'
                     </a>
                 </li>';
 
             //Invitations
             $active = $show == 'invitations' ? 'active' : null;
             $links .= '
-                <li class="invitations-icon ' . $active . '">
-                    <a href="' . api_get_path(WEB_CODE_PATH) . 'social/invitations.php">
-                        ' . $invitationsIcon . ' ' . get_lang('Invitations') . $total_invitations . '
+                <li class="invitations-icon ' . $active.'">
+                    <a href="' . api_get_path(WEB_CODE_PATH).'social/invitations.php">
+                        ' . $invitationsIcon.' '.get_lang('Invitations').$total_invitations.'
                     </a>
                 </li>';
 
             //Shared profile and groups
             $active = $show == 'shared_profile' ? 'active' : null;
             $links .= '
-                <li class="shared-profile-icon' . $active . '">
-                    <a href="' . api_get_path(WEB_CODE_PATH) . 'social/profile.php">
-                        ' . $sharedProfileIcon . ' ' . get_lang('ViewMySharedProfile') . '
+                <li class="shared-profile-icon' . $active.'">
+                    <a href="' . api_get_path(WEB_CODE_PATH).'social/profile.php">
+                        ' . $sharedProfileIcon.' '.get_lang('ViewMySharedProfile').'
                     </a>
                 </li>';
             $active = $show == 'friends' ? 'active' : null;
             $links .= '
-                <li class="friends-icon ' . $active . '">
-                    <a href="' . api_get_path(WEB_CODE_PATH) . 'social/friends.php">
-                        ' . $friendsIcon . ' ' . get_lang('Friends') . '
+                <li class="friends-icon ' . $active.'">
+                    <a href="' . api_get_path(WEB_CODE_PATH).'social/friends.php">
+                        ' . $friendsIcon.' '.get_lang('Friends').'
                     </a>
                 </li>';
             $active = $show == 'browse_groups' ? 'active' : null;
             $links .= '
-                <li class="browse-groups-icon ' . $active . '">
-                    <a href="' . api_get_path(WEB_CODE_PATH) . 'social/groups.php">
-                        ' . $groupsIcon . ' ' . get_lang('SocialGroups') . '
+                <li class="browse-groups-icon ' . $active.'">
+                    <a href="' . api_get_path(WEB_CODE_PATH).'social/groups.php">
+                        ' . $groupsIcon.' '.get_lang('SocialGroups').'
                     </a>
                 </li>';
 
             //Search users
             $active = $show == 'search' ? 'active' : null;
             $links .= '
-                <li class="search-icon ' . $active . '">
-                    <a href="' . api_get_path(WEB_CODE_PATH) . 'social/search.php">
-                        ' . $searchIcon . ' ' . get_lang('Search') . '
+                <li class="search-icon ' . $active.'">
+                    <a href="' . api_get_path(WEB_CODE_PATH).'social/search.php">
+                        ' . $searchIcon.' '.get_lang('Search').'
                     </a>
                 </li>';
 
@@ -795,9 +795,9 @@ 
             $active = $show == 'myfiles' ? 'active' : null;
 
             $myFiles = '
-                <li class="myfiles-icon ' . $active . '">
-                    <a href="' . api_get_path(WEB_CODE_PATH) . 'social/myfiles.php">
-                        ' . $filesIcon . ' ' . get_lang('MyFiles') . '
+                <li class="myfiles-icon ' . $active.'">
+                    <a href="' . api_get_path(WEB_CODE_PATH).'social/myfiles.php">
+                        ' . $filesIcon.' '.get_lang('MyFiles').'
                     </a>
                 </li>';
 
@@ -806,7 +806,7 @@ 
             }
             $links .= $myFiles;
 
-            $links .='</ul>';
+            $links .= '</ul>';
 
             $html .= Display::panelCollapse(
                     get_lang('SocialNetwork'),
@@ -827,57 +827,57 @@ 
         }
 
         if ($show == 'shared_profile') {
-            $links =  '<ul class="nav nav-pills nav-stacked">';
+            $links = '<ul class="nav nav-pills nav-stacked">';
             // My own profile
             if ($show_full_profile && $user_id == intval(api_get_user_id())) {
                 $links .= '
-                    <li class="home-icon ' . $active . '">
-                        <a href="' . api_get_path(WEB_CODE_PATH) . 'social/home.php">
-                            ' . $homeIcon . ' ' . get_lang('Home') . '
+                    <li class="home-icon ' . $active.'">
+                        <a href="' . api_get_path(WEB_CODE_PATH).'social/home.php">
+                            ' . $homeIcon.' '.get_lang('Home').'
                         </a>
                     </li>
-                    <li class="messages-icon ' . $active . '">
-                        <a href="' . api_get_path(WEB_CODE_PATH) . 'messages/inbox.php?f=social">
-                            ' . $messagesIcon . ' ' . get_lang('Messages') . $count_unread_message . '
+                    <li class="messages-icon ' . $active.'">
+                        <a href="' . api_get_path(WEB_CODE_PATH).'messages/inbox.php?f=social">
+                            ' . $messagesIcon.' '.get_lang('Messages').$count_unread_message.'
                         </a>
                     </li>';
                 $active = $show == 'invitations' ? 'active' : null;
                 $links .= '
-                    <li class="invitations-icon' . $active . '">
-                        <a href="' . api_get_path(WEB_CODE_PATH) . 'social/invitations.php">
-                            ' . $invitationsIcon . ' ' . get_lang('Invitations') . $total_invitations . '
+                    <li class="invitations-icon' . $active.'">
+                        <a href="' . api_get_path(WEB_CODE_PATH).'social/invitations.php">
+                            ' . $invitationsIcon.' '.get_lang('Invitations').$total_invitations.'
                         </a>
                     </li>';
 
                 $links .= '
                     <li class="shared-profile-icon active">
-                        <a href="' . api_get_path(WEB_CODE_PATH) . 'social/profile.php">
-                            ' . $sharedProfileIcon . ' ' . get_lang('ViewMySharedProfile') . '
+                        <a href="' . api_get_path(WEB_CODE_PATH).'social/profile.php">
+                            ' . $sharedProfileIcon.' '.get_lang('ViewMySharedProfile').'
                         </a>
                     </li>
                     <li class="friends-icon">
-                        <a href="' . api_get_path(WEB_CODE_PATH) . 'social/friends.php">
-                            ' . $friendsIcon . ' ' . get_lang('Friends') . '
+                        <a href="' . api_get_path(WEB_CODE_PATH).'social/friends.php">
+                            ' . $friendsIcon.' '.get_lang('Friends').'
                         </a>
                     </li>
                     <li class="browse-groups-icon">
-                        <a href="' . api_get_path(WEB_CODE_PATH) . 'social/groups.php">
-                            ' . $groupsIcon . ' ' . get_lang('SocialGroups') . '
+                        <a href="' . api_get_path(WEB_CODE_PATH).'social/groups.php">
+                            ' . $groupsIcon.' '.get_lang('SocialGroups').'
                         </a>
                     </li>';
                 $active = $show == 'search' ? 'active' : null;
                 $links .= '
-                    <li class="search-icon ' . $active . '">
-                        <a href="' . api_get_path(WEB_CODE_PATH) . 'social/search.php">
-                            ' . $searchIcon . ' ' . get_lang('Search') . '
+                    <li class="search-icon ' . $active.'">
+                        <a href="' . api_get_path(WEB_CODE_PATH).'social/search.php">
+                            ' . $searchIcon.' '.get_lang('Search').'
                         </a>
                     </li>';
                 $active = $show == 'myfiles' ? 'active' : null;
 
                 $myFiles = '
-                    <li class="myfiles-icon ' . $active . '">
-                     <a href="' . api_get_path(WEB_CODE_PATH) . 'social/myfiles.php">
-                            ' . $filesIcon . ' ' . get_lang('MyFiles') . '
+                    <li class="myfiles-icon ' . $active.'">
+                     <a href="' . api_get_path(WEB_CODE_PATH).'social/myfiles.php">
+                            ' . $filesIcon.' '.get_lang('MyFiles').'
                         </a>
                     </li>';
 
@@ -923,7 +923,7 @@ 
                 $links .= '<li><a href="'.api_get_path(WEB_CODE_PATH).'social/invitations.php">'.Display::return_icon('invitation.png', get_lang('YouAlreadySentAnInvitation')).'&nbsp;&nbsp;'.get_lang('YouAlreadySentAnInvitation').'</a></li>';
             } else {
                 if (!$show_full_profile) {
-                    $links .= '<li><a class="btn-to-send-invitation" href="#" data-send-to="' . $user_id . '" title="'.get_lang('SendInvitation').'">'.Display :: return_icon('invitation.png', get_lang('SocialInvitationToFriends')).'&nbsp;'.get_lang('SendInvitation').'</a></li>';
+                    $links .= '<li><a class="btn-to-send-invitation" href="#" data-send-to="'.$user_id.'" title="'.get_lang('SendInvitation').'">'.Display :: return_icon('invitation.png', get_lang('SocialInvitationToFriends')).'&nbsp;'.get_lang('SendInvitation').'</a></li>';
                 }
             }
 
@@ -1035,10 +1035,10 @@ 
         foreach ($user_list as $uid) {
             $user_info = api_get_user_info($uid, $checkIfUserOnline = true);
             $lastname = $user_info['lastname'];
-            $firstname =  $user_info['firstname'];
+            $firstname = $user_info['firstname'];
             $completeName = $firstname.', '.$lastname;
 
-            $user_rol = $user_info['status'] == 1 ? Display::return_icon('teacher.png',get_lang('Teacher'),null,ICON_SIZE_TINY) : Display::return_icon('user.png',get_lang('Student'),null,ICON_SIZE_TINY);
+            $user_rol = $user_info['status'] == 1 ? Display::return_icon('teacher.png', get_lang('Teacher'), null, ICON_SIZE_TINY) : Display::return_icon('user.png', get_lang('Student'), null, ICON_SIZE_TINY);
             $status_icon_chat = null;
             if ($user_info['user_is_online_in_chat'] == 1) {
                 $status_icon_chat = Display::return_icon('online.png', get_lang('Online'));
@@ -1049,7 +1049,7 @@ 
             $userPicture = $user_info['avatar'];
             $img = '<img class="img-responsive img-circle" title="'.$completeName.'" alt="'.$completeName.'" src="'.$userPicture.'">';
 
-            $url =  null;
+            $url = null;
             // Anonymous users can't have access to the profile
             if (!api_is_anonymous()) {
                 if (api_get_setting('allow_social_tool') == 'true') {
@@ -1215,13 +1215,13 @@ 
             case SOCIAL_CENTER_PLUGIN:
                 $social_plugins = array(1, 2);
                 if (is_array($social_plugins) && count($social_plugins) > 0) {
-                    $content.= '<div id="social-plugins">';
+                    $content .= '<div id="social-plugins">';
                     foreach ($social_plugins as $plugin) {
-                        $content.= '<div class="social-plugin-item">';
-                        $content.= $plugin;
-                        $content.= '</div>';
+                        $content .= '<div class="social-plugin-item">';
+                        $content .= $plugin;
+                        $content .= '</div>';
                     }
-                    $content.= '</div>';
+                    $content .= '</div>';
                 }
                 break;
             case SOCIAL_LEFT_PLUGIN:
@@ -1292,12 +1292,12 @@ 
         if (!in_array($extension, $allowedTypes)) {
             $flag = false;
         } else {
-            $newFileName = uniqid('') . '.' . $extension;
+            $newFileName = uniqid('').'.'.$extension;
             if (!file_exists($pathMessageAttach)) {
                 @mkdir($pathMessageAttach, api_get_permissions_for_new_directories(), true);
             }
 
-            $newPath = $pathMessageAttach . $newFileName;
+            $newPath = $pathMessageAttach.$newFileName;
             if (is_uploaded_file($fileAttach['tmp_name'])) {
                 @copy($fileAttach['tmp_name'], $newPath);
             }
@@ -1306,9 +1306,9 @@ 
             $medium = self::resize_picture($newPath, IMAGE_WALL_MEDIUM_SIZE);
 
             $big = new Image($newPath);
-            $ok = $small && $small->send_image($pathMessageAttach . IMAGE_WALL_SMALL . '_' . $newFileName) &&
-                $medium && $medium->send_image($pathMessageAttach . IMAGE_WALL_MEDIUM .'_' . $newFileName) &&
-                $big && $big->send_image($pathMessageAttach . IMAGE_WALL_BIG . '_' . $newFileName);
+            $ok = $small && $small->send_image($pathMessageAttach.IMAGE_WALL_SMALL.'_'.$newFileName) &&
+                $medium && $medium->send_image($pathMessageAttach.IMAGE_WALL_MEDIUM.'_'.$newFileName) &&
+                $big && $big->send_image($pathMessageAttach.IMAGE_WALL_BIG.'_'.$newFileName);
 
             // Insert
             $newFileName = $social.$newFileName;
@@ -1400,7 +1400,7 @@ 
             $start = '0000-00-00';
         }
 
-        $isOwnWall = (api_get_user_id() == $userId  && $userId == $friendId);
+        $isOwnWall = (api_get_user_id() == $userId && $userId == $friendId);
         $messages = self::getWallMessages($userId, MESSAGE_STATUS_WALL, $idMessage, $start, $limit, $offset);
         $formattedList = '<div class="sub-mediapost">';
         $users = array();
@@ -1415,20 +1415,20 @@ 
             }
 
             $nameComplete = api_is_western_name_order()
-                ? $users[$userIdLoop]['firstname'] .' ' . $users[$userIdLoop]['lastname']
-                : $users[$userIdLoop]['lastname'] . ' ' . $users[$userIdLoop]['firstname'];
+                ? $users[$userIdLoop]['firstname'].' '.$users[$userIdLoop]['lastname']
+                : $users[$userIdLoop]['lastname'].' '.$users[$userIdLoop]['firstname'];
             $url = api_get_path(WEB_CODE_PATH).'social/profile.php?u='.$userIdLoop;
             $media = '';
             $media .= '<div class="rep-post">';
             $media .= '<div class="col-md-2 col-xs-2 social-post-answers">';
             $media .= '<div class="user-image pull-right">';
-            $media .= '<a href="'.$url.'" ><img src="'. $users[$userIdLoop]['avatar'] .
+            $media .= '<a href="'.$url.'" ><img src="'.$users[$userIdLoop]['avatar'].
                        '" alt="'.$users[$userIdLoop]['complete_name'].'" class="avatar-thumb"></a>';
             $media .= '</div>';
             $media .= '</div>';
             $media .= '<div class="col-md-9 col-xs-9 social-post-answers">';
             $media .= '<div class="user-data">';
-            $media .= '<div class="username">' . '<a href="'.$url.'">'.$nameComplete.'</a> <span>'.Security::remove_XSS($message['content']).'</span></div>';
+            $media .= '<div class="username">'.'<a href="'.$url.'">'.$nameComplete.'</a> <span>'.Security::remove_XSS($message['content']).'</span></div>';
             $media .= '<div class="time timeago" title="'.$date.'">'.$date.'</div>';
             $media .= '<br />';
             $media .= '</div>';
@@ -1471,12 +1471,12 @@ 
      * @param   int     $offset     Wall messages offset
      * @return  array   $data       return user's starting wall messages along with message extra data
      */
-    public static function getWallMessagesPostHTML($userId, $friendId = 0, $start = null, $limit = 10, $offset= 0)
+    public static function getWallMessagesPostHTML($userId, $friendId = 0, $start = null, $limit = 10, $offset = 0)
     {
         if (empty($start)) {
             $start = '0000-00-00';
         }
-        $isOwnWall = (api_get_user_id() == $userId  && $userId == $friendId);
+        $isOwnWall = (api_get_user_id() == $userId && $userId == $friendId);
         $messages = self::getWallMessages($userId, MESSAGE_STATUS_WALL_POST, null, $start, $limit, $offset);
         $users = array();
         $data = array();
@@ -1535,7 +1535,7 @@ 
 
         $htmlReceiver = '';
         if ($authorId != $receiverId) {
-            $htmlReceiver = ' > <a href="'.$urlReceiver.'">' . $nameCompleteReceiver . '</a> ';
+            $htmlReceiver = ' > <a href="'.$urlReceiver.'">'.$nameCompleteReceiver.'</a> ';
         }
 
         $wallImage = '';
@@ -1570,7 +1570,7 @@ 
         $html .= '<div class="img-post">';
         $html .= $wallImage;
         $html .= '</div>';
-        $html .= '<p>'. Security::remove_XSS($message['content']).'</p>';
+        $html .= '<p>'.Security::remove_XSS($message['content']).'</p>';
         $html .= '</div>';
         $html .= '</div>'; // end mediaPost
 
@@ -1654,16 +1654,16 @@ 
         if (isset($array[2]) && !empty($array[2])) {
 
             if ($size == IMAGE_WALL_SMALL) {
-                $name = IMAGE_WALL_SMALL. '_' . $array[2];
-            }else if($size == IMAGE_WALL_MEDIUM){
-                $name = IMAGE_WALL_MEDIUM. '_' . $array[2];
-            }else if($size == IMAGE_WALL_BIG){
-                $name = IMAGE_WALL_BIG. '_' . $array[2];
-            }else {
-                $name = IMAGE_WALL_SMALL. '_' . $array[2];
+                $name = IMAGE_WALL_SMALL.'_'.$array[2];
+            } else if ($size == IMAGE_WALL_MEDIUM) {
+                $name = IMAGE_WALL_MEDIUM.'_'.$array[2];
+            } else if ($size == IMAGE_WALL_BIG) {
+                $name = IMAGE_WALL_BIG.'_'.$array[2];
+            } else {
+                $name = IMAGE_WALL_SMALL.'_'.$array[2];
             }
             $lessImage = str_replace($array[2], '', $path);
-            $name = $lessImage . $name;
+            $name = $lessImage.$name;
         }
 
         return $name;
@@ -1771,18 +1771,18 @@ 
         if ($number_friends != 0) {
             if ($number_friends > $number_of_images) {
                 if (api_get_user_id() == $user_id) {
-                    $friendHtml.= ' <span><a href="friends.php">'.get_lang('SeeAll').'</a></span>';
+                    $friendHtml .= ' <span><a href="friends.php">'.get_lang('SeeAll').'</a></span>';
                 } else {
-                    $friendHtml.= ' <span>'
+                    $friendHtml .= ' <span>'
                         .'<a href="'.api_get_path(WEB_CODE_PATH).'social/profile_friends_and_groups.inc.php'
                         .'?view=friends&height=390&width=610&user_id='.$user_id.'"'
                         .'class="ajax" data-title="'.get_lang('SeeAll').'" title="'.get_lang('SeeAll').'" >'.get_lang('SeeAll').'</a></span>';
                 }
             }
 
-            $friendHtml.= '<ul class="nav nav-list">';
+            $friendHtml .= '<ul class="nav nav-list">';
             $j = 1;
-            for ($k=0; $k < $number_friends; $k++) {
+            for ($k = 0; $k < $number_friends; $k++) {
                 if ($j > $number_of_images) break;
 
                 if (isset($friends[$k])) {
@@ -1796,26 +1796,26 @@ 
                         $statusIcon = Display::span('', array('class' => 'offline_user_in_text'));
                     }
 
-                    $friendHtml.= '<li>';
-                    $friendHtml.= '<div>';
+                    $friendHtml .= '<li>';
+                    $friendHtml .= '<div>';
 
                     // the height = 92 must be the same in the image_friend_network span style in default.css
                     $friends_profile = UserManager::getUserPicture($friend['friend_user_id'], USER_IMAGE_SIZE_SMALL);
-                    $friendHtml.= '<img src="'.$friends_profile.'" id="imgfriend_'.$friend['friend_user_id'].'" title="'.$name_user.'"/>';
+                    $friendHtml .= '<img src="'.$friends_profile.'" id="imgfriend_'.$friend['friend_user_id'].'" title="'.$name_user.'"/>';
                     $link_shared = (empty($link_shared)) ? '' : '&'.$link_shared;
-                    $friendHtml.= $statusIcon .'<a href="profile.php?' .'u=' . $friend['friend_user_id'] . $link_shared . '">' . $name_user .'</a>';
-                    $friendHtml.= '</div>';
-                    $friendHtml.= '</li>';
+                    $friendHtml .= $statusIcon.'<a href="profile.php?'.'u='.$friend['friend_user_id'].$link_shared.'">'.$name_user.'</a>';
+                    $friendHtml .= '</div>';
+                    $friendHtml .= '</li>';
                 }
                 $j++;
             }
-            $friendHtml.='</ul>';
+            $friendHtml .= '</ul>';
         } else {
-            $friendHtml.= '<div class="">'.get_lang('NoFriendsInYourContactList').'<br />'
-                .'<a class="btn btn-primary" href="'.api_get_path(WEB_PATH).'whoisonline.php"><em class="fa fa-search"></em> '. get_lang('TryAndFindSomeFriends').'</a></div>';
+            $friendHtml .= '<div class="">'.get_lang('NoFriendsInYourContactList').'<br />'
+                .'<a class="btn btn-primary" href="'.api_get_path(WEB_PATH).'whoisonline.php"><em class="fa fa-search"></em> '.get_lang('TryAndFindSomeFriends').'</a></div>';
         }
 
-        $friendHtml = Display::panel($friendHtml, get_lang('SocialFriend').' (' . $number_friends . ')' );
+        $friendHtml = Display::panel($friendHtml, get_lang('SocialFriend').' ('.$number_friends.')');
 
         return $friendHtml;
     }
@@ -1836,9 +1836,9 @@ 
 
         if ($number_friends != 0) {
 
-            $friendHtml.= '<div class="list-group">';
+            $friendHtml .= '<div class="list-group">';
             $j = 1;
-            for ($k=0; $k < $number_friends; $k++) {
+            for ($k = 0; $k < $number_friends; $k++) {
                 if ($j > $number_of_images) {
                     break;
                 }
@@ -1848,11 +1848,11 @@ 
                     $user_info_friend = api_get_user_info($friend['friend_user_id'], true);
 
                     if ($user_info_friend['user_is_online']) {
-                        $statusIcon = Display::return_icon('statusonline.png',get_lang('Online'));
-                        $status=1;
+                        $statusIcon = Display::return_icon('statusonline.png', get_lang('Online'));
+                        $status = 1;
                     } else {
-                        $statusIcon = Display::return_icon('statusoffline.png',get_lang('Offline'));
-                        $status=0;
+                        $statusIcon = Display::return_icon('statusoffline.png', get_lang('Offline'));
+                        $status = 0;
                     }
 
                     $friendAvatarMedium = UserManager::getUserPicture($friend['friend_user_id'], USER_IMAGE_SIZE_MEDIUM);
@@ -1861,24 +1861,24 @@ 
                     $showLinkToChat = api_is_global_chat_enabled() &&
                         $friend['friend_user_id'] != api_get_user_id();
 
-                    if ($showLinkToChat){
+                    if ($showLinkToChat) {
                         $friendHtml .= '<a onclick="javascript:chatWith(\''.$friend['friend_user_id'].'\', \''.$name_user.'\', \''.$status.'\',\''.$friendAvatarSmall.'\')" href="javascript:void(0);" class="list-group-item">';
-                        $friendHtml .=  $friend_avatar.' <span class="username">' . $name_user . '</span>';
-                        $friendHtml .= '<span class="status">' . $statusIcon . '</span>';
+                        $friendHtml .= $friend_avatar.' <span class="username">'.$name_user.'</span>';
+                        $friendHtml .= '<span class="status">'.$statusIcon.'</span>';
                     } else {
                         $link_shared = empty($link_shared) ? '' : '&'.$link_shared;
-                        $friendHtml .= '<a href="profile.php?' .'u=' . $friend['friend_user_id'] . $link_shared . '" class="list-group-item">';
-                        $friendHtml .=  $friend_avatar.' <span class="username-all">' . $name_user . '</span>';
+                        $friendHtml .= '<a href="profile.php?'.'u='.$friend['friend_user_id'].$link_shared.'" class="list-group-item">';
+                        $friendHtml .= $friend_avatar.' <span class="username-all">'.$name_user.'</span>';
                     }
 
                     $friendHtml .= '</a>';
                 }
                 $j++;
             }
-            $friendHtml.='</div>';
+            $friendHtml .= '</div>';
         } else {
-            $friendHtml.= '<div class="help">'.get_lang('NoFriendsInYourContactList').' '
-                .'<a href="'.api_get_path(WEB_PATH).'whoisonline.php"><em class="fa fa-search"></em> '. get_lang('TryAndFindSomeFriends').'</a></div>';
+            $friendHtml .= '<div class="help">'.get_lang('NoFriendsInYourContactList').' '
+                .'<a href="'.api_get_path(WEB_PATH).'whoisonline.php"><em class="fa fa-search"></em> '.get_lang('TryAndFindSomeFriends').'</a></div>';
         }
 
         return $friendHtml;
@@ -1896,7 +1896,7 @@ 
                 'post',
                 api_get_path(WEB_CODE_PATH).'social/profile.php'.$userId,
                 null,
-                array('enctype' => 'multipart/form-data') ,
+                array('enctype' => 'multipart/form-data'),
                 FormValidator::LAYOUT_HORIZONTAL
             );
 

main/inc/lib/sortable_table.class.php

Doc Comments +1 added lines

@@ -443,6 +443,7 @@
      * @param bool       hide navigation optionally
      * @param int        content per page when show navigation (optional)
      * @param bool       sort data optionally
+     * @param boolean $visibility_options
      * @return string    grid html
      */
     public function display_simple_grid($visibility_options, $hide_navigation = true, $per_page = 20, $sort_data = true, $grid_class = array())

Indentation +5 added lines, -5 removed lines

@@ -339,9 +339,9 @@ 
     }
 
     /**
-    * This function shows the content of a table in a grid.
-    * Should not be use to edit information (edit/delete rows) only.
-    **/
+     * This function shows the content of a table in a grid.
+     * Should not be use to edit information (edit/delete rows) only.
+     **/
     public function display_grid()
     {
 
@@ -790,7 +790,7 @@ 
                 //$param[$tablename.'_direction'] = $_GET[$tablename.'_direction'];
                 $my_get_direction = $_GET[$tablename.'_direction'];
                 if (!in_array($my_get_direction, array('ASC', 'DESC'))) {
-                     $param[$tablename.'_direction'] =  'ASC';
+                        $param[$tablename.'_direction'] =  'ASC';
                 } else {
                     $param[$tablename.'_direction'] = $my_get_direction;
                 }
@@ -917,7 +917,7 @@ 
         if (is_array($row)) {
             foreach ($row as & $value) {
                 if (empty($value)) {
-                     $value = '-';
+                        $value = '-';
                 }
             }
         }

Spacing +15 added lines, -15 removed lines

@@ -215,7 +215,7 @@ 
             $params['spacesBeforeSeparator'] = '';
             $params['spacesAfterSeparator'] = '';
             $query_vars = array_keys($_GET);
-            $query_vars_needed = array ($this->param_prefix.'column', $this->param_prefix.'direction', $this->param_prefix.'per_page');
+            $query_vars_needed = array($this->param_prefix.'column', $this->param_prefix.'direction', $this->param_prefix.'per_page');
             if (count($this->additional_parameters) > 0) {
                 $query_vars_needed = array_merge($query_vars_needed, array_keys($this->additional_parameters));
             }
@@ -285,7 +285,7 @@ 
 
         if (!$empty_table) {
             if (!empty($this->additional_parameters)) {
-                foreach($this->additional_parameters as $key => $value) {
+                foreach ($this->additional_parameters as $key => $value) {
                     $html .= '<input type="hidden" name ="'.Security::remove_XSS($key).'" value ="'.Security::remove_XSS($value).'" />';
                 }
             }
@@ -310,7 +310,7 @@ 
                     $html .= '<li><a data-action ="'.$action.'" href="#" onclick="javascript:action_click(this, \''.$table_id.'\');">'.$label.'</a></li>';
                 }
                 $html .= '</ul>';
-                $html .= '</div>';//btn-group
+                $html .= '</div>'; //btn-group
                 $html .= '</div>'; //toolbar
             } else {
                 $html .= $form;
@@ -334,7 +334,7 @@ 
             }
         }
 
-        return '<div class="table-responsive">' . $html . '</div>';
+        return '<div class="table-responsive">'.$html.'</div>';
     }
 
     /**
@@ -388,7 +388,7 @@ 
 
             $html .= '<div class="clear"></div>';
             if (count($this->form_actions) > 0) {
-                $script= '<script>
+                $script = '<script>
                             /*<![CDATA[*/
                             function setCheckbox(value) {
                                  d = document.form_'.$this->table_name.';
@@ -410,7 +410,7 @@ 
             }
         }
         // Getting the items of the table
-        $items = $this->get_clean_html(false);    //no sort
+        $items = $this->get_clean_html(false); //no sort
 
         // Generation of style classes must be improved. Maybe we need a a table name to create style on the fly:
         // i.e: .whoisonline_table_grid_container instead of  .grid_container
@@ -478,7 +478,7 @@ 
 
             $html .= '<div class="clear"></div>';
             if (count($this->form_actions) > 0) {
-                $script= '<script>
+                $script = '<script>
                             /*<![CDATA[*/
                             function setCheckbox(value) {
                                  d = document.form_'.$this->table_name.';
@@ -586,7 +586,7 @@ 
                     $counter = 0;
                     foreach ($row as $index => $rowInfo) {
                         if (!isset($this->columnsToHide[$index])) {
-                            $newRow[$counter] = $rowInfo ;
+                            $newRow[$counter] = $rowInfo;
                             $counter++;
                         }
                     }
@@ -601,7 +601,7 @@ 
         }
 
         if ($this->odd_even_rows_enabled == true) {
-            $this->altRowAttributes(0, array ('class' => 'row_odd'), array ('class' => 'row_even'), true);
+            $this->altRowAttributes(0, array('class' => 'row_odd'), array('class' => 'row_even'), true);
         }
 
         foreach ($this->th_attributes as $column => $attributes) {
@@ -663,11 +663,11 @@ 
         }
         $result[] = '<select name="'.$this->param_prefix.'per_page" onchange="javascript: this.form.submit();">';
         for ($nr = 10; $nr <= min(50, $total_number_of_items); $nr += 10) {
-            $result[] = '<option value="'.$nr.'" '. ($nr == $this->per_page ? 'selected="selected"' : '').'>'.$nr.'</option>';
+            $result[] = '<option value="'.$nr.'" '.($nr == $this->per_page ? 'selected="selected"' : '').'>'.$nr.'</option>';
         }
         // @todo no limits
         //if ($total_number_of_items < 500) {
-            $result[] = '<option value="'.$total_number_of_items.'" '. ($total_number_of_items == $this->per_page ? 'selected="selected"' : '').'>'.api_ucfirst(get_lang('All')).'</option>';
+            $result[] = '<option value="'.$total_number_of_items.'" '.($total_number_of_items == $this->per_page ? 'selected="selected"' : '').'>'.api_ucfirst(get_lang('All')).'</option>';
         //}
         $result[] = '</select>';
         $result[] = '<noscript>';
@@ -785,7 +785,7 @@ 
      */
     public function get_additional_url_paramstring()
     {
-        $param_string_parts = array ();
+        $param_string_parts = array();
         if (is_array($this->additional_parameters) && count($this->additional_parameters) > 0) {
             foreach ($this->additional_parameters as $key => & $value) {
                 $param_string_parts[] = urlencode($key).'='.urlencode($value);
@@ -798,7 +798,7 @@ 
                 //$param[$tablename.'_direction'] = $_GET[$tablename.'_direction'];
                 $my_get_direction = $_GET[$tablename.'_direction'];
                 if (!in_array($my_get_direction, array('ASC', 'DESC'))) {
-                     $param[$tablename.'_direction'] =  'ASC';
+                     $param[$tablename.'_direction'] = 'ASC';
                 } else {
                     $param[$tablename.'_direction'] = $my_get_direction;
                 }
@@ -812,7 +812,7 @@ 
             if (isset($_GET[$tablename.'_column'])) {
                 $param[$tablename.'_column'] = intval($_GET[$tablename.'_column']);
             }
-            $param_string_parts = array ();
+            $param_string_parts = array();
             foreach ($param as $key => & $value) {
                 $param_string_parts[] = urlencode($key).'='.urlencode($value);
             }
@@ -833,7 +833,7 @@ 
         $param[$this->param_prefix.'page_nr'] = $this->page_nr;
         $param[$this->param_prefix.'per_page'] = $this->per_page;
         $param[$this->param_prefix.'column'] = $this->column;
-        $param_string_parts = array ();
+        $param_string_parts = array();
         foreach ($param as $key => & $value) {
             $param_string_parts[] = urlencode($key).'='.urlencode($value);
         }

main/inc/lib/specific_fields_manager.lib.php

Doc Comments +3 added lines, -1 removed lines

@@ -100,7 +100,7 @@ 
 
 /**
  * @param array $conditions a list of condition (exemple : status=>STUDENT)
- * @param array $order_by a list of fields on which sort
+ * @param string[] $order_by a list of fields on which sort
  * @return array An array with all users of the platform.
  */
 function get_specific_field_values_list(
@@ -235,6 +235,7 @@ 
  * @param   string  Course code
  * @param   string  Tool ID
  * @param   int     Internal ID used in specific tool table
+ * @param string $tool_id
  */
 function delete_all_values_for_item($course_id, $tool_id, $ref_id) {
   $table_sf_values = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);
@@ -248,6 +249,7 @@ 
  * Defaults to the first letter of the name, otherwise iterate through available
  * letters
  * @param   string  Name
+ * @param string $name
  * @return  string  One-letter code, upper-case
  */
 function get_specific_field_code_from_name($name) {

Spacing +2 added lines, -2 removed lines

@@ -42,7 +42,7 @@ 
 function delete_specific_field($id)
 {
     $table_sf = Database:: get_main_table(TABLE_MAIN_SPECIFIC_FIELD);
-    $id = (int)$id;
+    $id = (int) $id;
     if (!is_numeric($id)) {
         return false;
     }
@@ -60,7 +60,7 @@ 
 function edit_specific_field($id, $name)
 {
     $table_sf = Database:: get_main_table(TABLE_MAIN_SPECIFIC_FIELD);
-    $id = (int)$id;
+    $id = (int) $id;
     if (!is_numeric($id)) {
         return false;
     }

Indentation +4 added lines, -4 removed lines

@@ -237,10 +237,10 @@
  * @param   int     Internal ID used in specific tool table
  */
 function delete_all_values_for_item($course_id, $tool_id, $ref_id) {
-  $table_sf_values = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);
-  $sql = 'DELETE FROM %s WHERE course_code = \'%s\' AND tool_id = \'%s\' AND ref_id = %s';
-  $sql = sprintf($sql, $table_sf_values, $course_id, $tool_id, $ref_id);
-  Database::query($sql);
+    $table_sf_values = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);
+    $sql = 'DELETE FROM %s WHERE course_code = \'%s\' AND tool_id = \'%s\' AND ref_id = %s';
+    $sql = sprintf($sql, $table_sf_values, $course_id, $tool_id, $ref_id);
+    Database::query($sql);
 }
 
 /**

main/inc/lib/statsUtils.lib.inc.php

Doc Comments +1 added lines

@@ -85,6 +85,7 @@
     /**
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @param sql : a sql query (as a string)
+     * @param integer $X
      * @desc Return many results of a query in a X column tab
      * in $resu[$i][0], $resu[$i][1],$resu[$i][2],...
      * this function is more 'standard' but use a little

Indentation +8 added lines, -8 removed lines

@@ -107,14 +107,14 @@
         return $resu;
     }
 
-	/**
-	 * @author Sebastien Piraux <piraux_seb@hotmail.com>
-	 * @param sql : a sql query (as a string)
-	 * @return hours_array
-	 * @desc        Return an assoc array.  Keys are the hours, values are
-	 * the number of time this hours was found.
-	 * key 'total' return the sum of all number of time hours
-	 * appear
+    /**
+     * @author Sebastien Piraux <piraux_seb@hotmail.com>
+     * @param sql : a sql query (as a string)
+     * @return hours_array
+     * @desc        Return an assoc array.  Keys are the hours, values are
+     * the number of time this hours was found.
+     * key 'total' return the sum of all number of time hours
+     * appear
      */
     public static function hoursTab($sql)
     {

Spacing +5 added lines, -5 removed lines

@@ -155,7 +155,7 @@ 
             $last_day = -1;
             while ($row = Database::fetch_row($res)) {
                 $date_array = getdate($row[0]);
-                $display_date = $date_array['mday'] . ' ' . $MonthsShort[$date_array['mon'] - 1] . ' ' . $date_array['year'];
+                $display_date = $date_array['mday'].' '.$MonthsShort[$date_array['mon'] - 1].' '.$date_array['year'];
                 if ($date_array['mday'] == $last_day) {
                     $days_array[$display_date]++;
                 } else {
@@ -221,7 +221,7 @@ 
                      
                 </td>
                 <td width='10%'>
-                    <b>" . get_lang('Hits') . "</b>
+                    <b>".get_lang('Hits')."</b>
                 </td>
                 <td width='15%'>
                     <b>%</b>
@@ -249,7 +249,7 @@ 
                     echo "<img src='".Display::returnIconPath('bar_1m.gif')."' width='1' height='12' alt='$periodPiece : $cpt hits &ndash; $pourcent %' />";
                 }
                 if ($pourcent != 100) {
-                    echo "<img src='".Display::returnIconPath('bar_1r.gif')."' width='" . ($maxSize - $barwidth) . "' height='12' alt='$periodPiece : $cpt hits &ndash; $pourcent %' />";
+                    echo "<img src='".Display::returnIconPath('bar_1r.gif')."' width='".($maxSize - $barwidth)."' height='12' alt='$periodPiece : $cpt hits &ndash; $pourcent %' />";
                 }
                 echo "<img src='".Display::returnIconPath('bar_1.gif')."' width='1' height='12' alt='$periodPiece : $cpt hits &ndash; $pourcent %' />
                     </td>
@@ -265,13 +265,13 @@ 
         }
         echo "<tr bgcolor='#E6E6E6'>
                 <td width='15%' align='center'>
-                    " . get_lang('Total') . "
+                    " . get_lang('Total')."
                 </td>
                 <td align='right' width='60%'>
                     &nbsp;
                 </td>
                 <td align='center' width='10%'>
-                    " . $period_array['total'] . "
+                    " . $period_array['total']."
                 </td>
                 <td width='15%'>
                     &nbsp;

main/inc/lib/sub_language.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -18,6 +18,7 @@ 
      * Get all files of lang folder (forum.inc.php,gradebook.inc.php,notebook.inc.php)
      * @param String The lang path folder  (/var/www/my_lms/main/lang/spanish)
      * @param bool true if we only want the "subname" trad4all instead of  trad4all.inc.php
+     * @param string $path
      *
      * @return Array All file of lang folder
      */
@@ -68,6 +69,7 @@ 
     /**
      * Get all information of language
      * @param Integer The parent id(Language father id)
+     * @param integer $parent_id
      * @return Array All information about language
      */
     public static function get_all_information_of_language($parent_id)
@@ -86,6 +88,7 @@ 
     /**
      * Get all information of chamilo file
      * @param String The chamilo path file (/var/www/chamilo/main/lang/spanish/gradebook.inc.php)
+     * @param string $system_path_file
      * @patam Bool Whether we want to remove the '$' prefix in the results or not
      * @return Array Contains all information of chamilo file
      */
@@ -345,7 +348,7 @@ 
     /**
      * Make available the language
      * @param Integer The language id
-     * @return void
+     * @return boolean
      */
     public static function make_available_language($language_id)
     {

Braces +3 added lines, -2 removed lines

@@ -29,8 +29,9 @@
                 while (($file = readdir($dh)) !== false) {
                     if ($file[0] <> '.' && substr($file, -4, strlen($file)) == '.php') {
                         if ($only_main_name) {
-                            if ($file != '' && strpos($file, '.inc.php'))
-                                $content_dir[] = substr($file, 0, strpos($file, '.inc.php'));
+                            if ($file != '' && strpos($file, '.inc.php')) {
+                                                            $content_dir[] = substr($file, 0, strpos($file, '.inc.php'));
+                            }
                         } else {
                             $content_dir[] = $file;
                         }

Spacing +32 added lines, -32 removed lines

@@ -21,7 +21,7 @@ 
     public static function getAllLanguages()
     {
         $table = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
-        $sql = 'SELECT * FROM ' . $table;
+        $sql = 'SELECT * FROM '.$table;
         $rs = Database::query($sql);
         $all_languages = [];
         while ($row = Database::fetch_array($rs, 'ASSOC')) {
@@ -70,10 +70,10 @@ 
     public static function get_all_information_of_sub_language($parent_id, $sub_language_id)
     {
         $table = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
-        $sql = 'SELECT * FROM ' . $table . '
+        $sql = 'SELECT * FROM '.$table.'
                 WHERE
                     parent_id= ' . intval($parent_id).' AND
-                    id= ' . intval($sub_language_id) . '';
+                    id= ' . intval($sub_language_id).'';
         $rs = Database::query($sql);
         $all_information = array();
         while ($row = Database::fetch_array($rs, 'ASSOC')) {
@@ -91,7 +91,7 @@ 
     public static function get_all_information_of_language($parent_id)
     {
         $table = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
-        $sql = 'SELECT * FROM ' . $table . ' WHERE id = "' . intval($parent_id) . '"';
+        $sql = 'SELECT * FROM '.$table.' WHERE id = "'.intval($parent_id).'"';
         $rs = Database::query($sql);
         $all_information = array();
         while ($row = Database::fetch_array($rs, 'ASSOC')) {
@@ -137,7 +137,7 @@ 
      */
     public static function add_file_in_language_directory($system_path_file)
     {
-        $return_value = @file_put_contents($system_path_file, '<?php' . PHP_EOL);
+        $return_value = @file_put_contents($system_path_file, '<?php'.PHP_EOL);
 
         return $return_value;
     }
@@ -152,10 +152,10 @@ 
     public static function write_data_in_file($path_file, $new_term, $new_variable)
     {
         $return_value = false;
-        $new_data = $new_variable . '=' . $new_term;
+        $new_data = $new_variable.'='.$new_term;
         $resource = @fopen($path_file, "a");
         if (file_exists($path_file) && $resource) {
-            if (fwrite($resource, $new_data . PHP_EOL) === false) {
+            if (fwrite($resource, $new_data.PHP_EOL) === false) {
                 //not allow to write
                 $return_value = false;
             } else {
@@ -177,7 +177,7 @@ 
         if (empty($sub_language_dir)) {
             return false;
         }
-        $dir = api_get_path(SYS_LANG_PATH) . $sub_language_dir;
+        $dir = api_get_path(SYS_LANG_PATH).$sub_language_dir;
         if (is_dir($dir)) {
             return true;
         } //even if the dir already exists, we reach the objective of having the directory there
@@ -201,8 +201,8 @@ 
             return false;
         }
         $table = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
-        $sql = 'SELECT dokeos_folder FROM ' . $table . '
-                WHERE parent_id = ' . $parent_id . ' and id = ' . $sub_language_id;
+        $sql = 'SELECT dokeos_folder FROM '.$table.'
+                WHERE parent_id = ' . $parent_id.' and id = '.$sub_language_id;
         $res = Database::query($sql);
         if ($res === false or Database::num_rows($res) < 1) {
             return false;
@@ -212,7 +212,7 @@ 
         if ($res === false) {
             return false;
         } //can't delete dir, so do not delete language record
-        $sql = 'DELETE FROM ' . $table . '
+        $sql = 'DELETE FROM '.$table.'
                 WHERE id= ' . intval($sub_language_id);
         $res = Database::query($sql);
 
@@ -229,7 +229,7 @@ 
         if (empty($sub_language_dir)) {
             return false;
         }
-        $dir = api_get_path(SYS_LANG_PATH) . $sub_language_dir;
+        $dir = api_get_path(SYS_LANG_PATH).$sub_language_dir;
         if (!is_dir($dir)) {
             return true;
         } //even if the dir does not exist, we reach the objective of not having the directory there
@@ -237,7 +237,7 @@ 
 
         if (count($content) > 0) {
             foreach ($content as $value_content) {
-                $path_file = $dir . '/' . $value_content;
+                $path_file = $dir.'/'.$value_content;
                 unlink($path_file);
             }
             return @rmdir($dir);
@@ -255,8 +255,8 @@ 
     {
         $table = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
         $sql = 'SELECT count(*) as count
-                FROM ' . $table . '
-                WHERE id="' . intval($language_id) . '"';
+                FROM ' . $table.'
+                WHERE id="' . intval($language_id).'"';
         $rs = Database::query($sql);
         if (Database::num_rows($rs) > 0) {
             if (Database::result($rs, 0, 'count') == 1) {
@@ -278,8 +278,8 @@ 
     {
         $table = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
         $sql = 'SELECT original_name
-                FROM ' . $table . '
-                WHERE id= ' . intval($language_id) . '';
+                FROM ' . $table.'
+                WHERE id= ' . intval($language_id).'';
         $rs = Database::query($sql);
         if (Database::num_rows($rs) > 0) {
             return Database::result($rs, 0, 'original_name');
@@ -297,8 +297,8 @@ 
     public static function check_if_language_is_sub_language($language_id)
     {
         $table = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
-        $sql = 'SELECT count(*) AS count FROM ' . $table . '
-                WHERE id = ' . intval($language_id) . ' AND NOT ISNULL(parent_id)';
+        $sql = 'SELECT count(*) AS count FROM '.$table.'
+                WHERE id = ' . intval($language_id).' AND NOT ISNULL(parent_id)';
         $rs = Database::query($sql);
 
         if (Database::num_rows($rs) > 0 && Database::result($rs, '0', 'count') == 1) {
@@ -316,7 +316,7 @@ 
     {
         $language_info = self::get_all_information_of_language($language_id);
         $table = Database :: get_main_table(TABLE_MAIN_USER);
-        $sql = 'SELECT count(*) AS count FROM ' . $table . '
+        $sql = 'SELECT count(*) AS count FROM '.$table.'
                 WHERE language ="' . Database::escape_string($language_info['english_name']).'"';
         $rs = Database::query($sql);
         if (Database::num_rows($rs) > 0 && Database::result($rs, '0', 'count') >= 1) {
@@ -334,8 +334,8 @@ 
     public static function check_if_language_is_father($language_id)
     {
         $table = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
-        $sql = 'SELECT count(*) AS count FROM ' . $table . '
-                WHERE parent_id= ' . intval($language_id) . ' AND NOT ISNULL(parent_id);';
+        $sql = 'SELECT count(*) AS count FROM '.$table.'
+                WHERE parent_id= ' . intval($language_id).' AND NOT ISNULL(parent_id);';
         $rs = Database::query($sql);
 
         if (Database::num_rows($rs) > 0 && Database::result($rs, '0', 'count') == 1) {
@@ -354,7 +354,7 @@ 
     {
         $tbl_admin_languages = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
         $sql = "UPDATE $tbl_admin_languages SET available='0'
-                WHERE id = " . intval($language_id) . "";
+                WHERE id = ".intval($language_id)."";
         $result = Database::query($sql);
 
         return $result !== false; //only return false on sql error
@@ -369,7 +369,7 @@ 
     {
         $tbl_admin_languages = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
         $sql = "UPDATE $tbl_admin_languages SET available='1'
-                WHERE id = " . intval($language_id) . "";
+                WHERE id = ".intval($language_id)."";
         $result = Database::query($sql);
 
         return $result !== false; //only return false on sql error
@@ -387,11 +387,11 @@ 
         }
         $tbl_admin_languages = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
         $tbl_settings_current = Database :: get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
-        $sql = "SELECT english_name FROM " . $tbl_admin_languages . "
-                WHERE id= " . intval($language_id) . "";
+        $sql = "SELECT english_name FROM ".$tbl_admin_languages."
+                WHERE id= " . intval($language_id)."";
         $result = Database::query($sql);
         $lang = Database::fetch_array($result);
-        $sql_update_2 = "UPDATE " . $tbl_settings_current . " SET selected_value='" . $lang['english_name'] . "'
+        $sql_update_2 = "UPDATE ".$tbl_settings_current." SET selected_value='".$lang['english_name']."'
                          WHERE variable='platformLanguage'";
         $result_2 = Database::query($sql_update_2);
         Event::addEvent(
@@ -411,7 +411,7 @@ 
     {
         $name = api_get_setting('platformLanguage');
         $tbl_admin_languages = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
-        $sql = "SELECT id FROM " . $tbl_admin_languages . " WHERE english_name ='$name'";
+        $sql = "SELECT id FROM ".$tbl_admin_languages." WHERE english_name ='$name'";
         $res = Database::query($sql);
         if (Database::num_rows($res) < 1) {
             return false;
@@ -430,10 +430,10 @@ 
     {
         $tbl_admin_languages = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
         $sql = "SELECT dokeos_folder
-                FROM " . $tbl_admin_languages . "
+                FROM " . $tbl_admin_languages."
                 WHERE id = (
-                    SELECT parent_id FROM " . $tbl_admin_languages . "
-                    WHERE dokeos_folder = '" . Database::escape_string($language_path) . "'
+                    SELECT parent_id FROM " . $tbl_admin_languages."
+                    WHERE dokeos_folder = '" . Database::escape_string($language_path)."'
                 )
                 ";
         $result = Database::query($sql);
@@ -455,7 +455,7 @@ 
         $adminLanguagesTable = Database :: get_main_table(TABLE_MAIN_LANGUAGE);
         // select language - if case several languages match, get the last (more recent) one
         $sql = "SELECT english_name
-                FROM " . $adminLanguagesTable . "
+                FROM " . $adminLanguagesTable."
                 WHERE
                     isocode ='$isocode' AND
                     available = 1