chamilo / chamilo-lms

main/gradebook/lib/be/learnpathlink.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 
 	/**
 	 * Get the progress of this learnpath. Only the last attempt are taken into account.
-	 * @param $stud_id student id (default: all students who have results - then the average is returned)
+	 * @param integer $stud_id student id (default: all students who have results - then the average is returned)
 	 * @return	array (score, max) if student is given
 	 * 			array (sum of scores, number of scores) otherwise
 	 * 			or null if no scores available

Indentation +243 added lines, -243 removed lines

@@ -9,261 +9,261 @@
  */
 class LearnpathLink extends AbstractLink
 {
-	private $course_info = null;
-	private $learnpath_table = null;
-	private $learnpath_data = null;
-
-	/**
-	 * Constructor
-	 */
-	public function __construct()
-	{
-		parent::__construct();
-		$this->set_type(LINK_LEARNPATH);
-	}
-
-	/**
-	 * Generate an array of learnpaths that a teacher hasn't created a link for.
-	 * @return array 2-dimensional array - every element contains 2 subelements (id, name)
-	 */
-	public function get_not_created_links()
-	{
-		return false;
-		if (empty($this->course_code))
-			die('Error in get_not_created_links() : course code not set');
-
-		$tbl_grade_links = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
-
-		$sql = 'SELECT id, name from '.$this->get_learnpath_table().' lp
+    private $course_info = null;
+    private $learnpath_table = null;
+    private $learnpath_data = null;
+
+    /**
+     * Constructor
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->set_type(LINK_LEARNPATH);
+    }
+
+    /**
+     * Generate an array of learnpaths that a teacher hasn't created a link for.
+     * @return array 2-dimensional array - every element contains 2 subelements (id, name)
+     */
+    public function get_not_created_links()
+    {
+        return false;
+        if (empty($this->course_code))
+            die('Error in get_not_created_links() : course code not set');
+
+        $tbl_grade_links = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
+
+        $sql = 'SELECT id, name from '.$this->get_learnpath_table().' lp
 				WHERE c_id = '.$this->course_id.' AND id NOT IN '
-			.' (SELECT ref_id FROM '.$tbl_grade_links
-			.' WHERE type = '.LINK_LEARNPATH
-			." AND course_code = '".$this->get_course_code()."'"
-			.') AND lp.session_id='.api_get_session_id().'';
-
-		$result = Database::query($sql);
-
-		$cats=array();
-		while ($data=Database::fetch_array($result)) {
-			$cats[] = array ($data['id'], $data['name']);
-		}
-
-		return $cats;
-	}
-
-	/**
-	 * Generate an array of all learnpaths available.
-	 * @return array 2-dimensional array - every element contains 2 subelements (id, name)
-	 */
-	public function get_all_links()
-	{
-		if (empty($this->course_code))
-			die('Error in get_not_created_links() : course code not set');
-
-		$session_id = api_get_session_id();
-		if (empty($session_id)) {
-			$session_condition = api_get_session_condition(0, true);
-		} else {
-			$session_condition = api_get_session_condition($session_id, true, true);
-		}
-
-		$sql = 'SELECT id, name FROM '.$this->get_learnpath_table().'
+            .' (SELECT ref_id FROM '.$tbl_grade_links
+            .' WHERE type = '.LINK_LEARNPATH
+            ." AND course_code = '".$this->get_course_code()."'"
+            .') AND lp.session_id='.api_get_session_id().'';
+
+        $result = Database::query($sql);
+
+        $cats=array();
+        while ($data=Database::fetch_array($result)) {
+            $cats[] = array ($data['id'], $data['name']);
+        }
+
+        return $cats;
+    }
+
+    /**
+     * Generate an array of all learnpaths available.
+     * @return array 2-dimensional array - every element contains 2 subelements (id, name)
+     */
+    public function get_all_links()
+    {
+        if (empty($this->course_code))
+            die('Error in get_not_created_links() : course code not set');
+
+        $session_id = api_get_session_id();
+        if (empty($session_id)) {
+            $session_condition = api_get_session_condition(0, true);
+        } else {
+            $session_condition = api_get_session_condition($session_id, true, true);
+        }
+
+        $sql = 'SELECT id, name FROM '.$this->get_learnpath_table().'
                 WHERE c_id = '.$this->course_id.' '.$session_condition.' ';
-		$result = Database::query($sql);
+        $result = Database::query($sql);
 
-		$cats = array();
-		while ($data=Database::fetch_array($result)) {
-			$cats[] = array ($data['id'], $data['name']);
-		}
+        $cats = array();
+        while ($data=Database::fetch_array($result)) {
+            $cats[] = array ($data['id'], $data['name']);
+        }
 
-		return $cats;
-	}
+        return $cats;
+    }
 
 
-	/**
-	 * Has anyone used this learnpath yet ?
-	 */
-	public function has_results()
-	{
-		$tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
-		$sql = "SELECT count(id) AS number FROM $tbl_stats
+    /**
+     * Has anyone used this learnpath yet ?
+     */
+    public function has_results()
+    {
+        $tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
+        $sql = "SELECT count(id) AS number FROM $tbl_stats
 				WHERE c_id = ".$this->course_id." AND lp_id = ".$this->get_ref_id();
-		$result = Database::query($sql);
-		$number = Database::fetch_array($result,'NUM');
-		return ($number[0] != 0);
-	}
-
-	/**
-	 * Get the progress of this learnpath. Only the last attempt are taken into account.
-	 * @param $stud_id student id (default: all students who have results - then the average is returned)
-	 * @return	array (score, max) if student is given
-	 * 			array (sum of scores, number of scores) otherwise
-	 * 			or null if no scores available
-	 */
-	public function calc_score($stud_id = null, $type = null)
-	{
-		$tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
-		$session_id = api_get_session_id();
-
-		$sql = "SELECT * FROM $tbl_stats
+        $result = Database::query($sql);
+        $number = Database::fetch_array($result,'NUM');
+        return ($number[0] != 0);
+    }
+
+    /**
+     * Get the progress of this learnpath. Only the last attempt are taken into account.
+     * @param $stud_id student id (default: all students who have results - then the average is returned)
+     * @return	array (score, max) if student is given
+     * 			array (sum of scores, number of scores) otherwise
+     * 			or null if no scores available
+     */
+    public function calc_score($stud_id = null, $type = null)
+    {
+        $tbl_stats = Database::get_course_table(TABLE_LP_VIEW);
+        $session_id = api_get_session_id();
+
+        $sql = "SELECT * FROM $tbl_stats
                 WHERE
                 	c_id = ".$this->course_id." AND
                     lp_id = ".$this->get_ref_id()." AND
                     session_id = $session_id ";
 
-		if (isset($stud_id))
-			$sql .= ' AND user_id = '.intval($stud_id);
-
-		// order by id, that way the student's first attempt is accessed first
-		$sql .= ' ORDER BY view_count DESC';
-
-		$scores = Database::query($sql);
-		// for 1 student
-		if (isset($stud_id)) {
-			if ($data = Database::fetch_assoc($scores)) {
-				return array ($data['progress'], 100);
-			} else
-				return null;
-		} else {
-			// all students -> get average
-			$students = array();  // user list, needed to make sure we only
-			// take first attempts into account
-			$rescount = 0;
-			$sum = 0;
-			$bestResult = 0;
-			$sumResult = 0;
-			while ($data = Database::fetch_array($scores)) {
-				if (!(array_key_exists($data['user_id'], $students))) {
-					$students[$data['user_id']] = $data['progress'];
-					$rescount++;
-					$sum += $data['progress'] / 100;
-					$sumResult += $data['progress'];
-
-					if ($data['progress'] > $bestResult) {
-						$bestResult = $data['progress'];
-					}
-				}
-			}
-
-			if ($rescount == 0) {
-				return null;
-			} else {
-
-				switch ($type) {
-					case 'best':
-						return array($bestResult, 100);
-						break;
-					case 'average':
-						return array($sumResult/$rescount, 100);
-						break;
-					case 'ranking':
-						return AbstractLink::getCurrentUserRanking($stud_id, $students);
-						break;
-					default:
-						return array($sum, $rescount);
-						break;
-				}
-			}
-		}
-	}
-
-	/**
-	 * Get URL where to go to if the user clicks on the link.
-	 */
-	public function get_link()
-	{
-		$session_id = api_get_session_id();
-		$url = api_get_path(WEB_CODE_PATH) . 'lp/lp_controller.php?'.api_get_cidreq_params($this->get_course_code(), $session_id).'&gradebook=view';
-
-		if (!api_is_allowed_to_edit() || $this->calc_score(api_get_user_id()) == null) {
-			$url .= '&action=view&lp_id='.$this->get_ref_id();
-		} else {
-			$url .= '&action=build&lp_id='.$this->get_ref_id();
-		}
-		return $url;
-	}
-
-	/**
-	 * Get name to display: same as learnpath title
-	 */
-	public function get_name()
-	{
-		$data = $this->get_learnpath_data();
-		return $data['name'];
-	}
-
-	/**
-	 * Get description to display: same as learnpath description
-	 */
-	public function get_description()
-	{
-		$data = $this->get_learnpath_data();
-		return $data['description'];
-	}
-
-	/**
-	 * Check if this still links to a learnpath
-	 */
-	public function is_valid_link() {
-		$sql = 'SELECT count(id) FROM '.$this->get_learnpath_table().'
+        if (isset($stud_id))
+            $sql .= ' AND user_id = '.intval($stud_id);
+
+        // order by id, that way the student's first attempt is accessed first
+        $sql .= ' ORDER BY view_count DESC';
+
+        $scores = Database::query($sql);
+        // for 1 student
+        if (isset($stud_id)) {
+            if ($data = Database::fetch_assoc($scores)) {
+                return array ($data['progress'], 100);
+            } else
+                return null;
+        } else {
+            // all students -> get average
+            $students = array();  // user list, needed to make sure we only
+            // take first attempts into account
+            $rescount = 0;
+            $sum = 0;
+            $bestResult = 0;
+            $sumResult = 0;
+            while ($data = Database::fetch_array($scores)) {
+                if (!(array_key_exists($data['user_id'], $students))) {
+                    $students[$data['user_id']] = $data['progress'];
+                    $rescount++;
+                    $sum += $data['progress'] / 100;
+                    $sumResult += $data['progress'];
+
+                    if ($data['progress'] > $bestResult) {
+                        $bestResult = $data['progress'];
+                    }
+                }
+            }
+
+            if ($rescount == 0) {
+                return null;
+            } else {
+
+                switch ($type) {
+                    case 'best':
+                        return array($bestResult, 100);
+                        break;
+                    case 'average':
+                        return array($sumResult/$rescount, 100);
+                        break;
+                    case 'ranking':
+                        return AbstractLink::getCurrentUserRanking($stud_id, $students);
+                        break;
+                    default:
+                        return array($sum, $rescount);
+                        break;
+                }
+            }
+        }
+    }
+
+    /**
+     * Get URL where to go to if the user clicks on the link.
+     */
+    public function get_link()
+    {
+        $session_id = api_get_session_id();
+        $url = api_get_path(WEB_CODE_PATH) . 'lp/lp_controller.php?'.api_get_cidreq_params($this->get_course_code(), $session_id).'&gradebook=view';
+
+        if (!api_is_allowed_to_edit() || $this->calc_score(api_get_user_id()) == null) {
+            $url .= '&action=view&lp_id='.$this->get_ref_id();
+        } else {
+            $url .= '&action=build&lp_id='.$this->get_ref_id();
+        }
+        return $url;
+    }
+
+    /**
+     * Get name to display: same as learnpath title
+     */
+    public function get_name()
+    {
+        $data = $this->get_learnpath_data();
+        return $data['name'];
+    }
+
+    /**
+     * Get description to display: same as learnpath description
+     */
+    public function get_description()
+    {
+        $data = $this->get_learnpath_data();
+        return $data['description'];
+    }
+
+    /**
+     * Check if this still links to a learnpath
+     */
+    public function is_valid_link() {
+        $sql = 'SELECT count(id) FROM '.$this->get_learnpath_table().'
                 WHERE c_id = '.$this->course_id.' AND id = '.$this->get_ref_id().' ';
-		$result = Database::query($sql);
-		$number = Database::fetch_row($result,'NUM');
-		return ($number[0] != 0);
-	}
-
-	public function get_type_name()
-	{
-		return get_lang('LearningPaths');
-	}
-
-	public function needs_name_and_description()
-	{
-		return false;
-	}
-
-	public function needs_max()
-	{
-		return false;
-	}
-
-	public function needs_results()
-	{
-		return false;
-	}
-
-	public function is_allowed_to_change_name()
-	{
-		return false;
-	}
-
-	// INTERNAL FUNCTIONS
-
-	/**
-	 * Lazy load function to get the database table of the learnpath
-	 */
-	private function get_learnpath_table()
-	{
-		$this->learnpath_table = Database :: get_course_table(TABLE_LP_MAIN);
-		return $this->learnpath_table;
-	}
-
-	/**
-	 * Lazy load function to get the database contents of this learnpath
-	 */
-	private function get_learnpath_data()
-	{
-		if (!isset($this->learnpath_data)) {
-			$sql = 'SELECT * FROM '.$this->get_learnpath_table().'
+        $result = Database::query($sql);
+        $number = Database::fetch_row($result,'NUM');
+        return ($number[0] != 0);
+    }
+
+    public function get_type_name()
+    {
+        return get_lang('LearningPaths');
+    }
+
+    public function needs_name_and_description()
+    {
+        return false;
+    }
+
+    public function needs_max()
+    {
+        return false;
+    }
+
+    public function needs_results()
+    {
+        return false;
+    }
+
+    public function is_allowed_to_change_name()
+    {
+        return false;
+    }
+
+    // INTERNAL FUNCTIONS
+
+    /**
+     * Lazy load function to get the database table of the learnpath
+     */
+    private function get_learnpath_table()
+    {
+        $this->learnpath_table = Database :: get_course_table(TABLE_LP_MAIN);
+        return $this->learnpath_table;
+    }
+
+    /**
+     * Lazy load function to get the database contents of this learnpath
+     */
+    private function get_learnpath_data()
+    {
+        if (!isset($this->learnpath_data)) {
+            $sql = 'SELECT * FROM '.$this->get_learnpath_table().'
                     WHERE c_id = '.$this->course_id.' AND id = '.$this->get_ref_id().' ';
-			$result = Database::query($sql);
-			$this->learnpath_data = Database::fetch_array($result);
-		}
-		return $this->learnpath_data;
-	}
-
-	public function get_icon_name()
-	{
-		return 'learnpath';
-	}
+            $result = Database::query($sql);
+            $this->learnpath_data = Database::fetch_array($result);
+        }
+        return $this->learnpath_data;
+    }
+
+    public function get_icon_name()
+    {
+        return 'learnpath';
+    }
 }

