chamilo / chamilo-lms

main/coursecopy/classes/CourseArchiver.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -173,7 +173,7 @@
 
     /**
      * @param array $file
-     * @return bool|string
+     * @return string|false
      */
     public static function import_uploaded_file($file)
     {

main/exercice/oral_expression.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
      * @param null $feedback_type
      * @param null $counter
      * @param null $score
-     * @return null|string
+     * @return string
      */
     function return_header($feedback_type = null, $counter = null, $score = null)
     {

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 +242 added lines, -242 removed lines

@@ -9,260 +9,260 @@
  */
 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()
-	{
-		$url = api_get_path(WEB_PATH).'main/newscorm/lp_controller.php?cidReq='.$this->get_course_code().'&gradebook=view';
-		$session_id = api_get_session_id();
-		if (!api_is_allowed_to_edit() || $this->calc_score(api_get_user_id()) == null) {
-			$url .= '&action=view&session_id='.$session_id.'&lp_id='.$this->get_ref_id();
-		} else {
-			$url .= '&action=build&session_id='.$session_id.'&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()
+    {
+        $url = api_get_path(WEB_PATH).'main/newscorm/lp_controller.php?cidReq='.$this->get_course_code().'&gradebook=view';
+        $session_id = api_get_session_id();
+        if (!api_is_allowed_to_edit() || $this->calc_score(api_get_user_id()) == null) {
+            $url .= '&action=view&session_id='.$session_id.'&lp_id='.$this->get_ref_id();
+        } else {
+            $url .= '&action=build&session_id='.$session_id.'&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 UserDataGenerator($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 UserDataGenerator($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/display.lib.php

Doc Comments +26 added lines, -15 removed lines

@@ -32,7 +32,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function toolList()
     {
@@ -290,7 +290,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show.
      * i.e: $visibility_options= array(true, false) we will only show the first column
      * 				Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -331,7 +330,6 @@ 
      * 					'page_nr' = The page to display
      * 					'hide_navigation' =  true to hide the navigation
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $form actions Additional variables to add in the query-string
      * @param mixed An array with bool values to know which columns show. i.e:
      *  $visibility_options= array(true, false) we will only show the first column
      * 	Can be also only a bool value. TRUE: show all columns, FALSE: show nothing
@@ -388,10 +386,11 @@ 
      * 					'per_page' = number of items to show per page
      * 					'page_nr' = The page to display
      * @param array $query_vars Additional variables to add in the query-string
-     * @param array $column_show Array of binaries 1= show columns 0. hide a column
+     * @param integer[] $column_show Array of binaries 1= show columns 0. hide a column
      * @param array $column_order An array of integers that let us decide how the columns are going to be sort.
      * 						      i.e:  $column_order=array('1''4','3','4'); The 2nd column will be order like the 4th column
      * @param array $form_actions Set optional forms actions
+     * @param string $table_name
      *
      * @author Julio Montoya
      */
@@ -444,7 +443,7 @@ 
      * @param bool	$filter (true) or not (false)
      * @param bool $returnValue
      *
-     * @return void
+     * @return string|null
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
@@ -474,7 +473,7 @@ 
     /**
      * Displays an confirmation message. Use this if something has been done successfully
      * @param bool	Filter (true) or not (false)
-     * @return void
+     * @return string|null
      */
     public static function display_confirmation_message ($message, $filter = true, $returnValue = false)
     {
@@ -491,7 +490,7 @@ 
      * @param string $message - include any additional html
      *                          tags if you need them
      * @param bool	Filter (true) or not (false)
-     * @return void
+     * @return string|null
      */
     public static function display_error_message ($message, $filter = true, $returnValue = false)
     {
@@ -681,6 +680,7 @@ 
      * @param string   The alt text (probably a language variable)
      * @param array    additional attributes (for instance height, width, onclick, ...)
      * @param integer  The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
+     * @param string $image
      * @return void
     */
     public static function display_icon(
@@ -881,6 +881,7 @@ 
     /**
      * Displays an HTML input tag
      *
+     * @param string $type
      */
     public static function input($type, $name, $value, $attributes = array())
     {
@@ -897,8 +898,8 @@ 
     }
 
     /**
-     * @param $name
-     * @param $value
+     * @param string $name
+     * @param string $value
      * @param array $attributes
      * @return string
      */
@@ -913,6 +914,7 @@ 
     /**
      * Displays an HTML select tag
      *
+     * @param string $blank_item_text
      */
     public static function select(
         $name,
@@ -983,6 +985,8 @@ 
      * @param   array   content that will be showed
      * @param   string  the id of the container of the tab in the example "tabs"
      * @param   array   attributes for the ul
+     * @param string[] $header_list
+     * @param string[] $content_list
      *
      */
     public static function tabs($header_list, $content_list, $id = 'tabs', $attributes = array(), $ul_attributes = array())
@@ -1029,7 +1033,7 @@ 
 
     /**
      * @param $headers
-     * @param null $selected
+     * @param integer $selected
      *
      * @return string
      */
@@ -1067,6 +1071,7 @@ 
      * As you can see both function use the same "my_grid_name" this is very important otherwise nothing will work
      *
      * @param   string  the div id, this value must be the same with the first parameter of Display::grid_js()
+     * @param string $div_id
      * @return  string  html
      *
      */
@@ -1622,6 +1627,8 @@ 
      * @param  string  url that will be added (for jquery see hot_courses.tpl)
 	 * @param	string	point info array see function CourseManager::get_course_ranking()
 	 * @param	bool	add a div wrapper
+	 * @param string $id
+	 * @param string $url
 	 * @todo	use     templates
      **/
     public static function return_rating_system($id, $url, $point_info = array(), $add_div_wrapper = true)
@@ -1717,6 +1724,9 @@ 
         return '<'.$size.'>'.Security::remove_XSS($title).'</'.$size.'>';
     }
 
+    /**
+     * @param string $title
+     */
     public static function page_subheader2($title, $second_title = null)
     {
         return self::page_header($title, $second_title, 'h4');
@@ -1947,6 +1957,7 @@ 
 
     /**
      * @todo use twig
+     * @param string $title
      */
     public static function group_button($title, $elements)
     {
@@ -2164,9 +2175,9 @@ 
 
     /**
      * @param int $id
-     * @param array $content
+     * @param string[] $content
      * @param int $col
-     * @param bool|true $right
+     * @param boolean $right
      * @return string
      */
     public static function toolbarAction($id, $content = array(), $col = 2, $right = true)
@@ -2248,10 +2259,10 @@ 
     /**
      * @param string $title
      * @param string $content
-     * @param null $id
+     * @param string $id
      * @param array $params
-     * @param null $idAccordion
-     * @param null $idCollapse
+     * @param string $idAccordion
+     * @param string $idCollapse
      * @param bool|true $open
      * @param bool|false $fullClickable
      * @return null|string

Indentation +69 added lines, -69 removed lines

@@ -49,12 +49,12 @@ 
         );
     }
 
-     /**
-     * Displays the page header
-     * @param string The name of the page (will be showed in the page title)
-     * @param string Optional help file name
-     * @param string $page_header
-     */
+        /**
+         * Displays the page header
+         * @param string The name of the page (will be showed in the page title)
+         * @param string Optional help file name
+         * @param string $page_header
+         */
     public static function display_header($tool_name ='', $help = null, $page_header = null)
     {
         $origin = api_get_origin();
@@ -448,7 +448,7 @@ 
      */
     public static function display_normal_message($message, $filter = true, $returnValue = false)
     {
-    	$message = self::return_message($message, 'normal', $filter);
+        $message = self::return_message($message, 'normal', $filter);
         if ($returnValue) {
             return $message;
         } else {
@@ -524,22 +524,22 @@ 
     public static function return_message($message, $type = 'normal', $filter = true)
     {
         if ($filter) {
-        	$message = api_htmlentities($message, ENT_QUOTES, api_is_xml_http_request() ? 'UTF-8' : api_get_system_encoding());
+            $message = api_htmlentities($message, ENT_QUOTES, api_is_xml_http_request() ? 'UTF-8' : api_get_system_encoding());
         }
 
         $class = "";
         switch($type) {
             case 'warning':
                $class .= 'alert alert-warning';
-               break;
+                break;
             case 'error':
                $class .= 'alert alert-danger';
-               break;
+                break;
             case 'confirmation':
             case 'confirm':
             case 'success':
                 $class .= 'alert alert-success';
-               break;
+                break;
             case 'normal':
             default:
                 $class .= 'alert alert-info';
@@ -682,7 +682,7 @@ 
      * @param array    additional attributes (for instance height, width, onclick, ...)
      * @param integer  The wanted width of the icon (to be looked for in the corresponding img/icons/ folder)
      * @return void
-    */
+     */
     public static function display_icon(
         $image,
         $alt_text = '',
@@ -705,7 +705,7 @@ 
      * @author Julio Montoya 2010 Function improved, adding image constants
      * @author Yannick Warnier 2011 Added size handler
      * @version Feb 2011
-    */
+     */
     public static function return_icon(
         $image,
         $alt_text = '',
@@ -884,14 +884,14 @@ 
      */
     public static function input($type, $name, $value, $attributes = array())
     {
-         if (isset($type)) {
-             $attributes['type']= $type;
-         }
-         if (isset($name)) {
-             $attributes['name']= $name;
-         }
-         if (isset($value)) {
-             $attributes['value']= $value;
+            if (isset($type)) {
+                $attributes['type']= $type;
+            }
+            if (isset($name)) {
+                $attributes['name']= $name;
+            }
+            if (isset($value)) {
+                $attributes['value']= $value;
         }
         return self::tag('input', '', $attributes);
     }
@@ -904,10 +904,10 @@ 
      */
     public static function button($name, $value, $attributes = array())
     {
-    	if (!empty($name)) {
+        if (!empty($name)) {
             $attributes['name'] = $name;
-    	}
-    	return self::tag('button', $value, $attributes);
+        }
+        return self::tag('button', $value, $attributes);
     }
 
     /**
@@ -974,7 +974,7 @@ 
      * in the $htmlHeadXtra variable before the display_header
      * Add this script
      * @example
-             * <script>
+     * <script>
                     $(function() {
                         $( "#tabs" ).tabs();
                     });
@@ -1035,20 +1035,20 @@ 
      */
     public static function tabsOnlyLink($headers, $selected = null)
     {
-         $id = uniqid();
-         $i = 1;
-         $lis = null;
-         foreach ($headers as $item) {
+            $id = uniqid();
+            $i = 1;
+            $lis = null;
+            foreach ($headers as $item) {
             $class = null;
             if ($i == $selected) {
                 $class = 'active';
             }
-             $item = self::tag(
-                 'a',
-                 $item['content'],
-                 array('id' => $id.'-'.$i, 'href' => $item['url'])
-             );
-             $lis .= self::tag('li', $item, array('class' => $class));
+                $item = self::tag(
+                    'a',
+                    $item['content'],
+                    array('id' => $id.'-'.$i, 'href' => $item['url'])
+                );
+                $lis .= self::tag('li', $item, array('class' => $class));
             $i++;
         }
         return self::tag('ul', $lis, array('class' => 'nav nav-tabs tabs-margin'));
@@ -1260,8 +1260,8 @@ 
      */
     public static function table($headers, $rows, $attributes = array())
     {
-    	if (empty($attributes)) {
-    		$attributes['class'] = 'data_table';
+        if (empty($attributes)) {
+            $attributes['class'] = 'data_table';
         }
         $table = new HTML_Table($attributes);
         $row = 0;
@@ -1269,17 +1269,17 @@ 
 
         // Course headers
         if (!empty($headers)) {
-	        foreach ($headers as $item) {
-	            $table->setHeaderContents($row, $column, $item);
-	            $column++;
-	        }
-	        $row = 1;
-	        $column = 0;
+            foreach ($headers as $item) {
+                $table->setHeaderContents($row, $column, $item);
+                $column++;
+            }
+            $row = 1;
+            $column = 0;
         }
 
         if (!empty($rows)) {
-	        foreach($rows as $content) {
-	            $table->setCellContents($row, $column, $content);
+            foreach($rows as $content) {
+                $table->setCellContents($row, $column, $content);
                 $row++;
             }
         }
@@ -1385,7 +1385,7 @@ 
                         //$item_property['tool'] != TOOL_DROPBOX &&
                         $item_property['tool'] != TOOL_NOTEBOOK &&
                         $item_property['tool'] != TOOL_CHAT)
-                   )
+                    )
                 )
                 // Take only what's visible or "invisible but where the user is a teacher" or where the visibility is unset.
                 && ($item_property['visibility'] == '1'
@@ -1401,7 +1401,7 @@ 
                         ($item_property['to_user_id'] != $user_id) &&
                         (!isset($item_property['to_group_id']) || !in_array($item_property['to_group_id'], $group_ids)))
                 ) {
-                   continue;
+                    continue;
                 }
 
                 // If it's a survey, make sure the user's invited. Otherwise drop it.
@@ -1620,21 +1620,21 @@ 
      *
      * @param  string  id of the rating ul element
      * @param  string  url that will be added (for jquery see hot_courses.tpl)
-	 * @param	string	point info array see function CourseManager::get_course_ranking()
-	 * @param	bool	add a div wrapper
-	 * @todo	use     templates
+     * @param	string	point info array see function CourseManager::get_course_ranking()
+     * @param	bool	add a div wrapper
+     * @todo	use     templates
      **/
     public static function return_rating_system($id, $url, $point_info = array(), $add_div_wrapper = true)
     {
-		$number_of_users_who_voted = isset($point_info['users_who_voted']) ? $point_info['users_who_voted'] : null;
-		$percentage = isset($point_info['point_average']) ? $point_info['point_average'] : 0;
+        $number_of_users_who_voted = isset($point_info['users_who_voted']) ? $point_info['users_who_voted'] : null;
+        $percentage = isset($point_info['point_average']) ? $point_info['point_average'] : 0;
 
-		if (!empty($percentage)) {
+        if (!empty($percentage)) {
             $percentage = $percentage*125/100;
         }
-		$accesses =  isset($point_info['accesses']) ? $point_info['accesses'] : 0;
+        $accesses =  isset($point_info['accesses']) ? $point_info['accesses'] : 0;
 
-		$star_label = sprintf(get_lang('XStarsOutOf5'), $point_info['point_average_star']);
+        $star_label = sprintf(get_lang('XStarsOutOf5'), $point_info['point_average_star']);
 
         $html = '<ul id="'.$id.'" class="star-rating">
 					<li class="current-rating" style="width:'.$percentage.'px;"></li>
@@ -1645,26 +1645,26 @@ 
 					<li><a href="javascript:void(0);" data-link="'.$url.'&amp;star=5" title="'.$star_label.'" class="five-stars">5</a></li>
 				</ul>';
 
-		$labels = array();
+        $labels = array();
 
-		$labels[]= $number_of_users_who_voted == 1 ? $number_of_users_who_voted.' '.get_lang('Vote') : $number_of_users_who_voted.' '.get_lang('Votes');
-		$labels[]= $accesses == 1 ? $accesses.' '.get_lang('Visit') : $accesses.' '.get_lang('Visits');
-		if (!empty($number_of_users_who_voted)) {
-			$labels[]= get_lang('Average').' '.$point_info['point_average_star'].'/5';
-		}
+        $labels[]= $number_of_users_who_voted == 1 ? $number_of_users_who_voted.' '.get_lang('Vote') : $number_of_users_who_voted.' '.get_lang('Votes');
+        $labels[]= $accesses == 1 ? $accesses.' '.get_lang('Visit') : $accesses.' '.get_lang('Visits');
+        if (!empty($number_of_users_who_voted)) {
+            $labels[]= get_lang('Average').' '.$point_info['point_average_star'].'/5';
+        }
 
-		$labels[]= $point_info['user_vote']  ? get_lang('YourVote').' ['.$point_info['user_vote'].']' : get_lang('YourVote'). ' [?] ';
+        $labels[]= $point_info['user_vote']  ? get_lang('YourVote').' ['.$point_info['user_vote'].']' : get_lang('YourVote'). ' [?] ';
 
-		if (!$add_div_wrapper && api_is_anonymous()) {
-			$labels[]= Display::tag('span', get_lang('LoginToVote'), array('class' => 'error'));
-		}
+        if (!$add_div_wrapper && api_is_anonymous()) {
+            $labels[]= Display::tag('span', get_lang('LoginToVote'), array('class' => 'error'));
+        }
 
         $html .= Display::div(implode(' | ', $labels) , array('id' =>  'vote_label_'.$id, 'class' => 'vote_label_info'));
         $html .= ' '.Display::span(' ', array('id' =>  'vote_label2_'.$id));
 
         if ($add_div_wrapper) {
-			$html = Display::div($html, array('id' => 'rating_wrapper_'.$id));
-		}
+            $html = Display::div($html, array('id' => 'rating_wrapper_'.$id));
+        }
 
         return $html;
     }
@@ -1702,8 +1702,8 @@ 
         return self::page_header($title, $second_title);
     }
 
-     public static function page_subheader_and_translate($title, $second_title = null)
-     {
+        public static function page_subheader_and_translate($title, $second_title = null)
+        {
         $title = get_lang($title);
         return self::page_subheader($title, $second_title);
     }