chamilo / chamilo-lms

main/inc/lib/plugin.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -626,7 +626,7 @@
 
     /**
      * Get first SMS plugin name
-     * @return string|boolean
+     * @return string|false
      */
     public function getSMSPluginName()
     {

Indentation +9 added lines, -9 removed lines

@@ -173,9 +173,9 @@ 
     }
 
     /**
-    * @param string $pluginName
-    * @param int    $urlId
-    */
+     * @param string $pluginName
+     * @param int    $urlId
+     */
     public function uninstall($pluginName, $urlId = null)
     {
         if (empty($urlId)) {
@@ -252,12 +252,12 @@ 
     }
 
     /**
-    * @param string $region
-    * @param string $template
-    * @param bool   $forced
-    *
-    * @return null|string
-    */
+     * @param string $region
+     * @param string $template
+     * @param bool   $forced
+     *
+     * @return null|string
+     */
     public function load_region($region, $template, $forced = false)
     {
         if ($region == 'course_tool_plugin') {

Spacing +6 added lines, -6 removed lines

@@ -426,7 +426,7 @@ 
             // Extra options
             $plugin_settings = api_get_settings_params(
                 array(
-                    "subkey = ? AND category = ? AND type = ? " => array($plugin_name, 'Plugins','setting')
+                    "subkey = ? AND category = ? AND type = ? " => array($plugin_name, 'Plugins', 'setting')
                 )
             );
 
@@ -532,7 +532,7 @@ 
             if (!empty($obj->course_settings)) {
                 if (is_file(api_get_path(SYS_CODE_PATH).'img/icons/'.ICON_SIZE_SMALL.'/'.$plugin_name.'.png')) {
                     $icon = Display::return_icon(
-                        $plugin_name . '.png',
+                        $plugin_name.'.png',
                         Security::remove_XSS($pluginTitle),
                         '',
                         ICON_SIZE_SMALL
@@ -548,18 +548,18 @@ 
 
                 $form->addHtml('<div class="panel panel-default">');
                 $form->addHtml('
-                    <div class="panel-heading" role="tab" id="heading-' . $plugin_name . '-settings">
+                    <div class="panel-heading" role="tab" id="heading-' . $plugin_name.'-settings">
                         <h4 class="panel-title">
-                            <a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion" href="#collapse-' . $plugin_name . '-settings" aria-expanded="false" aria-controls="collapse-' . $plugin_name . '-settings">
+                            <a class="collapsed" role="button" data-toggle="collapse" data-parent="#accordion" href="#collapse-' . $plugin_name.'-settings" aria-expanded="false" aria-controls="collapse-'.$plugin_name.'-settings">
                 ');
-                $form->addHtml($icon . ' ' . $pluginTitle);
+                $form->addHtml($icon.' '.$pluginTitle);
                 $form->addHtml('
                             </a>
                         </h4>
                     </div>
                 ');
                 $form->addHtml('
-                    <div id="collapse-' . $plugin_name . '-settings" class="panel-collapse collapse" role="tabpanel" aria-labelledby="heading-' . $plugin_name . '-settings">
+                    <div id="collapse-' . $plugin_name.'-settings" class="panel-collapse collapse" role="tabpanel" aria-labelledby="heading-'.$plugin_name.'-settings">
                         <div class="panel-body">
                 ');
 

main/inc/lib/portfolio.class.php

Doc Comments +7 added lines, -3 removed lines

@@ -126,6 +126,7 @@ 
      * Returns a temporary url to download files and/or folders.
      *
      * @param string|array $ids
+     * @param string $tool
      * @return string
      */
     public static function download_url($ids, $tool)
@@ -293,7 +294,7 @@ 
     /**
      * The name of the porfolio where to send.
      *
-     * @return type
+     * @return string
      */
     function get_portfolio()
     {
@@ -391,7 +392,6 @@ 
      * Create a "send to portfolio" button
      *
      * @param string $tool          The name of the tool: document, work.
-     * @param int $c_id             The id of the course
      * @param int $id               The id of the object
      * @param array $attributes     Html attributes
      * @return \PortfolioShare
@@ -405,7 +405,7 @@ 
     /**
      * Returns the current secuirty token. Used to avoid see surfing attacks.
      *
-     * @return type
+     * @return string
      */
     static function security_token()
     {
@@ -420,6 +420,10 @@ 
     protected $attributes = array();
     protected $tool = '';
 
+    /**
+     * @param string $tool
+     * @param integer $id
+     */
     function __construct($tool, $id, $attributes = array())
     {
         $this->tool = $tool;

Spacing +6 added lines, -6 removed lines

@@ -482,14 +482,14 @@ 
         $attributes['z-index'] = 100000;
         $s = ' ';
         foreach ($attributes as $key => $value) {
-            $s .= $key . '="' . $value . '" ';
+            $s .= $key.'="'.$value.'" ';
         }
 
         $result = array();
-        $result[] = '<span ' . $s . ' >';
+        $result[] = '<span '.$s.' >';
         $result[] = '<span class="dropdown" >';
         $result[] = '<a href="#" data-toggle="dropdown" class="dropdown-toggle">';
-        $result[] = Display::return_icon('document_send.png', get_lang('Send'), array(), ICON_SIZE_SMALL) . '<b class="caret"></b>';
+        $result[] = Display::return_icon('document_send.png', get_lang('Send'), array(), ICON_SIZE_SMALL).'<b class="caret"></b>';
         $result[] = '</a>';
         $result[] = '<ul class="dropdown-menu">';
 
@@ -505,7 +505,7 @@ 
             $parameters[PortfolioController::PARAM_TOOL] = $tool;
             $url = api_get_path(WEB_CODE_PATH).'portfolio/share.php?';
             $result[] = '<li>';
-            $result[] = '<a href="' . $url . '">' . $portfolio->get_title() . '</a>';
+            $result[] = '<a href="'.$url.'">'.$portfolio->get_title().'</a>';
             $result[] = '</li>';
         }
         $result[] = '</ul>';
@@ -564,8 +564,8 @@ 
      */
     public function __construct($portfolio)
     {
-        $this->name = md5(__CLASS__) . '_' . $portfolio->get_name();
-        $this->title = $portfolio->get_title() ? $portfolio->get_title() : get_lang('SendTo') . ' ' . $portfolio->get_name();
+        $this->name = md5(__CLASS__).'_'.$portfolio->get_name();
+        $this->title = $portfolio->get_title() ? $portfolio->get_title() : get_lang('SendTo').' '.$portfolio->get_name();
         $this->portfolio = $portfolio;
     }
 

main/inc/lib/promotion.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -129,7 +129,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_status_list()
     {
@@ -272,7 +272,7 @@ 
     /**
      * @param int $id
      *
-     * @return bool
+     * @return null|false
      */
     public function delete($id)
     {

Spacing +8 added lines, -8 removed lines

@@ -63,7 +63,7 @@ 
                     case 'updated_at':
                         break;
                     case 'name':
-                        $val .= ' ' . get_lang('CopyLabelSuffix');
+                        $val .= ' '.get_lang('CopyLabelSuffix');
                         $new[$key] = $val;
                         break;
                     case 'created_at':
@@ -72,7 +72,7 @@ 
                         break;
                     case 'career_id':
                         if (!empty($career_id)) {
-                            $val = (int)$career_id;
+                            $val = (int) $career_id;
                         }
                         $new[$key] = $val;
                         break;
@@ -160,22 +160,22 @@ 
     {
         // Action links
         echo '<div class="actions" style="margin-bottom:20px">';
-        echo '<a href="career_dashboard.php">' . Display::return_icon('back.png',
-                get_lang('Back'), '', '32') . '</a>';
-        echo '<a href="' . api_get_self() . '?action=add">' .
+        echo '<a href="career_dashboard.php">'.Display::return_icon('back.png',
+                get_lang('Back'), '', '32').'</a>';
+        echo '<a href="'.api_get_self().'?action=add">'.
             Display::return_icon(
                 'new_promotion.png',
                 get_lang('Add'),
                 '',
                 '32'
-            ) . '</a>';
-        echo '<a href="' . api_get_path(WEB_CODE_PATH) . 'session/session_add.php">' .
+            ).'</a>';
+        echo '<a href="'.api_get_path(WEB_CODE_PATH).'session/session_add.php">'.
             Display::return_icon(
                 'new_session.png',
                 get_lang('AddSession'),
                 '',
                 '32'
-            ) . '</a>';
+            ).'</a>';
         echo '</div>';
         echo Display::grid_html('promotions');
     }

main/inc/lib/rights.lib.php

Doc Comments +4 added lines

@@ -15,6 +15,10 @@
 
 	// warning the goal of this function is to enforce rights managment in Chamilo
 	// thus default return value is always true
+
+	/**
+	 * @param string $handler
+	 */
 	public static function hasRight($handler) {
 		if (array_key_exists($handler, self::$rights_cache))
 			return self::$rights_cache[$handler];

Indentation +33 added lines, -33 removed lines

@@ -5,42 +5,42 @@
  * @deprecated Don't use this class
  */
 class Rights {
-	private static $rights_cache = array();
-	private static $rights = array (
-		'show_tabs:reports' =>
-			array (
-				'type' => 'const',
-				'const' => 'true' )
-		);
+    private static $rights_cache = array();
+    private static $rights = array (
+        'show_tabs:reports' =>
+            array (
+                'type' => 'const',
+                'const' => 'true' )
+        );
 
-	// warning the goal of this function is to enforce rights managment in Chamilo
-	// thus default return value is always true
-	public static function hasRight($handler) {
-		if (array_key_exists($handler, self::$rights_cache))
-			return self::$rights_cache[$handler];
+    // warning the goal of this function is to enforce rights managment in Chamilo
+    // thus default return value is always true
+    public static function hasRight($handler) {
+        if (array_key_exists($handler, self::$rights_cache))
+            return self::$rights_cache[$handler];
 
-		if (!array_key_exists($handler, self::$rights))
-			return true; // handler does not exists
+        if (!array_key_exists($handler, self::$rights))
+            return true; // handler does not exists
 
-		if (self::$rights[$handler]['type'] == 'sql') {
-			$result = Database::query(self::$rights[$handler]['sql']);
-			if (Database::num_rows($result) > 0)
-				$result = true;
-			else
-				$result = false;
-		} else if (self::$rights[$handler]['type'] == 'const')
-			$result = self::$rights[$handler]['const'];
-		else if (self::$rights[$handler]['type'] == 'func')
-			$result = self::$rights[$handler]['func']();
-		else // handler type not implemented
-			return true;
-		self::$rights_cache[$handler] = $result;
-		return $result;
-	}
+        if (self::$rights[$handler]['type'] == 'sql') {
+            $result = Database::query(self::$rights[$handler]['sql']);
+            if (Database::num_rows($result) > 0)
+                $result = true;
+            else
+                $result = false;
+        } else if (self::$rights[$handler]['type'] == 'const')
+            $result = self::$rights[$handler]['const'];
+        else if (self::$rights[$handler]['type'] == 'func')
+            $result = self::$rights[$handler]['func']();
+        else // handler type not implemented
+            return true;
+        self::$rights_cache[$handler] = $result;
+        return $result;
+    }
 
-	public static function hasRightClosePageWithError($handler) {
-		if (hasRight($handler) == false)
-			die("You are not allowed here"); //FIXME
-	}
+    public static function hasRightClosePageWithError($handler) {
+        if (hasRight($handler) == false)
+            die("You are not allowed here"); //FIXME
+    }
 
 }

Spacing +2 added lines, -2 removed lines

@@ -6,9 +6,9 @@
  */
 class Rights {
 	private static $rights_cache = array();
-	private static $rights = array (
+	private static $rights = array(
 		'show_tabs:reports' =>
-			array (
+			array(
 				'type' => 'const',
 				'const' => 'true' )
 		);

Braces +23 added lines, -15 removed lines

@@ -16,31 +16,39 @@
 	// warning the goal of this function is to enforce rights managment in Chamilo
 	// thus default return value is always true
 	public static function hasRight($handler) {
-		if (array_key_exists($handler, self::$rights_cache))
-			return self::$rights_cache[$handler];
+		if (array_key_exists($handler, self::$rights_cache)) {
+					return self::$rights_cache[$handler];
+		}
 
-		if (!array_key_exists($handler, self::$rights))
-			return true; // handler does not exists
+		if (!array_key_exists($handler, self::$rights)) {
+					return true;
+		}
+		// handler does not exists
 
 		if (self::$rights[$handler]['type'] == 'sql') {
 			$result = Database::query(self::$rights[$handler]['sql']);
-			if (Database::num_rows($result) > 0)
-				$result = true;
-			else
-				$result = false;
-		} else if (self::$rights[$handler]['type'] == 'const')
-			$result = self::$rights[$handler]['const'];
-		else if (self::$rights[$handler]['type'] == 'func')
-			$result = self::$rights[$handler]['func']();
-		else // handler type not implemented
+			if (Database::num_rows($result) > 0) {
+							$result = true;
+			} else {
+							$result = false;
+			}
+		} else if (self::$rights[$handler]['type'] == 'const') {
+					$result = self::$rights[$handler]['const'];
+		} else if (self::$rights[$handler]['type'] == 'func') {
+					$result = self::$rights[$handler]['func']();
+		} else {
+		    // handler type not implemented
 			return true;
+		}
 		self::$rights_cache[$handler] = $result;
 		return $result;
 	}
 
 	public static function hasRightClosePageWithError($handler) {
-		if (hasRight($handler) == false)
-			die("You are not allowed here"); //FIXME
+		if (hasRight($handler) == false) {
+					die("You are not allowed here");
+		}
+		//FIXME
 	}
 
 }

main/inc/lib/search/ChamiloIndexer.class.php

Doc Comments +4 added lines

@@ -71,6 +71,10 @@
 
     /**
      * Get the terms stored at database
+     * @param string $prefix
+     * @param string $course_code
+     * @param string $tool_id
+     * @param integer $ref_id
      * @return  array Array of terms
      */
     function get_terms_on_db($prefix, $course_code, $tool_id, $ref_id) {

Spacing +5 added lines, -5 removed lines

@@ -7,7 +7,7 @@ 
 /**
  * code
  */
-require_once dirname(__FILE__) . '/../../global.inc.php';
+require_once dirname(__FILE__).'/../../global.inc.php';
 include_once 'xapian/XapianIndexer.class.php';
 
 /**
@@ -39,7 +39,7 @@ 
         if ((count(array_diff($terms, $stored_terms)) == 0) && (count(array_diff($stored_terms, $terms)) == 0))
             return FALSE;
 
-        require_once api_get_path(LIBRARY_PATH) . 'search/xapian/XapianQuery.php';
+        require_once api_get_path(LIBRARY_PATH).'search/xapian/XapianQuery.php';
 
         // compare terms
         $doc = $this->get_document($search_did);
@@ -55,10 +55,10 @@ 
 
         // save it to search engine
         foreach ($missing_terms as $term) {
-            $this->add_term_to_doc($prefix . $term, $doc);
+            $this->add_term_to_doc($prefix.$term, $doc);
         }
         foreach ($deprecated_terms as $term) {
-            $this->remove_term_from_doc($prefix . $term, $doc);
+            $this->remove_term_from_doc($prefix.$term, $doc);
         }
 
         // don't do anything if no change
@@ -74,7 +74,7 @@ 
      * @return  array Array of terms
      */
     function get_terms_on_db($prefix, $course_code, $tool_id, $ref_id) {
-        require_once api_get_path(LIBRARY_PATH) . 'specific_fields_manager.lib.php';
+        require_once api_get_path(LIBRARY_PATH).'specific_fields_manager.lib.php';
         $terms = get_specific_field_values_list_by_prefix($prefix, $course_code, $tool_id, $ref_id);
         $prefix_terms = array();
         foreach ($terms as $term) {

Braces +6 added lines, -4 removed lines

@@ -36,8 +36,9 @@ 
         $stored_terms = $this->get_terms_on_db($prefix, $course_code, $tool_id, $ref_id_high_level);
 
         // don't do anything if no change, verify only at DB, not the search engine
-        if ((count(array_diff($terms, $stored_terms)) == 0) && (count(array_diff($stored_terms, $terms)) == 0))
-            return FALSE;
+        if ((count(array_diff($terms, $stored_terms)) == 0) && (count(array_diff($stored_terms, $terms)) == 0)) {
+                    return FALSE;
+        }
 
         require_once api_get_path(LIBRARY_PATH) . 'search/xapian/XapianQuery.php';
 
@@ -45,8 +46,9 @@ 
         $doc = $this->get_document($search_did);
         $xapian_terms = xapian_get_doc_terms($doc, $prefix);
         $xterms = array();
-        foreach ($xapian_terms as $xapian_term)
-            $xterms[] = substr($xapian_term['name'], 1);
+        foreach ($xapian_terms as $xapian_term) {
+                    $xterms[] = substr($xapian_term['name'], 1);
+        }
 
         $dterms = $terms;
 

main/inc/lib/search/ChamiloQuery.php

Doc Comments +4 added lines, -1 removed lines

@@ -23,6 +23,9 @@ 
     return chamilo_preprocess_results($results);
 }
 
+/**
+ * @param string $query_string
+ */
 function chamilo_query_simple_query($query_string, $offset=0, $length=10, $extra=NULL) {
     return xapian_query($query_string, NULL, $offset, $length, $extra);
 }
@@ -30,7 +33,7 @@ 
 /**
  * Wrapper for getting boolean queries
  *
- * @param   string    $query_string   The term string
+ * @param string $term
  */
 function chamilo_get_boolean_query($term) {
   return xapian_get_boolean_query($term);

Spacing +6 added lines, -6 removed lines

@@ -18,12 +18,12 @@ 
  * @param   array     extra           Extra queries to join with. Optional
  * @return  array
  */
-function chamilo_query_query($query_string, $offset=0, $length=10, $extra=NULL) {
+function chamilo_query_query($query_string, $offset = 0, $length = 10, $extra = NULL) {
     list($count, $results) = xapian_query($query_string, NULL, $offset, $length, $extra);
     return chamilo_preprocess_results($results);
 }
 
-function chamilo_query_simple_query($query_string, $offset=0, $length=10, $extra=NULL) {
+function chamilo_query_simple_query($query_string, $offset = 0, $length = 10, $extra = NULL) {
     return xapian_query($query_string, NULL, $offset, $length, $extra);
 }
 
@@ -42,7 +42,7 @@ 
 function chamilo_preprocess_results($results) {
     // group by toolid
     $results_by_tool = array();
-    if (count($results)>0) {
+    if (count($results) > 0) {
 
 	    foreach ($results as $key => $row) {
 	        $results_by_tool[$row['toolid']][] = $row;
@@ -50,8 +50,8 @@ 
 
 	    $processed_results = array();
 	    foreach ($results_by_tool as $toolid => $rows) {
-	        $tool_processor_class = $toolid .'_processor';
-	        $tool_processor_path = api_get_path(LIBRARY_PATH) .'search/tool_processors/'. $tool_processor_class .'.class.php';
+	        $tool_processor_class = $toolid.'_processor';
+	        $tool_processor_path = api_get_path(LIBRARY_PATH).'search/tool_processors/'.$tool_processor_class.'.class.php';
 	        if (file_exists($tool_processor_path)) {
 	            require_once($tool_processor_path);
 	            $tool_processor = new $tool_processor_class($rows);
@@ -71,6 +71,6 @@ 
  * @param string $op
  * @return XapianQuery query joined
  */
-function chamilo_join_queries($query1, $query2=NULL, $op='or') {
+function chamilo_join_queries($query1, $query2 = NULL, $op = 'or') {
 	return xapian_join_queries($query1, $query2, $op);
 }

Indentation +16 added lines, -16 removed lines

@@ -33,7 +33,7 @@ 
  * @param   string    $query_string   The term string
  */
 function chamilo_get_boolean_query($term) {
-  return xapian_get_boolean_query($term);
+    return xapian_get_boolean_query($term);
 }
 
 /**
@@ -44,22 +44,22 @@ 
     $results_by_tool = array();
     if (count($results)>0) {
 
-	    foreach ($results as $key => $row) {
-	        $results_by_tool[$row['toolid']][] = $row;
-	    }
+        foreach ($results as $key => $row) {
+            $results_by_tool[$row['toolid']][] = $row;
+        }
 
-	    $processed_results = array();
-	    foreach ($results_by_tool as $toolid => $rows) {
-	        $tool_processor_class = $toolid .'_processor';
-	        $tool_processor_path = api_get_path(LIBRARY_PATH) .'search/tool_processors/'. $tool_processor_class .'.class.php';
-	        if (file_exists($tool_processor_path)) {
-	            require_once($tool_processor_path);
-	            $tool_processor = new $tool_processor_class($rows);
-	            $processed_results = array_merge($tool_processor->process(), $processed_results);
-	        }
-	    }
+        $processed_results = array();
+        foreach ($results_by_tool as $toolid => $rows) {
+            $tool_processor_class = $toolid .'_processor';
+            $tool_processor_path = api_get_path(LIBRARY_PATH) .'search/tool_processors/'. $tool_processor_class .'.class.php';
+            if (file_exists($tool_processor_path)) {
+                require_once($tool_processor_path);
+                $tool_processor = new $tool_processor_class($rows);
+                $processed_results = array_merge($tool_processor->process(), $processed_results);
+            }
+        }
 
-	    return array(count($processed_results), $processed_results);
+        return array(count($processed_results), $processed_results);
     }
 }
 
@@ -72,5 +72,5 @@ 
  * @return XapianQuery query joined
  */
 function chamilo_join_queries($query1, $query2=NULL, $op='or') {
-	return xapian_join_queries($query1, $query2, $op);
+    return xapian_join_queries($query1, $query2, $op);
 }

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