chamilo / chamilo-lms

main/inc/lib/course_request.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -18,7 +18,7 @@ 
     /**
      * Checks whether a given course code has been already occupied.
      * @param string $wanted_course_code    The code to be checked.
-     * @return string
+     * @return boolean
      * Returns TRUE if there is created:
      * - a course with the same code OR visual_code (visualcode).
      * - a course request with the same code as the given one, or
@@ -368,7 +368,7 @@ 
     }
 
     /**
-     * @param null $status
+     * @param integer $status
      * @return bool
      */
     public static function count_course_requests($status = null)
@@ -390,7 +390,7 @@ 
 
     /**
      * Gets all the information about a course request using its database id as an access key.
-     * @param int/string $id              The id (an integer number) of the corresponding database record.
+     * @param integer $id              The id (an integer number) of the corresponding database record.
      * @return array/bool                 Returns the requested data as an array or FALSE on failure.
      */
     public static function get_course_request_info($id)

main/inc/lib/dashboard.lib.php

Doc Comments +1 added lines

@@ -493,6 +493,7 @@
 	 * This function update extra user blocks data after closing a dashboard block
 	 * @param int 		User id
 	 * @param string	plugin path
+	 * @param integer $user_id
 	 * @return bool
 	 */
 	public static function close_user_block($user_id, $path)

main/inc/lib/database.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -66,7 +66,7 @@ 
      *
      * @param string $table
      *
-     * @return mixed
+     * @return string
      */
     public static function get_main_table($table)
     {
@@ -265,7 +265,7 @@ 
 
     /**
      * Frees all the memory associated with the provided result identifier.
-     * @return bool     Returns TRUE on success or FALSE on failure.
+     * @return boolean|null     Returns TRUE on success or FALSE on failure.
      * Notes: Use this method if you are concerned about how much memory is being used for queries that return large result sets.
      * Anyway, all associated result memory is automatically freed at the end of the script's execution.
      */
@@ -381,7 +381,7 @@ 
      * @param array     $attributes
      * @param bool      $show_query
      *
-     * @return bool|int
+     * @return false|string
      */
     public static function insert($table_name, $attributes, $show_query = false)
     {

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

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

main/inc/lib/events.lib.php

Doc Comments +18 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,7 @@ 
      * @param   int     lp id
      * @param   int     lp item id
      * @param   string 	order asc or desc
+     * @param integer $courseId
      * @return  array   with the results
      *
      */
@@ -1343,7 +1351,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 +1527,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/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/exercise_show_functions.lib.php

Doc Comments +38 added lines

@@ -24,6 +24,10 @@ 
 	 * @param int       Question ID
      * @param int $resultsDisabled
      * @param string $originalStudentAnswer
+     * @param integer $feedbackType
+     * @param string $answer
+     * @param integer $id
+     * @param integer $questionId
 	 * @return void
 	 */
 	public static function display_fill_in_blanks_answer($feedbackType, $answer, $id, $questionId, $resultsDisabled, $originalStudentAnswer = '')
@@ -62,6 +66,10 @@ 
      * @param string    Answer text
      * @param int       Exercise ID
      * @param int       Question ID
+     * @param integer $feedback_type
+     * @param string $answer
+     * @param integer $id
+     * @param integer $questionId
      * @return void
      */
     static function display_calculated_answer($feedback_type, $answer, $id, $questionId)
@@ -95,6 +103,9 @@ 
 	 * @param string    Answer text
 	 * @param int       Exercise ID
 	 * @param int       Question ID
+	 * @param integer $feedback_type
+	 * @param integer $exe_id
+	 * @param integer $questionId
 	 * @return void
 	 */
 	static function display_free_answer($feedback_type, $answer, $exe_id, $questionId, $questionScore = null)
@@ -117,6 +128,12 @@ 
         }
 	}
 
+	/**
+	 * @param integer $feedback_type
+	 * @param integer $id
+	 * @param integer $questionId
+	 * @param Nanogong $nano
+	 */
 	static function display_oral_expression_answer($feedback_type, $answer, $id, $questionId, $nano = null)
     {
         if (isset($nano)) {
@@ -158,6 +175,7 @@ 
 	 * @param string $answer
 	 * @param string $studentChoice
 	 * @param string $answerComment
+	 * @param integer $feedback_type
 	 */
 	static function display_hotspot_answer($feedback_type, $answerId, $answer, $studentChoice, $answerComment, $in_results_disabled)
 	 {
@@ -224,6 +242,12 @@ 
 	 * @param integer Exercise ID
 	 * @param integer Question ID
 	 * @param boolean Whether to show the answer comment or not
+	 * @param integer $answerType
+	 * @param string $answer
+	 * @param string $answerComment
+	 * @param integer $answerCorrect
+	 * @param integer $id
+	 * @param integer $questionId
 	 * @return void
 	 */
 	static function display_unique_or_multiple_answer(
@@ -308,6 +332,13 @@ 
      * @param integer Exercise ID
      * @param integer Question ID
      * @param boolean Whether to show the answer comment or not
+     * @param integer $feedback_type
+     * @param integer $answerType
+     * @param string $answer
+     * @param string $answerComment
+     * @param integer $answerCorrect
+     * @param integer $id
+     * @param integer $questionId
      * @return void
      */
     static function display_multiple_answer_true_false(
@@ -398,6 +429,13 @@ 
      * @param integer Exercise ID
      * @param integer Question ID
      * @param boolean Whether to show the answer comment or not
+     * @param integer $feedback_type
+     * @param integer $answerType
+     * @param string $answer
+     * @param string $answerComment
+     * @param integer $answerCorrect
+     * @param integer $id
+     * @param integer $questionId
      * @return void
      */
     static function display_multiple_answer_combination_true_false(

main/inc/lib/export.lib.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
      * @param string Name of common tag to place each line in
      * @param string Name of the root element. A root element should always be given.
      * @param string Encoding in which the data is provided
-     * @return void  Prompts the user for a file download
+     * @return boolean  Prompts the user for a file download
      */
     public static function export_complex_table_xml(
         $data,
@@ -283,7 +283,7 @@ 
      * @param string $name
      * @param string $format
      *
-     * @return bool
+     * @return false|null
      */
     public static function htmlToOdt($html, $name, $format = 'odt')
     {