chamilo / chamilo-lms

main/survey/survey.lib.php

Doc Comments +19 added lines, -16 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
      *
@@ -1838,7 +1838,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
      */
@@ -2392,6 +2392,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)
@@ -3032,7 +3033,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
      */
@@ -3254,7 +3255,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,
@@ -3560,6 +3561,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
@@ -3854,7 +3856,7 @@ 
 
     /**
      * @param $params
-     * @return bool|int
+     * @return false|string
      */
     public static function save_invitation($params)
     {
@@ -3908,6 +3910,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)
@@ -4802,7 +4805,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
      */
@@ -4975,7 +4978,7 @@ 
     /**
      * Check if the current survey has answers
      *
-     * @param $surveyId
+     * @param integer $surveyId
      * @return boolean return true if the survey has answers, false otherwise
      */
     public static function checkIfSurveyHasAnswers($surveyId)

main/survey/survey_question.php

Spacing +6 added lines, -6 removed lines

@@ -64,7 +64,7 @@ 
         if ($surveyData['survey_type'] == 1) {
             $table_survey_question_group = Database::get_course_table(TABLE_SURVEY_QUESTION_GROUP);
             $sql = 'SELECT id,name FROM '.$table_survey_question_group.'
-                    WHERE survey_id = '.(int)$_GET['survey_id'].'
+                    WHERE survey_id = '.(int) $_GET['survey_id'].'
                     ORDER BY name';
             $rs = Database::query($sql);
             $glist = null;
@@ -75,15 +75,15 @@ 
             $grouplist = $grouplist1 = $grouplist2 = $glist;
 
             if (!empty($formData['assigned'])) {
-                $grouplist = str_replace('<option value="'.$formData['assigned'].'"','<option value="'.$formData['assigned'].'" selected',$glist);
+                $grouplist = str_replace('<option value="'.$formData['assigned'].'"', '<option value="'.$formData['assigned'].'" selected', $glist);
             }
 
             if (!empty($formData['assigned1'])) {
-                $grouplist1 = str_replace('<option value="'.$formData['assigned1'].'"','<option value="'.$formData['assigned1'].'" selected',$glist);
+                $grouplist1 = str_replace('<option value="'.$formData['assigned1'].'"', '<option value="'.$formData['assigned1'].'" selected', $glist);
             }
 
             if (!empty($formData['assigned2'])) {
-                $grouplist2 = str_replace('<option value="'.$formData['assigned2'].'"','<option value="'.$formData['assigned2'].'" selected',$glist);
+                $grouplist2 = str_replace('<option value="'.$formData['assigned2'].'"', '<option value="'.$formData['assigned2'].'" selected', $glist);
             }
 
             $this->html .= '	<tr><td colspan="">
@@ -95,7 +95,7 @@ 
 
             $this->html .= '
 			<b>'.get_lang('Secondary').'</b><br />
-			'.'<input type="radio" name="choose" value="2" '.(($formData['choose']==2)?'checked':'').
+			'.'<input type="radio" name="choose" value="2" '.(($formData['choose'] == 2) ? 'checked' : '').
                 '><select name="assigned1">'.$grouplist1.'</select> '.
                 '<select name="assigned2">'.$grouplist2.'</select>'
                 .'</fieldset><br />';
@@ -131,7 +131,7 @@ 
                     <div class="form-group">
                         <label class="col-sm-2 control-label"></label>
                         <div class="col-sm-8">
-                            <div class="alert alert-info">' . get_lang('YouCantNotEditThisQuestionBecauseAlreadyExistAnswers') . '</div>
+                            <div class="alert alert-info">' . get_lang('YouCantNotEditThisQuestionBecauseAlreadyExistAnswers').'</div>
                         </div>
                         <div class="col-sm-2"></div>
                     </div>