chamilo / chamilo-lms

main/inc/lib/exercise.lib.php

Doc Comments +9 added lines, -6 removed lines

@@ -1255,6 +1255,7 @@ 
 
     /**
      * Validates the time control key
+     * @param integer $exercise_id
      */
     public static function exercise_time_control_is_valid(
         $exercise_id,
@@ -1388,7 +1389,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(
@@ -2179,7 +2180,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 $in_pass_pourcentage
+     * @param string $in_pass_pourcentage
      * @return boolean
      * In this version, pass_percentage and show_success_message are disabled if
      * pass_percentage is set to 0
@@ -2192,7 +2193,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)
     {
@@ -2208,7 +2209,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)
     {
@@ -2759,6 +2760,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(
@@ -3198,8 +3200,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)
@@ -3805,7 +3808,7 @@ 
 
     /**
      * @param int $countLetter
-     * @return mixed
+     * @return string
      */
     public static function detectInputAppropriateClass($countLetter)
     {

Spacing +114 added lines, -114 removed lines

@@ -67,7 +67,7 @@ 
                 if ($show_title) {
                     TestCategory::displayCategoryAndTitle($objQuestionTmp->id);
                     echo Display::div(
-                        $current_item . '. ' . $objQuestionTmp->selectTitle(),
+                        $current_item.'. '.$objQuestionTmp->selectTitle(),
                         array('class' => 'question_title')
                     );
                 }
@@ -112,7 +112,7 @@ 
                         <div class="clearfix">
                         <ul class="exercise-draggable-answer ui-helper-reset ui-helper-clearfix">';
                 } else {
-                    $s .= '<div id="drag' . $questionId . '_question" class="drag_question">
+                    $s .= '<div id="drag'.$questionId.'_question" class="drag_question">
                            <table class="data_table">';
                 }
 
@@ -159,12 +159,12 @@ 
             } elseif ($answerType == FREE_ANSWER) {
                 $fck_content = isset($user_choice[0]) && !empty($user_choice[0]['answer']) ? $user_choice[0]['answer'] : null;
 
-                $form = new FormValidator('free_choice_' . $questionId);
+                $form = new FormValidator('free_choice_'.$questionId);
                 $config = array(
                     'ToolbarSet' => 'TestFreeAnswer'
                 );
-                $form->addHtmlEditor("choice[" . $questionId . "]", null, false, false, $config);
-                $form->setDefaults(array("choice[" . $questionId . "]" => $fck_content));
+                $form->addHtmlEditor("choice[".$questionId."]", null, false, false, $config);
+                $form->setDefaults(array("choice[".$questionId."]" => $fck_content));
                 $s .= $form->returnForm();
             } elseif ($answerType == ORAL_EXPRESSION) {
                 // Add nanog
@@ -189,11 +189,11 @@ 
                     echo $nano->show_button();
                 }
 
-                $form = new FormValidator('free_choice_' . $questionId);
+                $form = new FormValidator('free_choice_'.$questionId);
                 $config = array(
                     'ToolbarSet' => 'TestFreeAnswer'
                 );
-                $form->addHtmlEditor("choice[" . $questionId . "]", null, false, false, $config);
+                $form->addHtmlEditor("choice[".$questionId."]", null, false, false, $config);
                 //$form->setDefaults(array("choice[" . $questionId . "]" => $fck_content));
                 $s .= $form->returnForm();
             }
@@ -278,7 +278,7 @@ 
                     case UNIQUE_ANSWER_NO_OPTION:
                         //no break
                     case UNIQUE_ANSWER_IMAGE:
-                        $input_id = 'choice-' . $questionId . '-' . $answerId;
+                        $input_id = 'choice-'.$questionId.'-'.$answerId;
 
                         if (isset($user_choice[0]['answer']) && $user_choice[0]['answer'] == $numAnswer) {
                             $attributes = array(
@@ -304,14 +304,14 @@ 
                         if ($answerType == UNIQUE_ANSWER_IMAGE) {
                             if ($show_comment) {
                                 if (empty($comment)) {
-                                    $s .= '<div id="answer' . $questionId . $numAnswer . '" '
+                                    $s .= '<div id="answer'.$questionId.$numAnswer.'" '
                                         . 'class="exercise-unique-answer-image" style="text-align: center">';
                                 } else {
-                                    $s .= '<div id="answer' . $questionId . $numAnswer . '" '
+                                    $s .= '<div id="answer'.$questionId.$numAnswer.'" '
                                         . 'class="exercise-unique-answer-image col-xs-6 col-sm-12" style="text-align: center">';
                                 }
                             } else {
-                                $s .= '<div id="answer' . $questionId . $numAnswer . '" '
+                                $s .= '<div id="answer'.$questionId.$numAnswer.'" '
                                     . 'class="exercise-unique-answer-image col-xs-6 col-md-3" style="text-align: center">';
                             }
                         }
@@ -319,7 +319,7 @@ 
                         $answer = Security::remove_XSS($answer, STUDENT);
                         $s .= Display::input(
                             'hidden',
-                            'choice2[' . $questionId . ']',
+                            'choice2['.$questionId.']',
                             '0'
                         );
 
@@ -327,13 +327,13 @@ 
 
                         if ($answerType == UNIQUE_ANSWER_IMAGE) {
                             $attributes['style'] = 'display: none;';
-                            $answer = '<div class="thumbnail">' . $answer . '</div>';
+                            $answer = '<div class="thumbnail">'.$answer.'</div>';
                         }
 
                         $answer_input .= '<label class="radio">';
                         $answer_input .= Display::input(
                             'radio',
-                            'choice[' . $questionId . ']',
+                            'choice['.$questionId.']',
                             $numAnswer,
                             $attributes
                         );
@@ -360,7 +360,7 @@ 
                     case MULTIPLE_ANSWER_TRUE_FALSE:
                         //no break
                     case GLOBAL_MULTIPLE_ANSWER:
-                        $input_id = 'choice-' . $questionId . '-' . $answerId;
+                        $input_id = 'choice-'.$questionId.'-'.$answerId;
                         $answer = Security::remove_XSS($answer, STUDENT);
 
                         if (in_array($numAnswer, $user_choice_array)) {
@@ -381,12 +381,12 @@ 
                         }
 
                         if ($answerType == MULTIPLE_ANSWER || $answerType == GLOBAL_MULTIPLE_ANSWER) {
-                            $s .= '<input type="hidden" name="choice2[' . $questionId . ']" value="0" />';
+                            $s .= '<input type="hidden" name="choice2['.$questionId.']" value="0" />';
 
                             $answer_input = '<label class="checkbox">';
                             $answer_input .= Display::input(
                                 'checkbox',
-                                'choice[' . $questionId . '][' . $numAnswer . ']',
+                                'choice['.$questionId.']['.$numAnswer.']',
                                 $numAnswer,
                                 $attributes
                             );
@@ -439,7 +439,7 @@ 
                                         'td',
                                         Display::input(
                                             'radio',
-                                            'choice[' . $questionId . '][' . $numAnswer . ']',
+                                            'choice['.$questionId.']['.$numAnswer.']',
                                             $id,
                                             $attributes
                                         ),
@@ -458,7 +458,7 @@ 
                         break;
                     case MULTIPLE_ANSWER_COMBINATION:
                         // multiple answers
-                        $input_id = 'choice-' . $questionId . '-' . $answerId;
+                        $input_id = 'choice-'.$questionId.'-'.$answerId;
 
                         if (in_array($numAnswer, $user_choice_array)) {
                             $attributes = array(
@@ -478,11 +478,11 @@ 
                         }
 
                         $answer = Security::remove_XSS($answer, STUDENT);
-                        $answer_input = '<input type="hidden" name="choice2[' . $questionId . ']" value="0" />';
+                        $answer_input = '<input type="hidden" name="choice2['.$questionId.']" value="0" />';
                         $answer_input .= '<label class="checkbox">';
                         $answer_input .= Display::input(
                             'checkbox',
-                            'choice[' . $questionId . '][' . $numAnswer . ']',
+                            'choice['.$questionId.']['.$numAnswer.']',
                             1,
                             $attributes
                         );
@@ -503,7 +503,7 @@ 
                         }
                         break;
                     case MULTIPLE_ANSWER_COMBINATION_TRUE_FALSE:
-                        $s .= '<input type="hidden" name="choice2[' . $questionId . ']" value="0" />';
+                        $s .= '<input type="hidden" name="choice2['.$questionId.']" value="0" />';
 
                         $my_choice = array();
                         if (!empty($user_choice_array)) {
@@ -538,7 +538,7 @@ 
                                 'td',
                                 Display::input(
                                     'radio',
-                                    'choice[' . $questionId . '][' . $numAnswer . ']',
+                                    'choice['.$questionId.']['.$numAnswer.']',
                                     $key,
                                     $attributes
                                 )
@@ -595,7 +595,7 @@ 
                                     // may be "" if student viewed the question, but did not fill the blanks
                                     $correctItem = $studentAnswerList[$i];
                                 }
-                                $attributes["style"] = "width:" . $listAnswerInformations["tabinputsize"][$i] . "px";
+                                $attributes["style"] = "width:".$listAnswerInformations["tabinputsize"][$i]."px";
                                 $answer .= FillBlanks::getFillTheBlankHtml($separatorStartRegexp, $separatorEndRegexp, $correctItemRegexp, $questionId, $correctItem, $attributes, $answer, $listAnswerInformations, $displayForStudent, $i);
                             }
                             // display the last common word
@@ -609,7 +609,7 @@ 
                                 // display the common words
                                 $answer .= $listAnswerInformations["commonwords"][$i];
                                 // display the blank word
-                                $attributes["style"] = "width:" . $listAnswerInformations["tabinputsize"][$i] . "px";
+                                $attributes["style"] = "width:".$listAnswerInformations["tabinputsize"][$i]."px";
                                 $correctItem = $listAnswerInformations["tabwords"][$i];
                                 $correctItemRegexp = $correctItem;
                                 // replace / with \/ to allow the preg_replace bellow and all the regexp char
@@ -635,8 +635,8 @@ 
                             $trackAttempts = Database::get_main_table(
                                 TABLE_STATISTIC_TRACK_E_ATTEMPT
                             );
-                            $sql = 'SELECT answer FROM ' . $trackAttempts . '
-                                WHERE exe_id=' . $exe_id . ' AND question_id=' . $questionId;
+                            $sql = 'SELECT answer FROM '.$trackAttempts.'
+                                WHERE exe_id=' . $exe_id.' AND question_id='.$questionId;
                             $rsLastAttempt = Database::query($sql);
                             $rowLastAttempt = Database::fetch_array($rsLastAttempt);
                             $answer = $rowLastAttempt['answer'];
@@ -693,7 +693,7 @@ 
                                     '',
                                     $answerCorrected
                                 );
-                                $answerCorrected = '[' . $answerCorrected . ']';
+                                $answerCorrected = '['.$answerCorrected.']';
                                 $studentAnswerList[] = $answerCorrected;
                             }
                         }
@@ -714,7 +714,7 @@ 
                         */
                         $tabComments = api_preg_split(
                             '/\[[^]]+\]/',
-                            ' ' . $answer . ' '
+                            ' '.$answer.' '
                         );
                         if (!empty($correctAnswerList) && !empty($studentAnswerList)) {
                             $answer = "";
@@ -731,7 +731,7 @@ 
                                     $size
                                 );
 