main/gradebook/lib/fe/gradebooktable.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -32,6 +32,8 @@ 
      * @param array $evals
      * @param array $links
      * @param null $addparams
+     * @param boolean $showTeacherView
+     * @param integer $userId
      */
     public function __construct(
         $currentcat,
@@ -895,7 +897,7 @@ 
 
     /**
      * @param $item
-     * @return mixed
+     * @return string|null
      */
     private function build_course_code($item)
     {

main/inc/lib/diagnoser.lib.php

Doc Comments +6 added lines

@@ -351,6 +351,12 @@
 
     /**
      * Additional functions needed for fast integration
+     * @param integer $status
+     * @param string $section
+     * @param string $title
+     * @param string $url
+     * @param string|null $formatter
+     * @param string $comment
      */
     public function build_setting($status, $section, $title, $url, $current_value, $expected_value, $formatter, $comment, $img_path = null) {
         switch ($status) {

Indentation +13 added lines, -13 removed lines

@@ -401,19 +401,19 @@
 
     public function format_yes_no_optional($value)
     {
-    	$return = '';
-    	switch($value) {
-     		case 0:
-     			$return = get_lang('No');
-     			break;
-     		case 1:
-     			$return = get_lang('Yes');
-     			break;
-			case 2:
-				$return = get_lang('Optional');
-				break;
-    	}
-    	return $return;
+        $return = '';
+        switch($value) {
+                case 0:
+                 $return = get_lang('No');
+                    break;
+                case 1:
+                 $return = get_lang('Yes');
+                    break;
+            case 2:
+                $return = get_lang('Optional');
+                break;
+        }
+        return $return;
 
     }
 

main/inc/lib/exercise.lib.php

Doc Comments +9 added lines, -6 removed lines

@@ -1255,6 +1255,7 @@ 
 
     /**
      * Validates the time control key
+     * @param integer $exercise_id
      */
     public static function exercise_time_control_is_valid(
         $exercise_id,
@@ -1388,7 +1389,7 @@ 
      * @param int $in_direction
      * @param string $in_hotpot_path
      * @param bool $in_get_count
-     * @param null $where_condition
+     * @param string $where_condition
      * @return array|int
      */
     public static function get_exam_results_hotpotatoes_data(
@@ -2179,7 +2180,7 @@ 
     /**
      * Return true if pass_pourcentage activated (we use the pass pourcentage feature
      * return false if pass_percentage = 0 (we don't use the pass pourcentage feature
-     * @param $in_pass_pourcentage
+     * @param string $in_pass_pourcentage
      * @return boolean
      * In this version, pass_percentage and show_success_message are disabled if
      * pass_percentage is set to 0
@@ -2192,7 +2193,7 @@ 
     /**
      * Converts a numeric value in a percentage example 0.66666 to 66.67 %
      * @param $value
-     * @return float Converted number
+     * @return string Converted number
      */
     public static function convert_to_percentage($value)
     {
@@ -2208,7 +2209,7 @@ 
      * @param   float $score
      * @param   float $weight
      * @deprecated seem not to be used
-     * @return  float   the score rounded converted to the new range
+     * @return  string|null   the score rounded converted to the new range
      */
     public static function convert_score($score, $weight)
     {
@@ -2759,6 +2760,7 @@ 
      * @param    int        exercise id
      * @param    int    $courseId
      * @param    int        session id
+     * @param integer $user_count
      * @return    float    Best average score
      */
     public static function get_best_average_score_by_exercise(
@@ -3198,8 +3200,9 @@ 
     }
 
     /**
-     * @param array $answer
+     * @param string|null $answer
      * @param string $user_answer
+     * @param string|null $current_answer
      * @return array
      */
     public static function check_fill_in_blanks($answer, $user_answer, $current_answer)
@@ -3805,7 +3808,7 @@ 
 
     /**
      * @param int $countLetter
-     * @return mixed
+     * @return string
      */
     public static function detectInputAppropriateClass($countLetter)
     {

main/inc/lib/formvalidator/Rule/MaxFileSize.php

Doc Comments -1 removed lines

@@ -9,7 +9,6 @@
 {
 	/**
 	 * @param $value array     Uploaded file info (from $_FILES)
-	 * @param null $options
 	 * @return bool
 	 */
 	public function validate($elementValue, $maxSize)

Indentation +17 added lines, -17 removed lines

@@ -7,22 +7,22 @@
  */
 class HTML_QuickForm_Rule_MaxFileSize extends HTML_QuickForm_Rule
 {
-	/**
-	 * @param $value array     Uploaded file info (from $_FILES)
-	 * @param null $options
-	 * @return bool
-	 */
-	public function validate($elementValue, $maxSize)
-	{
-		if (!empty($elementValue['error']) &&
-			(UPLOAD_ERR_FORM_SIZE == $elementValue['error'] || UPLOAD_ERR_INI_SIZE == $elementValue['error'])
-		) {
-			return false;
-		}
-		if (!HTML_QuickForm_file::_ruleIsUploadedFile($elementValue)) {
-			return true;
-		}
+    /**
+     * @param $value array     Uploaded file info (from $_FILES)
+     * @param null $options
+     * @return bool
+     */
+    public function validate($elementValue, $maxSize)
+    {
+        if (!empty($elementValue['error']) &&
+            (UPLOAD_ERR_FORM_SIZE == $elementValue['error'] || UPLOAD_ERR_INI_SIZE == $elementValue['error'])
+        ) {
+            return false;
+        }
+        if (!HTML_QuickForm_file::_ruleIsUploadedFile($elementValue)) {
+            return true;
+        }
 
-		return ($maxSize >= @filesize($elementValue['tmp_name']));
-	}
+        return ($maxSize >= @filesize($elementValue['tmp_name']));
+    }
 }

main/inc/lib/formvalidator/Rule/MobilePhoneNumber.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
      *
      * @param string Mobile phone number to be validated
      * @param string Not using it. Just to respect the declaration
-     * @return boolean Returns true if valid, false otherwise.
+     * @return integer Returns true if valid, false otherwise.
      */
     function validate($mobilePhoneNumber, $options = null)
     {

main/inc/lib/hook/HookManagement.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
 
     /**
      * Return a list an associative array where keys are the active hook observer class name
-     * @param $eventName
+     * @param string $eventName
      *
      * @return array
      */

main/inc/lib/login.lib.php

Doc Comments +2 added lines, -1 removed lines

@@ -266,6 +266,7 @@ 
      * @global bool   $is_platformAdmin
      * @global bool   $is_allowedCreateCourse
      * @global object $_user
+     * @param boolean $reset
      */
     public static function init_user($user_id, $reset)
     {
@@ -355,7 +356,7 @@ 
      * @global type $is_allowed_in_course
      *
      * @param type $course_id
-     * @param type $reset
+     * @param boolean $reset
      */
     static function init_course($course_id, $reset)
     {

Indentation +6 added lines, -6 removed lines

@@ -852,14 +852,14 @@ 
             $email = false;
         }
 
-		if ($email) {
-			$condition = "LOWER(email) = '".Database::escape_string($username)."' ";
-		} else {
+        if ($email) {
+            $condition = "LOWER(email) = '".Database::escape_string($username)."' ";
+        } else {
             $condition = "LOWER(username) = '".Database::escape_string($username)."'";
         }
 
-		$tbl_user = Database :: get_main_table(TABLE_MAIN_USER);
-		$query = "SELECT 
+        $tbl_user = Database :: get_main_table(TABLE_MAIN_USER);
+        $query = "SELECT 
 		            user_id AS uid, 
 		            lastname AS lastName, 
 		            firstname AS firstName, 
@@ -874,7 +874,7 @@ 
                     auth_source
 				 FROM $tbl_user
 				 WHERE ( $condition AND active = 1) ";
-		$result = Database::query($query);
+        $result = Database::query($query);
         $num_rows = Database::num_rows($result);
         if ($result && $num_rows > 0) {
             return Database::fetch_assoc($result);

main/inc/lib/model.lib.php

Doc Comments +1 added lines

@@ -25,6 +25,7 @@
 
     /**
      * Useful finder - experimental akelos like only use in notification.lib.php send function
+     * @param string $type
      */
     public function find($type, $options = null)
     {