chamilo / chamilo-lms

main/inc/lib/career.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 
     /**
      * Available driver list.
-     * @return array
+     * @return string[]
      */
     private function getDefaultDriverList()
     {

main/inc/lib/pear/PEAR.php

Doc Comments +2 added lines, -1 removed lines

@@ -490,7 +490,7 @@ 
      *                  PEAR_ERROR_TRIGGER, PEAR_ERROR_DIE,
      *                  PEAR_ERROR_CALLBACK, PEAR_ERROR_EXCEPTION.
      *
-     * @param mixed $options If $mode is PEAR_ERROR_TRIGGER, this parameter
+     * @param integer|null $options If $mode is PEAR_ERROR_TRIGGER, this parameter
      *                  specifies the PHP-internal error level (one of
      *                  E_USER_NOTICE, E_USER_WARNING or E_USER_ERROR).
      *                  If $mode is PEAR_ERROR_CALLBACK, this
@@ -581,6 +581,7 @@ 
      * message, code and userinfo are enough.
      *
      * @param string $message
+     * @param integer $code
      *
      */
     function &throwError($message = null,

main/survey/survey.lib.php

Doc Comments +17 added lines, -15 removed lines

@@ -47,7 +47,7 @@ 
      * Deletes all survey invitations of a user
      * @param int $user_id
      *
-     * @return boolean
+     * @return false|null
      * @assert ('') === false
      */
     public static function delete_all_survey_invitations_by_user($user_id)
@@ -104,7 +104,7 @@ 
      * Retrieves all the survey information
      *
      * @param integer $survey_id the id of the survey
-     * @param boolean $shared this parameter determines if
+     * @param integer $shared this parameter determines if
      * we have to get the information of a survey from the central (shared) database or from the
      * 		  course database
      * @param string course code optional
@@ -571,7 +571,7 @@ 
      * This function deletes a survey (and also all the question in that survey
      *
      * @param int $survey_id id of the survey that has to be deleted
-     * @return true
+     * @return boolean
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version January 2007
@@ -756,7 +756,7 @@ 
      *
      * @param int $survey_id id of the survey that has to be duplicated
      * @param int $courseId id of the course which survey has to be duplicated
-     * @return true
+     * @return boolean
      *
      * @author Eric Marguin <e.marguin@elixir-interactive.com>, Elixir Interactive
      * @version October 2007
@@ -796,7 +796,7 @@ 
     /**
      * This function recalculates the number of people who have taken the survey (=filled at least one question)
      *
-     * @param int $survey_id the id of the survey somebody
+     * @param int $survey_data the id of the survey somebody
      * @return true
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1367,7 +1367,7 @@ 
      * This function deletes a shared survey question from the main database and all its options
      *
      * @param int $question_id the id of the question
-     * @param int $shared
+     * @param integer $survey_id
      *
      * @todo delete all the options of this question
      *
@@ -1494,8 +1494,8 @@ 
      * This function deletes all the options of the questions of a given survey
      * This function is normally only called when a survey is deleted
      *
-     * @param $survey_id the id of the survey that has to be deleted
-     * @return true
+     * @param integer $survey_id the id of the survey that has to be deleted
+     * @return boolean
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version January 2007
@@ -1561,8 +1561,8 @@ 
      * This function deletes all the answers anyone has given on this survey
      * This function is normally only called when a survey is deleted
      *
-     * @param $survey_id the id of the survey that has to be deleted
-     * @return true
+     * @param integer $survey_id the id of the survey that has to be deleted
+     * @return boolean
      *
      * @todo write the function
      *
@@ -1804,7 +1804,7 @@ 
     /**
      * This function checks the parameters that are used in this page
      *
-     * @return 	string 	The header, an error and the footer if any parameter fails, else it returns true
+     * @return 	null|boolean 	The header, an error and the footer if any parameter fails, else it returns true
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version February 2007
      */
@@ -2371,6 +2371,7 @@ 
      * Display score data about a survey question
      * @param	array	Question info
      * @param	integer	The offset of results shown
+     * @param integer $offset
      * @return	void 	(direct output)
      */
     public static function display_question_report_score($survey_data, $question, $offset)
@@ -3208,7 +3209,7 @@ 
      * @param	array	User's answers
      * @param 	mixed	User ID or user details as string - Used as a string in the result string
      * @param	boolean	Whether to display user fields or not
-     * @return	string	One line of the csv file
+     * @return	string[]	One line of the csv file
      */
     public static function export_complete_report_row_xls(
         $survey_data,
@@ -3801,7 +3802,7 @@ 
 
     /**
      * @param $params
-     * @return bool|int
+     * @return false|string
      */
     public static function save_invitation($params)
     {
@@ -3855,6 +3856,7 @@ 
      *
      * @param int invitedUser - the userId (course user) or emailaddress of additional user
      * $param string $invitation_code - the unique invitation code for the URL
+     * @param string|null $invitation_text
      * @return	void
      */
     public static function send_invitation_mail($invitedUser, $invitation_code, $invitation_title, $invitation_text)
@@ -4783,7 +4785,7 @@ 
     /**
      * @author Isaac Flores Paz <florespaz@bidsoftperu.com>
      * @param int $user_id - User ID
-     * @param int $user_id_answer - User in survey answer table (user id or anonymus)
+     * @param int $user_answer - User in survey answer table (user id or anonymus)
      * @return boolean
      */
     static function show_link_available($user_id, $survey_code, $user_answer)
@@ -4829,7 +4831,7 @@ 
      * Display survey question chart
      * @param	array	Chart data
      * @param	boolean	Tells if the chart has a serie. False by default
-     * @return	void 	(direct output)
+     * @return	string 	(direct output)
      */
     public static function drawChart($chartData, $hasSerie = false, $chartContainerId = 'chartContainer')
     {

main/inc/lib/events.lib.php

Doc Comments +19 added lines, -10 removed lines

@@ -239,7 +239,7 @@ 
     }
 
     /**
-     * @param doc_id id of document (id in mainDb.document table)
+     * @param doc_id string of document (id in mainDb.document table)
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @desc Record information for upload event
      * used in the works tool to record informations when
@@ -311,6 +311,8 @@ 
      * @param   int     session_id
      * @param   int     learnpath_id (id of the learnpath)
      * @param   int     learnpath_item_id (id of the learnpath_item)
+     * @param integer $weighting
+     * @param integer $session_id
      *
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @author Julio Montoya Armas <gugli100@gmail.com> Reworked 2010
@@ -412,7 +414,9 @@ 
      * @param	integer	Session ID (from the session table). Default value of null means "get from context".
      * @param	integer	Learnpath ID (from c_lp table). Default value of null means "get from context".
      * @param	integer	Learnpath item ID (from the c_lp_item table). Default value of null means "get from context".
-     * @return	boolean	Result of the insert query
+     * @param integer $exe_id
+     * @param integer $position
+     * @return	false|string	Result of the insert query
      */
     public static function saveQuestionAttempt(
         $score,
@@ -582,6 +586,7 @@ 
      * @param	int		Whether this answer is correct (1) or not (0)
      * @param	string	Coordinates of this point (e.g. 123;324)
      * @param	bool update results?
+     * @param integer $exe_id
      * @return	boolean	Result of the insert query
      * @uses Course code and user_id from global scope $_cid and $_user
      */
@@ -714,7 +719,6 @@ 
     /**
      * Get every email stored in the database
      *
-     * @param int $etId
      * @return type
      * @assert () !== false
      */
@@ -782,11 +786,11 @@ 
     /**
      * Save the new message for one event and for one language
      *
-     * @param string $eventName
+     * @param string $event_name
      * @param array $users
      * @param string $message
      * @param string $subject
-     * @param string $eventMessageLanguage
+     * @param string $event_message_language
      * @param int $activated
      */
     public static function save_event_type_message($event_name, $users, $message, $subject, $event_message_language, $activated)
@@ -920,10 +924,10 @@ 
     }
 
     /**
-     * @param $user_id
+     * @param integer $user_id
      * @param $exerciseId
-     * @param $lp_id
-     * @param $lp_item_id
+     * @param integer $lp_id
+     * @param integer $lp_item_id
      * @return int
      */
     public static function get_attempt_count_not_finished($user_id, $exerciseId, $lp_id, $lp_item_id)
@@ -1100,6 +1104,7 @@ 
      * @param   int     exercise id
      * @param   int $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1195,6 +1200,7 @@ 
      * @param   int     exercise id
      * @param   int  $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1235,6 +1241,7 @@ 
      * @param   int     exercise id
      * @param   string  course code
      * @param   int     session id
+     * @param integer $exe_id
      * @return  array   with the results
      *
      */
@@ -1284,6 +1291,8 @@ 
      * @param   int     lp id
      * @param   int     lp item id
      * @param   string 	order asc or desc
+     * @param integer $courseId
+     * @param string $order
      * @return  array   with the results
      *
      */
@@ -1343,7 +1352,7 @@ 
      * @param   int     exercise id
      * @param   int     $courseId
      * @param   int     session id
-     * @return  array   with the results
+     * @return  string   with the results
      *
      */
     public static function count_exercise_attempts_by_user($user_id, $exercise_id, $courseId, $session_id = 0)
@@ -1519,7 +1528,7 @@ 
      * @param   int     exercise id
      * @param   int   course id
      * @param   int     session id
-     * @return  array   with the results
+     * @return  integer   with the results
      *
      */
     public static function get_count_exercises_attempted_by_course($courseId, $session_id = 0)

main/newscorm/lp_final_item.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
  * @param int $sessionId
  * @param string $downloadCertificateLink
  * @param string $badgeLink
- * @return mixed|string
+ * @return string
  */
 function generateLPFinalItemTemplate($lpItemId, $courseCode, $sessionId=0, $downloadCertificateLink='', $badgeLink='')
 {

main/inc/lib/magpierss/extlib/Snoopy.class.inc

Doc Comments +12 added lines

@@ -366,6 +366,9 @@ 
 	Output:		$expandedLinks	the expanded links
 \*======================================================================*/
 
+	/**
+	 * @param string $links
+	 */
 	private function _expandlinks($links,$URI)
 	{
 		
@@ -400,6 +403,9 @@ 
 	Output:		
 \*======================================================================*/
 	
+	/**
+	 * @param string $http_method
+	 */
 	private function _httprequest($url,$fp,$URI,$http_method,$content_type="",$body="")
 	{
 		if($this->passcookies && $this->_redirectaddr)
@@ -583,6 +589,9 @@ 
 	Output:		
 \*======================================================================*/
 	
+	/**
+	 * @param string $http_method
+	 */
 	private function _httpsrequest($url,$URI,$http_method,$content_type="",$body="")
 	{
 		if($this->passcookies && $this->_redirectaddr)
@@ -766,6 +775,9 @@ 
 	Input:		$fp	file pointer
 \*======================================================================*/
 	
+	/**
+	 * @param boolean $fp
+	 */
 	private function _connect(&$fp)
 	{
 		if(!empty($this->proxy_host) && !empty($this->proxy_port))

main/inc/lib/magpierss/rss_cache.inc

Doc Comments +12 added lines

@@ -50,6 +50,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     true on sucess  
 \*=======================================================================*/
+    /**
+     * @param string $url
+     */
     public function set ($url, $rss) {
         $this->ERROR = "";
         $cache_file = $this->file_name( $url );
@@ -76,6 +79,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     cached object on HIT, false on MISS 
 \*=======================================================================*/ 
+    /**
+     * @param string $url
+     */
     public function get ($url) {
         $this->ERROR = "";
         $cache_file = $this->file_name( $url );
@@ -112,6 +118,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     cached object on HIT, false on MISS 
 \*=======================================================================*/     
+    /**
+     * @param string $url
+     */
     public function check_cache ( $url ) {
         $this->ERROR = "";
         $filename = $this->file_name( $url );
@@ -158,6 +167,9 @@ 
 /*=======================================================================*\
     Function:   unserialize
 \*=======================================================================*/     
+    /**
+     * @param string $data
+     */
     public function unserialize ( $data ) {
         return unserialize( $data );
     }

main/inc/lib/magpierss/rss_fetch.inc

Doc Comments +9 added lines

@@ -228,6 +228,9 @@ 
     Purpose:    set MAGPIE_ERROR, and trigger error
 \*=======================================================================*/
 
+/**
+ * @param integer $lvl
+ */
 function error ($errormsg, $lvl=E_USER_WARNING) {
         global $MAGPIE_ERROR;
         
@@ -242,6 +245,9 @@ 
         }
 }
 
+/**
+ * @param integer $lvl
+ */
 function debug ($debugmsg, $lvl=E_USER_NOTICE) {
     trigger_error("MagpieRSS [debug] $debugmsg", $lvl);
 }
@@ -288,6 +294,9 @@ 
     Input:      an HTTP response object (see Snoopy)
     Output:     parsed RSS object (see rss_parse)
 \*=======================================================================*/
+/**
+ * @param Snoopy $resp
+ */
 function _response_to_rss ($resp) {
     $rss = new MagpieRSS( $resp->results, MAGPIE_OUTPUT_ENCODING, MAGPIE_INPUT_ENCODING, MAGPIE_DETECT_ENCODING );
     

main/inc/lib/magpierss/rss_parse.inc

Doc Comments +10 added lines

@@ -449,6 +449,10 @@ 
     /**
     * return XML parser, and possibly re-encoded source
     *
+    * @param string $source
+    * @param string $out_enc
+    * @param string|null $in_enc
+    * @param boolean $detect
     */
     public function create_parser($source, $out_enc, $in_enc, $detect) {
         if ( substr(phpversion(),0,1) == 5) {
@@ -558,6 +562,9 @@ 
         }
     }
 
+    /**
+     * @param integer $lvl
+     */
     public function error ($errormsg, $lvl=E_USER_WARNING) {
         // append PHP's error message if track_errors enabled
         if ( isset($php_errormsg) ) { 
@@ -593,6 +600,9 @@ 
 	define("CASE_LOWER",0);
 
 
+	/**
+	 * @param integer $case
+	 */
 	function array_change_key_case($array,$case=CASE_LOWER) {
        if ($case=CASE_LOWER) $cmd=strtolower;
        elseif ($case=CASE_UPPER) $cmd=strtoupper;