chamilo / chamilo-lms

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.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -326,6 +326,7 @@ 
 
     /**
      * Gets an element
+     * @param integer $gradebook_id
      */
     public function get_skill_info($skill_id, $gradebook_id)
     {
@@ -544,7 +545,7 @@ 
      * Gets an element
      * @param int $id
      *
-     * @return array|mixed
+     * @return integer
      */
     public function get($id)
     {
@@ -885,7 +886,7 @@ 
     /**
      * Get user's skills
      *
-     * @param int $userId User's id
+     * @param integer $user_id User's id
      * @param bool $get_skill_data
      */
     public function get_user_skills($user_id, $get_skill_data = false)

Indentation +8 added lines, -8 removed lines

@@ -33,11 +33,11 @@ 
     }
 
     /**
-    * This function is for editing profile info from profile_id.
-    * @param int    $profileId
-    * @param string $name
-    * @param string $description
-    */
+     * This function is for editing profile info from profile_id.
+     * @param int    $profileId
+     * @param string $name
+     * @param string $description
+     */
     public function updateProfileInfo($profileId, $name, $description)
     {
         $profileId = intval($profileId);
@@ -128,9 +128,9 @@ 
     }
 
     /**
-    * This function is for getting profile info from profile_id.
-    * @param int $profileId
-    */
+     * This function is for getting profile info from profile_id.
+     * @param int $profileId
+     */
 
     public function getProfileInfo($profileId)
     {

Spacing +9 added lines, -9 removed lines

@@ -803,7 +803,7 @@ 
                     $attributes = array(
                         'skill_id'      => $skill_id,
                         'parent_id'     => $parent_id,
-                        'relation_type' => (isset($params['relation_type'])?$params['relation_type']:0),
+                        'relation_type' => (isset($params['relation_type']) ? $params['relation_type'] : 0),
                         //'level'         => $params['level'],
                     );
                     $skill_rel_skill->save($attributes);
@@ -1012,7 +1012,7 @@ 
                     $skills[$skill_id] = $skill_info;
                     // Uncomment code below to hide the searched skill
                     $skills[$skill_id]['data']['parent_id'] = $skill_info['extra']['parent_id'];
-                    $skills[$skill_id]['parent_id'] =  1;
+                    $skills[$skill_id]['parent_id'] = 1;
                 }
             }
         }
@@ -1077,7 +1077,7 @@ 
                     $skill['data']['skill_has_gradebook'] = true;
                 }
                 $refs[$skill['id']] = &$skill;
-                $flat_array[$skill['id']] =  &$skill;
+                $flat_array[$skill['id']] = &$skill;
             }
 
             // Checking family value
@@ -1098,7 +1098,7 @@ 
                 $refs['root']['children'][0] = $skills[1];
                 $skills[$skill_id]['data']['family_id'] = 1;
                 $refs['root']['children'][0]['children'][0] = $skills[$skill_id];
-                $flat_array[$skill_id] =  $skills[$skill_id];
+                $flat_array[$skill_id] = $skills[$skill_id];
             } else {
                 // Moving node to the children index of their parents
 
@@ -1107,7 +1107,7 @@ 
                         $skill['data']['family_id'] = $new_family_array[$skill['id']];
                     }
                     $refs[$skill['parent_id']]['children'][] = &$skill;
-                    $flat_array[$my_skill_id] =  $skill;
+                    $flat_array[$my_skill_id] = $skill;
                 }
             }
 
@@ -1219,7 +1219,7 @@ 
                 INNER JOIN {$this->table_skill_rel_user} su
                 ON (s.id = su.skill_id)
                 WHERE user_id = $user_id";
-        $result  = Database::query($sql);
+        $result = Database::query($sql);
         if (Database::num_rows($result)) {
             $result = Database::fetch_row($result);
             return $result[0];
@@ -1261,7 +1261,7 @@ 
      */
     public function get_user_list_skill_ranking_count()
     {
-        $sql    = "SELECT count(*) FROM (
+        $sql = "SELECT count(*) FROM (
                         SELECT count(distinct 1)
                         FROM {$this->table} s
                         INNER JOIN {$this->table_skill_rel_user} su
@@ -1316,7 +1316,7 @@ 
                 ON c.code = g.course_code
                 WHERE sg.skill_id = $skill_id
                 AND (g.session_id IS NULL OR g.session_id = 0)";
-        $result   = Database::query($sql);
+        $result = Database::query($sql);
 
         return Database::store_result($result, 'ASSOC');
     }
@@ -1505,7 +1505,7 @@ 
                 WHERE sg.skill_id = $skillId
                 AND g.session_id > 0";
 
-        $result   = Database::query($sql);
+        $result = Database::query($sql);
 
         return Database::store_result($result, 'ASSOC');
     }

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