chamilo / chamilo-lms

main/exercice/answer.class.php

Doc Comments +5 added lines

@@ -187,6 +187,7 @@ 
      * Reads answer information from the data base ordered by parameter
      * @param	string	Field we want to order by
      * @param	string	DESC or ASC
+     * @param string $field
      * @author 	Frederic Vauthier
      */
     public function readOrderedBy($field, $order='ASC')
@@ -329,6 +330,7 @@ 
 
 	/**
 	 * return array answer by id else return a bool
+	 * @param integer $auto_id
 	 */
 	public function selectAnswerByAutoId($auto_id)
 	{
@@ -443,6 +445,7 @@ 
 	 *
 	 * @author Olivier Brouckaert
 	 * @param - integer $id - answer ID
+	 * @param integer $id
 	 * @return integer - 0 if bad answer, not 0 if good answer
 	 */
     public function isCorrect($id)
@@ -455,6 +458,7 @@ 
 	 *
 	 * @author Olivier Brouckaert
 	 * @param - integer $id - answer ID
+	 * @param integer $id
 	 * @return string - answer comment
 	 */
     public function selectComment($id)
@@ -467,6 +471,7 @@ 
 	 *
 	 * @author Olivier Brouckaert
 	 * @param - integer $id - answer ID
+	 * @param integer $id
 	 * @return integer - answer weighting
 	 */
     public function selectWeighting($id)

main/exercice/export/qti2/qti2_export.php

Doc Comments +8 added lines, -5 removed lines

@@ -32,7 +32,7 @@ 
     /**
      * Constructor.
      *
-     * @param $question Ims2Question object we want to export.
+     * @param Ims2Question $question Ims2Question object we want to export.
      */
      function ImsAssessmentItem($question)
      {
@@ -101,7 +101,7 @@ 
       * This is a default behaviour, some classes may want to override this.
       *
       * @param $standalone: Boolean stating if it should be exported as a stand-alone question
-      * @return A string, the XML flow for an Item.
+      * @return string string, the XML flow for an Item.
       */
      function export($standalone = false)
      {
@@ -239,7 +239,7 @@ 
      * Export the exercise in IMS/QTI.
      *
      * @param bool $standalone Wether it should include XML tag and DTD line.
-     * @return a string containing the XML flow
+     * @return string string containing the XML flow
      * @author Amand Tihon <amand@alrj.org>
      */
     function export($standalone)
@@ -383,7 +383,7 @@ 
       * This is a default behaviour, some classes may want to override this.
       *
       * @param $standalone: Boolean stating if it should be exported as a stand-alone question
-      * @return A string, the XML flow for an Item.
+      * @return string string, the XML flow for an Item.
       * @author Amand Tihon <amand@alrj.org>
       */
      function export($standalone = False)
@@ -417,7 +417,7 @@ 
  *
  * @param int $exerciseId The exercise to export
  * @param boolean $standalone Wether it should include XML tag and DTD line.
- * @return The XML as a string, or an empty string if there's no exercise with given ID.
+ * @return string XML as a string, or an empty string if there's no exercise with given ID.
  */
 function export_exercise_to_qti($exerciseId, $standalone = true)
 {
@@ -474,6 +474,9 @@ 
     return htmlspecialchars($text);
 }
 
+/**
+ * @param string $text
+ */
 function cleanAttribute($text)
 {
     return $text;

main/exercice/export/scorm/scorm_classes.php

Doc Comments +4 added lines, -3 removed lines

@@ -27,6 +27,7 @@ 
      * @param int  The JavaScript ID for this question.
      * Due to the nature of interactions, we must have a natural sequence for
      * questions in the generated JavaScript.
+     * @param integer $js_id
      */
     public static function export_question($questionId, $standalone = true, $js_id)
     {
@@ -687,7 +688,7 @@ 
     /**
      * Constructor.
      *
-     * @param $question The Question object we want to export.
+     * @param ScormQuestion $question The Question object we want to export.
      */
     public function ScormAssessmentItem($question, $standalone = false)
     {
@@ -915,7 +916,7 @@ 
      *
      * @param int $exerciseId The exercise to exporte
      * @param boolean $standalone Wether it should include XML tag and DTD line.
-     * @return The XML as a string, or an empty string if there's no exercise with given ID.
+     * @return string XML as a string, or an empty string if there's no exercise with given ID.
      */
     public static function export_exercise_to_scorm($exerciseId, $standalone=true) {
         $exercise = new Exercise();
@@ -1091,7 +1092,7 @@ 
      * This is a default behaviour, some classes may want to override this.
      *
      * @param $standalone: Boolean stating if it should be exported as a stand-alone question
-     * @return A string, the XML flow for an Item.
+     * @return string string, the XML flow for an Item.
      */
     function export()
     {

main/exercice/question.class.php

Doc Comments +10 added lines, -5 removed lines

@@ -264,7 +264,7 @@ 
     }
 
     /**
-     * @return bool|string
+     * @return string|false
      */
     public function selectPicturePath()
     {
@@ -589,7 +589,7 @@ 
      * @param string $Dimension - Resizing happens proportional according to given dimension: height|width|any
      * @param integer $Max - Maximum size
      *
-     * @return boolean - true if success, false if failed
+     * @return boolean|null - true if success, false if failed
      *
      * @author Toon Keppens
      */
@@ -750,6 +750,7 @@ 
 
     /**
      * Sets extra info
+     * @param string $extra
      */
     public function setExtra($extra)
     {
@@ -955,6 +956,9 @@ 
         }
     }
 
+    /**
+     * @param integer $exerciseId
+     */
     public function search_engine_edit($exerciseId, $addQs=false, $rmQs=false)
     {
         // update search engine and its values table if enabled
@@ -1273,7 +1277,7 @@ 
      *
      * @author Olivier Brouckaert
      * @param  array   $course_info Course info of the destination course
-     * @return int     ID of the new question
+     * @return false|string     ID of the new question
      */
     public function duplicate($course_info = [])
     {
@@ -1649,7 +1653,7 @@ 
      * @param string $name
      * @param int $course_id
      * @param int $position
-     * @return bool|int
+     * @return false|string
      */
     static function saveQuestionOption($question_id, $name, $course_id, $position = 0)
     {
@@ -1870,6 +1874,7 @@ 
     /**
      * Get course medias
      * @param int course id
+     * @param integer $course_id
      */
     static function get_course_medias(
         $course_id,
@@ -1935,7 +1940,7 @@ 
     }
 
     /**
-     * @return array
+     * @return integer[]
      */
     public static function get_default_levels()
     {

main/inc/lib/events.lib.php

Doc Comments +13 added lines, -7 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
@@ -313,6 +313,9 @@ 
      * @param   int     session_id
      * @param   int     learnpath_id (id of the learnpath)
      * @param   int     learnpath_item_id (id of the learnpath_item)
+     * @param integer $score
+     * @param integer $weighting
+     * @param integer $session_id
      *
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @author Julio Montoya Armas <gugli100@gmail.com> Reworked 2010
@@ -414,7 +417,7 @@ 
      * @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
+     * @return	false|string	Result of the insert query
      */
     public static function saveQuestionAttempt(
         $score,
@@ -716,7 +719,6 @@ 
     /**
      * Get every email stored in the database
      *
-     * @param int $etId
      * @return type
      * @assert () !== false
      */
@@ -784,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)
@@ -1102,6 +1104,7 @@ 
      * @param   int     exercise id
      * @param   int $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1197,6 +1200,7 @@ 
      * @param   int     exercise id
      * @param   int  $courseId
      * @param   int     session id
+     * @param integer $user_id
      * @return  array   with the results
      *
      */
@@ -1286,6 +1290,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
      *
      */
@@ -1345,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)
@@ -1521,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 +8 added lines, -5 removed lines

@@ -1279,6 +1279,7 @@ 
 
     /**
      * Validates the time control key
+     * @param integer $exercise_id
      */
     public static function exercise_time_control_is_valid(
         $exercise_id,
@@ -1412,7 +1413,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(
@@ -2213,7 +2214,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)
     {
@@ -2229,7 +2230,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)
     {
@@ -2780,6 +2781,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(
@@ -3219,8 +3221,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)
@@ -3848,7 +3851,7 @@ 
 
     /**
      * @param int $countLetter
-     * @return mixed
+     * @return string
      */
     public static function detectInputAppropriateClass($countLetter)
     {

main/inc/lib/specific_fields_manager.lib.php

Doc Comments +2 added lines

@@ -235,6 +235,7 @@ 
  * @param   string  Course code
  * @param   string  Tool ID
  * @param   int     Internal ID used in specific tool table
+ * @param string $tool_id
  */
 function delete_all_values_for_item($course_id, $tool_id, $ref_id) {
   $table_sf_values = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);
@@ -248,6 +249,7 @@ 
  * Defaults to the first letter of the name, otherwise iterate through available
  * letters
  * @param   string  Name
+ * @param string $name
  * @return  string  One-letter code, upper-case
  */
 function get_specific_field_code_from_name($name) {