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