chamilo / chamilo-lms

main/exercice/export/scorm/scorm_classes.php

Doc Comments +5 added lines, -4 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();
@@ -930,7 +931,7 @@ 
 
     /**
      * Constructor.
-     * @param $exe The Exercise instance to export
+     * @param Exercise $exe The Exercise instance to export
      * @author Amand Tihon <amand@alrj.org>
      */
     function ScormSection($exe) {
@@ -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/fill_blanks.class.php

Doc Comments +15 added lines, -14 removed lines

@@ -415,7 +415,7 @@ 
      * @param null $feedback_type
      * @param null $counter
      * @param null $score
-     * @return null|string
+     * @return string
      */
     public function return_header($feedback_type = null, $counter = null, $score = null)
     {
@@ -429,15 +429,16 @@ 
     }
 
     /**
-     * @param $separatorStartRegexp
-     * @param $separatorEndRegexp
-     * @param $correctItemRegexp
-     * @param $questionId
+     * @param string $separatorStartRegexp
+     * @param string $separatorEndRegexp
+     * @param string $correctItemRegexp
+     * @param integer $questionId
      * @param $correctItem
      * @param $attributes
-     * @param $answer
+     * @param string $answer
      * @param $listAnswersInfo
-     * @param $displayForStudent
+     * @param boolean $displayForStudent
+     * @param integer $inBlankNumber
      * @return string
      */
     public static function getFillTheBlankHtml(
@@ -736,11 +737,11 @@ 
     *  0  : student answer is correct
     * >0  : for fill the blank question with choice menu, is the index of the student answer (right answer indice is 0)
     *
-    * @param $testId
-    * @param $questionId
+    * @param integer $testId
+    * @param integer $questionId
     * @param $studentsIdList
-    * @param $startDate
-    * @param $endDate
+    * @param string $startDate
+    * @param string $endDate
     * @param bool $useLastAnswerredAttempt
     * @return array
     * (
@@ -917,7 +918,7 @@ 
      * return $text protected for use in regexp
      * @param string $text
      *
-     * @return mixed
+     * @return string
      */
     public static function getRegexpProtected($text)
     {
@@ -975,7 +976,7 @@ 
      * return the start separator for answer
      * @param string $number
      *
-     * @return mixed
+     * @return string
      */
     public static function getStartSeparator($number)
     {
@@ -988,7 +989,7 @@ 
      * return the end separator for answer
      * @param string $number
      *
-     * @return mixed
+     * @return string
      */
     public static function getEndSeparator($number)
     {

main/exercice/hotpotatoes.lib.php

Doc Comments +5 added lines, -1 removed lines

@@ -94,7 +94,7 @@ 
  * Sets the comment in the database for a particular path.
  * @param    string    File path
  * @param    string    Comment to set
- * @return   string    Result of the database operation (Database::query will output some message directly on error anyway)
+ * @return   Doctrine\DBAL\Driver\Statement|null    Result of the database operation (Database::query will output some message directly on error anyway)
  */
 function SetComment($path, $comment)
 {
@@ -112,6 +112,7 @@ 
 /**
  * Reads the file contents into a string.
  * @param    string    Urlencoded path
+ * @param string $full_file_path
  * @return   string    The file contents or false on security error
  */
 function ReadFileCont($full_file_path)
@@ -257,6 +258,7 @@ 
  * Searches for a node in the given array.
  * @param    reference    Reference to the array to search
  * @param    string       Node we are looking for in the array
+ * @param string $node
  * @return   mixed        Node name or false if not found
  */
 function myarraysearch(&$array, $node)
@@ -316,6 +318,8 @@ 
  * Fills the folder name up to a certain length with "0".
  * @param    string    Original folder name
  * @param    integer   Length to reach
+ * @param integer $name
+ * @param integer $nsize
  * @return   string    Modified folder name
  */
 function FillFolderName($name, $nsize)

main/exercice/hotpotatoes_exercise_result.class.php

Doc Comments +1 added lines

@@ -18,6 +18,7 @@
 	 * Gets the results of all students (or just one student if access is limited)
 	 * @param	string		The document path (for HotPotatoes retrieval)
 	 * @param	integer		User ID. Optional. If no user ID is provided, we take all the results. Defauts to null
+	 * @param string $document_path
 	 */
 	public function getExercisesReporting($document_path, $hotpotato_name)
     {

main/exercice/hotspot.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	/**
 	 * @param FormValidator $form
 	 * @param null $objExercise
-	 * @return bool
+	 * @return null|false
 	 */
 	public function processCreation($form, $objExercise = null)
 	{

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/exercice/question.class.php

Doc Comments +8 added lines, -5 removed lines

@@ -265,7 +265,7 @@ 
     }
 
     /**
-     * @return bool|string
+     * @return string|false
      */
     public function selectPicturePath()
     {
@@ -590,7 +590,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
      */
@@ -751,6 +751,7 @@ 
 
     /**
      * Sets extra info
+     * @param string $extra
      */
     public function setExtra($extra)
     {
@@ -1261,7 +1262,7 @@ 
      *
      * @author Olivier Brouckaert
      * @param  array   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 = null)
     {
@@ -1636,7 +1637,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)
     {
@@ -1775,6 +1776,7 @@ 
      * @param   int     Maximum result for the question
      * @param   int     Type of question (see constants at beginning of question.class.php)
      * @param   int     Question level/category
+     * @param string $quiz_id
      */
     public function create_question(
         $quiz_id,
@@ -1857,6 +1859,7 @@ 
     /**
      * Get course medias
      * @param int course id
+     * @param integer $course_id
      */
     static function get_course_medias(
         $course_id,
@@ -1922,7 +1925,7 @@ 
     }
 
     /**
-     * @return array
+     * @return integer[]
      */
     public static function get_default_levels()
     {

main/exercice/unique_answer.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -417,8 +417,8 @@
      * @param int $question_id  The question ID (to which the answer is attached)
      * @param string $title The text of the answer
      * @param string $comment The feedback for the answer
-     * @param float|null $score  The score you get when picking this answer
-     * @param int|null $correct  Whether this answer is considered *the* correct one (this is the unique answer type)
+     * @param double $score  The score you get when picking this answer
+     * @param integer $correct  Whether this answer is considered *the* correct one (this is the unique answer type)
      */
     public function addAnswer(
         $id,

main/forum/forumfunction.inc.php

Doc Comments +16 added lines, -7 removed lines

@@ -1058,7 +1058,7 @@ 
  * an up and down icon except for the first (no up icon) and the last (no down icon)
  *          The key of this $list array is the id of the item.
  *
- * @return void HTML
+ * @return string HTML
  **/
 function return_up_down_icon($content, $id, $list)
 {
@@ -2011,7 +2011,7 @@ 
  * This function retrieves forum thread users details
  * @param   int Thread ID
  * @param   string  Course DB name (optional)
- * @return  resource array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
+ * @return  Doctrine\DBAL\Driver\Statement|null array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
  * @author Christian Fasanando <christian.fasanando@dokeos.com>,
  * @todo     this function need to be improved
  * @version octubre 2008, dokeos 1.8
@@ -2066,7 +2066,7 @@ 
  * This function retrieves forum thread users qualify
  * @param   int Thread ID
  * @param   string  Course DB name (optional)
- * @return  array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
+ * @return  Doctrine\DBAL\Driver\Statement|null Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
  * @author Jhon Hinojosa
  * @todo     this function need to be improved
  */
@@ -2133,7 +2133,7 @@ 
  * This function retrieves forum thread users not qualify
  * @param   int Thread ID
  * @param   string  Course DB name (optional)
- * @return  array Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
+ * @return  Doctrine\DBAL\Driver\Statement|null Array of type ([user_id=>w,lastname=>x,firstname=>y,thread_id=>z],[])
  * @author   Jhon Hinojosa<jhon.hinojosa@dokeos.com>,
  * @version oct 2008, dokeos 1.8
  */
@@ -3163,6 +3163,10 @@ 
  * @param integer contains the information the current user id
  * @param integer contains the information the current thread id
  * @param integer contains the information the current qualify
+ * @param string $option
+ * @param integer $course_id
+ * @param integer $user_id
+ * @param integer $thread_id
  * @return void
  * <code>$option=1 obtained the qualification of the current thread</code>
  * @author Isaac Flores <isaac.flores@dokeos.com>, U.N.A.S University
@@ -3722,6 +3726,8 @@ 
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8
+ * @param string $last_post_id
+ * @param string $post_date
  */
 function updateThreadInfo($thread_id, $last_post_id, $post_date)
 {
@@ -4025,6 +4031,8 @@ 
  *
  * @param string  Content type (post, thread, forum, forum_category)
  * @param int     Item DB ID
+ * @param string $content
+ * @param integer $id
  * @return string language variable
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @version february 2006, dokeos 1.8
@@ -4461,6 +4469,7 @@ 
 /**
  * Display the search results
  * @param string
+ * @param string $search_term
  * @return void display the results
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version march 2008, dokeos 1.8.5
@@ -4590,7 +4599,7 @@ 
  * This function adds an attachment file into a forum
  * @param string $file_comment  a comment about file
  * @param int $last_id from forum_post table
- * @return int|bool
+ * @return false|null
  */
 function add_forum_attachment_file($file_comment, $last_id)
 {
@@ -4801,7 +4810,7 @@ 
  * @param post id
  * @param int $id_attach
  * @param bool $display to show or not result message
- * @return void
+ * @return integer
  * @author Julio Montoya Dokeos
  * @version october 2014, chamilo 1.9.8
  */
@@ -5083,7 +5092,7 @@ 
  * @param integer $forum_id the id of the forum
  * @param integer $thread_id the id of the thread
  * @param integer $post_id the id of the post
- * @return bool
+ * @return false|null
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version May 2008, dokeos 1.8.5