chamilo / chamilo-lms

main/exercise/export/qti2/qti2_classes.php

Doc Comments +16 added lines

@@ -77,6 +77,8 @@ 
     /**
      * Return the XML flow for the possible answers.
      *
+     * @param string $questionIdent
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -104,6 +106,7 @@ 
     /**
      * Return the XML flow of answer ResponsesDeclaration
      *
+     * @param string $questionIdent
      */
     public function imsExportResponsesDeclaration($questionIdent)
     {
@@ -155,6 +158,8 @@ 
      * Export the text with missing words.
      *
      *
+     * @param string $questionIdent
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -174,6 +179,7 @@ 
 
     /**
      *
+     * @param string $questionIdent
      */
     public function imsExportResponsesDeclaration($questionIdent)
     {
@@ -213,6 +219,8 @@ 
 
     /**
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionIdent
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment)
     {
@@ -255,6 +263,7 @@ 
 
     /**
      *
+     * @param string $questionIdent
      */
     public function imsExportResponsesDeclaration($questionIdent)
     {
@@ -300,6 +309,8 @@ 
     /**
      * TODO update this to match hot spots instead of copying matching
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionIdent
+     * @param string $questionStatment
      */
     public function imsExportResponses($questionIdent, $questionStatment, $questionDesc = '', $questionMedia = '')
     {
@@ -354,6 +365,7 @@ 
 
     /**
      *
+     * @param string $questionIdent
      */
     public function imsExportResponsesDeclaration($questionIdent)
     {
@@ -384,6 +396,8 @@ 
     /**
      * TODO implement
      * Export the question part as a matrix-choice, with only one possible answer per line.
+     * @param string $questionIdent
+     * @param string $questionStatment
      */
     public function imsExportResponses(
         $questionIdent,
@@ -400,6 +414,8 @@ 
     }
     /**
      *
+     * @param string $questionIdent
+     * @param Ims2Question $question
      */
     public function imsExportResponsesDeclaration($questionIdent, $question)
     {

main/inc/lib/skill.lib.php

Doc Comments +5 added lines, -4 removed lines

@@ -365,6 +365,7 @@ 
 
     /**
      * Gets an element
+     * @param integer $gradebook_id
      */
     public function get_skill_info($skill_id, $gradebook_id)
     {
@@ -612,7 +613,7 @@ 
      * Gets an element
      * @param int $id
      *
-     * @return array|mixed
+     * @return integer
      */
     public function get($id)
     {
@@ -1182,7 +1183,7 @@ 
      * @param int skill id
      * @param bool return a flat array or not
      * @param int depth of the skills
-     * @return json
+     * @return string
      */
     public function get_skills_tree_json(
         $user_id = null,
@@ -1677,8 +1678,8 @@ 
     }
 
     /**
-     * @param $currentUserId
-     * @param $studentId
+     * @param integer $currentUserId
+     * @param integer $studentId
      * @return bool
      */
     public static function hasAccessToUserSkill($currentUserId, $studentId)

main/survey/survey.lib.php

Doc Comments +10 added lines, -9 removed lines

@@ -50,7 +50,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)
@@ -107,7 +107,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
@@ -577,7 +577,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
@@ -765,7 +765,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
@@ -805,7 +805,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
@@ -1385,6 +1385,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 integer $survey_id
      *
      * @todo delete all the options of this question
      *
@@ -1510,8 +1511,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
@@ -1581,8 +1582,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
      *

main/inc/lib/exercise.lib.php

Doc Comments +11 added lines, -8 removed lines

@@ -1454,6 +1454,7 @@ 
 
     /**
      * Generates the time control key
+     * @param integer $exercise_id
      */
     public static function get_time_control_key(
         $exercise_id,
@@ -1541,7 +1542,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(
@@ -2443,7 +2444,7 @@ 
      * @param string $name
      * @param $weight
      * @param $selected
-     * @return bool
+     * @return false|null
      */
     public static function addScoreModelInput(
         FormValidator & $form,
@@ -2569,7 +2570,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 $value
+     * @param string $value
      * @return boolean
      * In this version, pass_percentage and show_success_message are disabled if
      * pass_percentage is set to 0
@@ -2582,7 +2583,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)
     {
@@ -2598,7 +2599,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)
     {
@@ -3152,6 +3153,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(
@@ -3579,8 +3581,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)
@@ -4275,7 +4278,7 @@ 
 
     /**
      * @param int $countLetter
-     * @return mixed
+     * @return string
      */
     public static function detectInputAppropriateClass($countLetter)
     {
@@ -4401,7 +4404,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getNotificationSettings()
     {

main/forum/forumfunction.inc.php

Doc Comments +6 added lines, -6 removed lines

@@ -91,7 +91,7 @@ 
  * called but this make the code there cleaner.
  * @param int $lp_id Learning path Id
  *
- * @return void
+ * @return null|string
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @author Juan Carlos Raña Trabado (return to lp_id)
  * @version may 2011, Chamilo 1.8.8
@@ -222,7 +222,7 @@ 
  *
  * @param array $inputvalues
  * @param int $lp_id
- * @return void HTML
+ * @return null|string HTML
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @author Juan Carlos Raña Trabado (return to lp_id)
@@ -463,7 +463,7 @@ 
  * (storing was done twice)
  *
  * @param array
- * @return void HTML
+ * @return null|string HTML
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8
@@ -2437,7 +2437,7 @@ 
  * This function update a thread
  *
  * @param array $values - The form Values
- * @return void HTML
+ * @return string|null HTML
  *
  */
 function updateThread($values)
@@ -3103,7 +3103,7 @@ 
  * @param integer $thread_qualify
  * @param integer $qualify_time
  * @param integer $session_id
- * @return array optional
+ * @return string|null optional
  * @author Isaac Flores <isaac.flores@dokeos.com>, U.N.A.S University
  * @version October 2008, dokeos  1.8.6
  */
@@ -3848,7 +3848,7 @@ 
 
 /**
  * This function is used to find all the information about what's new in the forum tool
- * @return void
+ * @return false|null
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8

main/lp/lp_final_item.php

Doc Comments +1 added lines, -1 removed lines

@@ -200,7 +200,7 @@
  * @param int $sessionId
  * @param string $downloadCertificateLink
  * @param string $badgeLink
- * @return mixed|string
+ * @return string
  */
 function generateLPFinalItemTemplate(
     $lpItemId,

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

Doc Comments +1 added lines, -1 removed lines

@@ -284,7 +284,7 @@
     }
 
     /**
-     * @return null
+     * @return null|integer
      */
     public function getMinimumToValidate()
     {

main/inc/lib/grade_model.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -258,10 +258,10 @@
     }
 
     /**
-     * @param $form
+     * @param CatForm $form
      * @param string $name
-     * @param null $default_value
-     * @return bool
+     * @param null|integer $default_value
+     * @return false|null
      */
     public function fill_grade_model_select_in_form(&$form, $name = 'gradebook_model_id', $default_value = null)
     {

main/survey/surveyUtil.class.php

Doc Comments +5 added lines, -3 removed lines

@@ -137,7 +137,7 @@ 
     /**
      * This function checks the parameters that are used in this page
      *
-     * @return string $people_filled The header, an error and the footer if any parameter fails, else it returns true
+     * @return null|boolean $people_filled 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
      */
@@ -729,6 +729,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)
@@ -1431,7 +1432,7 @@ 
      * Quite similar to display_complete_report(), returns an HTML string
      * that can be used in a csv file
      * @todo consider merging this function with display_complete_report
-     * @return string The contents of a csv file
+     * @return false|null The contents of a csv file
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
      * @version February 2007
      */
@@ -2302,7 +2303,7 @@ 
 
     /**
      * @param $params
-     * @return bool|int
+     * @return false|string
      */
     public static function save_invitation($params)
     {
@@ -2358,6 +2359,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(