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/gradebook/lib/user_data_generator.class.php

Doc Comments +5 added lines, -4 removed lines

@@ -72,6 +72,7 @@ 
 
 	/**
 	 * Get actual array data
+	 * @param integer $count
 	 * @return array 2-dimensional array - each array contains the elements:
 	 * 0: eval/link object
 	 * 1: item name
@@ -285,7 +286,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_average_column($item, $ignore_score_color)
@@ -306,7 +307,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_result_column($item, $ignore_score_color)
@@ -323,7 +324,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_mask_column($item, $ignore_score_color)
@@ -339,7 +340,7 @@ 
 
 	/**
 	 * @param $coursecode
-	 * @return mixed
+	 * @return string
 	 */
 	private function get_course_name_from_code_cached($coursecode)
 	{

Indentation +346 added lines, -346 removed lines

@@ -10,28 +10,28 @@ 
  */
 class UserDataGenerator
 {
-	// Sorting types constants
-	const UDG_SORT_TYPE = 1;
-	const UDG_SORT_NAME = 2;
-	const UDG_SORT_COURSE = 4;
-	const UDG_SORT_CATEGORY = 8;
-	const UDG_SORT_AVERAGE = 16;
-	const UDG_SORT_SCORE = 32;
-	const UDG_SORT_MASK = 64;
-
-	const UDG_SORT_ASC = 128;
-	const UDG_SORT_DESC = 256;
-
-	private $items;
-	private $userid;
-
-	private $coursecodecache;
-	private $categorycache;
-	private $scorecache;
-	private $avgcache;
-
-	public function __construct($userid, $evals = array(), $links = array())
-	{
+    // Sorting types constants
+    const UDG_SORT_TYPE = 1;
+    const UDG_SORT_NAME = 2;
+    const UDG_SORT_COURSE = 4;
+    const UDG_SORT_CATEGORY = 8;
+    const UDG_SORT_AVERAGE = 16;
+    const UDG_SORT_SCORE = 32;
+    const UDG_SORT_MASK = 64;
+
+    const UDG_SORT_ASC = 128;
+    const UDG_SORT_DESC = 256;
+
+    private $items;
+    private $userid;
+
+    private $coursecodecache;
+    private $categorycache;
+    private $scorecache;
+    private $avgcache;
+
+    public function __construct($userid, $evals = array(), $links = array())
+    {
         $this->userid = $userid;
         $evals_filtered = array();
         $result = array();
@@ -62,330 +62,330 @@ 
         $this->avgcache = null;
     }
 
-	/**
-	 * Get total number of items (rows)
-	 */
-	public function get_total_items_count()
-	{
-		return count($this->items);
-	}
-
-	/**
-	 * Get actual array data
-	 * @return array 2-dimensional array - each array contains the elements:
-	 * 0: eval/link object
-	 * 1: item name
-	 * 2: course name
-	 * 3: category name
-	 * 4: average score
-	 * 5: student's score
-	 * 6: student's score as custom display (only if custom scoring enabled)
-	 */
-	public function get_data($sorting = 0, $start = 0, $count = null, $ignore_score_color = false)
-	{
-		// do some checks on count, redefine if invalid value
-		if (!isset($count)) {
-			$count = count ($this->items) - $start;
-		}
-		if ($count < 0) {
-			$count = 0;
-		}
-		$allitems = $this->items;
-
-		// sort users array
-		if ($sorting & self :: UDG_SORT_TYPE) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_type'));
-		}elseif ($sorting & self :: UDG_SORT_NAME) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_name'));
-		} elseif ($sorting & self :: UDG_SORT_COURSE) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_course'));
-		} elseif ($sorting & self :: UDG_SORT_CATEGORY) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_category'));
-		} elseif ($sorting & self :: UDG_SORT_AVERAGE) {
-			// if user sorts on average scores, first calculate them and cache them
-			foreach ($allitems as $item) {
-				$this->avgcache[$item->get_item_type() . $item->get_id()]= $item->calc_score();
-			}
-			usort($allitems, array('UserDataGenerator', 'sort_by_average'));
-		} elseif ($sorting & self :: UDG_SORT_SCORE) {
-			// if user sorts on student's scores, first calculate them and cache them
-			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
-					= $item->calc_score($this->userid);
-			}
-			usort($allitems, array('UserDataGenerator', 'sort_by_score'));
-		} elseif ($sorting & self :: UDG_SORT_MASK) {
-			// if user sorts on student's masks, first calculate scores and cache them
-			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
-					= $item->calc_score($this->userid);
-			}
-			usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
-		}
-
-		if ($sorting & self :: UDG_SORT_DESC) {
-			$allitems = array_reverse($allitems);
-		}
-		// select the items we have to display
-		$visibleitems = array_slice($allitems, $start, $count);
-
-		// fill score cache if not done yet
-		if (!isset ($this->scorecache)) {
-			foreach ($visibleitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
-					= $item->calc_score($this->userid);
-			}
-
-		}
-		// generate the data to display
-		$scoredisplay = ScoreDisplay :: instance();
-		$data = array();
-		foreach ($visibleitems as $item) {
-			$row = array ();
-			$row[] = $item;
-			$row[] = $item->get_name();
-			$row[] = $this->build_course_name($item);
-			$row[] = $this->build_category_name($item);
-			$row[] = $this->build_average_column($item, $ignore_score_color);
-			$row[] = $this->build_result_column($item, $ignore_score_color);
-			if ($scoredisplay->is_custom())
-				$row[] = $this->build_mask_column($item, $ignore_score_color);
-			$data[] = $row;
-		}
-		return $data;
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_type($item1, $item2)
-	{
-		if ($item1->get_item_type() == $item2->get_item_type()) {
-			return $this->sort_by_name($item1,$item2);
-		} else {
-			return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
-		}
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_course($item1, $item2)
-	{
-		$name1 = api_strtolower($this->get_course_name_from_code_cached($item1->get_course_code()));
-		$name2 = api_strtolower($this->get_course_name_from_code_cached($item2->get_course_code()));
-		return api_strnatcmp($name1, $name2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_category($item1, $item2)
-	{
-		$cat1 = $this->get_category_cached($item1->get_category_id());
-		$cat2 = $this->get_category_cached($item2->get_category_id());
-		$name1 = api_strtolower($this->get_category_name_to_display($cat1));
-		$name2 = api_strtolower($this->get_category_name_to_display($cat2));
-
-		return api_strnatcmp($name1, $name2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_name($item1, $item2)
-	{
-		return api_strnatcmp($item1->get_name(),$item2->get_name());
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_average($item1, $item2)
-	{
-		$score1 = $this->avgcache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->avgcache[$item2->get_item_type() . $item2->get_id()];
-
-		return $this->compare_scores($score1, $score2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_score($item1, $item2)
-	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
-
-		return $this->compare_scores($score1, $score2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_mask($item1, $item2)
-	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
-
-		return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
-	}
-
-	/**
-	 * @param $score1
-	 * @param $score2
-	 * @return int
-	 */
-	function compare_scores($score1, $score2)
-	{
-		if (!isset($score1)) {
-			return (isset($score2) ? 1 : 0);
-		} elseif (!isset($score2)) {
-			return -1;
-		} elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
-			return 0;
-		} else {
-			return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
-		}
-	}
-
-	/**
-	 * @param $item
-	 * @return mixed
-	 */
-	private function build_course_name($item)
-	{
-		return $this->get_course_name_from_code_cached($item->get_course_code());
-	}
-
-	/**
-	 * @param $item
-	 * @return string
-	 */
-	private function build_category_name($item)
-	{
-		$cat = $this->get_category_cached($item->get_category_id());
-
-		return $this->get_category_name_to_display($cat);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_average_column($item, $ignore_score_color)
-	{
-		if (isset($this->avgcache)) {
-			$avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
-		} else {
-			$avgscore = $item->calc_score();
-		}
-
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_AVERAGE;
-		/*if ($ignore_score_color)
+    /**
+     * Get total number of items (rows)
+     */
+    public function get_total_items_count()
+    {
+        return count($this->items);
+    }
+
+    /**
+     * Get actual array data
+     * @return array 2-dimensional array - each array contains the elements:
+     * 0: eval/link object
+     * 1: item name
+     * 2: course name
+     * 3: category name
+     * 4: average score
+     * 5: student's score
+     * 6: student's score as custom display (only if custom scoring enabled)
+     */
+    public function get_data($sorting = 0, $start = 0, $count = null, $ignore_score_color = false)
+    {
+        // do some checks on count, redefine if invalid value
+        if (!isset($count)) {
+            $count = count ($this->items) - $start;
+        }
+        if ($count < 0) {
+            $count = 0;
+        }
+        $allitems = $this->items;
+
+        // sort users array
+        if ($sorting & self :: UDG_SORT_TYPE) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_type'));
+        }elseif ($sorting & self :: UDG_SORT_NAME) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_name'));
+        } elseif ($sorting & self :: UDG_SORT_COURSE) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_course'));
+        } elseif ($sorting & self :: UDG_SORT_CATEGORY) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_category'));
+        } elseif ($sorting & self :: UDG_SORT_AVERAGE) {
+            // if user sorts on average scores, first calculate them and cache them
+            foreach ($allitems as $item) {
+                $this->avgcache[$item->get_item_type() . $item->get_id()]= $item->calc_score();
+            }
+            usort($allitems, array('UserDataGenerator', 'sort_by_average'));
+        } elseif ($sorting & self :: UDG_SORT_SCORE) {
+            // if user sorts on student's scores, first calculate them and cache them
+            foreach ($allitems as $item) {
+                $this->scorecache[$item->get_item_type() . $item->get_id()]
+                    = $item->calc_score($this->userid);
+            }
+            usort($allitems, array('UserDataGenerator', 'sort_by_score'));
+        } elseif ($sorting & self :: UDG_SORT_MASK) {
+            // if user sorts on student's masks, first calculate scores and cache them
+            foreach ($allitems as $item) {
+                $this->scorecache[$item->get_item_type() . $item->get_id()]
+                    = $item->calc_score($this->userid);
+            }
+            usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
+        }
+
+        if ($sorting & self :: UDG_SORT_DESC) {
+            $allitems = array_reverse($allitems);
+        }
+        // select the items we have to display
+        $visibleitems = array_slice($allitems, $start, $count);
+
+        // fill score cache if not done yet
+        if (!isset ($this->scorecache)) {
+            foreach ($visibleitems as $item) {
+                $this->scorecache[$item->get_item_type() . $item->get_id()]
+                    = $item->calc_score($this->userid);
+            }
+
+        }
+        // generate the data to display
+        $scoredisplay = ScoreDisplay :: instance();
+        $data = array();
+        foreach ($visibleitems as $item) {
+            $row = array ();
+            $row[] = $item;
+            $row[] = $item->get_name();
+            $row[] = $this->build_course_name($item);
+            $row[] = $this->build_category_name($item);
+            $row[] = $this->build_average_column($item, $ignore_score_color);
+            $row[] = $this->build_result_column($item, $ignore_score_color);
+            if ($scoredisplay->is_custom())
+                $row[] = $this->build_mask_column($item, $ignore_score_color);
+            $data[] = $row;
+        }
+        return $data;
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_type($item1, $item2)
+    {
+        if ($item1->get_item_type() == $item2->get_item_type()) {
+            return $this->sort_by_name($item1,$item2);
+        } else {
+            return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
+        }
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_course($item1, $item2)
+    {
+        $name1 = api_strtolower($this->get_course_name_from_code_cached($item1->get_course_code()));
+        $name2 = api_strtolower($this->get_course_name_from_code_cached($item2->get_course_code()));
+        return api_strnatcmp($name1, $name2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_category($item1, $item2)
+    {
+        $cat1 = $this->get_category_cached($item1->get_category_id());
+        $cat2 = $this->get_category_cached($item2->get_category_id());
+        $name1 = api_strtolower($this->get_category_name_to_display($cat1));
+        $name2 = api_strtolower($this->get_category_name_to_display($cat2));
+
+        return api_strnatcmp($name1, $name2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_name($item1, $item2)
+    {
+        return api_strnatcmp($item1->get_name(),$item2->get_name());
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_average($item1, $item2)
+    {
+        $score1 = $this->avgcache[$item1->get_item_type() . $item1->get_id()];
+        $score2 = $this->avgcache[$item2->get_item_type() . $item2->get_id()];
+
+        return $this->compare_scores($score1, $score2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_score($item1, $item2)
+    {
+        $score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
+        $score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+
+        return $this->compare_scores($score1, $score2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_mask($item1, $item2)
+    {
+        $score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
+        $score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+
+        return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
+    }
+
+    /**
+     * @param $score1
+     * @param $score2
+     * @return int
+     */
+    function compare_scores($score1, $score2)
+    {
+        if (!isset($score1)) {
+            return (isset($score2) ? 1 : 0);
+        } elseif (!isset($score2)) {
+            return -1;
+        } elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
+            return 0;
+        } else {
+            return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
+        }
+    }
+
+    /**
+     * @param $item
+     * @return mixed
+     */
+    private function build_course_name($item)
+    {
+        return $this->get_course_name_from_code_cached($item->get_course_code());
+    }
+
+    /**
+     * @param $item
+     * @return string
+     */
+    private function build_category_name($item)
+    {
+        $cat = $this->get_category_cached($item->get_category_id());
+
+        return $this->get_category_name_to_display($cat);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_average_column($item, $ignore_score_color)
+    {
+        if (isset($this->avgcache)) {
+            $avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
+        } else {
+            $avgscore = $item->calc_score();
+        }
+
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_AVERAGE;
+        /*if ($ignore_score_color)
 			$displaytype |= SCORE_IGNORE_SPLIT;
         */
-		return $scoredisplay->display_score($avgscore, $displaytype);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_result_column($item, $ignore_score_color)
-	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_DIV_PERCENT;
-		if ($ignore_score_color) {
-			$displaytype |= SCORE_IGNORE_SPLIT;
-		}
-
-		return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_DEFAULT);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_mask_column($item, $ignore_score_color)
-	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_DIV_PERCENT;
-		if ($ignore_score_color) {
-			$displaytype |= SCORE_IGNORE_SPLIT;
-		}
-		return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_CUSTOM);
-	}
-
-	/**
-	 * @param $coursecode
-	 * @return mixed
-	 */
-	private function get_course_name_from_code_cached($coursecode)
-	{
-		if (isset ($this->coursecodecache)
-			&& isset ($this->coursecodecache[$coursecode])) {
-			return $this->coursecodecache[$coursecode];
-		} else {
-			$name = CourseManager::getCourseNameFromCode($coursecode);
-			$this->coursecodecache[$coursecode] = $name;
-			return $name;
-		}
-	}
-
-	/**
-	 * @param $category_id
-	 * @return null
-	 */
-	private function get_category_cached($category_id)
-	{
-		if (isset ($this->categorycache)
-			&& isset ($this->categorycache[$category_id])) {
-			return $this->categorycache[$category_id];
-		}else {
-			$cat = Category::load($category_id);
-			if (isset($cat)){
-				$this->categorycache[$category_id] = $cat[0];
-				return $cat[0];
-			}else
-				return null;
-		}
-	}
-
-	/**
-	 * @param $cat
-	 * @return string
-	 */
-	private function get_category_name_to_display($cat)
-	{
-		if (isset($cat)) {
-			if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
-				return '';
-			} else {
-				return $cat->get_name();
-			}
-		} else {
-			return '';
-		}
-	}
+        return $scoredisplay->display_score($avgscore, $displaytype);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_result_column($item, $ignore_score_color)
+    {
+        $studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_DIV_PERCENT;
+        if ($ignore_score_color) {
+            $displaytype |= SCORE_IGNORE_SPLIT;
+        }
+
+        return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_DEFAULT);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_mask_column($item, $ignore_score_color)
+    {
+        $studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_DIV_PERCENT;
+        if ($ignore_score_color) {
+            $displaytype |= SCORE_IGNORE_SPLIT;
+        }
+        return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_CUSTOM);
+    }
+
+    /**
+     * @param $coursecode
+     * @return mixed
+     */
+    private function get_course_name_from_code_cached($coursecode)
+    {
+        if (isset ($this->coursecodecache)
+            && isset ($this->coursecodecache[$coursecode])) {
+            return $this->coursecodecache[$coursecode];
+        } else {
+            $name = CourseManager::getCourseNameFromCode($coursecode);
+            $this->coursecodecache[$coursecode] = $name;
+            return $name;
+        }
+    }
+
+    /**
+     * @param $category_id
+     * @return null
+     */
+    private function get_category_cached($category_id)
+    {
+        if (isset ($this->categorycache)
+            && isset ($this->categorycache[$category_id])) {
+            return $this->categorycache[$category_id];
+        }else {
+            $cat = Category::load($category_id);
+            if (isset($cat)){
+                $this->categorycache[$category_id] = $cat[0];
+                return $cat[0];
+            }else
+                return null;
+        }
+    }
+
+    /**
+     * @param $cat
+     * @return string
+     */
+    private function get_category_name_to_display($cat)
+    {
+        if (isset($cat)) {
+            if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
+                return '';
+            } else {
+                return $cat->get_name();
+            }
+        } else {
+            return '';
+        }
+    }
 }

main/inc/lib/AnnouncementManager.php

Doc Comments +9 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_tags()
     {
@@ -40,7 +40,7 @@ 
      * @param string    $course_code
      * @param int       $session_id
      *
-     * @return mixed
+     * @return string
      */
     public static function parse_content($userId, $content, $course_code, $session_id = 0)
     {
@@ -349,7 +349,7 @@ 
      * @param array	    uploaded file $_FILES
      * @param string    Comment describing the attachment
      * @param bool  $sendToUsersInSession
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $emailTitle,
@@ -460,7 +460,7 @@ 
      * @param $to_users
      * @param array $file
      * @param string $file_comment
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $emailTitle,
@@ -699,7 +699,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -719,6 +719,7 @@ 
      * Gets all announcements from a user by course
      * @param	string course db
      * @param	int user id
+     * @param integer $user_id
      * @return	array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1184,6 +1185,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1308,6 +1310,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file($id_attach, $file, $file_comment)

Indentation +1 added lines, -1 removed lines

@@ -1510,7 +1510,7 @@
                             ip.to_user_id=$user_id OR (ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".implode(", ", $group_memberships)."))
                         ) ";
                     } else {
-                       $cond_user_id = " AND (
+                        $cond_user_id = " AND (
                             ip.to_user_id=$user_id OR (ip.to_group_id IS NULL OR ip.to_group_id IN (0, ".api_get_group_id()."))
                         )";
                     }

main/inc/lib/course_home.lib.php

Doc Comments +3 added lines, -2 removed lines

@@ -213,7 +213,7 @@ 
     /**
      * Displays the tools of a certain category.
      *
-     * @return void
+     * @return string
      * @param string $course_tool_category	contains the category of tools to display:
      * "Public", "PublicButHide", "courseAdmin", "claroAdmin"
      */
@@ -650,7 +650,7 @@ 
      * @param array $all_tools_list List of tools as returned by get_tools_category()
      * @param bool  $rows
      *
-     * @return void
+     * @return string
      */
     public static function show_tools_category($all_tools_list, $rows = false)
     {
@@ -1194,6 +1194,7 @@ 
 
     /**
      * Show a toolbar with shortcuts to the course tool
+     * @param integer $orientation
      */
     public static function show_navigation_tool_shortcuts($orientation = SHORTCUTS_HORIZONTAL)
     {

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)
     {