chamilo / chamilo-lms

main/inc/lib/course_description.lib.php

Doc Comments +5 added lines, -5 removed lines

@@ -359,7 +359,7 @@ 
 
     /**
      * Get description titles by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_title()
     {
@@ -378,7 +378,7 @@ 
 
     /**
      * Get description titles editable by default
-     * @return array
+     * @return boolean[]
      */
     public function get_default_description_title_editable()
     {
@@ -397,7 +397,7 @@ 
 
     /**
      * Get description icons by default
-     * @return array
+     * @return string[]
      */
     public function get_default_description_icon()
     {
@@ -417,7 +417,7 @@ 
 
     /**
      * Get questions by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_question()
     {
@@ -436,7 +436,7 @@ 
 
     /**
      * Get informations by default for help
-     * @return array
+     * @return string[]
      */
     public function get_default_information()
     {

main/inc/lib/exercise_show_functions.lib.php

Doc Comments +36 added lines, -4 removed lines

@@ -25,6 +25,7 @@ 
 	 * @param int $questionId      Question ID
      * @param int $resultsDisabled
      * @param string $originalStudentAnswer
+     * @param boolean $showTotalScoreAndUserChoices
      *
 	 * @return void
 	 */
@@ -71,6 +72,11 @@ 
      * @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
+     * @param boolean|string $showTotalScoreAndUserChoices
      * @return void
      */
     public static function display_calculated_answer(
@@ -110,6 +116,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
 	 */
 	public static function display_free_answer(
@@ -139,11 +148,10 @@ 
 	}
 
     /**
-    * @param $feedback_type
+    * @param integer $feedback_type
     * @param $answer
-    * @param $id
-    * @param $questionId
-    * @param null $nano
+    * @param integer $id
+    * @param integer $questionId
     * @param int $results_disabled
      */
 	public static function display_oral_expression_answer($feedback_type, $answer, $id, $questionId, $fileUrl = null, $results_disabled = 0)
@@ -193,6 +201,7 @@ 
      * @param string $answerComment
      * @param int $resultsDisabled
      * @param int $orderColor
+     * @param boolean $showTotalScoreAndUserChoices
      */
 	public static function display_hotspot_answer(
         $feedback_type,
@@ -277,6 +286,13 @@ 
 	 * @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
+	 * @param boolean $showTotalScoreAndUserChoices
 	 * @return void
 	 */
 	public static function display_unique_or_multiple_answer(
@@ -373,6 +389,14 @@ 
      * @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
+     * @param boolean $showTotalScoreAndUserChoices
      * @return void
      */
     public static function display_multiple_answer_true_false(
@@ -477,6 +501,14 @@ 
      * @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
+     * @param boolean $showTotalScoreAndUserChoices
      * @return void
      */
     public static function display_multiple_answer_combination_true_false(

main/inc/lib/plugin.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -256,7 +256,7 @@ 
     * @param string $template
     * @param bool   $forced
     *
-    * @return null|string
+    * @return string
     */
     public function load_region($region, $template, $forced = false)
     {
@@ -628,7 +628,7 @@ 
 
     /**
      * Get first SMS plugin name
-     * @return string|boolean
+     * @return string|false
      */
     public function getSMSPluginName()
     {

src/Chamilo/CoreBundle/Component/Filesystem/Data.php

Doc Comments +2 added lines, -2 removed lines

@@ -116,7 +116,7 @@ 
 
     /**
      * Create folders
-     * @param array            $folderList
+     * @param string[]            $folderList
      * @param OutputInterface  $output
      * @param string           $folderPermissions
      */
@@ -200,7 +200,7 @@ 
      * http://chamilo/courses/ABC/document/file.jpg
      * @param string $content
      *
-     * @return string
+     * @return \simplehtmldom_1_5\simple_html_dom
      */
     public function convertRelativeToAbsoluteUrl($content)
     {

src/Chamilo/CoreBundle/Entity/SkillRelUser.php

Doc Comments +2 added lines, -2 removed lines

@@ -197,7 +197,7 @@ 
 
     /**
      * Get user
-     * @return \User
+     * @return User
      */
     public function getUser()
     {
@@ -512,7 +512,7 @@ 
 
     /**
      * Calculate the average value from the feedback comments
-     * @return int
+     * @return string
      */
     public function getAverage()
     {

src/Chamilo/CoreBundle/Entity/SkillRelUserComment.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
 
     /**
      * Get feedbackDateTime
-     * @return type
+     * @return \DateTime
      */
     public function getFeedbackDateTime()
     {

main/survey/survey.lib.php

Doc Comments +17 added lines, -14 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
@@ -1562,8 +1562,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
      *
@@ -1832,7 +1832,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
      */
@@ -2383,6 +2383,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)
@@ -3223,7 +3224,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,
@@ -3532,6 +3533,7 @@ 
      *
      * @param	integer	Survey ID
      * @param	integer	Question ID
+     * @param integer $survey_id
      * @return 	Array	Array containing all answers of all users, grouped by user
      *
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -3826,7 +3828,7 @@ 
 
     /**
      * @param $params
-     * @return bool|int
+     * @return false|string
      */
     public static function save_invitation($params)
     {
@@ -3880,6 +3882,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)
@@ -4786,7 +4789,7 @@ 
      * @author Isaac Flores Paz <florespaz@bidsoftperu.com>
      * @param int $user_id - User ID
      * @param string $survey_code
-     * @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
      */

main/admin/class_import.php

Doc Comments +2 added lines

@@ -11,6 +11,7 @@ 
 
 /**
  * Validates imported data.
+ * @param Ddeboer\DataImport\Reader\CsvReader $classes
  */
 function validate_data($classes) {
     $errors = array();
@@ -35,6 +36,7 @@ 
 
 /**
  * Save imported class data to database
+ * @param Ddeboer\DataImport\Reader\CsvReader $classes
  */
 function save_data($classes) {
     $number_of_added_classes = 0;

main/admin/course_import.php

Doc Comments +1 added lines, -1 removed lines

@@ -151,7 +151,7 @@
 /**
  * Read the CSV-file
  * @param string $file Path to the CSV-file
- * @return array All course-information read from the file
+ * @return Ddeboer\DataImport\Reader\CsvReader All course-information read from the file
  */
 function parse_csv_data($file)
 {