-                                $answer .= $tabComments[$i] .
+                                $answer .= $tabComments[$i].
                                     Display::input(
                                         'text',
                                         "choice[$questionId][]",
@@ -778,12 +778,12 @@ 
                             $s .= '<tr><td width="45%" valign="top">';
                             $parsed_answer = $answer;
                             //left part questions
-                            $s .= '<p class="indent">' . $lines_count . '.&nbsp;' . $parsed_answer . '</p></td>';
+                            $s .= '<p class="indent">'.$lines_count.'.&nbsp;'.$parsed_answer.'</p></td>';
                             //middle part (matches selects)
 
                             $s .= '<td width="10%" valign="top" align="center" >
                                 <div class="select-matching">
-                                <select name="choice[' . $questionId . '][' . $numAnswer . ']">';
+                                <select name="choice[' . $questionId.']['.$numAnswer.']">';
 
                             // fills the list-box
                             foreach ($select_items as $key => $val) {
@@ -799,14 +799,14 @@ 
                                 if (isset($user_choice_array_position[$numAnswer]) && $val['id'] == $user_choice_array_position[$numAnswer]) {
                                     $selected = 'selected="selected"';
                                 }
-                                $s .= '<option value="' . $val['id'] . '" ' . $selected . '>' . $val['letter'] . '</option>';
+                                $s .= '<option value="'.$val['id'].'" '.$selected.'>'.$val['letter'].'</option>';
 
                             }  // end foreach()
 
                             $s .= '</select></div></td><td width="5%" class="separate">&nbsp;</td>';
                             $s .= '<td width="40%" valign="top" >';
                             if (isset($select_items[$lines_count])) {
-                                $s .= '<div class="text-right"><p class="indent">' . $select_items[$lines_count]['letter'] . '.&nbsp; ' . $select_items[$lines_count]['answer'] . '</p></div>';
+                                $s .= '<div class="text-right"><p class="indent">'.$select_items[$lines_count]['letter'].'.&nbsp; '.$select_items[$lines_count]['answer'].'</p></div>';
                             } else {
                                 $s .= '&nbsp;';
                             }
@@ -821,7 +821,7 @@ 
                                     $s .= '<tr>
                                       <td colspan="2"></td>
                                       <td valign="top">';
-                                    $s .= '<b>' . $select_items[$lines_count]['letter'] . '.</b> ' . $select_items[$lines_count]['answer'];
+                                    $s .= '<b>'.$select_items[$lines_count]['letter'].'.</b> '.$select_items[$lines_count]['answer'];
                                     $s .= "</td>
                                 </tr>";
                                     $lines_count++;
@@ -838,9 +838,9 @@ 
                             $data = $objAnswerTmp->getAnswerByAutoId($data['correct']);
                             $lines_count = $data['answer'];*/
 
-                            $windowId = $questionId . '_' . $lines_count;
+                            $windowId = $questionId.'_'.$lines_count;
 
-                            $s .= '<li class="touch-items" id="' . $windowId . '">';
+                            $s .= '<li class="touch-items" id="'.$windowId.'">';
                             $s .= Display::div(
                                 $parsed_answer,
                                 [
@@ -898,7 +898,7 @@ 
                                     Display::tag(
                                         'b',
                                         $select_items[$lines_count]['letter']
-                                    ) . $select_items[$lines_count]['answer'],
+                                    ).$select_items[$lines_count]['answer'],
                                     [
                                         'id' => "window_{$windowId}_answer",
                                         'style' => 'display: none;'
@@ -1069,7 +1069,7 @@ 
 
                 for ($answerId = 1; $answerId <= $nbrAnswers; $answerId++) {
                     $answerCorrect = $objAnswerTmp->isCorrect($answerId);
-                    $windowId = $questionId . '_' . $counterAnswer;
+                    $windowId = $questionId.'_'.$counterAnswer;
 
                     if ($answerCorrect) {
                         $s .= Display::div(
@@ -1114,7 +1114,7 @@ 
                 $course = api_get_course_info();
                 $doc_id = DocumentManager::get_document_id(
                     $course,
-                    '/images/' . $pictureName
+                    '/images/'.$pictureName
                 );
                 if (is_numeric($doc_id)) {
                     $images_folder_visibility = api_get_item_visibility(
@@ -1139,7 +1139,7 @@ 
                 echo "
                     <script>
                         $(document).on('ready', function () {
-                            new " . ($answerType == HOT_SPOT ? "HotspotQuestion" : "DelineationQuestion") . "({
+                            new " . ($answerType == HOT_SPOT ? "HotspotQuestion" : "DelineationQuestion")."({
                                 questionId: $questionId,
                                 exerciseId: $exerciseId,
                                 selector: '#hotspot-preview-$questionId',
@@ -1173,7 +1173,7 @@ 
             if ($answerType != HOT_SPOT_DELINEATION) {
                 $answerList = '
                     <div class="well well-sm">
-                        <h5 class="page-header">' . get_lang('HotspotZones') . '</h5>
+                        <h5 class="page-header">' . get_lang('HotspotZones').'</h5>
                         <ol>
                 ';
 
@@ -1198,7 +1198,7 @@ 
             if (!$only_questions) {
                 if ($show_title) {
                     TestCategory::displayCategoryAndTitle($objQuestionTmp->id);
-                    echo '<div class="question_title">' . $current_item . '. ' . $questionName . '</div>';
+                    echo '<div class="question_title">'.$current_item.'. '.$questionName.'</div>';
                 }
                 //@todo I need to the get the feedback type
                 echo <<<HOTSPOT
@@ -1215,7 +1215,7 @@ 
                                 <div class=\"hotspot-image\"></div>
                                 <script>
                                     $(document).on('ready', function () {
-                                        new " . ($answerType == HOT_SPOT_DELINEATION ? 'DelineationQuestion' : 'HotspotQuestion') . "({
+                                        new " . ($answerType == HOT_SPOT_DELINEATION ? 'DelineationQuestion' : 'HotspotQuestion')."({
                                             questionId: $questionId,
                                             exerciseId: $exe_id,
                                             selector: '#question_div_' + $questionId + ' .hotspot-image',
@@ -1336,11 +1336,11 @@ 
         $lp_id = intval($lp_id);
         $lp_item_id = intval($lp_item_id);
         return
-            api_get_course_int_id() . '_' .
-            api_get_session_id() . '_' .
-            $exercise_id . '_' .
-            api_get_user_id() . '_' .
-            $lp_id . '_' .
+            api_get_course_int_id().'_'.
+            api_get_session_id().'_'.
+            $exercise_id.'_'.
+            api_get_user_id().'_'.
+            $lp_id.'_'.
             $lp_item_id;
     }
 
@@ -1454,14 +1454,14 @@ 
         $res = Database::query($sql);
         $result = array();
         $apiIsAllowedToEdit = api_is_allowed_to_edit();
-        $urlBase = api_get_path(WEB_CODE_PATH) .
-            'exercice/hotpotatoes_exercise_report.php?action=delete&' .
-            api_get_cidreq() . '&id=';
+        $urlBase = api_get_path(WEB_CODE_PATH).
+            'exercice/hotpotatoes_exercise_report.php?action=delete&'.
+            api_get_cidreq().'&id=';
         while ($data = Database::fetch_array($res)) {
             $actions = null;
 
             if ($apiIsAllowedToEdit) {
-                $url = $urlBase . $data['id'] . '&path=' . $data['exe_name'];
+                $url = $urlBase.$data['id'].'&path='.$data['exe_name'];
                 $actions = Display::url(
                     Display::return_icon('delete.png', get_lang('Delete')),
                     $url
@@ -1477,7 +1477,7 @@ 
                     GroupManager::get_user_group_name($data['user_id'])
                 ),
                 'exe_date' => $data['exe_date'],
-                'score' => $data['exe_result'] . ' / ' . $data['exe_weighting'],
+                'score' => $data['exe_result'].' / '.$data['exe_weighting'],
                 'actions' => $actions,
             );
         }
@@ -1562,18 +1562,18 @@ 
         $TBL_TRACK_HOTPOTATOES = Database:: get_main_table(TABLE_STATISTIC_TRACK_E_HOTPOTATOES);
         $TBL_TRACK_ATTEMPT_RECORDING = Database:: get_main_table(TABLE_STATISTIC_TRACK_E_ATTEMPT_RECORDING);
 
-        $session_id_and = ' AND te.session_id = ' . $sessionId . ' ';
+        $session_id_and = ' AND te.session_id = '.$sessionId.' ';
         $exercise_id = intval($exercise_id);
 
         $exercise_where = '';
         if (!empty($exercise_id)) {
-            $exercise_where .= ' AND te.exe_exo_id = ' . $exercise_id . '  ';
+            $exercise_where .= ' AND te.exe_exo_id = '.$exercise_id.'  ';
         }
 
         $hotpotatoe_where = '';
         if (!empty($_GET['path'])) {
             $hotpotatoe_path = Database::escape_string($_GET['path']);
-            $hotpotatoe_where .= ' AND exe_name = "' . $hotpotatoe_path . '"  ';
+            $hotpotatoe_where .= ' AND exe_name = "'.$hotpotatoe_path.'"  ';
         }
 
         // sql for chamilo-type tests for teacher / tutor view
@@ -1585,7 +1585,7 @@ 
             WHERE
                 c_id = $course_id AND
                 exe_exo_id = $exercise_id AND
-                ttte.session_id = " . $sessionId . "
+                ttte.session_id = ".$sessionId."
         )";
 
         if ($is_allowedToEdit) {
@@ -1608,9 +1608,9 @@ 
                         g.id as group_id
                     FROM $TBL_USER u
                     INNER JOIN $TBL_GROUP_REL_USER gru
-                    ON (gru.user_id = u.user_id AND gru.c_id=" . $course_id . ")
+                    ON (gru.user_id = u.user_id AND gru.c_id=".$course_id.")
                     INNER JOIN $TBL_GROUP g
-                    ON (gru.group_id = g.id AND g.c_id=" . $course_id . ")
+                    ON (gru.group_id = g.id AND g.c_id=".$course_id.")
                 )";
             }
 
@@ -1672,9 +1672,9 @@ 
                     g.id as group_id
                 FROM $TBL_USER u
                 LEFT OUTER JOIN $TBL_GROUP_REL_USER gru
-                ON ( gru.user_id = u.user_id AND gru.c_id=" . $course_id . " )
+                ON ( gru.user_id = u.user_id AND gru.c_id=".$course_id." )
                 LEFT OUTER JOIN $TBL_GROUP g
-                ON (gru.group_id = g.id AND g.c_id = " . $course_id . ")
+                ON (gru.group_id = g.id AND g.c_id = ".$course_id.")
             )";
             }
 
@@ -1687,12 +1687,12 @@ 
             (
                 SELECT u.user_id, firstname, lastname, email, username, ' ' as group_name, '' as group_id, official_code
                 FROM $TBL_USER u
-                WHERE u.status NOT IN(" . api_get_users_status_ignored_in_reports('string') . ")
+                WHERE u.status NOT IN(".api_get_users_status_ignored_in_reports('string').")
             )";
             }
 
             $sqlFromOption = " , $TBL_GROUP_REL_USER AS gru ";
-            $sqlWhereOption = "  AND gru.c_id = " . $course_id . " AND gru.user_id = user.user_id ";
+            $sqlWhereOption = "  AND gru.c_id = ".$course_id." AND gru.user_id = user.user_id ";
             $first_and_last_name = api_is_western_name_order() ? "firstname, lastname" : "lastname, firstname";
 
             if ($get_count) {
@@ -1729,8 +1729,8 @@ 
                 ON (user.user_id = exe_user_id)
                 WHERE
                     te.status != 'incomplete' AND
-                    te.c_id = " . $course_id . " $session_id_and AND
-                    ce.active <>-1 AND ce.c_id = " . $course_id . "
+                    te.c_id = ".$course_id." $session_id_and AND
+                    ce.active <>-1 AND ce.c_id = ".$course_id."
                     $exercise_where
                     $extra_where_conditions
                 ";
@@ -1757,12 +1757,12 @@ 
                     $sqlFromOption
                 WHERE
                     user.user_id=tth.exe_user_id
-                    AND tth.c_id = " . $course_id . "
+                    AND tth.c_id = ".$course_id."
                     $hotpotatoe_where
                     $sqlWhereOption
-                    AND user.status NOT IN(" . api_get_users_status_ignored_in_reports(
+                    AND user.status NOT IN(".api_get_users_status_ignored_in_reports(
                     'string'
-                ) . ")
+                ).")
                 ORDER BY
                     tth.c_id ASC,
                     tth.exe_date DESC";
@@ -1835,12 +1835,12 @@ 
 
                     if ($from_gradebook && ($is_allowedToEdit)) {
                         if (in_array(
-                            $results[$i]['username'] . $results[$i]['firstname'] . $results[$i]['lastname'],
+                            $results[$i]['username'].$results[$i]['firstname'].$results[$i]['lastname'],
                             $users_array_id
                         )) {
                             continue;
                         }
-                        $users_array_id[] = $results[$i]['username'] . $results[$i]['firstname'] . $results[$i]['lastname'];
+                        $users_array_id[] = $results[$i]['username'].$results[$i]['firstname'].$results[$i]['lastname'];
                     }
 
                     $lp_obj = isset($results[$i]['orig_lp_id']) && isset($lp_list[$results[$i]['orig_lp_id']]) ? $lp_list[$results[$i]['orig_lp_id']] : null;
@@ -1849,7 +1849,7 @@ 
                     if ($lp_obj) {
                         $url = api_get_path(
                                 WEB_CODE_PATH
-                            ) . 'newscorm/lp_controller.php?' . api_get_cidreq() . '&action=view&lp_id=' . $results[$i]['orig_lp_id'];
+                            ).'newscorm/lp_controller.php?'.api_get_cidreq().'&action=view&lp_id='.$results[$i]['orig_lp_id'];
                         $lp_name = Display::url(
                             $lp_obj['lp_name'],
                             $url,
@@ -1867,7 +1867,7 @@ 
                         );
 
                         foreach ($group_list as $id) {
-                            $group_name_list .= $clean_group_list[$id] . '<br/>';
+                            $group_name_list .= $clean_group_list[$id].'<br/>';
                         }
                         $results[$i]['group_name'] = $group_name_list;
                     }
@@ -1923,7 +1923,7 @@ 
                                 }
                             }
                             if ($revised) {
-                                $actions .= "<a href='exercise_show.php?" . api_get_cidreq() . "&action=edit&id=$id'>" .
+                                $actions .= "<a href='exercise_show.php?".api_get_cidreq()."&action=edit&id=$id'>".
                                     Display:: return_icon(
                                         'edit.png',
                                         get_lang('Edit'),
@@ -1932,7 +1932,7 @@ 
                                     );
                                 $actions .= '&nbsp;';
                             } else {
-                                $actions .= "<a href='exercise_show.php?" . api_get_cidreq() . "&action=qualify&id=$id'>" .
+                                $actions .= "<a href='exercise_show.php?".api_get_cidreq()."&action=qualify&id=$id'>".
                                     Display:: return_icon(
                                         'quiz.gif',
                                         get_lang('Qualify')
@@ -1942,11 +1942,11 @@ 
                             $actions .= "</a>";
 
                             if ($filter == 2) {
-                                $actions .= ' <a href="exercise_history.php?' . api_get_cidreq() . '&exe_id=' . $id . '">' .
+                                $actions .= ' <a href="exercise_history.php?'.api_get_cidreq().'&exe_id='.$id.'">'.
                                     Display:: return_icon(
                                         'history.gif',
                                         get_lang('ViewHistoryChange')
-                                    ) . '</a>';
+                                    ).'</a>';
                             }
 
                             //Admin can always delete the attempt
@@ -1957,31 +1957,31 @@ 
                                     date('Y-m-d h:i:s'),
                                     false
                                 );
-                                $actions .= '<a href="http://www.whatsmyip.org/ip-geo-location/?ip=' . $ip . '" target="_blank">
-                                ' . Display::return_icon('info.png', $ip) . '
+                                $actions .= '<a href="http://www.whatsmyip.org/ip-geo-location/?ip='.$ip.'" target="_blank">
+                                ' . Display::return_icon('info.png', $ip).'
                                 </a>';
 
-                                $delete_link = '<a href="exercise_report.php?' . api_get_cidreq() . '&filter_by_user=' . intval($_GET['filter_by_user']) . '&filter=' . $filter . '&exerciseId=' . $exercise_id . '&delete=delete&did=' . $id . '"
+                                $delete_link = '<a href="exercise_report.php?'.api_get_cidreq().'&filter_by_user='.intval($_GET['filter_by_user']).'&filter='.$filter.'&exerciseId='.$exercise_id.'&delete=delete&did='.$id.'"
                                 onclick="javascript:if(!confirm(\'' . sprintf(
                                         get_lang('DeleteAttempt'),
                                         $results[$i]['username'],
                                         $dt
-                                    ) . '\')) return false;">' . Display:: return_icon(
+                                    ).'\')) return false;">'.Display:: return_icon(
                                         'delete.png',
                                         get_lang('Delete')
-                                    ) . '</a>';
+                                    ).'</a>';
                                 $delete_link = utf8_encode($delete_link);
 
                                 if (api_is_drh() && !api_is_platform_admin()) {
                                     $delete_link = null;
                                 }
-                                $actions .= $delete_link . '&nbsp;';
+                                $actions .= $delete_link.'&nbsp;';
                             }
 
                         } else {
                             $attempt_url = api_get_path(
                                     WEB_CODE_PATH
-                                ) . 'exercice/result.php?' . api_get_cidreq() . '&id=' . $results[$i]['exe_id'] . '&id_session=' . $sessionId;
+                                ).'exercice/result.php?'.api_get_cidreq().'&id='.$results[$i]['exe_id'].'&id_session='.$sessionId;
                             $attempt_link = Display::url(
                                 get_lang('Show'),
                                 $attempt_url,
@@ -2038,7 +2038,7 @@ 
                     $hp_result = round(
                             ($hpresults[$i][4] / ($hpresults[$i][5] != 0 ? $hpresults[$i][5] : 1)) * 100,
                             2
-                        ) . '% (' . $hpresults[$i][4] . ' / ' . $hpresults[$i][5] . ')';
+                        ).'% ('.$hpresults[$i][4].' / '.$hpresults[$i][5].')';
                     if ($is_allowedToEdit) {
                         $list_info[] = array(
                             $hpresults[$i][0],
@@ -2112,13 +2112,13 @@ 
 
         $html = null;
         if ($show_percentage) {
-            $parent = '(' . $score . ' / ' . $weight . ')';
-            $html = $percentage . "%  $parent";
+            $parent = '('.$score.' / '.$weight.')';
+            $html = $percentage."%  $parent";
             if ($show_only_percentage) {
-                $html = $percentage . "% ";
+                $html = $percentage."% ";
             }
         } else {
-            $html = $score . ' / ' . $weight;
+            $html = $score.' / '.$weight;
         }
         $html = Display::span($html, array('class' => 'score_exercise'));
 
@@ -2212,7 +2212,7 @@ 
     {
         $return = '-';
         if ($value != '') {
-            $return = float_format($value * 100, 1) . ' %';
+            $return = float_format($value * 100, 1).' %';
         }
         return $return;
     }
@@ -2291,7 +2291,7 @@ 
         }
 
         $needle_where = !empty($search) ? " AND title LIKE '?' " : '';
-        $needle = !empty($search) ? "%" . $search . "%" : '';
+        $needle = !empty($search) ? "%".$search."%" : '';
 
         // Show courses by active status
         $active_sql = '';
@@ -2306,7 +2306,7 @@ 
         if ($search_all_sessions == true) {
             $conditions = array(
                 'where' => array(
-                    $active_sql . ' c_id = ? ' . $needle_where . $time_conditions => array(
+                    $active_sql.' c_id = ? '.$needle_where.$time_conditions => array(
                         $course_id,
                         $needle
                     )
@@ -2317,7 +2317,7 @@ 
             if ($session_id == 0) {
                 $conditions = array(
                     'where' => array(
-                        $active_sql . ' session_id = ? AND c_id = ? ' . $needle_where . $time_conditions => array(
+                        $active_sql.' session_id = ? AND c_id = ? '.$needle_where.$time_conditions => array(
                             $session_id,
                             $course_id,
                             $needle
@@ -2328,7 +2328,7 @@ 
             } else {
                 $conditions = array(
                     'where' => array(
-                        $active_sql . ' (session_id = 0 OR session_id = ? ) AND c_id = ? ' . $needle_where . $time_conditions => array(
+                        $active_sql.' (session_id = 0 OR session_id = ? ) AND c_id = ? '.$needle_where.$time_conditions => array(
                             $session_id,
                             $course_id,
                             $needle
@@ -2509,7 +2509,7 @@ 
 
             if ($return_string) {
                 if (!empty($position) && !empty($my_ranking)) {
-                    $return_value = $position . '/' . count($my_ranking);
+                    $return_value = $position.'/'.count($my_ranking);
                 } else {
                     $return_value = '-';
                 }
@@ -2590,7 +2590,7 @@ 
 
             if ($return_string) {
                 if (!empty($position) && !empty($my_ranking)) {
-                    return $position . '/' . count($my_ranking);
+                    return $position.'/'.count($my_ranking);
                 }
             }
             return $return_value;
@@ -2996,7 +2996,7 @@ 
             $courseCondition = "
             INNER JOIN $courseUser cu
             ON cu.c_id = c.id AND cu.user_id  = exe_user_id";
-            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = " . STUDENT;
+            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = ".STUDENT;
         } else {
             $courseCondition = "
             INNER JOIN $courseUserSession cu
@@ -3072,7 +3072,7 @@ 
             $courseCondition = "
             INNER JOIN $courseUser cu
             ON cu.c_id = c.id AND cu.user_id  = exe_user_id";
-            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = " . STUDENT;
+            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = ".STUDENT;
         } else {
             $courseCondition = "
             INNER JOIN $courseUserSession cu
@@ -3165,7 +3165,7 @@ 
             $courseCondition = "
             INNER JOIN $courseUser cu
             ON cu.c_id = c.id AND cu.user_id  = exe_user_id";
-            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = " . STUDENT;
+            $courseConditionWhere = " AND relation_type <> 2 AND cu.status = ".STUDENT;
         } else {
             $courseCondition = "
             INNER JOIN $courseUserSession cu
@@ -3347,7 +3347,7 @@ 
                 }
             }
             // adds the correct word, followed by ] to close the blank
-            $answer .= ' / <font color="green"><b>' . $real_correct_tags[$i] . '</b></font>]';
+            $answer .= ' / <font color="green"><b>'.$real_correct_tags[$i].'</b></font>]';
             if (isset ($real_text[$i + 1])) {
                 $answer .= $real_text[$i + 1];
             }
@@ -3407,13 +3407,13 @@ 
         // check the default value of option
         $tabSelected = array($in_default => " selected='selected' ");
         $res = "";
-        $res .= "<select name='$in_name' id='$in_name' onchange='" . $in_onchange . "' >";
-        $res .= "<option value='-1'" . $tabSelected["-1"] . ">-- " . get_lang(
+        $res .= "<select name='$in_name' id='$in_name' onchange='".$in_onchange."' >";
+        $res .= "<option value='-1'".$tabSelected["-1"].">-- ".get_lang(
                 'AllGroups'
-            ) . " --</option>";
-        $res .= "<option value='0'" . $tabSelected["0"] . ">- " . get_lang(
+            )." --</option>";
+        $res .= "<option value='0'".$tabSelected["0"].">- ".get_lang(
                 'NotInAGroup'
-            ) . " -</option>";
+            )." -</option>";
         $tabGroups = GroupManager::get_group_list();
         $currentCatId = 0;
         for ($i = 0; $i < count($tabGroups); $i++) {
@@ -3421,10 +3421,10 @@ 
                 $tabGroups[$i]["id"]
             );
             if ($tabCategory["id"] != $currentCatId) {
-                $res .= "<option value='-1' disabled='disabled'>" . $tabCategory["title"] . "</option>";
+                $res .= "<option value='-1' disabled='disabled'>".$tabCategory["title"]."</option>";
                 $currentCatId = $tabCategory["id"];
             }
-            $res .= "<option " . $tabSelected[$tabGroups[$i]["id"]] . "style='margin-left:40px' value='" . $tabGroups[$i]["id"] . "'>" . $tabGroups[$i]["name"] . "</option>";
+            $res .= "<option ".$tabSelected[$tabGroups[$i]["id"]]."style='margin-left:40px' value='".$tabGroups[$i]["id"]."'>".$tabGroups[$i]["name"]."</option>";
         }
         $res .= "</select>";
         return $res;
@@ -3657,14 +3657,14 @@ 
                 if ($show_results) {
                     $comnt = Event::get_comments($exe_id, $questionId);
                     if (!empty($comnt)) {
-                        echo '<b>' . get_lang('Feedback') . '</b>';
-                        echo '<div id="question_feedback">' . $comnt . '</div>';
+                        echo '<b>'.get_lang('Feedback').'</b>';
+                        echo '<div id="question_feedback">'.$comnt.'</div>';
                     }
                 }
 
                 if ($show_results) {
                     $score = array(
-                        'result' => get_lang('Score') . " : " . self::show_score(
+                        'result' => get_lang('Score')." : ".self::show_score(
                                 $my_total_score,
                                 $my_total_weight,
                                 false,
@@ -3732,9 +3732,9 @@ 
         }
 
         if ($show_all_but_expected_answer) {
-            $exercise_content .= "<div class='normal-message'>" . get_lang(
+            $exercise_content .= "<div class='normal-message'>".get_lang(
                     "ExerciseWithFeedbackWithoutCorrectionComment"
-                ) . "</div>";
+                )."</div>";
         }
         // Remove audio auto play from questions on results page - refs BT#7939
         $exercise_content = preg_replace(
@@ -3834,11 +3834,11 @@ 
                     $ribbon_total_success_or_error = ' ribbon-total-error';
                 }
             }
-            $ribbon .= '<div class="total ' . $ribbon_total_success_or_error . '">';
+            $ribbon .= '<div class="total '.$ribbon_total_success_or_error.'">';
         } else {
             $ribbon .= '<div class="total">';
         }
-        $ribbon .= '<h3>' . get_lang('YourTotalScore') . ":&nbsp;";
+        $ribbon .= '<h3>'.get_lang('YourTotalScore').":&nbsp;";
         $ribbon .= self::show_score($score, $weight, false, true);
         $ribbon .= '</h3>';
         $ribbon .= '</div>';

main/inc/lib/export.lib.inc.php

Doc Comments +2 added lines, -2 removed lines

@@ -157,7 +157,7 @@ 
      * @param string Name of common tag to place each line in
      * @param string Name of the root element. A root element should always be given.
      * @param string Encoding in which the data is provided
-     * @return void  Prompts the user for a file download
+     * @return boolean  Prompts the user for a file download
      */
     public static function export_complex_table_xml(
         $data,
@@ -283,7 +283,7 @@ 
      * @param string $name
      * @param string $format
      *
-     * @return bool
+     * @return false|null
      */
     public static function htmlToOdt($html, $name, $format = 'odt')
     {

Indentation +11 added lines, -11 removed lines

@@ -56,7 +56,7 @@ 
 
         DocumentManager::file_send_for_download($filePath, true, $filename.'.csv');
         exit;
-	}
+    }
 
     /**
      * Export tabular data to XLS-file
@@ -79,7 +79,7 @@ 
 
         DocumentManager::file_send_for_download($filePath, true, $filename.'.xlsx');
         exit;
-	}
+    }
 
     /**
      * Export tabular data to XLS-file (as html table)
@@ -112,13 +112,13 @@ 
     }
 
     /**
-    * Export tabular data to XML-file
-    * @param array  Simple array of data to put in XML
-    * @param string Name of file to be given to the user
-    * @param string Name of common tag to place each line in
-    * @param string Name of the root element. A root element should always be given.
-    * @param string Encoding in which the data is provided
-    */
+     * Export tabular data to XML-file
+     * @param array  Simple array of data to put in XML
+     * @param string Name of file to be given to the user
+     * @param string Name of common tag to place each line in
+     * @param string Name of the root element. A root element should always be given.
+     * @param string Encoding in which the data is provided
+     */
     public static function arrayToXml(
         $data,
         $filename = 'export',
@@ -148,7 +148,7 @@ 
         fclose($handle);
         DocumentManager :: file_send_for_download($file, true, $filename.'.xml');
         exit;
-	}
+    }
 
     /**
      * Export hierarchical tabular data to XML-file
@@ -197,7 +197,7 @@ 
         foreach ($data as $row) {
             $string .= "\n".str_repeat("\t",$level).'<'.$row['name'].'>';
             if (is_array($row['value'])) {
-            	$string .= self::_export_complex_table_xml_helper($row['value'],$level+1)."\n";
+                $string .= self::_export_complex_table_xml_helper($row['value'],$level+1)."\n";
                 $string .= str_repeat("\t",$level).'</'.$row['name'].'>';
             } else {
                 $string .= $row['value'];

Spacing +5 added lines, -5 removed lines

@@ -99,7 +99,7 @@ 
         }
         foreach ($data as $row) {
             $string = implode("</td><td>", $row);
-            $string = '<tr><td>' . $string . '</td></tr>';
+            $string = '<tr><td>'.$string.'</td></tr>';
             if ($encoding != 'utf-8') {
                 $string = api_convert_encoding($string, $encoding, $systemEncoding);
             }
@@ -173,7 +173,7 @@ 
             fwrite($handle, '<'.$wrapper_tagname.'>');
         }
         $s = self::_export_complex_table_xml_helper($data);
-        fwrite($handle,$s);
+        fwrite($handle, $s);
         if (!is_null($wrapper_tagname)) {
             fwrite($handle, '</'.$wrapper_tagname.'>'."\n");
         }
@@ -195,10 +195,10 @@ 
         }
         $string = '';
         foreach ($data as $row) {
-            $string .= "\n".str_repeat("\t",$level).'<'.$row['name'].'>';
+            $string .= "\n".str_repeat("\t", $level).'<'.$row['name'].'>';
             if (is_array($row['value'])) {
-            	$string .= self::_export_complex_table_xml_helper($row['value'],$level+1)."\n";
-                $string .= str_repeat("\t",$level).'</'.$row['name'].'>';
+            	$string .= self::_export_complex_table_xml_helper($row['value'], $level + 1)."\n";
+                $string .= str_repeat("\t", $level).'</'.$row['name'].'>';
             } else {
                 $string .= $row['value'];
                 $string .= '</'.$row['name'].'>';

main/inc/lib/extra_field.lib.php

Doc Comments +8 added lines, -9 removed lines

@@ -123,7 +123,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getValidExtraFieldTypes()
     {
@@ -199,7 +199,7 @@ 
 
     /**
      * @param array $conditions
-     * @param null  $order_field_options_by
+     * @param string  $order_field_options_by
      *
      * @return array
      */
@@ -237,7 +237,7 @@ 
     /**
      * @param string $variable
      *
-     * @return array|bool
+     * @return integer
      */
     public function get_handler_field_info_by_field_variable($variable)
     {
@@ -319,7 +319,7 @@ 
     /**
      * @param string $handler
      *
-     * @return array
+     * @return string[]
      */
     public static function get_extra_fields_by_handler($handler)
     {
@@ -496,7 +496,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_field_types()
     {
@@ -506,7 +506,7 @@ 
     /**
      * @param int $id
      *
-     * @return null
+     * @return string|null
      */
     public function get_field_type_by_id($id)
     {
@@ -691,7 +691,6 @@ 
      * @param FormValidator $form
      * @param array $extraData
      * @param bool $admin_permissions
-     * @param int $user_id
      * @param array $extra
      * @param int $itemId
      * @param array $exclude variables of extra field to exclude
@@ -1592,7 +1591,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getJqgridColumnNames()
     {
@@ -1832,7 +1831,7 @@ 
     }
 
     /**
-     * @param array $columns
+     * @param string[] $columns
      * @param array  $column_model
      * @param array  $extraFields
      * @return array

Indentation +3 added lines, -3 removed lines

@@ -19,7 +19,7 @@ 
         'changeable',
         'filter',
         'extra_field_type',
-         /* Enable this when field_loggeable is introduced as a table field (2.0)
+            /* Enable this when field_loggeable is introduced as a table field (2.0)
         'field_loggeable',
          */
         'created_at'
@@ -523,7 +523,7 @@ 
      * France:Paris;Bretagne;Marseilles;Lyon|Belgique:Bruxelles;Namur;Liège;Bruges|Peru:Lima;Piura;
      * into
      * array(
- *      'France' =>
+     *      'France' =>
      *      array('Paris', 'Bregtane', 'Marseilles'),
      *  'Belgique' =>
      *      array('Namur', 'Liège')
@@ -1184,7 +1184,7 @@ 
 
                         if ($this->type == 'user') {
 
-                           /* //the magic should be here
+                            /* //the magic should be here
                             $user_tags = UserManager::get_user_tags($user_id, $field_details[0]);
 
                             $tag_list = '';

Spacing +33 added lines, -33 removed lines

@@ -26,19 +26,19 @@ 
     );
 
     public $ops = array(
-        'eq' => '=',        //equal
-        'ne' => '<>',       //not equal
-        'lt' => '<',        //less than
-        'le' => '<=',       //less than or equal
-        'gt' => '>',        //greater than
-        'ge' => '>=',       //greater than or equal
-        'bw' => 'LIKE',     //begins with
+        'eq' => '=', //equal
+        'ne' => '<>', //not equal
+        'lt' => '<', //less than
+        'le' => '<=', //less than or equal
+        'gt' => '>', //greater than
+        'ge' => '>=', //greater than or equal
+        'bw' => 'LIKE', //begins with
         'bn' => 'NOT LIKE', //doesn't begin with
-        'in' => 'LIKE',     //is in
+        'in' => 'LIKE', //is in
         'ni' => 'NOT LIKE', //is not in
-        'ew' => 'LIKE',     //ends with
+        'ew' => 'LIKE', //ends with
         'en' => 'NOT LIKE', //doesn't end with
-        'cn' => 'LIKE',     //contains
+        'cn' => 'LIKE', //contains
         'nc' => 'NOT LIKE'  //doesn't contain
     );
 
@@ -323,7 +323,7 @@ 
      */
     public static function get_extra_fields_by_handler($handler)
     {
-        $types= array();
+        $types = array();
         $types[self::FIELD_TYPE_TEXT] = get_lang('FieldTypeText');
         $types[self::FIELD_TYPE_TEXTAREA] = get_lang('FieldTypeTextarea');
         $types[self::FIELD_TYPE_RADIO] = get_lang('FieldTypeRadio');
@@ -962,7 +962,7 @@ 
                         // chzn-select doesn't work for sessions??
                         $form->addElement(
                             'select',
-                            'extra_' . $field_details['variable'],
+                            'extra_'.$field_details['variable'],
                             $field_details['display_text'],
                             $options,
                             array('id' => 'extra_'.$field_details['variable'])
@@ -1021,7 +1021,7 @@ 
 
                         if (!$admin_permissions) {
                             if ($field_details['visible'] == 0) {
-                                $form->freeze('extra_' . $field_details['variable']);
+                                $form->freeze('extra_'.$field_details['variable']);
                             }
                         }
                         break;
@@ -1369,9 +1369,9 @@ 
 
                         if (is_array($extraData) && array_key_exists($fieldVariable, $extraData)) {
 
-                            if (file_exists(api_get_path(SYS_UPLOAD_PATH) . $extraData[$fieldVariable])) {
+                            if (file_exists(api_get_path(SYS_UPLOAD_PATH).$extraData[$fieldVariable])) {
                                 $fieldTexts[] = Display::img(
-                                    api_get_path(WEB_UPLOAD_PATH) . $extraData[$fieldVariable],
+                                    api_get_path(WEB_UPLOAD_PATH).$extraData[$fieldVariable],
                                     $field_details['display_text'],
                                     array('width' => '300')
                                 );
@@ -1388,10 +1388,10 @@ 
                         $form->applyFilter('extra_'.$field_details['variable'], 'stripslashes');
                         $form->applyFilter('extra_'.$field_details['variable'], 'trim');
 
-                        $allowed_picture_types = array ('jpg', 'jpeg', 'png', 'gif');
+                        $allowed_picture_types = array('jpg', 'jpeg', 'png', 'gif');
                         $form->addRule(
                             'extra_'.$field_details['variable'],
-                            get_lang('OnlyImagesAllowed') . ' ('.implode(',', $allowed_picture_types).')',
+                            get_lang('OnlyImagesAllowed').' ('.implode(',', $allowed_picture_types).')',
                             'filetype',
                             $allowed_picture_types
                         );
@@ -1433,10 +1433,10 @@ 
                         if (is_array($extraData) &&
                             array_key_exists($fieldVariable, $extraData)
                         ) {
-                            if (file_exists(api_get_path(SYS_UPLOAD_PATH) . $extraData[$fieldVariable])) {
+                            if (file_exists(api_get_path(SYS_UPLOAD_PATH).$extraData[$fieldVariable])) {
                                 $fieldTexts[] = Display::url(
-                                    api_get_path(WEB_UPLOAD_PATH) . $extraData[$fieldVariable],
-                                    api_get_path(WEB_UPLOAD_PATH) . $extraData[$fieldVariable],
+                                    api_get_path(WEB_UPLOAD_PATH).$extraData[$fieldVariable],
+                                    api_get_path(WEB_UPLOAD_PATH).$extraData[$fieldVariable],
                                     array(
                                         'title' => $field_details['display_text'],
                                         'target' => '_blank'
@@ -1486,12 +1486,12 @@ 
                             "extra_{$field_details['variable']}",
                             $field_details['display_text']
                         );
-                        $form->applyFilter('extra_' . $field_details['variable'], 'stripslashes');
+                        $form->applyFilter('extra_'.$field_details['variable'], 'stripslashes');
 
                         if (!$admin_permissions) {
                             if ($field_details['visible'] == 0) {
                                 $form->freeze(
-                                    'extra_' . $field_details['variable']
+                                    'extra_'.$field_details['variable']
                                 );
                             }
                         }
@@ -1502,13 +1502,13 @@ 
                             $field_details['display_text']
                         );
                         $form->applyFilter(
-                            'extra_' . $field_details['variable'],
+                            'extra_'.$field_details['variable'],
                             'stripslashes'
                         );
                         if (!$admin_permissions) {
                             if ($field_details['visible'] == 0) {
                                 $form->freeze(
-                                    'extra_' . $field_details['variable']
+                                    'extra_'.$field_details['variable']
                                 );
                             }
                         }
@@ -1518,12 +1518,12 @@ 
                             "extra_{$field_details['variable']}",
                             $field_details['display_text']
                         );
-                        $form->applyFilter('extra_' . $field_details['variable'], 'stripslashes');
+                        $form->applyFilter('extra_'.$field_details['variable'], 'stripslashes');
 
                         if (!$admin_permissions) {
                             if ($field_details['visible'] == 0) {
                                 $form->freeze(
-                                    'extra_' . $field_details['variable']
+                                    'extra_'.$field_details['variable']
                                 );
                             }
                         }
@@ -1534,13 +1534,13 @@ 
                             $field_details['display_text']
                         );
                         $form->applyFilter(
-                            'extra_' . $field_details['variable'],
+                            'extra_'.$field_details['variable'],
                             'stripslashes'
                         );
                         if (!$admin_permissions) {
                             if ($field_details['visible'] == 0) {
                                 $form->freeze(
-                                    'extra_' . $field_details['variable']
+                                    'extra_'.$field_details['variable']
                                 );
                             }
                         }
@@ -2221,19 +2221,19 @@ 
                         break;
                     }
 
-                    if (!file_exists(api_get_path(SYS_UPLOAD_PATH) . $valueData['value'])) {
+                    if (!file_exists(api_get_path(SYS_UPLOAD_PATH).$valueData['value'])) {
                         break;
                     }
 
                     $image = Display::img(
-                        api_get_path(WEB_UPLOAD_PATH) . $valueData['value'],
+                        api_get_path(WEB_UPLOAD_PATH).$valueData['value'],
                         $field['display_text'],
                         array('width' => '300')
                     );
 
                     $displayedValue = Display::url(
                         $image,
-                        api_get_path(WEB_UPLOAD_PATH) . $valueData['value'],
+                        api_get_path(WEB_UPLOAD_PATH).$valueData['value'],
                         array('target' => '_blank')
                     );
                     break;
@@ -2242,13 +2242,13 @@ 
                         break;
                     }
 
-                    if (!file_exists(api_get_path(SYS_UPLOAD_PATH) . $valueData['value'])) {
+                    if (!file_exists(api_get_path(SYS_UPLOAD_PATH).$valueData['value'])) {
                         break;
                     }
 
                     $displayedValue = Display::url(
                         get_lang('Download'),
-                        api_get_path(WEB_UPLOAD_PATH) . $valueData['value'],
+                        api_get_path(WEB_UPLOAD_PATH).$valueData['value'],
                         array(
                             'title' => $field['display_text'],
                             'target' => '_blank'

main/inc/lib/extra_field_value.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -43,7 +43,7 @@ 
     }
 
     /**
-     * @return ExtraField
+     * @return string
      */
     public function getExtraField()
     {
@@ -72,7 +72,7 @@ 
      * This function is used with $extraField->addElements()
      * @param array $params array for the insertion into the *_field_values table
      *
-     * @return mixed false on empty params, void otherwise
+     * @return false|null false on empty params, void otherwise
      * @assert (array()) === false
      */
     public function saveFieldValues($params)
@@ -500,7 +500,7 @@ 
      * @param int $item_id Item ID (It could be a session_id, course_id or user_id)
      * @param int $field_id Field ID (the ID from the *_field table)
      * @param bool $transform Whether to transform the result to a human readable strings
-     * @return mixed A structured array with the field_id and field_value, or false on error
+     * @return string A structured array with the field_id and field_value, or false on error
      * @assert (-1,-1) === false
      */
     public function get_values_by_handler_and_field_id($item_id, $field_id, $transform = false)
@@ -593,7 +593,7 @@ 
      * @param int $item_id Item ID from the original table
      * @param string $field_variable The name of the field we are looking for
      * @param bool $transform
-     * @param bool $allVisibility
+     * @param bool $visibility
      *
      * @return mixed Array of results, or false on error or not found
      * @assert (-1,'') === false

Indentation +5 added lines, -6 removed lines

@@ -720,11 +720,11 @@ 
         return false;
     }
 
-     /**
-     * @param int $itemId
-     * @param int $fieldId
-     * @return array
-     */
+        /**
+         * @param int $itemId
+         * @param int $fieldId
+         * @return array
+         */
     public function getAllValuesByItemAndField($itemId, $fieldId)
     {
         $fieldId = intval($fieldId);
@@ -847,7 +847,6 @@ 
     /**
      * Deletes all values from an item
      * @param int $itemId (session id, course id, etc)
-
      * @assert (-1,-1) == null
      */
     public function deleteValuesByItem($itemId)

Spacing +8 added lines, -8 removed lines

@@ -209,7 +209,7 @@ 
                             break;
                     }
 
-                    $fileName = ExtraField::FIELD_TYPE_FILE_IMAGE . "_{$params['item_id']}.png";
+                    $fileName = ExtraField::FIELD_TYPE_FILE_IMAGE."_{$params['item_id']}.png";
 
                     if (!file_exists($fileDir)) {
                         mkdir($fileDir, $dirPermissions, true);
@@ -217,11 +217,11 @@ 
 
                     if ($value['error'] == 0) {
                         $imageExtraField = new Image($value['tmp_name']);
-                        $imageExtraField->send_image($fileDir . $fileName, -1, 'png');
+                        $imageExtraField->send_image($fileDir.$fileName, -1, 'png');
                         $newParams = array(
                             'item_id' => $params['item_id'],
                             'field_id' => $extraFieldInfo['id'],
-                            'value' => $fileDirStored . $fileName,
+                            'value' => $fileDirStored.$fileName,
                             'comment' => $comment
                         );
 
@@ -247,18 +247,18 @@ 
                     }
 
                     $cleanedName = api_replace_dangerous_char($value['name']);
-                    $fileName = ExtraField::FIELD_TYPE_FILE . "_{$params['item_id']}_$cleanedName";
+                    $fileName = ExtraField::FIELD_TYPE_FILE."_{$params['item_id']}_$cleanedName";
                     if (!file_exists($fileDir)) {
                         mkdir($fileDir, $dirPermissions, true);
                     }
 
                     if ($value['error'] == 0) {
-                        moveUploadedFile($value, $fileDir . $fileName);
+                        moveUploadedFile($value, $fileDir.$fileName);
 
                         $new_params = array(
                             'item_id' => $params['item_id'],
                             'field_id' => $extraFieldInfo['id'],
-                            'value' => $fileDirStored . $fileName
+                            'value' => $fileDirStored.$fileName
                         );
 
                         if ($this->type !== 'session' && $this->type !== 'course') {
@@ -380,7 +380,7 @@ 
                 */
                 if (false) {
                     global $app;
-                    switch($this->type) {
+                    switch ($this->type) {
                         case 'question':
                             $extraFieldValue = new ChamiloLMS\Entity\QuestionFieldValues();
                             $extraFieldValue->setUserId(api_get_user_id());
@@ -442,7 +442,7 @@ 
                 */
                 if (false) {
                     global $app;
-                    switch($this->type) {
+                    switch ($this->type) {
                         case 'question':
                             $extraFieldValue = $app['orm.ems']['db_write']->getRepository('ChamiloLMS\Entity\QuestionFieldValues')->find($field_values['id']);
                             $extraFieldValue->setUserId(api_get_user_id());

main/inc/lib/fileManage.lib.php

Doc Comments +7 added lines, -6 removed lines

@@ -13,6 +13,8 @@ 
  * @param  - action (string) - action type require : 'delete' or 'update'
  * @param  - old_path (string) - old path info stored to change
  * @param  - new_path (string) - new path info to substitute
+ * @param string $action
+ * @param string $old_path
  * @desc Update the file or directory path in the document db document table
  *
  */
@@ -76,8 +78,8 @@ 
  * Deletes a file or a directory
  *
  * @author - Hugues Peeters
- * @param  $file (String) - the path of file or directory to delete
- * @return boolean - true if the delete succeed, false otherwise.
+ * @param  string $file (String) - the path of file or directory to delete
+ * @return boolean|null - true if the delete succeed, false otherwise.
  * @see    - delete() uses check_name_exist() and removeDir() functions
  */
 function my_delete($file)
@@ -162,9 +164,9 @@ 
  * Renames a file or a directory
  *
  * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
- * @param  - $file_path (string) - complete path of the file or the directory
- * @param  - $new_file_name (string) - new name for the file or the directory
- * @return - boolean - true if succeed
+ * @param  string $file_path (string) - complete path of the file or the directory
+ * @param  string $new_file_name (string) - new name for the file or the directory
+ * @return string boolean - true if succeed
  *         - boolean - false otherwise
  * @see    - rename() uses the check_name_exist() and php2phps() functions
  */
@@ -327,7 +329,6 @@ 
  * Calculation size of a directory
  *
  * @returns integer size
- * @param 	string	$path path to size
  * @param 	boolean $recursive if true , include subdir in total
  */
 function dirsize($root, $recursive = true) {

Spacing +13 added lines, -13 removed lines

@@ -225,9 +225,9 @@ 
 		/* File case */
 		if (is_file($source)) {
 			if ($forceMove && !$isWindowsOS && $canExec) {
-				exec('mv ' . $source . ' ' . $target . '/' . $file_name);
+				exec('mv '.$source.' '.$target.'/'.$file_name);
 			} else {
-				copy($source, $target . '/' . $file_name);
+				copy($source, $target.'/'.$file_name);
 				unlink($source);
 			}
 			return true;
@@ -278,7 +278,7 @@ 
 		}
 		$destination_trail = $destination.'/'.$dir_name;
 		if (is_dir($destination)) {
-			chdir($orig_dir_path) ;
+			chdir($orig_dir_path);
 			$handle = opendir($orig_dir_path);
 
 			while ($element = readdir($handle)) {
@@ -288,14 +288,14 @@ 
 					copy($element, $destination_trail.'/'.$element);
 
 					if ($move) {
-						unlink($element) ;
+						unlink($element);
 					}
 				} elseif (is_dir($element)) {
 					$dir_to_copy[] = $orig_dir_path.'/'.$element;
 				}
 			}
 
-			closedir($handle) ;
+			closedir($handle);
 
 			if (sizeof($dir_to_copy) > 0) {
 				foreach ($dir_to_copy as $this_dir) {
@@ -304,7 +304,7 @@ 
 			}
 
 			if ($move) {
-				rmdir($orig_dir_path) ;
+				rmdir($orig_dir_path);
 			}
 			chdir($save_dir);
 		}
@@ -389,17 +389,17 @@ 
 			// Recursive operation if subdirectories exist
 			$dir_number = sizeof($dir_array);
 			if ($dir_number > 0) {
-				for ($i = 0 ; $i < $dir_number ; $i++) {
+				for ($i = 0; $i < $dir_number; $i++) {
 					$sub_dir_array = FileManager::list_all_directories($dir_array[$i]); // Function recursivity
 					if (is_array($dir_array) && is_array($sub_dir_array)) {
-						$dir_array  =  array_merge($dir_array, $sub_dir_array); // Data merge
+						$dir_array = array_merge($dir_array, $sub_dir_array); // Data merge
 					}
 				}
 			}
-			$result_array  =  $dir_array;
-			chdir($save_dir) ;
+			$result_array = $dir_array;
+			chdir($save_dir);
 		}
-		return $result_array ;
+		return $result_array;
 	}
 
 	/**
@@ -444,8 +444,8 @@ 
 		$buffer = '';
 		if (file_exists($file_name)) {
 			$fp = fopen($file_name, 'rb');
-			$buffer = fread ($fp, filesize($file_name));
-			fclose ($fp);
+			$buffer = fread($fp, filesize($file_name));
+			fclose($fp);
 		}
 		return $buffer;
 	}

Braces +12 added lines, -4 removed lines

@@ -33,7 +33,9 @@ 
             Database::query($query);
             break;
         case 'update':
-            if ($new_path[0] == '.') $new_path = substr($new_path, 1);
+            if ($new_path[0] == '.') {
+                $new_path = substr($new_path, 1);
+            }
             $new_path = str_replace('//', '/', $new_path);
 
             // Attempt to update	- tested & working for root	dir
@@ -379,7 +381,9 @@ 
 			chdir($path);
 			$handle = opendir($path);
 			while ($element = readdir($handle)) {
-				if ($element == '.' || $element == '..') continue;
+				if ($element == '.' || $element == '..') {
+				    continue;
+				}
                 // Skip the current and parent directories
 				if (is_dir($element)) {
 					$dir_array[] = $path.'/'.$element;
@@ -419,7 +423,9 @@ 
 				chdir($directory);
 				$handle = opendir($directory);
 			   	while ($element = readdir($handle)) {
-					if ($element == '.' || $element == '..' || $element == '.htaccess') continue;
+					if ($element == '.' || $element == '..' || $element == '.htaccess') {
+					    continue;
+					}
                     // Skip the current and parent directories
 					if (!is_dir($element)) {
 						$element_array[] = $directory.'/'.$element;
@@ -469,7 +475,9 @@ 
 	 */
 	function set_default_settings($upload_path, $filename, $filetype = 'file', $glued_table, $default_visibility = 'v')
     {
-		if (!$default_visibility) $default_visibility = 'v';
+		if (!$default_visibility) {
+		    $default_visibility = 'v';
+		}
 
 		// Make sure path is not wrongly formed
 		$upload_path = !empty($upload_path) ? "/$upload_path" : '';

Indentation +231 added lines, -232 removed lines

@@ -170,37 +170,37 @@ 
  */
 function my_rename($file_path, $new_file_name) {
 
-	$save_dir = getcwd();
-	$path = dirname($file_path);
-	$old_file_name = basename($file_path);
-	$new_file_name = api_replace_dangerous_char($new_file_name);
-
-	// If no extension, take the old one
-	if ((strpos($new_file_name, '.') === false) && ($dotpos = strrpos($old_file_name, '.'))) {
-		$new_file_name .= substr($old_file_name, $dotpos);
-	}
-
-	// Note: still possible: 'xx.yy' -rename-> '.yy' -rename-> 'zz'
-	// This is useful for folder names, where otherwise '.' would be sticky
-
-	// Extension PHP is not allowed, change to PHPS
-	$new_file_name = php2phps($new_file_name);
-
-	if ($new_file_name == $old_file_name) {
-		return $old_file_name;
-	}
-
-	if (strtolower($new_file_name) != strtolower($old_file_name) && check_name_exist($path.'/'.$new_file_name)) {
-		return false;
-	}
-	// On a Windows server, it would be better not to do the above check
-	// because it succeeds for some new names resembling the old name.
-	// But on Unix/Linux the check must be done because rename overwrites.
-
-	chdir($path);
-	$res = rename($old_file_name, $new_file_name) ? $new_file_name : false;
-	chdir($save_dir);
-	return $res;
+    $save_dir = getcwd();
+    $path = dirname($file_path);
+    $old_file_name = basename($file_path);
+    $new_file_name = api_replace_dangerous_char($new_file_name);
+
+    // If no extension, take the old one
+    if ((strpos($new_file_name, '.') === false) && ($dotpos = strrpos($old_file_name, '.'))) {
+        $new_file_name .= substr($old_file_name, $dotpos);
+    }
+
+    // Note: still possible: 'xx.yy' -rename-> '.yy' -rename-> 'zz'
+    // This is useful for folder names, where otherwise '.' would be sticky
+
+    // Extension PHP is not allowed, change to PHPS
+    $new_file_name = php2phps($new_file_name);
+
+    if ($new_file_name == $old_file_name) {
+        return $old_file_name;
+    }
+
+    if (strtolower($new_file_name) != strtolower($old_file_name) && check_name_exist($path.'/'.$new_file_name)) {
+        return false;
+    }
+    // On a Windows server, it would be better not to do the above check
+    // because it succeeds for some new names resembling the old name.
+    // But on Unix/Linux the check must be done because rename overwrites.
+
+    chdir($path);
+    $res = rename($old_file_name, $new_file_name) ? $new_file_name : false;
+    chdir($save_dir);
+    return $res;
 }
 
 /**
@@ -217,38 +217,38 @@ 
  */
 function move($source, $target, $forceMove = false, $moveContent = false)
 {
-	if (check_name_exist($source)) {
-		$file_name = basename($source);
+    if (check_name_exist($source)) {
+        $file_name = basename($source);
         $isWindowsOS = api_is_windows_os();
         $canExec = function_exists('exec');
 
-		/* File case */
-		if (is_file($source)) {
-			if ($forceMove && !$isWindowsOS && $canExec) {
-				exec('mv ' . $source . ' ' . $target . '/' . $file_name);
-			} else {
-				copy($source, $target . '/' . $file_name);
-				unlink($source);
-			}
-			return true;
-		} elseif (is_dir($source)) {
-			/* Directory */
-			if ($forceMove && !$isWindowsOS && $canExec) {
-				if ($moveContent) {
-					$base = basename($source);
-					exec('mv '.$source.'/* '.$target.$base.'/');
-					exec('rm -rf '.$source);
-				} else {
-					exec('mv $source $target');
-				}
-			} else {
-				copyDirTo($source, $target);
-			}
-			return true;
-		}
-	} else {
-		return false;
-	}
+        /* File case */
+        if (is_file($source)) {
+            if ($forceMove && !$isWindowsOS && $canExec) {
+                exec('mv ' . $source . ' ' . $target . '/' . $file_name);
+            } else {
+                copy($source, $target . '/' . $file_name);
+                unlink($source);
+            }
+            return true;
+        } elseif (is_dir($source)) {
+            /* Directory */
+            if ($forceMove && !$isWindowsOS && $canExec) {
+                if ($moveContent) {
+                    $base = basename($source);
+                    exec('mv '.$source.'/* '.$target.$base.'/');
+                    exec('rm -rf '.$source);
+                } else {
+                    exec('mv $source $target');
+                }
+            } else {
+                copyDirTo($source, $target);
+            }
+            return true;
+        }
+    } else {
+        return false;
+    }
 }
 
 /**
@@ -261,54 +261,54 @@ 
  */
 function copyDirTo($orig_dir_path, $destination, $move = true)
 {
-	if ($orig_dir_path == $destination) {
-		return false;
-	}
+    if ($orig_dir_path == $destination) {
+        return false;
+    }
 
-	$save_dir = getcwd();
-	// Extract directory name - create it at destination - update destination trail
-	$dir_name = basename($orig_dir_path);
+    $save_dir = getcwd();
+    // Extract directory name - create it at destination - update destination trail
+    $dir_name = basename($orig_dir_path);
     $dir_to_copy = array();
-	if (is_dir($orig_dir_path)) {
-		if (!is_dir($destination.'/'.$dir_name)) {
-			mkdir(
-				$destination.'/'.$dir_name,
-				api_get_permissions_for_new_directories()
-			);
-		}
-		$destination_trail = $destination.'/'.$dir_name;
-		if (is_dir($destination)) {
-			chdir($orig_dir_path) ;
-			$handle = opendir($orig_dir_path);
-
-			while ($element = readdir($handle)) {
-				if ($element == '.' || $element == '..') {
-					continue; // Skip the current and parent directories
-				} elseif (is_file($element)) {
-					copy($element, $destination_trail.'/'.$element);
-
-					if ($move) {
-						unlink($element) ;
-					}
-				} elseif (is_dir($element)) {
-					$dir_to_copy[] = $orig_dir_path.'/'.$element;
-				}
-			}
-
-			closedir($handle) ;
-
-			if (sizeof($dir_to_copy) > 0) {
-				foreach ($dir_to_copy as $this_dir) {
-					copyDirTo($this_dir, $destination_trail, $move); // Recursivity
-				}
-			}
-
-			if ($move) {
-				rmdir($orig_dir_path) ;
-			}
-			chdir($save_dir);
-		}
-	}
+    if (is_dir($orig_dir_path)) {
+        if (!is_dir($destination.'/'.$dir_name)) {
+            mkdir(
+                $destination.'/'.$dir_name,
+                api_get_permissions_for_new_directories()
+            );
+        }
+        $destination_trail = $destination.'/'.$dir_name;
+        if (is_dir($destination)) {
+            chdir($orig_dir_path) ;
+            $handle = opendir($orig_dir_path);
+
+            while ($element = readdir($handle)) {
+                if ($element == '.' || $element == '..') {
+                    continue; // Skip the current and parent directories
+                } elseif (is_file($element)) {
+                    copy($element, $destination_trail.'/'.$element);
+
+                    if ($move) {
+                        unlink($element) ;
+                    }
+                } elseif (is_dir($element)) {
+                    $dir_to_copy[] = $orig_dir_path.'/'.$element;
+                }
+            }
+
+            closedir($handle) ;
+
+            if (sizeof($dir_to_copy) > 0) {
+                foreach ($dir_to_copy as $this_dir) {
+                    copyDirTo($this_dir, $destination_trail, $move); // Recursivity
+                }
+            }
+
+            if ($move) {
+                rmdir($orig_dir_path) ;
+            }
+            chdir($save_dir);
+        }
+    }
 }
 
 
@@ -319,8 +319,8 @@ 
  * @param 	string	$filename 		filename
  */
 function getextension($filename) {
-	$bouts = explode('.', $filename);
-	return array(array_pop($bouts), implode('.', $bouts));
+    $bouts = explode('.', $filename);
+    return array(array_pop($bouts), implode('.', $bouts));
 }
 
 /**
@@ -331,19 +331,19 @@ 
  * @param 	boolean $recursive if true , include subdir in total
  */
 function dirsize($root, $recursive = true) {
-	$dir = @opendir($root);
-	$size = 0;
-	while ($file = @readdir($dir)) {
-		if (!in_array($file, array('.', '..'))) {
-			if (is_dir($root.'/'.$file)) {
-				$size += $recursive ? dirsize($root.'/'.$file) : 0;
-			} else {
-				$size += @filesize($root.'/'.$file);
-			}
-		}
-	}
-	@closedir($dir);
-	return $size;
+    $dir = @opendir($root);
+    $size = 0;
+    while ($file = @readdir($dir)) {
+        if (!in_array($file, array('.', '..'))) {
+            if (is_dir($root.'/'.$file)) {
+                $size += $recursive ? dirsize($root.'/'.$file) : 0;
+            } else {
+                $size += @filesize($root.'/'.$file);
+            }
+        }
+    }
+    @closedir($dir);
+    return $size;
 }
 
 /*	CLASS FileManager */
@@ -362,7 +362,7 @@ 
 */
 class FileManager
 {
-	/**
+    /**
 		Returns a list of all directories, except the base dir,
 		of the current course. This function uses recursion.
 
@@ -370,131 +370,130 @@ 
 
 		@author Roan Embrechts
 		@version 1.0.1
-	*/
-	function list_all_directories($path)
+     */
+    function list_all_directories($path)
     {
-		$result_array = array();
-		if (is_dir($path)) {
-			$save_dir = getcwd();
-			chdir($path);
-			$handle = opendir($path);
-			while ($element = readdir($handle)) {
-				if ($element == '.' || $element == '..') continue;
+        $result_array = array();
+        if (is_dir($path)) {
+            $save_dir = getcwd();
+            chdir($path);
+            $handle = opendir($path);
+            while ($element = readdir($handle)) {
+                if ($element == '.' || $element == '..') continue;
                 // Skip the current and parent directories
-				if (is_dir($element)) {
-					$dir_array[] = $path.'/'.$element;
-				}
-			}
-			closedir($handle);
-			// Recursive operation if subdirectories exist
-			$dir_number = sizeof($dir_array);
-			if ($dir_number > 0) {
-				for ($i = 0 ; $i < $dir_number ; $i++) {
-					$sub_dir_array = FileManager::list_all_directories($dir_array[$i]); // Function recursivity
-					if (is_array($dir_array) && is_array($sub_dir_array)) {
-						$dir_array  =  array_merge($dir_array, $sub_dir_array); // Data merge
-					}
-				}
-			}
-			$result_array  =  $dir_array;
-			chdir($save_dir) ;
-		}
-		return $result_array ;
-	}
-
-	/**
+                if (is_dir($element)) {
+                    $dir_array[] = $path.'/'.$element;
+                }
+            }
+            closedir($handle);
+            // Recursive operation if subdirectories exist
+            $dir_number = sizeof($dir_array);
+            if ($dir_number > 0) {
+                for ($i = 0 ; $i < $dir_number ; $i++) {
+                    $sub_dir_array = FileManager::list_all_directories($dir_array[$i]); // Function recursivity
+                    if (is_array($dir_array) && is_array($sub_dir_array)) {
+                        $dir_array  =  array_merge($dir_array, $sub_dir_array); // Data merge
+                    }
+                }
+            }
+            $result_array  =  $dir_array;
+            chdir($save_dir) ;
+        }
+        return $result_array ;
+    }
+
+    /**
 		This function receives a list of directories.
 		It returns a list of all files in these directories
 
 		@author Roan Embrechts
 		@version 1.0
-	*/
-	function list_all_files($dir_array)
+     */
+    function list_all_files($dir_array)
     {
-		$element_array = array();
-		if (is_dir($dir_array)) {
-
-			$save_dir = getcwd();
-			foreach ($dir_array as $directory) {
-				chdir($directory);
-				$handle = opendir($directory);
-			   	while ($element = readdir($handle)) {
-					if ($element == '.' || $element == '..' || $element == '.htaccess') continue;
+        $element_array = array();
+        if (is_dir($dir_array)) {
+
+            $save_dir = getcwd();
+            foreach ($dir_array as $directory) {
+                chdir($directory);
+                $handle = opendir($directory);
+                    while ($element = readdir($handle)) {
+                    if ($element == '.' || $element == '..' || $element == '.htaccess') continue;
                     // Skip the current and parent directories
-					if (!is_dir($element)) {
-						$element_array[] = $directory.'/'.$element;
-					}
-				}
-				closedir($handle);
-				chdir('..');
-				chdir($save_dir);
-			}
-		}
-
-		return $element_array;
-	}
-
-	/**
+                    if (!is_dir($element)) {
+                        $element_array[] = $directory.'/'.$element;
+                    }
+                }
+                closedir($handle);
+                chdir('..');
+                chdir($save_dir);
+            }
+        }
+
+        return $element_array;
+    }
+
+    /**
 		Loads contents of file $filename into memory and returns them as a string.
 		Function kept for compatibility with older PHP versions.
 		Function is binary safe (is needed on Windows)
-	*/
-	function compat_load_file($file_name)
+     */
+    function compat_load_file($file_name)
     {
-		$buffer = '';
-		if (file_exists($file_name)) {
-			$fp = fopen($file_name, 'rb');
-			$buffer = fread ($fp, filesize($file_name));
-			fclose ($fp);
-		}
-		return $buffer;
-	}
-
-	/**
-	 * Adds file/folder to document table in database
-	 * improvement from set_default_settings (see below):
-	 * take all info from function parameters
-	 * no global variables needed
-	 *
-	 * NOTE $glued_table should already have backticks around it
-	 * (get it from the database library, and it is done automatically)
-	 *
-	 * @param	path, filename, filetype,
-				$glued_table, default_visibility
+        $buffer = '';
+        if (file_exists($file_name)) {
+            $fp = fopen($file_name, 'rb');
+            $buffer = fread ($fp, filesize($file_name));
+            fclose ($fp);
+        }
+        return $buffer;
+    }
 
-	 * action:	Adds an entry to the document table with the default settings.
-	 * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
-	 * @author	Roan Embrechts
-	 * @version 1.2
-	 */
-	function set_default_settings($upload_path, $filename, $filetype = 'file', $glued_table, $default_visibility = 'v')
+    /**
+     * Adds file/folder to document table in database
+     * improvement from set_default_settings (see below):
+     * take all info from function parameters
+     * no global variables needed
+     *
+     * NOTE $glued_table should already have backticks around it
+     * (get it from the database library, and it is done automatically)
+     *
+     * @param	path, filename, filetype,
+				$glued_table, default_visibility
+     * action:	Adds an entry to the document table with the default settings.
+     * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
+     * @author	Roan Embrechts
+     * @version 1.2
+     */
+    function set_default_settings($upload_path, $filename, $filetype = 'file', $glued_table, $default_visibility = 'v')
     {
-		if (!$default_visibility) $default_visibility = 'v';
-
-		// Make sure path is not wrongly formed
-		$upload_path = !empty($upload_path) ? "/$upload_path" : '';
-
-		$endchar = substr($filename, strlen($filename) - 1, 1);
-		if ($endchar == "\\" || $endchar == '/') {
-			$filename = substr($filename, 0, strlen($filename) - 1);
-		}
-
-		$full_file_name = $upload_path.'/'.$filename;
-		$full_file_name = str_replace("//", '/', $full_file_name);
-
-		$sql_query = "SELECT count(*) as number_existing FROM $glued_table WHERE path='$full_file_name'";
-		$sql_result = Database::query($sql_query);
-		$result = Database::fetch_array($sql_result);
-		// Determine which query to execute
-		if ($result['number_existing'] > 0) {
-			// Entry exists, update
-			$query = "UPDATE $glued_table SET path='$full_file_name',visibility='$default_visibility', filetype='$filetype'
+        if (!$default_visibility) $default_visibility = 'v';
+
+        // Make sure path is not wrongly formed
+        $upload_path = !empty($upload_path) ? "/$upload_path" : '';
+
+        $endchar = substr($filename, strlen($filename) - 1, 1);
+        if ($endchar == "\\" || $endchar == '/') {
+            $filename = substr($filename, 0, strlen($filename) - 1);
+        }
+
+        $full_file_name = $upload_path.'/'.$filename;
+        $full_file_name = str_replace("//", '/', $full_file_name);
+
+        $sql_query = "SELECT count(*) as number_existing FROM $glued_table WHERE path='$full_file_name'";
+        $sql_result = Database::query($sql_query);
+        $result = Database::fetch_array($sql_result);
+        // Determine which query to execute
+        if ($result['number_existing'] > 0) {
+            // Entry exists, update
+            $query = "UPDATE $glued_table SET path='$full_file_name',visibility='$default_visibility', filetype='$filetype'
 			          WHERE path='$full_file_name'";
-		} else {
-			// No entry exists, create new one
-			$query = "INSERT INTO $glued_table (path,visibility,filetype)
+        } else {
+            // No entry exists, create new one
+            $query = "INSERT INTO $glued_table (path,visibility,filetype)
 			          VALUES ('$full_file_name','$default_visibility','$filetype')";
-		}
-		Database::query($query);
-	}
+        }
+        Database::query($query);
+    }
 }

main/inc/lib/fileUpload.lib.php

Doc Comments +10 added lines, -6 removed lines

@@ -17,6 +17,7 @@ 
  *
  * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
  * @param  - file_name (string) name of a file
+ * @param string $file_name
  * @return - the filenam phps'ized
  */
 function php2phps($file_name) {
@@ -73,7 +74,7 @@ 
  * Returns the name without extension, used for the title
  *
  * @param string $name
- * @return name without the extension
+ * @return string without the extension
  */
 function get_document_title($name) {
     // If they upload .htaccess...
@@ -86,7 +87,7 @@ 
  * This function checks if the upload succeeded
  *
  * @param array $uploaded_file ($_FILES)
- * @return true if upload succeeded
+ * @return boolean if upload succeeded
  */
 function process_uploaded_file($uploaded_file, $show_output = true)
 {
@@ -698,6 +699,8 @@ 
  * @param  - dir (string) - Path of the directory
  *           whe the file should be added
  * @param  - max_dir_space (int) - maximum size of the diretory in byte
+ * @param string $dir
+ * @param integer $max_dir_space
  * @return - boolean true if there is enough space,
  *				boolean false otherwise
  *
@@ -1022,7 +1025,7 @@ 
  * @param array  $courseInfo
  * @param array  $userInfo
  * @param array  $uploaded_file - follows the $_FILES Structure
- * @param string $upload_path   - destination of the upload.
+ * @param string $uploadPath   - destination of the upload.
  *                               This path is to append to $base_work_dir
  * @param string $base_work_dir  - base working directory of the module
  * @param int    $maxFilledSpace  - amount of bytes to not exceed in the base
@@ -1201,7 +1204,7 @@ 
  * @param bool $save_visibility
  * @param int $group_id
  * @param int $session_id Session ID, if any
- * @return int id if inserted document
+ * @return string|false id if inserted document
  */
 function add_document(
     $_course,
@@ -1337,7 +1340,7 @@ 
  *
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path+filename eg: /main/document/document.php
- * @return	The directory depth
+ * @return	integer directory depth
  */
 function get_levels($filename) {
     $levels = explode('/', $filename);
@@ -1354,6 +1357,7 @@ 
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path,filename
  * action:	Adds an entry to the document table with the default settings.
+ * @param string $upload_path
  */
 function set_default_settings($upload_path, $filename, $filetype = 'file')
 {
@@ -1778,6 +1782,7 @@ 
 
 @author Roan Embrechts
 @version 0.6
+ * @param string $buffer
  */
 function api_replace_links_in_string($upload_path, $buffer) {
     // Search for hyperlinks
@@ -2013,7 +2018,6 @@ 
  * @param int $groupId
  * @param bool $output
  * @param array $parent
- * @param string $uploadPath
  *
  */
 function add_all_documents_in_folder_to_database(

Braces +3 added lines, -1 removed lines

@@ -993,7 +993,9 @@
                     if ($file != '.' && $file != '..') {
 
                         $filetype = 'file';
-                        if (is_dir($base_work_dir.$upload_path.'/'.$file)) $filetype = 'folder';
+                        if (is_dir($base_work_dir.$upload_path.'/'.$file)) {
+                            $filetype = 'folder';
+                        }
 
                         $safe_file = api_replace_dangerous_char($file, 'strict');
                         @rename($base_work_dir.$upload_path.'/'.$file,$base_work_dir.$upload_path.'/'.$safe_file);

Spacing +92 added lines, -92 removed lines

@@ -63,10 +63,10 @@ 
     $name_no_ext = substr($name, 0, strlen($name) - strlen(strstr($name, $ext)));
     $n = 0;
     $unique = '';
-    while (file_exists($path . $name_no_ext . $unique . $ext)) {
-        $unique = '_' . ++$n;
+    while (file_exists($path.$name_no_ext.$unique.$ext)) {
+        $unique = '_'.++$n;
     }
-    return $name_no_ext . $unique . $ext;
+    return $name_no_ext.$unique.$ext;
 }
 
 /**
@@ -105,7 +105,7 @@ 
                 // Not used at the moment, but could be handy if we want to limit the size of an upload (e.g. image upload in html editor).
                 $max_file_size = intval($_POST['MAX_FILE_SIZE']);
                 if ($show_output) {
-                    Display::display_error_message(get_lang('UplExceedMaxPostSize'). format_file_size($max_file_size));
+                    Display::display_error_message(get_lang('UplExceedMaxPostSize').format_file_size($max_file_size));
                 }
 
                 return false;
@@ -119,7 +119,7 @@ 
             case 4:
                 // No file was uploaded.
                 if ($show_output) {
-                    Display::display_error_message(get_lang('UplNoFileUploaded').' '. get_lang('UplSelectFileFirst'));
+                    Display::display_error_message(get_lang('UplNoFileUploaded').' '.get_lang('UplSelectFileFirst'));
                 }
 
                 return false;
@@ -459,7 +459,7 @@ 
                             // Display success message with extra info to user
                             if ($output) {
                                 Display::display_confirmation_message(
-                                    get_lang('UplUploadSucceeded') . '<br /> ' . $documentTitle . ' ' . get_lang('UplFileOverwritten'),
+                                    get_lang('UplUploadSucceeded').'<br /> '.$documentTitle.' '.get_lang('UplFileOverwritten'),
                                     false
                                 );
                             }
@@ -583,7 +583,7 @@ 
                         // Display success message to user
                         if ($output) {
                             Display::display_confirmation_message(
-                                get_lang('UplUploadSucceeded') . '<br />' . get_lang('UplFileSavedAs') .' '.$documentTitle,
+                                get_lang('UplUploadSucceeded').'<br />'.get_lang('UplFileSavedAs').' '.$documentTitle,
                                 false
                             );
                         }
@@ -730,12 +730,12 @@ 
 function dir_total_space($dir_path)
 {
     $save_dir = getcwd();
-    chdir($dir_path) ;
+    chdir($dir_path);
     $handle = opendir($dir_path);
     $sumSize = 0;
     $dirList = array();
     while ($element = readdir($handle)) {
-        if ( $element == '.' || $element == '..') {
+        if ($element == '.' || $element == '..') {
             continue; // Skip the current and parent directories
         }
         if (is_file($element)) {
@@ -746,11 +746,11 @@ 
         }
     }
 
-    closedir($handle) ;
+    closedir($handle);
 
     if (sizeof($dirList) > 0) {
         foreach ($dirList as $j) {
-            $sizeDir = dir_total_space($j);	// Recursivity
+            $sizeDir = dir_total_space($j); // Recursivity
             $sumSize += $sizeDir;
         }
     }
@@ -784,63 +784,63 @@ 
 
         static $mime_type = array();
 
-        $mime_type[] = 'application/msword';             $extension[] = '.doc';
-        $mime_type[] = 'application/rtf';                $extension[] = '.rtf';
-        $mime_type[] = 'application/vnd.ms-powerpoint';  $extension[] = '.ppt';
-        $mime_type[] = 'application/vnd.ms-excel';       $extension[] = '.xls';
-        $mime_type[] = 'application/pdf';                $extension[] = '.pdf';
-        $mime_type[] = 'application/postscript';         $extension[] = '.ps';
-        $mime_type[] = 'application/mac-binhex40';       $extension[] = '.hqx';
-        $mime_type[] = 'application/x-gzip';             $extension[] = 'tar.gz';
-        $mime_type[] = 'application/x-shockwave-flash';  $extension[] = '.swf';
-        $mime_type[] = 'application/x-stuffit';          $extension[] = '.sit';
-        $mime_type[] = 'application/x-tar';              $extension[] = '.tar';
-        $mime_type[] = 'application/zip';                $extension[] = '.zip';
-        $mime_type[] = 'application/x-tar';              $extension[] = '.tar';
-        $mime_type[] = 'text/html';                      $extension[] = '.html';
-        $mime_type[] = 'text/plain';                     $extension[] = '.txt';
-        $mime_type[] = 'text/rtf';                       $extension[] = '.rtf';
-        $mime_type[] = 'img/gif';                        $extension[] = '.gif';
-        $mime_type[] = 'img/jpeg';                       $extension[] = '.jpg';
-        $mime_type[] = 'img/png';                        $extension[] = '.png';
-        $mime_type[] = 'audio/midi';                     $extension[] = '.mid';
-        $mime_type[] = 'audio/mpeg';                     $extension[] = '.mp3';
-        $mime_type[] = 'audio/x-aiff';                   $extension[] = '.aif';
-        $mime_type[] = 'audio/x-pn-realaudio';           $extension[] = '.rm';
-        $mime_type[] = 'audio/x-pn-realaudio-plugin';    $extension[] = '.rpm';
-        $mime_type[] = 'audio/x-wav';                    $extension[] = '.wav';
-        $mime_type[] = 'video/mpeg';                     $extension[] = '.mpg';
-        $mime_type[] = 'video/mpeg4-generic';            $extension[] = '.mp4';
-        $mime_type[] = 'video/quicktime';                $extension[] = '.mov';
-        $mime_type[] = 'video/x-msvideo';                $extension[] = '.avi';
-
-        $mime_type[] = 'video/x-ms-wmv';                 $extension[] = '.wmv';
-        $mime_type[] = 'video/x-flv';                    $extension[] = '.flv';
-        $mime_type[] = 'image/svg+xml';                  $extension[] = '.svg';
-        $mime_type[] = 'image/svg+xml';                  $extension[] = '.svgz';
-        $mime_type[] = 'video/ogg';                  	 $extension[] = '.ogv';
-        $mime_type[] = 'audio/ogg';                  	 $extension[] = '.oga';
-        $mime_type[] = 'application/ogg';                $extension[] = '.ogg';
-        $mime_type[] = 'application/ogg';                $extension[] = '.ogx';
-        $mime_type[] = 'application/x-freemind';         $extension[] = '.mm';
-
-        $mime_type[] = 'application/vnd.ms-word.document.macroEnabled.12';							$extension[] = '.docm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document';	$extension[] = '.docx';
-        $mime_type[] = 'application/vnd.ms-word.template.macroEnabled.12';							$extension[] = '.dotm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.wordprocessingml.template';	$extension[] = '.dotx';
-        $mime_type[] = 'application/vnd.ms-powerpoint.template.macroEnabled.12';					$extension[] = '.potm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.template';		$extension[] = '.potx';
-        $mime_type[] = 'application/vnd.ms-powerpoint.addin.macroEnabled.12';						$extension[] = '.ppam';
-        $mime_type[] = 'application/vnd.ms-powerpoint.slideshow.macroEnabled.12';					$extension[] = '.ppsm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.slideshow';	$extension[] = '.ppsx';
-        $mime_type[] = 'application/vnd.ms-powerpoint.presentation.macroEnabled.12';				$extension[] = '.pptm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.presentation';	$extension[] = '.pptx';
-        $mime_type[] = 'application/vnd.ms-excel.addin.macroEnabled.12';							$extension[] = '.xlam';
-        $mime_type[] = 'application/vnd.ms-excel.sheet.binary.macroEnabled.12';						$extension[] = '.xlsb';
-        $mime_type[] = 'application/vnd.ms-excel.sheet.macroEnabled.12';							$extension[] = '.xlsm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet';			$extension[] = '.xlsx';
-        $mime_type[] = 'application/vnd.ms-excel.template.macroEnabled.12';							$extension[] = '.xltm';
-        $mime_type[] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.template';		$extension[] = '.xltx';
+        $mime_type[] = 'application/msword'; $extension[] = '.doc';
+        $mime_type[] = 'application/rtf'; $extension[] = '.rtf';
+        $mime_type[] = 'application/vnd.ms-powerpoint'; $extension[] = '.ppt';
+        $mime_type[] = 'application/vnd.ms-excel'; $extension[] = '.xls';
+        $mime_type[] = 'application/pdf'; $extension[] = '.pdf';
+        $mime_type[] = 'application/postscript'; $extension[] = '.ps';
+        $mime_type[] = 'application/mac-binhex40'; $extension[] = '.hqx';
+        $mime_type[] = 'application/x-gzip'; $extension[] = 'tar.gz';
+        $mime_type[] = 'application/x-shockwave-flash'; $extension[] = '.swf';
+        $mime_type[] = 'application/x-stuffit'; $extension[] = '.sit';
+        $mime_type[] = 'application/x-tar'; $extension[] = '.tar';
+        $mime_type[] = 'application/zip'; $extension[] = '.zip';
+        $mime_type[] = 'application/x-tar'; $extension[] = '.tar';
+        $mime_type[] = 'text/html'; $extension[] = '.html';
+        $mime_type[] = 'text/plain'; $extension[] = '.txt';
+        $mime_type[] = 'text/rtf'; $extension[] = '.rtf';
+        $mime_type[] = 'img/gif'; $extension[] = '.gif';
+        $mime_type[] = 'img/jpeg'; $extension[] = '.jpg';
+        $mime_type[] = 'img/png'; $extension[] = '.png';
+        $mime_type[] = 'audio/midi'; $extension[] = '.mid';
+        $mime_type[] = 'audio/mpeg'; $extension[] = '.mp3';
+        $mime_type[] = 'audio/x-aiff'; $extension[] = '.aif';
+        $mime_type[] = 'audio/x-pn-realaudio'; $extension[] = '.rm';
+        $mime_type[] = 'audio/x-pn-realaudio-plugin'; $extension[] = '.rpm';
+        $mime_type[] = 'audio/x-wav'; $extension[] = '.wav';
+        $mime_type[] = 'video/mpeg'; $extension[] = '.mpg';
+        $mime_type[] = 'video/mpeg4-generic'; $extension[] = '.mp4';
+        $mime_type[] = 'video/quicktime'; $extension[] = '.mov';
+        $mime_type[] = 'video/x-msvideo'; $extension[] = '.avi';
+
+        $mime_type[] = 'video/x-ms-wmv'; $extension[] = '.wmv';
+        $mime_type[] = 'video/x-flv'; $extension[] = '.flv';
+        $mime_type[] = 'image/svg+xml'; $extension[] = '.svg';
+        $mime_type[] = 'image/svg+xml'; $extension[] = '.svgz';
+        $mime_type[] = 'video/ogg'; $extension[] = '.ogv';
+        $mime_type[] = 'audio/ogg'; $extension[] = '.oga';
+        $mime_type[] = 'application/ogg'; $extension[] = '.ogg';
+        $mime_type[] = 'application/ogg'; $extension[] = '.ogx';
+        $mime_type[] = 'application/x-freemind'; $extension[] = '.mm';
+
+        $mime_type[] = 'application/vnd.ms-word.document.macroEnabled.12'; $extension[] = '.docm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'; $extension[] = '.docx';
+        $mime_type[] = 'application/vnd.ms-word.template.macroEnabled.12'; $extension[] = '.dotm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.wordprocessingml.template'; $extension[] = '.dotx';
+        $mime_type[] = 'application/vnd.ms-powerpoint.template.macroEnabled.12'; $extension[] = '.potm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.template'; $extension[] = '.potx';
+        $mime_type[] = 'application/vnd.ms-powerpoint.addin.macroEnabled.12'; $extension[] = '.ppam';
+        $mime_type[] = 'application/vnd.ms-powerpoint.slideshow.macroEnabled.12'; $extension[] = '.ppsm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.slideshow'; $extension[] = '.ppsx';
+        $mime_type[] = 'application/vnd.ms-powerpoint.presentation.macroEnabled.12'; $extension[] = '.pptm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.presentationml.presentation'; $extension[] = '.pptx';
+        $mime_type[] = 'application/vnd.ms-excel.addin.macroEnabled.12'; $extension[] = '.xlam';
+        $mime_type[] = 'application/vnd.ms-excel.sheet.binary.macroEnabled.12'; $extension[] = '.xlsb';
+        $mime_type[] = 'application/vnd.ms-excel.sheet.macroEnabled.12'; $extension[] = '.xlsm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'; $extension[] = '.xlsx';
+        $mime_type[] = 'application/vnd.ms-excel.template.macroEnabled.12'; $extension[] = '.xltm';
+        $mime_type[] = 'application/vnd.openxmlformats-officedocument.spreadsheetml.template'; $extension[] = '.xltx';
 
         // Test on PC (files with no extension get application/octet-stream)
         //$mime_type[] = 'application/octet-stream';      $extension[] = '.ext';
@@ -849,7 +849,7 @@ 
 
         foreach ($mime_type as $key => & $type) {
             if ($type == $file_type) {
-                $file_name .=  $extension[$key];
+                $file_name .= $extension[$key];
                 break;
             }
         }
@@ -957,12 +957,12 @@ 
         }
 
         // It happens on Linux that $upload_path sometimes doesn't start with '/'
-        if ($upload_path[0] != '/' && substr($base_work_dir,-1,1) != '/') {
+        if ($upload_path[0] != '/' && substr($base_work_dir, -1, 1) != '/') {
             $upload_path = '/'.$upload_path;
         }
 
         if ($upload_path[strlen($upload_path) - 1] == '/') {
-            $upload_path=substr($upload_path, 0, -1);
+            $upload_path = substr($upload_path, 0, -1);
         }
 
         /*	Uncompressing phase */
@@ -974,15 +974,15 @@ 
             - add it to the database
             - parse & change relative html links
         */
-        if (PHP_OS == 'Linux' && ! get_cfg_var('safe_mode') && false) { // *** UGent, changed by OC ***
+        if (PHP_OS == 'Linux' && !get_cfg_var('safe_mode') && false) { // *** UGent, changed by OC ***
             // Shell Method - if this is possible, it gains some speed
-            exec("unzip -d \"".$base_work_dir.$upload_path."/\"".$uploaded_file['name']." " .$uploaded_file['tmp_name']);
+            exec("unzip -d \"".$base_work_dir.$upload_path."/\"".$uploaded_file['name']." ".$uploaded_file['tmp_name']);
         } else {
             // PHP method - slower...
             $save_dir = getcwd();
             chdir($base_work_dir.$upload_path);
             $unzippingState = $zip_file->extract();
-            for ($j=0; $j < count($unzippingState); $j++) {
+            for ($j = 0; $j < count($unzippingState); $j++) {
                 $state = $unzippingState[$j];
 
                 // Fix relative links in html files
@@ -996,8 +996,8 @@ 
                         if (is_dir($base_work_dir.$upload_path.'/'.$file)) $filetype = 'folder';
 
                         $safe_file = api_replace_dangerous_char($file, 'strict');
-                        @rename($base_work_dir.$upload_path.'/'.$file,$base_work_dir.$upload_path.'/'.$safe_file);
-                        set_default_settings($upload_path, $safe_file,$filetype);
+                        @rename($base_work_dir.$upload_path.'/'.$file, $base_work_dir.$upload_path.'/'.$safe_file);
+                        set_default_settings($upload_path, $safe_file, $filetype);
                     }
                 }
 
@@ -1047,7 +1047,7 @@ 
     $zip = new PclZip($uploaded_file['tmp_name']);
 
     // Check the zip content (real size and file extension)
-    $zip_content_array = (array)$zip->listContent();
+    $zip_content_array = (array) $zip->listContent();
 
     $realSize = 0;
     foreach ($zip_content_array as & $this_content) {
@@ -1143,7 +1143,7 @@ 
 function filter_extension(&$filename)
 {
     if (substr($filename, -1) == '/') {
-        return 1;  // Authorize directories
+        return 1; // Authorize directories
     }
     $blacklist = api_get_setting('upload_extensions_list_type');
     if ($blacklist != 'whitelist') { // if = blacklist
@@ -1369,9 +1369,9 @@ 
     $upload_path = str_replace('//', '/', $upload_path);
 
     if ($upload_path == '/') {
-        $upload_path='';
+        $upload_path = '';
     } elseif (!empty($upload_path) && $upload_path[0] != '/') {
-        $upload_path="/$upload_path";
+        $upload_path = "/$upload_path";
     }
 
     $endchar = substr($filename, strlen($filename) - 1, 1);
@@ -1409,7 +1409,7 @@ 
     $img_path_list = array();
 
     if (!$fp = fopen($html_file, 'r')) {
-        return ;
+        return;
     }
 
     // Aearch and store occurences of the <img> tag in an array
@@ -1429,7 +1429,7 @@ 
         $img_tag_list = $matches[0];
     }
 
-    fclose ($fp);
+    fclose($fp);
     unset($buffer);
 
     // Search the image file path from all the <IMG> tag detected
@@ -1529,7 +1529,7 @@ 
 
     if (!is_dir($base_work_dir.$systemFolderName)) {
         $result = mkdir(
-            $base_work_dir . $systemFolderName,
+            $base_work_dir.$systemFolderName,
             api_get_permissions_for_new_directories(),
             true
         );
@@ -1542,7 +1542,7 @@ 
                     WHERE
                         c_id = $course_id AND
                         (
-                            path = '" . $systemFolderName . "'
+                            path = '".$systemFolderName."'
                         )
             ";
 
@@ -1695,7 +1695,7 @@ 
 
     // Fix the image tags
 
-    for ($i = 0, $fileNb = count($original_img_path); $i < $fileNb ; $i++) {
+    for ($i = 0, $fileNb = count($original_img_path); $i < $fileNb; $i++) {
         $replace_what = $original_img_path[$i];
         // We only need the directory and the filename /path/to/file_html_files/missing_file.gif -> file_html_files/missing_file.gif
         $exploded_file_path = explode('/', $new_img_path[$i]);
@@ -1736,7 +1736,7 @@ 
         .'</body>'
         .'</html>';
     if (file_exists($file_path)) {
-        if (!($fp = fopen ($file_path, 'w'))) {
+        if (!($fp = fopen($file_path, 'w'))) {
             return false;
         }
         return fwrite($fp, $file_content);
@@ -1756,7 +1756,7 @@ 
     // Open the file
     if (file_exists($full_file_name)) {
         $fp = fopen($full_file_name, 'r');
-        $buffer = fread ($fp, filesize ($full_file_name));
+        $buffer = fread($fp, filesize($full_file_name));
 
         // Parse the contents
         $new_html_content = api_replace_links_in_string($upload_path, $buffer);
@@ -1899,7 +1899,7 @@ 
 
         foreach ($tag_list as & $this_tag) {
             //Display::display_normal_message(htmlentities($this_tag)); //debug
-            if ( preg_match("~".$param_name."[\s]*=[\s]*[\"]{1}([^\"]+)[\"]{1}~i", $this_tag, $matches)) {
+            if (preg_match("~".$param_name."[\s]*=[\s]*[\"]{1}([^\"]+)[\"]{1}~i", $this_tag, $matches)) {
                 $file_path_list[] = $matches[1]; // older
                 $href_list[] = $matches[0]; // to also add target="_self"
             }
@@ -1920,9 +1920,9 @@ 
 
                 // Fix the link to use download.php or showinframes.php
                 if (preg_match("/<a([\s]*[\"\/:'=a-z0-9]*){5}href[^<]*>/i", $tag_list[$count])) {
-                    $replace_by[$count] = " $param_name =\"showinframes.php?file=" . $upload_path.$file_path_list[$count]."\" target=\"_self\" ";
+                    $replace_by[$count] = " $param_name =\"showinframes.php?file=".$upload_path.$file_path_list[$count]."\" target=\"_self\" ";
                 } else {
-                    $replace_by[$count] = " $param_name =\"download.php?doc_url=" . $upload_path.$file_path_list[$count]."\" ";
+                    $replace_by[$count] = " $param_name =\"download.php?doc_url=".$upload_path.$file_path_list[$count]."\" ";
                 }
             } else {
                 // "mailto" or url already fixed, leave as is
@@ -1931,7 +1931,7 @@ 
             }
         } elseif ($is_absolute_hyperlink) {
             //$message .= "Absolute hyperlink, don't change, add target=_self: ";
-            $replace_by[$count] = " $param_name=\"" . $file_path_list[$count] . "\" target =\"_self\"";
+            $replace_by[$count] = " $param_name=\"".$file_path_list[$count]."\" target =\"_self\"";
         } else {
             // Don't change anything
             //$message .= "Local anchor, don't change: ";
@@ -1976,7 +1976,7 @@ 
 {
     // Do we need a / or not?
     $added_slash = ($upload_path == '/') ? '' : '/';
-    $folder_id      = DocumentManager::get_document_id(api_get_course_info(), $upload_path);
+    $folder_id = DocumentManager::get_document_id(api_get_course_info(), $upload_path);
     // Build the form
     $form = "<p><strong>".get_lang('MissingImagesDetected')."</strong></p>"
         ."<form method=\"post\" action=\"".api_get_self()."\" enctype=\"multipart/form-data\">"

main/inc/lib/formvalidator/Element/DateRangePicker.php

Doc Comments +1 added lines

@@ -145,6 +145,7 @@
 
     /**
     * @param array $dates result of parseDateRange()
+    * @param string $format
     *
     * @return bool
     */

Indentation +6 added lines, -6 removed lines

@@ -7,8 +7,8 @@ 
 class DateRangePicker extends HTML_QuickForm_text
 {
     /**
-    * Constructor
-    */
+     * Constructor
+     */
     public function __construct($elementName = null, $elementLabel = null, $attributes = null)
     {
         if (!isset($attributes['id'])) {
@@ -144,10 +144,10 @@ 
     }
 
     /**
-    * @param array $dates result of parseDateRange()
-    *
-    * @return bool
-    */
+     * @param array $dates result of parseDateRange()
+     *
+     * @return bool
+     */
     public function validateDates($dates, $format = null)
     {
         if (empty($dates['start']) || empty($dates['end'])) {

Spacing +1 added lines, -1 removed lines

@@ -88,7 +88,7 @@
         }
 
         $timePicker = 'true';
-        $timePickerValue =  $this->getAttribute('timePicker');
+        $timePickerValue = $this->getAttribute('timePicker');
         if (!empty($timePickerValue)) {
             $timePicker = $timePickerValue;
         }

main/inc/lib/formvalidator/FormValidator.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -213,7 +213,7 @@ 
      * @param string $label
      * @param array $attributes
      *
-     * @return mixed
+     * @return HTML_QuickForm_element
      */
     public function addDatePicker($name, $label, $attributes = [])
     {
@@ -225,7 +225,7 @@ 
      * @param string $label
      * @param array $attributes
      *
-     * @return mixed
+     * @return HTML_QuickForm_element
      */
     public function addDateTimePicker($name, $label, $attributes = [])
     {
@@ -688,7 +688,7 @@ 
      * @param array  $options
      * @param array  $attributes
      *
-     * @return HTML_QuickForm_radio
+     * @return HTML_QuickForm_group
      */
     public function addRadio($name, $label, $options = array(), $attributes = array())
     {
@@ -817,7 +817,7 @@ 
      * @param string $name
      * @param string $label
      *
-     * @return mixed
+     * @return HTML_QuickForm_element
      */
     public function addButtonAdvancedSettings($name, $label = '')
     {
@@ -914,7 +914,7 @@ 
     /**
      * This function has been created for avoiding changes directly within QuickForm class.
      * When we use it, the element is threated as 'required' to be dealt during validation.
-     * @param array $element					The array of elements
+     * @param array $elements					The array of elements
      * @param string $message					The message displayed
      */
     public function add_multiple_required_rule($elements, $message)

Spacing +12 added lines, -12 removed lines

@@ -99,7 +99,7 @@ 
         $renderer->setHeaderTemplate('<legend>{header}</legend>');
 
         //Set required field template
-        $this->setRequiredNote('<span class="form_required">*</span> <small>' . get_lang('ThisFieldIsRequired') . '</small>');
+        $this->setRequiredNote('<span class="form_required">*</span> <small>'.get_lang('ThisFieldIsRequired').'</small>');
         $noteTemplate = <<<EOT
 	<div class="form-group">
 		<div class="col-sm-offset-2 col-sm-10">{requiredNote}</div>
@@ -851,9 +851,9 @@ 
             $label = get_lang('PleaseStandBy');
         }
         $this->with_progress_bar = true;
-        $this->updateAttributes("onsubmit=\"javascript: myUpload.start('dynamic_div','".Display::returnIconPath('progress_bar.gif')."','" . $label . "','" . $this->getAttribute('id') . "')\"");
-        $this->addElement('html', '<script language="javascript" src="' . api_get_path(WEB_LIBRARY_PATH) . 'javascript/upload.js" type="text/javascript"></script>');
-        $this->addElement('html', '<script type="text/javascript">var myUpload = new upload(' . (abs(intval($delay)) * 1000) . ');</script>');
+        $this->updateAttributes("onsubmit=\"javascript: myUpload.start('dynamic_div','".Display::returnIconPath('progress_bar.gif')."','".$label."','".$this->getAttribute('id')."')\"");
+        $this->addElement('html', '<script language="javascript" src="'.api_get_path(WEB_LIBRARY_PATH).'javascript/upload.js" type="text/javascript"></script>');
+        $this->addElement('html', '<script type="text/javascript">var myUpload = new upload('.(abs(intval($delay)) * 1000).');</script>');
     }
 
     /**
@@ -870,11 +870,11 @@ 
             return;
         }
 
-        $xajax_upload = new xajax(api_get_path(WEB_LIBRARY_PATH) . 'upload.xajax.php');
+        $xajax_upload = new xajax(api_get_path(WEB_LIBRARY_PATH).'upload.xajax.php');
 
         $xajax_upload->registerFunction('updateProgress');
         // IMPORTANT : must be the first element of the form
-        $el = $this->insertElementBefore(FormValidator::createElement('html', '<input type="hidden" name="UPLOAD_IDENTIFIER" value="' . $upload_id . '" />'), $element_after);
+        $el = $this->insertElementBefore(FormValidator::createElement('html', '<input type="hidden" name="UPLOAD_IDENTIFIER" value="'.$upload_id.'" />'), $element_after);
 
         $this->addElement('html', '<br />');
 
@@ -882,7 +882,7 @@ 
         $this->addElement(
             'html',
             '<div id="dynamic_div_container" style="display:none">
-                <div id="dynamic_div_label">' . get_lang('UploadFile') . '</div>
+                <div id="dynamic_div_label">' . get_lang('UploadFile').'</div>
                 <div id="dynamic_div_frame" style="width:214px; height:12px; border:1px solid grey; background-image:url(' . Display::returnIconPath('real_upload_frame.gif').');">
                     <div id="dynamic_div_filled" style="width:0%;height:100%;background-image:url(' . Display::returnIconPath('real_upload_step.gif').');background-repeat:repeat-x;background-position:center;"></div>
                 </div>
@@ -893,7 +893,7 @@ 
             $this->addElement('html', '
 			<div id="dynamic_div_waiter_container" style="display:none">
 				<div id="dynamic_div_waiter_label">
-					' . get_lang('SlideshowConversion') . '
+					' . get_lang('SlideshowConversion').'
 				</div>
 				<div id="dynamic_div_waiter_frame">
 					'.Display::return_icon('real_upload_frame.gif').'
@@ -903,18 +903,18 @@ 
         }
 
         // Get the xajax code
-        $this->addElement('html', $xajax_upload->getJavascript(api_get_path(WEB_LIBRARY_PATH) . 'xajax'));
+        $this->addElement('html', $xajax_upload->getJavascript(api_get_path(WEB_LIBRARY_PATH).'xajax'));
 
         // Get the upload code
-        $this->addElement('html', '<script language="javascript" src="' . api_get_path(WEB_LIBRARY_PATH) . 'javascript/upload.js" type="text/javascript"></script>');
-        $this->addElement('html', '<script type="text/javascript">var myUpload = new upload(' . (abs(intval($delay)) * 1000) . ');</script>');
+        $this->addElement('html', '<script language="javascript" src="'.api_get_path(WEB_LIBRARY_PATH).'javascript/upload.js" type="text/javascript"></script>');
+        $this->addElement('html', '<script type="text/javascript">var myUpload = new upload('.(abs(intval($delay)) * 1000).');</script>');
 
         if (!$wait_after_upload) {
             $wait_after_upload = 0;
         }
 
         // Add the upload event
-        $this->updateAttributes("onsubmit=\"javascript: myUpload.startRealUpload('dynamic_div','" . $upload_id . "','" . $this->getAttribute('id') . "'," . $wait_after_upload . ")\"");
+        $this->updateAttributes("onsubmit=\"javascript: myUpload.startRealUpload('dynamic_div','".$upload_id."','".$this->getAttribute('id')."',".$wait_after_upload.")\"");
     }
 
     /**

main/inc/lib/formvalidator/Rule/HTML.php

Doc Comments +1 added lines, -2 removed lines

@@ -25,8 +25,7 @@
      * Get allowed tags
      * @param int $mode NO_HTML, STUDENT_HTML, TEACHER_HTML,
      * STUDENT_HTML_FULLPAGE or TEACHER_HTML_FULLPAGE
-     * @param boolean $fullpage If true, the allowed tags for full-page editing
-     * are returned.
+     * @return string
      */
     static function get_allowed_tags($mode)
     {

Spacing +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
      */
     function validate($html, $mode = NO_HTML)
     {
-        $allowed_tags = self::get_allowed_tags ($mode, $fullpage);
+        $allowed_tags = self::get_allowed_tags($mode, $fullpage);
         $cleaned_html = kses($html, $allowed_tags);
         return $html == $cleaned_html;
     }
@@ -33,7 +33,7 @@ 
         // Include the allowed tags.
         //include(dirname(__FILE__).'/allowed_tags.inc.php');
         global $allowed_tags_student, $allowed_tags_student_full_page, $allowed_tags_teacher, $allowed_tags_teacher_full_page;
-        switch($mode)
+        switch ($mode)
         {
             case NO_HTML:
                 return array();