chamilo / chamilo-lms

main/gradebook/lib/be/result.class.php

Doc Comments +3 added lines

@@ -59,6 +59,9 @@
         $this->evaluation = $evaluation_id;
     }
 
+    /**
+     * @param string $creation_date
+     */
     public function set_date($creation_date)
     {
         $this->created_at = $creation_date;

Spacing +29 added lines, -29 removed lines

@@ -90,23 +90,23 @@ 
         if (is_null($id) && is_null($user_id) && !is_null($evaluation_id)) {
             // Verified_if_exist_evaluation
             $sql = 'SELECT COUNT(*) AS count
-                    FROM ' . $tbl_grade_results . '
-                    WHERE evaluation_id="' . Database::escape_string($evaluation_id) . '";';
+                    FROM ' . $tbl_grade_results.'
+                    WHERE evaluation_id="' . Database::escape_string($evaluation_id).'";';
             $result = Database::query($sql);
             $existEvaluation = Database::result($result, 0, 0);
 
             if ($existEvaluation != 0) {
                 if ($sessionId) {
                     $sql = 'SELECT c_id, user_id as user_id, status
-                            FROM ' . $tbl_session_rel_course_user . '
+                            FROM ' . $tbl_session_rel_course_user.'
 							WHERE
 							    status= 0 AND
-							    c_id = "' . api_get_course_int_id() . '" AND
+							    c_id = "' . api_get_course_int_id().'" AND
 							    session_id = ' . $sessionId;
                 } else {
                     $sql = 'SELECT c_id, user_id, status
-                            FROM ' . $tbl_course_rel_course . '
-                            WHERE status ="' . STUDENT . '" AND c_id = "' . api_get_course_int_id() . '" ';
+                            FROM ' . $tbl_course_rel_course.'
+                            WHERE status ="' . STUDENT.'" AND c_id = "'.api_get_course_int_id().'" ';
                 }
 
                 $res_course_rel_user = Database::query($sql);
@@ -116,15 +116,15 @@ 
                 $current_date = api_get_utc_datetime();
                 for ($i = 0; $i < count($list_user_course_list); $i++) {
                     $sql_verified = 'SELECT COUNT(*) AS count
-                                    FROM ' . $tbl_grade_results . '
+                                    FROM ' . $tbl_grade_results.'
                                     WHERE
-                                        user_id="' . intval($list_user_course_list[$i]['user_id']) . '" AND
-                                        evaluation_id="' . intval($evaluation_id) . '";';
+                                        user_id="' . intval($list_user_course_list[$i]['user_id']).'" AND
+                                        evaluation_id="' . intval($evaluation_id).'";';
                     $res_verified = Database::query($sql_verified);
                     $info_verified = Database::result($res_verified, 0, 0);
                     if ($info_verified == 0) {
-                        $sql_insert = 'INSERT INTO ' . $tbl_grade_results . '(user_id,evaluation_id,created_at,score)
-									   VALUES ("' . intval($list_user_course_list[$i]['user_id']) . '","' . intval($evaluation_id) . '","' . $current_date . '",0);';
+                        $sql_insert = 'INSERT INTO '.$tbl_grade_results.'(user_id,evaluation_id,created_at,score)
+									   VALUES ("' . intval($list_user_course_list[$i]['user_id']).'","'.intval($evaluation_id).'","'.$current_date.'",0);';
                         Database::query($sql_insert);
                     }
                 }
@@ -148,16 +148,16 @@ 
 
         $paramcount = 0;
         if (!empty($id)) {
-            $sql.= ' WHERE gr.id = ' . intval($id);
-            $paramcount ++;
+            $sql .= ' WHERE gr.id = '.intval($id);
+            $paramcount++;
         }
         if (!empty($user_id)) {
             if ($paramcount != 0)
                 $sql .= ' AND';
             else
                 $sql .= ' WHERE';
-            $sql .= ' gr.user_id = ' . intval($user_id);
-            $paramcount ++;
+            $sql .= ' gr.user_id = '.intval($user_id);
+            $paramcount++;
         }
         if (!empty($evaluation_id)) {
             if ($paramcount != 0) {
@@ -165,8 +165,8 @@ 
             } else {
                 $sql .= ' WHERE';
             }
-            $sql .= ' gr.evaluation_id = ' . intval($evaluation_id);
-            $paramcount ++;
+            $sql .= ' gr.evaluation_id = '.intval($evaluation_id);
+            $paramcount++;
         }
         $sql .= ' ORDER BY u.lastname, u.firstname';
         $result = Database::query($sql);
@@ -191,17 +191,17 @@ 
     {
         if (isset($this->user_id) && isset($this->evaluation)) {
             $tbl_grade_results = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_RESULT);
-            $sql = "INSERT INTO " . $tbl_grade_results
+            $sql = "INSERT INTO ".$tbl_grade_results
                 . " (user_id, evaluation_id,
 					created_at";
             if (isset($this->score)) {
                 $sql .= ",score";
             }
             $sql .= ") VALUES
-					(" . (int) $this->get_user_id() . ", " . (int) $this->get_evaluation_id()
-                . ", '" . $this->get_date() . "' ";
+					(" . (int) $this->get_user_id().", ".(int) $this->get_evaluation_id()
+                . ", '".$this->get_date()."' ";
             if (isset($this->score)) {
-                $sql .= ", " . $this->get_score();
+                $sql .= ", ".$this->get_score();
             }
             $sql .= ")";
             Database::query($sql);
@@ -222,16 +222,16 @@ 
             $arr_result = $result->load(null, $userid, $evaluationid);
             $arr = get_object_vars($arr_result[0]);
 
-            $sql = 'INSERT INTO ' . $tbl_grade_results_log
+            $sql = 'INSERT INTO '.$tbl_grade_results_log
                 . ' (id_result,user_id, evaluation_id,created_at';
             if (isset($arr['score'])) {
                 $sql .= ',score';
             }
             $sql .= ') VALUES
-					(' . (int) $arr['id'] . ',' . (int) $arr['user_id'] . ', ' . (int) $arr['evaluation']
-                . ", '" . api_get_utc_datetime() . "'";
+					(' . (int) $arr['id'].','.(int) $arr['user_id'].', '.(int) $arr['evaluation']
+                . ", '".api_get_utc_datetime()."'";
             if (isset($arr['score'])) {
-                $sql .= ', ' . $arr['score'];
+                $sql .= ', '.$arr['score'];
             }
             $sql .= ')';
 
@@ -247,16 +247,16 @@ 
     public function save()
     {
         $tbl_grade_results = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_RESULT);
-        $sql = 'UPDATE ' . $tbl_grade_results . '
+        $sql = 'UPDATE '.$tbl_grade_results.'
                 SET user_id = ' . $this->get_user_id()
-            . ', evaluation_id = ' . $this->get_evaluation_id()
+            . ', evaluation_id = '.$this->get_evaluation_id()
             . ', score = ';
         if (isset($this->score)) {
             $sql .= $this->get_score();
         } else {
             $sql .= 'null';
         }
-        $sql .= ' WHERE id = ' . $this->id;
+        $sql .= ' WHERE id = '.$this->id;
         // no need to update creation date
         Database::query($sql);
     }
@@ -267,7 +267,7 @@ 
     public function delete()
     {
         $tbl_grade_results = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_RESULT);
-        $sql = 'DELETE FROM ' . $tbl_grade_results . ' WHERE id = ' . $this->id;
+        $sql = 'DELETE FROM '.$tbl_grade_results.' WHERE id = '.$this->id;
         Database::query($sql);
     }
 }

Braces +5 added lines, -4 removed lines

@@ -152,10 +152,11 @@
             $paramcount ++;
         }
         if (!empty($user_id)) {
-            if ($paramcount != 0)
-                $sql .= ' AND';
-            else
-                $sql .= ' WHERE';
+            if ($paramcount != 0) {
+                            $sql .= ' AND';
+            } else {
+                            $sql .= ' WHERE';
+            }
             $sql .= ' gr.user_id = ' . intval($user_id);
             $paramcount ++;
         }

main/gradebook/lib/fe/gradebooktable.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -32,6 +32,8 @@ 
      * @param array $evals
      * @param array $links
      * @param null $addparams
+     * @param boolean $showTeacherView
+     * @param integer $userId
      */
     public function __construct(
         $currentcat,
@@ -895,7 +897,7 @@ 
 
     /**
      * @param $item
-     * @return mixed
+     * @return string|null
      */
     private function build_course_code($item)
     {

Spacing +42 added lines, -42 removed lines

@@ -71,7 +71,7 @@ 
             $this->set_additional_parameters($addparams);
         }
 
-        $column= 0;
+        $column = 0;
         if ($this->teacherView) {
             if ($this->exportToPdf == false) {
                 $this->set_header($column++, '', '', 'width="25px"');
@@ -283,13 +283,13 @@ 
                 $main_categories[$item->get_id()]['name'] = $item->get_name();
             } else {
                 $name = $this->build_name_link($item, $type);
-                $row[] = $invisibility_span_open.$name. $invisibility_span_close;
+                $row[] = $invisibility_span_open.$name.$invisibility_span_close;
                 $main_categories[$item->get_id()]['name'] = $name;
             }
 
             $this->dataForGraph['categories'][] = $item->get_name();
 
-            $main_categories[$item->get_id()]['weight']= $item->get_weight();
+            $main_categories[$item->get_id()]['weight'] = $item->get_weight();
             $total_categories_weight += $item->get_weight();
 
             // Description.
@@ -309,9 +309,9 @@ 
             );
 
             if ($this->teacherView) {
-                $row[] = $invisibility_span_open .Display::tag('p', $weight, array('class' => 'score')).$invisibility_span_close;
+                $row[] = $invisibility_span_open.Display::tag('p', $weight, array('class' => 'score')).$invisibility_span_close;
             } else {
-                $row[] = $invisibility_span_open .$weight.$invisibility_span_close;
+                $row[] = $invisibility_span_open.$weight.$invisibility_span_close;
             }
 
             $category_weight = $item->get_weight();
@@ -337,7 +337,7 @@ 
 
                 if (!empty($score[1])) {
                     $completeScore = $scoredisplay->display_score($score, SCORE_DIV_PERCENT);
-                    $score = $score[0]/$score[1]*$item->get_weight();
+                    $score = $score[0] / $score[1] * $item->get_weight();
                     $score = $scoredisplay->display_score(array($score, null), SCORE_SIMPLE);
                     $scoreToDisplay = Display::tip($score, $completeScore);
                 } else {
@@ -373,7 +373,7 @@ 
                     $totalResultAverageValue = strip_tags($scoredisplay->display_score($totalResult, SCORE_AVERAGE));
                     $this->dataForGraph['my_result'][] = (float) str_replace('%', '', $totalResultAverageValue);
                     $totalAverageValue = strip_tags($scoredisplay->display_score($totalAverage, SCORE_AVERAGE));
-                    $this->dataForGraph['average'][] =  (float) str_replace('%', '', $totalAverageValue);
+                    $this->dataForGraph['average'][] = (float) str_replace('%', '', $totalAverageValue);
                     // Ranking
                     $row[] = $ranking;
                     // Best
@@ -456,7 +456,7 @@ 
                         $row[] = $this->build_type_column($item, array('style' => 'padding-left:5px'));
 
                         // Name.
-                        $row[] = $invisibility_span_open."     ".$this->build_name_link($item, $type) . $invisibility_span_close;
+                        $row[] = $invisibility_span_open."     ".$this->build_name_link($item, $type).$invisibility_span_close;
 
                         // Description.
                         if ($this->exportToPdf == false) {
@@ -494,7 +494,7 @@ 
                             // Students get the results and certificates columns
                             $eval_n_links = array_merge($alleval, $alllink);
 
-                            if (count($eval_n_links)> 0) {
+                            if (count($eval_n_links) > 0) {
                                 $value_data = isset($data[4]) ? $data[4] : null;
 
                                 if (!is_null($value_data)) {
@@ -593,7 +593,7 @@ 
                 $row = array(
                     null,
                     null,
-                    '<strong>' . get_lang('Total') . '</strong>',
+                    '<strong>'.get_lang('Total').'</strong>',
                     null,
                     $total
                 );
@@ -663,7 +663,7 @@ 
                 if ($this->exportToPdf) {
                     $row = array(
                         null,
-                        '<h3>' . get_lang('Total') . '</h3>',
+                        '<h3>'.get_lang('Total').'</h3>',
                         $main_weight,
                         $totalResult,
                         $totalRanking,
@@ -673,7 +673,7 @@ 
                 } else {
                     $row = array(
                         null,
-                        '<h3>' . get_lang('Total') . '</h3>',
+                        '<h3>'.get_lang('Total').'</h3>',
                         null,
                         $main_weight,
                         $totalResult,
@@ -688,7 +688,7 @@ 
         }
 
         // Warning messages
-        $view = isset($_GET['view']) ? $_GET['view']: null;
+        $view = isset($_GET['view']) ? $_GET['view'] : null;
 
         if ($this->teacherView) {
             if (isset($_GET['selectcat']) &&
@@ -701,14 +701,14 @@ 
                 $weight_category = intval($this->build_weight($category[0]));
 
                 $course_code = $this->build_course_code($category[0]);
-                $weight_total_links  = round($weight_total_links);
+                $weight_total_links = round($weight_total_links);
 
                 if ($weight_total_links > $weight_category ||
                     $weight_total_links < $weight_category ||
                     $weight_total_links > $weight_category
                 ) {
                     $warning_message = sprintf(get_lang('TotalWeightMustBeX'), $weight_category);
-                    $modify_icons  = '<a href="gradebook_edit_cat.php?editcat='.$id_cat.'&cidReq='.$course_code.'&id_session='.api_get_session_id().'">'.
+                    $modify_icons = '<a href="gradebook_edit_cat.php?editcat='.$id_cat.'&cidReq='.$course_code.'&id_session='.api_get_session_id().'">'.
                         Display::return_icon('edit.png', $warning_message, array(), ICON_SIZE_SMALL).'</a>';
                     $warning_message .= $modify_icons;
                     Display::display_warning_message($warning_message, false);
@@ -721,7 +721,7 @@ 
                 );
 
                 if (!empty($content_html)) {
-                    $new_content = explode('</head>',$content_html['content']);
+                    $new_content = explode('</head>', $content_html['content']);
                 }
 
                 if (empty($new_content[0])) {
@@ -755,7 +755,7 @@ 
                     is_array($course_codes)
                 ) {
                     $warning_message = '';
-                    for ($x = 0; $x<count($weight_categories);$x++) {
+                    for ($x = 0; $x < count($weight_categories); $x++) {
                         $weight_category = intval($weight_categories[$x]);
                         $certificate_min_score = intval($certificate_min_scores[$x]);
                         $course_code = $course_codes[$x];
@@ -763,12 +763,12 @@ 
                         if (empty($certificate_min_score) ||
                             ($certificate_min_score > $weight_category)
                         ) {
-                            $warning_message .= $course_code .'&nbsp;-&nbsp;'.get_lang('CertificateMinimunScoreIsRequiredAndMustNotBeMoreThan').'&nbsp;'.$weight_category.'<br />';
+                            $warning_message .= $course_code.'&nbsp;-&nbsp;'.get_lang('CertificateMinimunScoreIsRequiredAndMustNotBeMoreThan').'&nbsp;'.$weight_category.'<br />';
                         }
                     }
 
                     if (!empty($warning_message)) {
-                        Display::display_warning_message($warning_message,false);
+                        Display::display_warning_message($warning_message, false);
                     }
                 }
             }
@@ -812,15 +812,15 @@ 
             $pChart->Antialias = FALSE;
 
             /* Add a border to the picture */
-            $pChart->drawRectangle(0,0,$xSize-10,$ySize-10,array("R"=>0,"G"=>0,"B"=>0));
+            $pChart->drawRectangle(0, 0, $xSize - 10, $ySize - 10, array("R"=>0, "G"=>0, "B"=>0));
 
-            $pChart->drawText(10,16,get_lang('Results'),array("FontSize"=>11,"Align"=>TEXT_ALIGN_BOTTOMLEFT));
+            $pChart->drawText(10, 16, get_lang('Results'), array("FontSize"=>11, "Align"=>TEXT_ALIGN_BOTTOMLEFT));
 
-            $pChart->setGraphArea(50, 30, $xSize-50, $ySize-50);
+            $pChart->setGraphArea(50, 30, $xSize - 50, $ySize - 50);
 
             $pChart->setFontProperties(
                 array(
-                    'FontName' => api_get_path(SYS_FONTS_PATH) . 'opensans/OpenSans-Regular.ttf',
+                    'FontName' => api_get_path(SYS_FONTS_PATH).'opensans/OpenSans-Regular.ttf',
                     'FontSize' => 10,
                 )
             );
@@ -840,7 +840,7 @@ 
 
             /* Draw the line chart */
             $pChart->drawLineChart();
-            $pChart->drawPlotChart(array("DisplayValues"=>TRUE,"PlotBorder"=>TRUE,"BorderSize"=>2,"Surrounding"=>-60,"BorderAlpha"=>80));
+            $pChart->drawPlotChart(array("DisplayValues"=>TRUE, "PlotBorder"=>TRUE, "BorderSize"=>2, "Surrounding"=>-60, "BorderAlpha"=>80));
 
             /* Write the chart legend */
             $pChart->drawLegend(
@@ -860,13 +860,13 @@ 
             $chartHash = $myCache->getHash($dataSet);
 
             $myCache->writeToCache($chartHash, $pChart);
-            $imgSysPath = api_get_path(SYS_ARCHIVE_PATH) . $chartHash;
+            $imgSysPath = api_get_path(SYS_ARCHIVE_PATH).$chartHash;
             $myCache->saveFromCache($chartHash, $imgSysPath);
-            $imgWebPath = api_get_path(WEB_ARCHIVE_PATH) . $chartHash;
+            $imgWebPath = api_get_path(WEB_ARCHIVE_PATH).$chartHash;
 
             if (file_exists($imgSysPath)) {
                 $result = '<div id="contentArea" style="text-align: center;" >';
-                $result .= '<img src="' . $imgWebPath.'" >';
+                $result .= '<img src="'.$imgWebPath.'" >';
                 $result .= '</div>';
                 return $result;
             }
@@ -911,13 +911,13 @@ 
         switch ($item->get_item_type()) {
             // category
             case 'C' :
-                return 'CATE' . $item->get_id();
+                return 'CATE'.$item->get_id();
             // evaluation
             case 'E' :
-                return 'EVAL' . $item->get_id();
+                return 'EVAL'.$item->get_id();
             // link
             case 'L' :
-                return 'LINK' . $item->get_id();
+                return 'LINK'.$item->get_id();
         }
     }
 
@@ -945,20 +945,20 @@ 
         switch ($item->get_item_type()) {
             // category
             case 'C' :
-                $prms_uri='?selectcat=' . $item->get_id() . '&amp;view='.$view;
+                $prms_uri = '?selectcat='.$item->get_id().'&amp;view='.$view;
 
                 if (isset($_GET['isStudentView'])) {
-                    if ( isset($is_student) || ( isset($_SESSION['studentview']) && $_SESSION['studentview']=='studentview') ) {
-                        $prms_uri=$prms_uri.'&amp;isStudentView='.Security::remove_XSS($_GET['isStudentView']);
+                    if (isset($is_student) || (isset($_SESSION['studentview']) && $_SESSION['studentview'] == 'studentview')) {
+                        $prms_uri = $prms_uri.'&amp;isStudentView='.Security::remove_XSS($_GET['isStudentView']);
                     }
                 }
 
                 $cat = new Category();
-                $show_message=$cat->show_message_resource_delete($item->get_course_code());
+                $show_message = $cat->show_message_resource_delete($item->get_course_code());
                 return '&nbsp;<a href="'.Security::remove_XSS($_SESSION['gradebook_dest']).$prms_uri.'">'
                 . $item->get_name()
                 . '</a>'
-                . ($item->is_course() ? ' &nbsp;[' . $item->get_course_code() . ']'.$show_message : '');
+                . ($item->is_course() ? ' &nbsp;['.$item->get_course_code().']'.$show_message : '');
                 // evaluation
             case 'E' :
                 $cat = new Category();
@@ -966,10 +966,10 @@ 
                 $show_message = $cat->show_message_resource_delete($course_id);
 
                 // course/platform admin can go to the view_results page
-                if (api_is_allowed_to_edit() && $show_message===false) {
+                if (api_is_allowed_to_edit() && $show_message === false) {
                     if ($item->get_type() == 'presence') {
                         return '&nbsp;'
-                        . '<a href="gradebook_view_result.php?cidReq='.$course_id.'&amp;selecteval=' . $item->get_id() . '">'
+                        . '<a href="gradebook_view_result.php?cidReq='.$course_id.'&amp;selecteval='.$item->get_id().'">'
                         . $item->get_name()
                         . '</a>';
                     } else {
@@ -978,20 +978,20 @@ 
                             $extra = '';
                         }
                         return '&nbsp;'
-                        . '<a href="gradebook_view_result.php?' . api_get_cidreq() . '&selecteval=' . $item->get_id() . '">'
+                        . '<a href="gradebook_view_result.php?'.api_get_cidreq().'&selecteval='.$item->get_id().'">'
                         . $item->get_name()
                         . '</a>&nbsp;'.$extra;
                     }
-                } elseif (ScoreDisplay :: instance()->is_custom() && $show_message===false) {
+                } elseif (ScoreDisplay :: instance()->is_custom() && $show_message === false) {
                     // students can go to the statistics page (if custom display enabled)
                     return '&nbsp;'
-                    . '<a href="gradebook_statistics.php?' . api_get_cidreq() . '&selecteval=' . $item->get_id() . '">'
+                    . '<a href="gradebook_statistics.php?'.api_get_cidreq().'&selecteval='.$item->get_id().'">'
                     . $item->get_name()
                     . '</a>';
 
                 } elseif ($show_message === false && !api_is_allowed_to_edit() && !ScoreDisplay :: instance()->is_custom()) {
                     return '&nbsp;'
-                    . '<a href="gradebook_statistics.php?' . api_get_cidreq() . '&selecteval=' . $item->get_id() . '">'
+                    . '<a href="gradebook_statistics.php?'.api_get_cidreq().'&selecteval='.$item->get_id().'">'
                     . $item->get_name()
                     . '</a>';
                 } else {
@@ -1006,7 +1006,7 @@ 
                 $url = $item->get_link();
 
                 if (isset($url) && $show_message === false) {
-                    $text = '&nbsp;<a href="' . $item->get_link() . '">'
+                    $text = '&nbsp;<a href="'.$item->get_link().'">'
                         . $item->get_name()
                         . '</a>';
                 } else {

Braces +3 added lines, -2 removed lines

@@ -256,10 +256,11 @@
         }
 
         // Categories.
-        if (!empty($data_array))
-        foreach ($data_array as $data) {
+        if (!empty($data_array)) {
+                foreach ($data_array as $data) {
             // list of items inside the gradebook (exercises, lps, forums, etc)
             $row  = array();
+        }
             /** @var AbstractLink $item */
             $item = $mainCategory = $data[0];
 

Unused Use Statements -1 removed lines

@@ -1,7 +1,6 @@
 <?php
 /* For licensing terms, see /license.txt */
 
-use ChamiloSession as Session;
 use Symfony\Component\Finder\Finder;
 
 require_once '../inc/global.inc.php';

main/gradebook/lib/fe/linkform.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -124,8 +124,8 @@
 	}
 
 	/**
-	 * @param $link
-	 * @param $courseCode
+	 * @param integer $link
+	 * @param null|string $courseCode
 	 * @return AttendanceLink|DropboxLink|ExerciseLink|ForumThreadLink|LearnpathLink|null|StudentPublicationLink|SurveyLink
 	 */
 	private function createLink($link, $courseCode)

Indentation +117 added lines, -117 removed lines

@@ -10,133 +10,133 @@
  */
 class LinkForm extends FormValidator
 {
-	const TYPE_CREATE = 1;
-	const TYPE_MOVE = 2;
-	/** @var Category */
-	private $category_object;
-	private $link_object;
-	private $extra;
+    const TYPE_CREATE = 1;
+    const TYPE_MOVE = 2;
+    /** @var Category */
+    private $category_object;
+    private $link_object;
+    private $extra;
 
-	/**
-	 * Builds a form containing form items based on a given parameter
-	 * @param int form_type 1=choose link
-	 * @param obj cat_obj the category object
-	 * @param string form name
-	 * @param method
-	 * @param action
-	 */
-	public function LinkForm(
-		$form_type,
-		$category_object,
-		$link_object,
-		$form_name,
-		$method = 'post',
-		$action = null,
-		$extra = null
-	) {
-		parent :: __construct($form_name, $method, $action);
+    /**
+     * Builds a form containing form items based on a given parameter
+     * @param int form_type 1=choose link
+     * @param obj cat_obj the category object
+     * @param string form name
+     * @param method
+     * @param action
+     */
+    public function LinkForm(
+        $form_type,
+        $category_object,
+        $link_object,
+        $form_name,
+        $method = 'post',
+        $action = null,
+        $extra = null
+    ) {
+        parent :: __construct($form_name, $method, $action);
 
-		if (isset ($category_object)) {
-			$this->category_object = $category_object;
-		} else {
-			if (isset($link_object)) {
-				$this->link_object = $link_object;
-			}
-		}
+        if (isset ($category_object)) {
+            $this->category_object = $category_object;
+        } else {
+            if (isset($link_object)) {
+                $this->link_object = $link_object;
+            }
+        }
 
-		if (isset ($extra)) {
-			$this->extra = $extra;
-		}
-		if ($form_type == self :: TYPE_CREATE) {
-			$this->build_create();
-		} elseif ($form_type == self :: TYPE_MOVE) {
-			$this->build_move();
-		}
-	}
+        if (isset ($extra)) {
+            $this->extra = $extra;
+        }
+        if ($form_type == self :: TYPE_CREATE) {
+            $this->build_create();
+        } elseif ($form_type == self :: TYPE_MOVE) {
+            $this->build_move();
+        }
+    }
 
-	protected function build_move()
-	{
-		$renderer =& $this->defaultRenderer();
-		$renderer->setCustomElementTemplate('<span>{element}</span> ');
-		$this->addElement('static',null,null,'"'.$this->link_object->get_name().'" ');
-		$this->addElement('static',null,null,get_lang('MoveTo').' : ');
-		$select = $this->addElement('select','move_cat',null,null);
-		$line = '';
-		foreach ($this->link_object->get_target_categories() as $cat) {
-			for ($i=0;$i<$cat[2];$i++) {
-				$line .= '&mdash;';
-			}
-			$select->addoption($line.' '.$cat[1],$cat[0]);
-			$line = '';
-		}
-		$this->addElement('submit', null, get_lang('Ok'));
-	}
+    protected function build_move()
+    {
+        $renderer =& $this->defaultRenderer();
+        $renderer->setCustomElementTemplate('<span>{element}</span> ');
+        $this->addElement('static',null,null,'"'.$this->link_object->get_name().'" ');
+        $this->addElement('static',null,null,get_lang('MoveTo').' : ');
+        $select = $this->addElement('select','move_cat',null,null);
+        $line = '';
+        foreach ($this->link_object->get_target_categories() as $cat) {
+            for ($i=0;$i<$cat[2];$i++) {
+                $line .= '&mdash;';
+            }
+            $select->addoption($line.' '.$cat[1],$cat[0]);
+            $line = '';
+        }
+        $this->addElement('submit', null, get_lang('Ok'));
+    }
 
-	/**
-	 * Builds the form
-	 */
-	protected function build_create()
-	{
-		$this->addElement('header', get_lang('MakeLink'));
-		$select = $this->addElement(
-			'select',
-			'select_link',
-			get_lang('ChooseLink'),
-			null,
-			array('onchange' => 'document.create_link.submit()')
-		);
+    /**
+     * Builds the form
+     */
+    protected function build_create()
+    {
+        $this->addElement('header', get_lang('MakeLink'));
+        $select = $this->addElement(
+            'select',
+            'select_link',
+            get_lang('ChooseLink'),
+            null,
+            array('onchange' => 'document.create_link.submit()')
+        );
 
-		$linkTypes = LinkFactory::get_all_types();
+        $linkTypes = LinkFactory::get_all_types();
 
-		$select->addoption('['.get_lang('ChooseLink').']', 0);
+        $select->addoption('['.get_lang('ChooseLink').']', 0);
 
-		$courseCode = $this->category_object->get_course_code();
+        $courseCode = $this->category_object->get_course_code();
 
-		foreach ($linkTypes as $linkType) {
-			// The hot potatoe link will be added "inside" the exercise option.
-			if ($linkType == LINK_HOTPOTATOES) {
-				continue;
-			}
-			$link = $this->createLink($linkType, $courseCode);
-			// disable this element if the link works with a dropdownlist
-			// and if there are no links left
-			if (!$link->needs_name_and_description() && count($link->get_all_links()) == '0') {
-				$select->addoption($link->get_type_name(), $linkType, 'disabled');
-			} else {
-				if ($link->get_type() == LINK_EXERCISE) {
-					// Adding exercise
-					$select->addoption($link->get_type_name(), $linkType);
-					// Adding hot potatoes
-					$linkHot = $this->createLink(LINK_HOTPOTATOES, $courseCode);
-					$select->addoption(
-						'&nbsp;&nbsp;&nbsp;'.$linkHot->get_type_name(),
-						LINK_HOTPOTATOES
-					);
-				} else {
-					$select->addoption($link->get_type_name(), $linkType);
-				}
-			}
-		}
+        foreach ($linkTypes as $linkType) {
+            // The hot potatoe link will be added "inside" the exercise option.
+            if ($linkType == LINK_HOTPOTATOES) {
+                continue;
+            }
+            $link = $this->createLink($linkType, $courseCode);
+            // disable this element if the link works with a dropdownlist
+            // and if there are no links left
+            if (!$link->needs_name_and_description() && count($link->get_all_links()) == '0') {
+                $select->addoption($link->get_type_name(), $linkType, 'disabled');
+            } else {
+                if ($link->get_type() == LINK_EXERCISE) {
+                    // Adding exercise
+                    $select->addoption($link->get_type_name(), $linkType);
+                    // Adding hot potatoes
+                    $linkHot = $this->createLink(LINK_HOTPOTATOES, $courseCode);
+                    $select->addoption(
+                        '&nbsp;&nbsp;&nbsp;'.$linkHot->get_type_name(),
+                        LINK_HOTPOTATOES
+                    );
+                } else {
+                    $select->addoption($link->get_type_name(), $linkType);
+                }
+            }
+        }
 
-		if (isset($this->extra)) {
-			$this->setDefaults(array('select_link' => $this->extra));
-		}
-	}
+        if (isset($this->extra)) {
+            $this->setDefaults(array('select_link' => $this->extra));
+        }
+    }
 
-	/**
-	 * @param $link
-	 * @param $courseCode
-	 * @return AttendanceLink|DropboxLink|ExerciseLink|ForumThreadLink|LearnpathLink|null|StudentPublicationLink|SurveyLink
-	 */
-	private function createLink($link, $courseCode)
-	{
-		$link = LinkFactory::create($link);
-		if (!empty($courseCode)) {
-			$link->set_course_code($courseCode);
-		} elseif(!empty($_GET['course_code'])) {
-			$link->set_course_code(Database::escape_string($_GET['course_code'], null, false));
-		}
+    /**
+     * @param $link
+     * @param $courseCode
+     * @return AttendanceLink|DropboxLink|ExerciseLink|ForumThreadLink|LearnpathLink|null|StudentPublicationLink|SurveyLink
+     */
+    private function createLink($link, $courseCode)
+    {
+        $link = LinkFactory::create($link);
+        if (!empty($courseCode)) {
+            $link->set_course_code($courseCode);
+        } elseif(!empty($_GET['course_code'])) {
+            $link->set_course_code(Database::escape_string($_GET['course_code'], null, false));
+        }
 
-		return $link;
-	}
+        return $link;
+    }
 }

Spacing +7 added lines, -7 removed lines

@@ -56,17 +56,17 @@ 
 
 	protected function build_move()
 	{
-		$renderer =& $this->defaultRenderer();
+		$renderer = & $this->defaultRenderer();
 		$renderer->setCustomElementTemplate('<span>{element}</span> ');
-		$this->addElement('static',null,null,'"'.$this->link_object->get_name().'" ');
-		$this->addElement('static',null,null,get_lang('MoveTo').' : ');
-		$select = $this->addElement('select','move_cat',null,null);
+		$this->addElement('static', null, null, '"'.$this->link_object->get_name().'" ');
+		$this->addElement('static', null, null, get_lang('MoveTo').' : ');
+		$select = $this->addElement('select', 'move_cat', null, null);
 		$line = '';
 		foreach ($this->link_object->get_target_categories() as $cat) {
-			for ($i=0;$i<$cat[2];$i++) {
+			for ($i = 0; $i < $cat[2]; $i++) {
 				$line .= '&mdash;';
 			}
-			$select->addoption($line.' '.$cat[1],$cat[0]);
+			$select->addoption($line.' '.$cat[1], $cat[0]);
 			$line = '';
 		}
 		$this->addElement('submit', null, get_lang('Ok'));
@@ -133,7 +133,7 @@ 
 		$link = LinkFactory::create($link);
 		if (!empty($courseCode)) {
 			$link->set_course_code($courseCode);
-		} elseif(!empty($_GET['course_code'])) {
+		} elseif (!empty($_GET['course_code'])) {
 			$link->set_course_code(Database::escape_string($_GET['course_code'], null, false));
 		}
 

main/gradebook/lib/flatview_data_generator.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -30,7 +30,7 @@ 
      * @param array $evals
      * @param array $links
      * @param array $params
-     * @param null $mainCourseCategory
+     * @param Category|null $mainCourseCategory
      */
     public function FlatViewDataGenerator(
         $users = array(),
@@ -276,6 +276,8 @@ 
 
     /**
      * Get actual array data
+     * @param integer $users_count
+     * @param integer $items_count
      * @return array 2-dimensional array - each array contains the elements:
      * 0: user id
      * 1: user lastname

Spacing +44 added lines, -44 removed lines

@@ -114,10 +114,10 @@ 
             isset($this->params['only_subcat']) &&
             $this->params['only_subcat'] == $this->category->get_id()
         ) {
-            $main_weight  = $this->category->get_weight();
+            $main_weight = $this->category->get_weight();
             $grade_model_id = $this->category->get_grade_model_id();
         } else {
-            $main_cat  = Category::load($parent_id, null, null);
+            $main_cat = Category::load($parent_id, null, null);
             $main_weight = $main_cat[0]->get_weight();
             $grade_model_id = $main_cat[0]->get_grade_model_id();
         }
@@ -199,7 +199,7 @@ 
                     $list = [];
                     $list['items'] = $finalList;
                     $list['header'] = '<center>'.$mainHeader.'</center>';
-                    $headers[]= $list;
+                    $headers[] = $list;
                 } else {
                     $headers[] = '<center>'.$mainHeader.'</center>';
                 }
@@ -209,7 +209,7 @@ 
                 (isset($this->params['only_total_category']) &&
                     $this->params['only_total_category'] == false)
             ) {
-                for ($count=0; ($count < $items_count ) && ($items_start + $count < count($this->evals_links)); $count++) {
+                for ($count = 0; ($count < $items_count) && ($items_start + $count < count($this->evals_links)); $count++) {
                     /** @var AbstractLink $item */
                     $item = $this->evals_links[$count + $items_start];
                     $weight = round(100 * $item->get_weight() / $main_weight, 1);
@@ -227,7 +227,7 @@ 
                     !in_array($item->get_id(), $evaluationsAdded)
                 ) {
                     $weight = round(100 * $item->get_weight() / $main_weight, 1);
-                    $headers[] = $item->get_name() . ' ' . $weight . ' % ';
+                    $headers[] = $item->get_name().' '.$weight.' % ';
                 }
             }
         }
@@ -266,7 +266,7 @@ 
         if (!isset($items_count)) {
             $items_count = count($this->evals_links) - $items_start;
         }
-        for ($count=0; ($count < $items_count ) && ($items_start + $count < count($this->evals_links)); $count++) {
+        for ($count = 0; ($count < $items_count) && ($items_start + $count < count($this->evals_links)); $count++) {
             $item = $this->evals_links [$count + $items_start];
             $headers[] = $item->get_name();
         }
@@ -293,13 +293,13 @@ 
     ) {
         // Do some checks on users/items counts, redefine if invalid values
         if (!isset($users_count)) {
-            $users_count = count ($this->users) - $users_start;
+            $users_count = count($this->users) - $users_start;
         }
         if ($users_count < 0) {
             $users_count = 0;
         }
         if (!isset($items_count)) {
-            $items_count = count ($this->evals) + count ($this->links) - $items_start;
+            $items_count = count($this->evals) + count($this->links) - $items_start;
         }
         if ($items_count < 0) {
             $items_count = 0;
@@ -312,10 +312,10 @@ 
 
         // sort users array
         if ($users_sorting & self :: FVDG_SORT_LASTNAME) {
-            usort($userTable, array('FlatViewDataGenerator','sort_by_last_name'));
+            usort($userTable, array('FlatViewDataGenerator', 'sort_by_last_name'));
 
         } elseif ($users_sorting & self :: FVDG_SORT_FIRSTNAME) {
-            usort($userTable, array('FlatViewDataGenerator','sort_by_first_name'));
+            usort($userTable, array('FlatViewDataGenerator', 'sort_by_first_name'));
         }
 
         if ($users_sorting & self :: FVDG_SORT_DESC) {
@@ -356,10 +356,10 @@ 
         $parent_id = $this->category->get_parent_id();
 
         if ($parent_id == 0 or $this->params['only_subcat'] == $this->category->get_id()) {
-            $main_weight  = $this->category->get_weight();
+            $main_weight = $this->category->get_weight();
             $grade_model_id = $this->category->get_grade_model_id();
         } else {
-            $main_cat  = Category::load($parent_id, null, null);
+            $main_cat = Category::load($parent_id, null, null);
             $main_weight = $main_cat[0]->get_weight();
             $grade_model_id = $main_cat[0]->get_grade_model_id();
         }
@@ -471,11 +471,11 @@ 
                     $divide = $score[1] == 0 ? 1 : $score[1];
 
                     $sub_cat_percentage = $sum_categories_weight_array[$sub_cat->get_id()];
-                    $item_value  = $score[0]/$divide*$main_weight;
+                    $item_value = $score[0] / $divide * $main_weight;
 
                     // Fixing total when using one or multiple gradebooks
-                    $percentage = $sub_cat->get_weight()/($sub_cat_percentage) * $sub_cat_percentage/$this->category->get_weight();
-                    $item_value = $percentage*$item_value;
+                    $percentage = $sub_cat->get_weight() / ($sub_cat_percentage) * $sub_cat_percentage / $this->category->get_weight();
+                    $item_value = $percentage * $item_value;
                     $item_total += $sub_cat->get_weight();
                     /*
                         if ($convert_using_the_global_weight) {
@@ -521,7 +521,7 @@ 
                 if ($convert_using_the_global_weight) {
                     //$item_total = $main_weight;
                 }
-            } else  {
+            } else {
                 // All evaluations
                 $result = $this->parseEvaluations(
                     $user_id,
@@ -628,7 +628,7 @@ 
             // Sub cat weight
             //$sub_cat_percentage = $sum_categories_weight_array[$item->get_category_id()];
 
-            $item_value = isset($score[0]) ? $score[0]/$divide : 0;
+            $item_value = isset($score[0]) ? $score[0] / $divide : 0;
 
             // Fixing total when using one or multiple gradebooks.
             if (empty($parentCategoryIdFilter)) {
@@ -710,11 +710,11 @@ 
         $data = array();
 
         foreach ($selected_users as $user) {
-            $row = array ();
-            for ($count=0;$count < count($this->evals_links); $count++) {
+            $row = array();
+            for ($count = 0; $count < count($this->evals_links); $count++) {
                 $item = $this->evals_links [$count];
                 $score = $item->calc_score($user[0]);
-                $porcent_score = isset($score[1]) &&  $score[1] > 0 ? ($score[0]*100)/$score[1] :0;
+                $porcent_score = isset($score[1]) && $score[1] > 0 ? ($score[0] * 100) / $score[1] : 0;
                 $row[$item->get_name()] = $porcent_score;
             }
             $data[$user[0]] = $row;
@@ -726,7 +726,7 @@ 
             $tmp = array();
             foreach ($items as $item => $value) {
                 $tmp[] = $item;
-                if (in_array($item,$tmp)) {
+                if (in_array($item, $tmp)) {
                     $data_by_item[$item][$uid] = $value;
                 }
             }
@@ -737,7 +737,7 @@ 
         */
         $result = array();
         foreach ($data_by_item as $k => $v) {
-            $average = round(array_sum($v)/count($v));
+            $average = round(array_sum($v) / count($v));
             arsort($v);
             $maximum = array_shift($v);
             $minimum = array_pop($v);
@@ -746,7 +746,7 @@ 
                 $minimum = 0;
             }
 
-            $summary= array(
+            $summary = array(
                 'max' => $maximum,
                 'min' => $minimum,
                 'avg' => $average
@@ -763,32 +763,32 @@ 
     public function get_data_to_graph()
     {
         // do some checks on users/items counts, redefine if invalid values
-        $usertable = array ();
+        $usertable = array();
         foreach ($this->users as $user) {
             $usertable[] = $user;
         }
         // sort users array
-        usort($usertable, array ('FlatViewDataGenerator','sort_by_first_name'));
+        usort($usertable, array('FlatViewDataGenerator', 'sort_by_first_name'));
 
-        $data = array ();
+        $data = array();
 
         $selected_users = $usertable;
         foreach ($selected_users as $user) {
-            $row = array ();
-            $row[] = $user[0];    // user id
+            $row = array();
+            $row[] = $user[0]; // user id
             $item_value = 0;
             $item_total = 0;
 
-            for ($count=0;$count < count($this->evals_links); $count++) {
+            for ($count = 0; $count < count($this->evals_links); $count++) {
                 $item = $this->evals_links[$count];
                 $score = $item->calc_score($user[0]);
 
-                $divide =( ($score[1])==0 ) ? 1 : $score[1];
-                $item_value += $score[0]/$divide*$item->get_weight();
+                $divide = (($score[1]) == 0) ? 1 : $score[1];
+                $item_value += $score[0] / $divide * $item->get_weight();
                 $item_total += $item->get_weight();
 
 
-                $score_denom = ($score[1]==0) ? 1 : $score[1];
+                $score_denom = ($score[1] == 0) ? 1 : $score[1];
                 $score_final = ($score[0] / $score_denom) * 100;
                 $row[] = $score_final;
             }
@@ -814,15 +814,15 @@ 
             $usertable[] = $user;
         }
         // sort users array
-        usort($usertable, array ('FlatViewDataGenerator','sort_by_first_name'));
+        usort($usertable, array('FlatViewDataGenerator', 'sort_by_first_name'));
 
         // generate actual data array
         $scoredisplay = ScoreDisplay :: instance();
         $data = array();
         $selected_users = $usertable;
         foreach ($selected_users as $user) {
-            $row = array ();
-            $row[] = $user[0];    // user id
+            $row = array();
+            $row[] = $user[0]; // user id
             $item_value = 0;
             $item_total = 0;
             $final_score = 0;
@@ -843,8 +843,8 @@ 
                     $divide = $score[1] == 0 ? 1 : $score[1];
 
                     //$sub_cat_percentage = $sum_categories_weight_array[$sub_cat->get_id()];
-                    $item_value     = $score[0]/$divide*$main_weight;
-                    $item_total        += $sub_cat->get_weight();
+                    $item_value = $score[0] / $divide * $main_weight;
+                    $item_total += $sub_cat->get_weight();
 
                     $row[] = array(
                         $item_value,
@@ -861,23 +861,23 @@ 
                     trim($scoredisplay->display_score($total_score, SCORE_CUSTOM, null, true))
                 );
             } else {
-                for ($count=0;$count < count($this->evals_links); $count++) {
+                for ($count = 0; $count < count($this->evals_links); $count++) {
                     $item = $this->evals_links [$count];
                     $score = $item->calc_score($user[0]);
                     $divide = ($score[1]) == 0 ? 1 : $score[1];
                     $item_value += $score[0] / $divide * $item->get_weight();
-                    $item_total+=$item->get_weight();
-                    $score_denom=($score[1]==0) ? 1 : $score[1];
+                    $item_total += $item->get_weight();
+                    $score_denom = ($score[1] == 0) ? 1 : $score[1];
                     $score_final = ($score[0] / $score_denom) * 100;
-                    $row[] = array ($score_final, trim($scoredisplay->display_score($score, SCORE_CUSTOM,null, true)));
+                    $row[] = array($score_final, trim($scoredisplay->display_score($score, SCORE_CUSTOM, null, true)));
 
                 }
-                $total_score=array($item_value,$item_total);
+                $total_score = array($item_value, $item_total);
                 $score_final = ($item_value / $item_total) * 100;
                 if ($displayWarning) {
-                    Display::display_warning_message( Display::display_warning_message($total_score[1]));
+                    Display::display_warning_message(Display::display_warning_message($total_score[1]));
                 }
-                $row[] =array ($score_final, trim($scoredisplay->display_score($total_score, SCORE_CUSTOM, null, true)));
+                $row[] = array($score_final, trim($scoredisplay->display_score($total_score, SCORE_CUSTOM, null, true)));
             }
 
             $data[] = $row;

main/gradebook/lib/gradebook_data_generator.class.php

Doc Comments +2 added lines, -1 removed lines

@@ -71,6 +71,7 @@ 
 
     /**
      * Get actual array data
+     * @param integer $count
      * @return array 2-dimensional array - each array contains the elements:
      * 0: cat/eval/link object
      * 1: item name
@@ -304,7 +305,7 @@ 
     /**
      * @param int $userId
      * @param GradebookItem $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return null|string
      */
     private function build_result_column(

Spacing +10 added lines, -10 removed lines

@@ -42,12 +42,12 @@ 
         if (count($allcats) > 0) {
             // get sub categories id
             $tabCategories = array();
-            for ($i=0; $i < count($allcats); $i++) {
+            for ($i = 0; $i < count($allcats); $i++) {
                 $tabCategories[] = $allcats[$i]->get_id();
             }
             // dont display links that belongs to a sub category
             $tabLinkToDisplay = array();
-            for ($i=0; $i < count($alllinks); $i++) {
+            for ($i = 0; $i < count($alllinks); $i++) {
                 if (!in_array($alllinks[$i]->get_category_id(), $tabCategories)) {
                     $tabLinkToDisplay[] = $alllinks[$i];
                 }
@@ -89,7 +89,7 @@ 
         //$status = CourseManager::get_user_in_course_status(api_get_user_id(), api_get_course_id());
         // do some checks on count, redefine if invalid value
         if (!isset($count)) {
-            $count = count ($this->items) - $start;
+            $count = count($this->items) - $start;
         }
         if ($count < 0) {
             $count = 0;
@@ -246,7 +246,7 @@ 
         $display = $scoreDisplay->display_score($score, SCORE_DIV, SCORE_BOTH, true);
         $type = $item->get_item_type();
         if ($type == 'L' && get_class($item) == 'ExerciseLink') {
-            $display  = ExerciseLib::show_score($score[0], $score[1], false);
+            $display = ExerciseLib::show_score($score[0], $score[1], false);
         }
 
         return array(
@@ -268,7 +268,7 @@ 
         $type = $item->get_item_type();
 
         if ($type == 'L' && get_class($item) == 'ExerciseLink') {
-            $display  = ExerciseLib::show_score($score[0], $score[1], false);
+            $display = ExerciseLib::show_score($score[0], $score[1], false);
         }
 
         return array(
@@ -361,7 +361,7 @@ 
 
                 $type = $item->get_item_type();
                 if ($type == 'L' && get_class($item) == 'ExerciseLink') {
-                    $display  = ExerciseLib::show_score($score[0], $score[1], false);
+                    $display = ExerciseLib::show_score($score[0], $score[1], false);
                 }
 
                 return array(
@@ -442,7 +442,7 @@ 
     public function sort_by_type($item1, $item2)
     {
         if ($item1->get_item_type() == $item2->get_item_type()) {
-            return $this->sort_by_name($item1,$item2);
+            return $this->sort_by_name($item1, $item2);
         } else {
             return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
         }
@@ -457,7 +457,7 @@ 
     {
         $result = api_strcmp($item1->get_description(), $item2->get_description());
         if ($result == 0) {
-            return $this->sort_by_name($item1,$item2);
+            return $this->sort_by_name($item1, $item2);
         }
         return $result;
     }
@@ -470,7 +470,7 @@ 
     public function sort_by_weight($item1, $item2)
     {
         if ($item1->get_weight() == $item2->get_weight()) {
-            return $this->sort_by_name($item1,$item2);
+            return $this->sort_by_name($item1, $item2);
         } else {
             return ($item1->get_weight() < $item2->get_weight() ? -1 : 1);
         }
@@ -501,7 +501,7 @@ 
         }
 
         if ($timestamp1 == $timestamp2) {
-            return $this->sort_by_name($item1,$item2);
+            return $this->sort_by_name($item1, $item2);
         } else {
             return ($timestamp1 < $timestamp2 ? -1 : 1);
         }

main/gradebook/lib/gradebook_result.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
 
     /**
      * Exports the complete report as an XLS file
-     * @return	boolean		False on error
+     * @return	boolean|null		False on error
      */
     public function exportCompleteReportXLS($data)
     {

Spacing +12 added lines, -12 removed lines

@@ -14,7 +14,7 @@ 
     /**
      * constructor of the class
      */
-    public function __construct($get_questions=false,$get_answers=false)
+    public function __construct($get_questions = false, $get_answers = false)
     {
     }
 
@@ -36,21 +36,21 @@ 
         //titles
 
         foreach ($dato[0] as $header_col) {
-            if(!empty($header_col)) {
-                $data .= str_replace("\r\n",'  ',api_html_entity_decode(strip_tags($header_col))).';';
+            if (!empty($header_col)) {
+                $data .= str_replace("\r\n", '  ', api_html_entity_decode(strip_tags($header_col))).';';
             }
         }
 
-        $data .="\r\n";
+        $data .= "\r\n";
         $cant_students = count($dato[1]);
         //print_r($data);		exit();
 
-        for($i=0;$i<$cant_students;$i++) {
+        for ($i = 0; $i < $cant_students; $i++) {
             $column = 0;
-            foreach($dato[1][$i] as $col_name) {
-                $data .= str_replace("\r\n",'  ',api_html_entity_decode(strip_tags($col_name))).';';
+            foreach ($dato[1][$i] as $col_name) {
+                $data .= str_replace("\r\n", '  ', api_html_entity_decode(strip_tags($col_name))).';';
             }
-            $data .="\r\n";
+            $data .= "\r\n";
         }
 
         //output the results
@@ -101,7 +101,7 @@ 
         for ($i = 0; $i < $cant_students; $i++) {
             $column = 0;
             foreach ($data[1][$i] as $col_name) {
-                $worksheet->SetCellValueByColumnAndRow($line,$column, html_entity_decode(strip_tags($col_name)));
+                $worksheet->SetCellValueByColumnAndRow($line, $column, html_entity_decode(strip_tags($col_name)));
                 $column++;
             }
             $line++;
@@ -137,9 +137,9 @@ 
             'border_sz' => 20
         );
         $lines = 0;
-        $values[] = implode("\t",$data[0]);
+        $values[] = implode("\t", $data[0]);
         foreach ($data[1] as $line) {
-            $values[] = implode("\t",$line);
+            $values[] = implode("\t", $line);
             $lines++;
         }
         //$data = array();
@@ -154,7 +154,7 @@ 
             //    'right' => 4000,
             //    'left' => 4000
         );
-        $docx->createDocx($filepath,$paramsPage);
+        $docx->createDocx($filepath, $paramsPage);
         //output the results
         $data = file_get_contents($filepath.'.docx');
         $len = strlen($data);

main/gradebook/lib/GradebookUtils.php

Doc Comments +7 added lines, -3 removed lines

@@ -19,6 +19,7 @@ 
      * @param   int     Visibility (0 hidden, 1 shown)
      * @param   int     Session ID (optional or 0 if not defined)
      * @param   int
+     * @param integer $resource_type
      * @return  boolean True on success, false on failure
      */
     public static function add_resource_to_course_gradebook(
@@ -117,7 +118,6 @@ 
 
     /**
      * Builds an img tag for a gradebook item
-     * @param string $type value returned by a gradebookitem's get_icon_name()
      */
     public static function build_type_icon_tag($kind, $attributes = array())
     {
@@ -382,6 +382,7 @@ 
      * @param    int     Resource type (use constants defined in linkfactory.class.php)
      * @param    int     Resource ID in the corresponding tool
      * @param    int     Session ID (optional -  0 if not defined)
+     * @param integer $resource_type
      * @return   int     false on error or array of resource
      */
     public static function is_resource_in_course_gradebook($course_code, $resource_type, $resource_id, $session_id = 0)
@@ -579,6 +580,9 @@ 
      * @param int The user id
      * @param float The score obtained for certified
      * @param Datetime The date when you obtained the certificate
+     * @param integer $cat_id
+     * @param integer $user_id
+     * @param string $date_certificate
      * @return void()
      */
     public static function register_user_info_about_certificate($cat_id, $user_id, $score_certificate, $date_certificate)
@@ -955,7 +959,7 @@ 
     }
 
     /**
-     * @param array $list_values
+     * @param string[] $list_values
      * @return string
      */
     public static function score_badges($list_values)
@@ -1015,7 +1019,7 @@ 
     }
 
     /**
-     * @param $result
+     * @param Doctrine\DBAL\Driver\Statement|null $result
      * @return array
      */
     public static function get_user_array_from_sql_result($result)

Indentation +1 added lines, -1 removed lines

@@ -249,7 +249,7 @@
                     }
                 }
 
-               $modify_icons .= '<a href="gradebook_edit_all.php?selectcat=' .$cat->get_id() . '&cidReq=' . $cat->get_course_code() . '&id_session='.$cat->get_session_id().'">' .
+                $modify_icons .= '<a href="gradebook_edit_all.php?selectcat=' .$cat->get_id() . '&cidReq=' . $cat->get_course_code() . '&id_session='.$cat->get_session_id().'">' .
                     Display::return_icon(
                         'percentage.png',
                         get_lang('EditAllWeights'),

Spacing +87 added lines, -87 removed lines

@@ -77,9 +77,9 @@ 
         $course_code = Database::escape_string($course_code);
         if (!empty($link_id)) {
             $link_id = intval($link_id);
-            $sql = 'UPDATE ' . Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK) . '
-                    SET weight = ' . "'" . Database::escape_string((float) $weight) . "'" . '
-                    WHERE course_code = "' . $course_code . '" AND id = ' . $link_id;
+            $sql = 'UPDATE '.Database :: get_main_table(TABLE_MAIN_GRADEBOOK_LINK).'
+                    SET weight = ' . "'".Database::escape_string((float) $weight)."'".'
+                    WHERE course_code = "' . $course_code.'" AND id = '.$link_id;
             Database::query($sql);
         }
 
@@ -99,7 +99,7 @@ 
 
         // TODO find the corresponding category (the first one for this course, ordered by ID)
         $l = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
-        $sql = "DELETE FROM $l WHERE id = ".(int)$link_id;
+        $sql = "DELETE FROM $l WHERE id = ".(int) $link_id;
         Database::query($sql);
 
         return true;
@@ -195,8 +195,8 @@ 
             $visibility_icon = ($cat->is_visible() == 0) ? 'invisible' : 'visible';
             $visibility_command = ($cat->is_visible() == 0) ? 'set_visible' : 'set_invisible';
 
-            $modify_icons .= '<a class="view_children" data-cat-id="' . $cat->get_id() . '" href="javascript:void(0);">' .
-                Display::return_icon('view_more_stats.gif', get_lang('Show'), '', ICON_SIZE_SMALL) . '</a>';
+            $modify_icons .= '<a class="view_children" data-cat-id="'.$cat->get_id().'" href="javascript:void(0);">'.
+                Display::return_icon('view_more_stats.gif', get_lang('Show'), '', ICON_SIZE_SMALL).'</a>';
 
             if (!api_is_allowed_to_edit(null, true)) {
                 $modify_icons .= Display::url(
@@ -206,9 +206,9 @@ 
                         '',
                         ICON_SIZE_SMALL
                     ),
-                    'personal_stats.php?' . http_build_query([
+                    'personal_stats.php?'.http_build_query([
                         'selectcat' => $cat->get_id()
-                    ]) . '&' . api_get_cidreq(),
+                    ]).'&'.api_get_cidreq(),
                     [
                         'class' => 'ajax',
                         'data-title' => get_lang('FlatView')
@@ -222,16 +222,16 @@ 
                 if (api_get_setting('gradebook_locking_enabled') == 'true') {
                     if ($cat->is_locked()) {
                         if (api_is_platform_admin()) {
-                            $modify_icons .= '&nbsp;<a onclick="javascript:if (!confirm(\'' . addslashes(get_lang('ConfirmToUnlockElement')) . '\')) return false;" href="' . api_get_self() . '?' . api_get_cidreq() . '&category_id=' . $cat->get_id() . '&action=unlock">' .
-                                Display::return_icon('lock.png', get_lang('UnLockEvaluation'), '', ICON_SIZE_SMALL) . '</a>';
+                            $modify_icons .= '&nbsp;<a onclick="javascript:if (!confirm(\''.addslashes(get_lang('ConfirmToUnlockElement')).'\')) return false;" href="'.api_get_self().'?'.api_get_cidreq().'&category_id='.$cat->get_id().'&action=unlock">'.
+                                Display::return_icon('lock.png', get_lang('UnLockEvaluation'), '', ICON_SIZE_SMALL).'</a>';
                         } else {
-                            $modify_icons .= '&nbsp;<a href="#">' . Display::return_icon('lock_na.png', get_lang('GradebookLockedAlert'), '', ICON_SIZE_SMALL) . '</a>';
+                            $modify_icons .= '&nbsp;<a href="#">'.Display::return_icon('lock_na.png', get_lang('GradebookLockedAlert'), '', ICON_SIZE_SMALL).'</a>';
                         }
-                        $modify_icons .= '&nbsp;<a href="gradebook_flatview.php?export_pdf=category&selectcat=' . $cat->get_id() . '" >' . Display::return_icon('pdf.png', get_lang('ExportToPDF'), '', ICON_SIZE_SMALL) . '</a>';
+                        $modify_icons .= '&nbsp;<a href="gradebook_flatview.php?export_pdf=category&selectcat='.$cat->get_id().'" >'.Display::return_icon('pdf.png', get_lang('ExportToPDF'), '', ICON_SIZE_SMALL).'</a>';
                     } else {
-                        $modify_icons .= '&nbsp;<a onclick="javascript:if (!confirm(\'' . addslashes(get_lang('ConfirmToLockElement')) . '\')) return false;" href="' . api_get_self() . '?' . api_get_cidreq() . '&category_id=' . $cat->get_id() . '&action=lock">' .
-                            Display::return_icon('unlock.png', get_lang('LockEvaluation'), '', ICON_SIZE_SMALL) . '</a>';
-                        $modify_icons .= '&nbsp;<a href="#" >' . Display::return_icon('pdf_na.png', get_lang('ExportToPDF'), '', ICON_SIZE_SMALL) . '</a>';
+                        $modify_icons .= '&nbsp;<a onclick="javascript:if (!confirm(\''.addslashes(get_lang('ConfirmToLockElement')).'\')) return false;" href="'.api_get_self().'?'.api_get_cidreq().'&category_id='.$cat->get_id().'&action=lock">'.
+                            Display::return_icon('unlock.png', get_lang('LockEvaluation'), '', ICON_SIZE_SMALL).'</a>';
+                        $modify_icons .= '&nbsp;<a href="#" >'.Display::return_icon('pdf_na.png', get_lang('ExportToPDF'), '', ICON_SIZE_SMALL).'</a>';
                     }
                 }
 
@@ -239,44 +239,44 @@ 
                     if ($cat->is_locked() && !api_is_platform_admin()) {
                         $modify_icons .= Display::return_icon('edit_na.png', get_lang('Modify'), '', ICON_SIZE_SMALL);
                     } else {
-                        $modify_icons .= '<a href="gradebook_edit_cat.php?' .'editcat=' . $cat->get_id() . '&cidReq=' .$cat->get_course_code() . '&id_session='.$cat->get_session_id().'">' .
+                        $modify_icons .= '<a href="gradebook_edit_cat.php?'.'editcat='.$cat->get_id().'&cidReq='.$cat->get_course_code().'&id_session='.$cat->get_session_id().'">'.
                             Display::return_icon(
                                 'edit.png',
                                 get_lang('Modify'),
                                 '',
                                 ICON_SIZE_SMALL
-                            ) . '</a>';
+                            ).'</a>';
                     }
                 }
 
-               $modify_icons .= '<a href="gradebook_edit_all.php?selectcat=' .$cat->get_id() . '&cidReq=' . $cat->get_course_code() . '&id_session='.$cat->get_session_id().'">' .
+               $modify_icons .= '<a href="gradebook_edit_all.php?selectcat='.$cat->get_id().'&cidReq='.$cat->get_course_code().'&id_session='.$cat->get_session_id().'">'.
                     Display::return_icon(
                         'percentage.png',
                         get_lang('EditAllWeights'),
                         '',
                         ICON_SIZE_SMALL
-                    ) . '</a>';
+                    ).'</a>';
 
-                $modify_icons .= '<a href="gradebook_flatview.php?selectcat=' .$cat->get_id() . '&cidReq=' . $cat->get_course_code() . '&id_session='.$cat->get_session_id(). '">' .
+                $modify_icons .= '<a href="gradebook_flatview.php?selectcat='.$cat->get_id().'&cidReq='.$cat->get_course_code().'&id_session='.$cat->get_session_id().'">'.
                     Display::return_icon(
                         'stats.png',
                         get_lang('FlatView'),
                         '',
                         ICON_SIZE_SMALL
-                    ) . '</a>';
-                $modify_icons .= '&nbsp;<a href="' . api_get_self() .'?visiblecat=' . $cat->get_id() . '&' .$visibility_command . '=&selectcat=' . $selectcat .'&cidReq=' . $cat->get_course_code() . '&id_session='.$cat->get_session_id(). '">' .
+                    ).'</a>';
+                $modify_icons .= '&nbsp;<a href="'.api_get_self().'?visiblecat='.$cat->get_id().'&'.$visibility_command.'=&selectcat='.$selectcat.'&cidReq='.$cat->get_course_code().'&id_session='.$cat->get_session_id().'">'.
                     Display::return_icon(
-                        $visibility_icon . '.png',
+                        $visibility_icon.'.png',
                         get_lang('Visible'),
                         '',
                         ICON_SIZE_SMALL
-                    ) . '</a>';
+                    ).'</a>';
 
                 if ($cat->is_locked() && !api_is_platform_admin()) {
                     $modify_icons .= Display::return_icon('delete_na.png', get_lang('DeleteAll'), '', ICON_SIZE_SMALL);
                 } else {
-                    $modify_icons .= '&nbsp;<a href="' . api_get_self() . '?deletecat=' . $cat->get_id() . '&selectcat=' . $selectcat . '&cidReq=' . $cat->get_course_code() . '&id_session='.$cat->get_session_id(). '" onclick="return confirmation();">' .
-                        Display::return_icon('delete.png', get_lang('DeleteAll'), '', ICON_SIZE_SMALL) . '</a>';
+                    $modify_icons .= '&nbsp;<a href="'.api_get_self().'?deletecat='.$cat->get_id().'&selectcat='.$selectcat.'&cidReq='.$cat->get_course_code().'&id_session='.$cat->get_session_id().'" onclick="return confirmation();">'.
+                        Display::return_icon('delete.png', get_lang('DeleteAll'), '', ICON_SIZE_SMALL).'</a>';
                 }
             }
 
@@ -303,21 +303,21 @@ 
             if ($is_locked && !api_is_platform_admin()) {
                 $modify_icons = Display::return_icon('edit_na.png', get_lang('Modify'), '', ICON_SIZE_SMALL);
             } else {
-                $modify_icons = '<a href="gradebook_edit_eval.php?editeval=' . $eval->get_id() . '&cidReq=' . $eval->get_course_code() . '&id_session='.$eval->getSessionId(). '">' .
-                    Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '</a>';
+                $modify_icons = '<a href="gradebook_edit_eval.php?editeval='.$eval->get_id().'&cidReq='.$eval->get_course_code().'&id_session='.$eval->getSessionId().'">'.
+                    Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL).'</a>';
             }
 
-            $modify_icons .= '&nbsp;<a href="' . api_get_self() . '?visibleeval=' . $eval->get_id() . '&' . $visibility_command . '=&selectcat=' . $selectcat . '&id_session='.$eval->getSessionId(). ' ">' .
-                Display::return_icon($visibility_icon . '.png', get_lang('Visible'), '', ICON_SIZE_SMALL) . '</a>';
+            $modify_icons .= '&nbsp;<a href="'.api_get_self().'?visibleeval='.$eval->get_id().'&'.$visibility_command.'=&selectcat='.$selectcat.'&id_session='.$eval->getSessionId().' ">'.
+                Display::return_icon($visibility_icon.'.png', get_lang('Visible'), '', ICON_SIZE_SMALL).'</a>';
             if (api_is_allowed_to_edit(null, true)) {
-                $modify_icons .= '&nbsp;<a href="gradebook_showlog_eval.php?visiblelog=' . $eval->get_id() . '&selectcat=' . $selectcat . ' &cidReq=' . $eval->get_course_code() . '&id_session='.$eval->getSessionId(). '">' .
-                    Display::return_icon('history.png', get_lang('GradebookQualifyLog'), '', ICON_SIZE_SMALL) . '</a>';
+                $modify_icons .= '&nbsp;<a href="gradebook_showlog_eval.php?visiblelog='.$eval->get_id().'&selectcat='.$selectcat.' &cidReq='.$eval->get_course_code().'&id_session='.$eval->getSessionId().'">'.
+                    Display::return_icon('history.png', get_lang('GradebookQualifyLog'), '', ICON_SIZE_SMALL).'</a>';
             }
 
             if ($is_locked && !api_is_platform_admin()) {
-                $modify_icons .= '&nbsp;' . Display::return_icon('delete_na.png', get_lang('Delete'), '', ICON_SIZE_SMALL);
+                $modify_icons .= '&nbsp;'.Display::return_icon('delete_na.png', get_lang('Delete'), '', ICON_SIZE_SMALL);
             } else {
-                $modify_icons .= '&nbsp;<a href="' . api_get_self() . '?deleteeval=' . $eval->get_id() . '&selectcat=' . $selectcat . ' &cidReq=' . $eval->get_course_code() . '&id_session='.$eval->getSessionId(). '" onclick="return confirmation();">' . Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL) . '</a>';
+                $modify_icons .= '&nbsp;<a href="'.api_get_self().'?deleteeval='.$eval->get_id().'&selectcat='.$selectcat.' &cidReq='.$eval->get_course_code().'&id_session='.$eval->getSessionId().'" onclick="return confirmation();">'.Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).'</a>';
             }
             return $modify_icons;
         }
@@ -347,21 +347,21 @@ 
             if ($is_locked && !api_is_platform_admin()) {
                 $modify_icons = Display::return_icon('edit_na.png', get_lang('Modify'), '', ICON_SIZE_SMALL);
             } else {
-                $modify_icons = '<a href="gradebook_edit_link.php?editlink=' . $link->get_id() . '&cidReq=' . $link->get_course_code() . '&id_session='.$link->get_session_id().'">' .
-                    Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL) . '</a>';
+                $modify_icons = '<a href="gradebook_edit_link.php?editlink='.$link->get_id().'&cidReq='.$link->get_course_code().'&id_session='.$link->get_session_id().'">'.
+                    Display::return_icon('edit.png', get_lang('Modify'), '', ICON_SIZE_SMALL).'</a>';
             }
-            $modify_icons .= '&nbsp;<a href="' . api_get_self() . '?visiblelink=' . $link->get_id() . '&' . $visibility_command . '=&selectcat=' . $selectcat . '&id_session='.$link->get_session_id(). ' ">' .
-                Display::return_icon($visibility_icon . '.png', get_lang('Visible'), '', ICON_SIZE_SMALL) . '</a>';
-            $modify_icons .= '&nbsp;<a href="gradebook_showlog_link.php?visiblelink=' . $link->get_id() . '&selectcat=' . $selectcat . '&cidReq=' . $link->get_course_code() . '&id_session='.$link->get_session_id(). '">' .
-                Display::return_icon('history.png', get_lang('GradebookQualifyLog'), '', ICON_SIZE_SMALL) . '</a>';
+            $modify_icons .= '&nbsp;<a href="'.api_get_self().'?visiblelink='.$link->get_id().'&'.$visibility_command.'=&selectcat='.$selectcat.'&id_session='.$link->get_session_id().' ">'.
+                Display::return_icon($visibility_icon.'.png', get_lang('Visible'), '', ICON_SIZE_SMALL).'</a>';
+            $modify_icons .= '&nbsp;<a href="gradebook_showlog_link.php?visiblelink='.$link->get_id().'&selectcat='.$selectcat.'&cidReq='.$link->get_course_code().'&id_session='.$link->get_session_id().'">'.
+                Display::return_icon('history.png', get_lang('GradebookQualifyLog'), '', ICON_SIZE_SMALL).'</a>';
 
             //If a work is added in a gradebook you can only delete the link in the work tool
 
             if ($is_locked && !api_is_platform_admin()) {
-                $modify_icons .= '&nbsp;' . Display::return_icon('delete_na.png', get_lang('Delete'), '', ICON_SIZE_SMALL);
+                $modify_icons .= '&nbsp;'.Display::return_icon('delete_na.png', get_lang('Delete'), '', ICON_SIZE_SMALL);
             } else {
-                $modify_icons .= '&nbsp;<a href="' . api_get_self() . '?deletelink=' . $link->get_id() . '&selectcat=' . $selectcat . ' &cidReq=' . $link->get_course_code() . '&id_session='.$link->get_session_id(). '" onclick="return confirmation();">' .
-                    Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL) . '</a>';
+                $modify_icons .= '&nbsp;<a href="'.api_get_self().'?deletelink='.$link->get_id().'&selectcat='.$selectcat.' &cidReq='.$link->get_course_code().'&id_session='.$link->get_session_id().'" onclick="return confirmation();">'.
+                    Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL).'</a>';
             }
             return $modify_icons;
         }
@@ -382,8 +382,8 @@ 
         $sql = "SELECT * FROM $table l
                 WHERE
                     course_code = '$course_code' AND
-                    type = ".(int)$resource_type . " AND
-                    ref_id = " . (int)$resource_id;
+                    type = ".(int) $resource_type." AND
+                    ref_id = " . (int) $resource_id;
         $res = Database::query($sql);
 
         if (Database::num_rows($res) < 1) {
@@ -405,7 +405,7 @@ 
         }
         // TODO find the corresponding category (the first one for this course, ordered by ID)
         $l = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
-        $sql = "SELECT * FROM $l WHERE id = " . (int) $link_id;
+        $sql = "SELECT * FROM $l WHERE id = ".(int) $link_id;
         $res = Database::query($sql);
         $row = array();
         if (Database::num_rows($res) > 0) {
@@ -423,10 +423,10 @@ 
     {
         $course_table = Database::get_main_table(TABLE_MAIN_COURSE);
         $tbl_grade_links = Database::get_main_table(TABLE_MAIN_GRADEBOOK_LINK);
-        $sql = 'SELECT c.id FROM ' . $course_table . ' c
-                INNER JOIN ' . $tbl_grade_links . ' l
+        $sql = 'SELECT c.id FROM '.$course_table.' c
+                INNER JOIN ' . $tbl_grade_links.' l
                 ON c.code = l.course_code
-                WHERE l.id=' . intval($id_link) . ' OR l.category_id=' . intval($id_link);
+                WHERE l.id=' . intval($id_link).' OR l.category_id='.intval($id_link);
         $res = Database::query($sql);
         $array = Database::fetch_array($res, 'ASSOC');
         return $array['id'];
@@ -535,7 +535,7 @@ 
     {
         $result = Result :: load($resid);
         if ($importscore > $eval_max) {
-            header('Location: gradebook_view_result.php?selecteval=' . Security::remove_XSS($_GET['selecteval']) . '&overwritemax=');
+            header('Location: gradebook_view_result.php?selecteval='.Security::remove_XSS($_GET['selecteval']).'&overwritemax=');
             exit;
         }
         $result[0]->set_score($importscore);
@@ -576,8 +576,8 @@ 
     {
         $table = Database::get_main_table(TABLE_MAIN_GRADEBOOK_CERTIFICATE);
         $sql = 'SELECT COUNT(*) as count
-                FROM ' . $table . ' gc
-                WHERE gc.cat_id="' . intval($cat_id) . '" AND user_id="' . intval($user_id) . '" ';
+                FROM ' . $table.' gc
+                WHERE gc.cat_id="' . intval($cat_id).'" AND user_id="'.intval($user_id).'" ';
         $rs_exist = Database::query($sql);
         $row = Database::fetch_array($rs_exist);
         if ($row['count'] == 0) {
@@ -600,8 +600,8 @@ 
     public static function get_certificate_by_user_id($cat_id, $user_id)
     {
         $table_certificate = Database::get_main_table(TABLE_MAIN_GRADEBOOK_CERTIFICATE);
-        $sql = 'SELECT * FROM ' . $table_certificate . '
-                WHERE cat_id="' . intval($cat_id) . '" AND user_id="' . intval($user_id) . '"';
+        $sql = 'SELECT * FROM '.$table_certificate.'
+                WHERE cat_id="' . intval($cat_id).'" AND user_id="'.intval($user_id).'"';
 
         $result = Database::query($sql);
         $row = Database::fetch_array($result, 'ASSOC');
@@ -620,18 +620,18 @@ 
         $table_certificate = Database::get_main_table(TABLE_MAIN_GRADEBOOK_CERTIFICATE);
         $table_user = Database::get_main_table(TABLE_MAIN_USER);
         $sql = 'SELECT DISTINCT u.user_id, u.lastname, u.firstname, u.username
-                FROM ' . $table_user . ' u
-                INNER JOIN ' . $table_certificate . ' gc
+                FROM ' . $table_user.' u
+                INNER JOIN ' . $table_certificate.' gc
                 ON u.user_id=gc.user_id ';
         if (!is_null($cat_id) && $cat_id > 0) {
-            $sql.=' WHERE cat_id=' . intval($cat_id);
+            $sql .= ' WHERE cat_id='.intval($cat_id);
         }
         if (!empty($userList)) {
             $userList = array_map('intval', $userList);
             $userListCondition = implode("','", $userList);
             $sql .= " AND u.user_id IN ('$userListCondition')";
         }
-        $sql.=' ORDER BY u.firstname';
+        $sql .= ' ORDER BY u.firstname';
         $rs = Database::query($sql);
 
         $list_users = array();
@@ -652,10 +652,10 @@ 
     {
         $table_certificate = Database::get_main_table(TABLE_MAIN_GRADEBOOK_CERTIFICATE);
         $sql = 'SELECT gc.score_certificate, gc.created_at, gc.path_certificate, gc.cat_id, gc.user_id, gc.id
-                FROM  ' . $table_certificate . ' gc
-                WHERE gc.user_id="' . intval($user_id) . '" ';
+                FROM  ' . $table_certificate.' gc
+                WHERE gc.user_id="' . intval($user_id).'" ';
         if (!is_null($cat_id) && $cat_id > 0) {
-            $sql.=' AND cat_id=' . intval($cat_id);
+            $sql .= ' AND cat_id='.intval($cat_id);
         }
 
         $rs = Database::query($sql);
@@ -693,12 +693,12 @@ 
             $variables = $content_html['variables'];
         }
 
-        $path_image = api_get_path(WEB_COURSE_PATH) . api_get_course_path($course_code) . '/document/images/gallery';
+        $path_image = api_get_path(WEB_COURSE_PATH).api_get_course_path($course_code).'/document/images/gallery';
         $new_content_html = str_replace('../images/gallery', $path_image, $new_content_html);
 
-        $path_image_in_default_course = api_get_path(WEB_CODE_PATH) . 'default_course_document';
+        $path_image_in_default_course = api_get_path(WEB_CODE_PATH).'default_course_document';
         $new_content_html = str_replace('/main/default_course_document', $path_image_in_default_course, $new_content_html);
-        $new_content_html = str_replace(SYS_CODE_PATH . 'img/', api_get_path(WEB_IMG_PATH), $new_content_html);
+        $new_content_html = str_replace(SYS_CODE_PATH.'img/', api_get_path(WEB_IMG_PATH), $new_content_html);
 
         //add print header
         if ($hide_print_button == false) {
@@ -709,7 +709,7 @@ 
         }
 
         // Add header
-        $new_content_html =  $contentHead. $print . '</head>' . $new_content_html;
+        $new_content_html = $contentHead.$print.'</head>'.$new_content_html;
 
         return array(
             'content' => $new_content_html,
@@ -731,9 +731,9 @@ 
             $session_id = api_get_session_id();
 
             $t = Database::get_main_table(TABLE_MAIN_GRADEBOOK_CATEGORY);
-            $sql = "SELECT * FROM $t WHERE course_code = '" . Database::escape_string($course_code) . "' ";
+            $sql = "SELECT * FROM $t WHERE course_code = '".Database::escape_string($course_code)."' ";
             if (!empty($session_id)) {
-                $sql .= " AND session_id = " . (int) $session_id;
+                $sql .= " AND session_id = ".(int) $session_id;
             } else {
                 $sql .= " AND (session_id IS NULL OR session_id = 0) ";
             }
@@ -745,7 +745,7 @@ 
                 if (!empty($session_id)) {
                     $my_session_id = api_get_session_id();
                     $s_name = api_get_session_name($my_session_id);
-                    $cat->set_name($course_code . ' - ' . get_lang('Session') . ' ' . $s_name);
+                    $cat->set_name($course_code.' - '.get_lang('Session').' '.$s_name);
                     $cat->set_session_id($session_id);
                 } else {
                     $cat->set_name($course_code);
@@ -867,13 +867,13 @@ 
 
         if ($use_grade_model) {
             if ($parent_id == 0) {
-                $title = api_strtoupper(get_lang('Average')) . '<br />' . get_lang('Detailed');
+                $title = api_strtoupper(get_lang('Average')).'<br />'.get_lang('Detailed');
             } else {
-                $title = api_strtoupper(get_lang('Average')) . '<br />' . $cat[0]->get_description() . ' - (' . $cat[0]->get_name() . ')';
+                $title = api_strtoupper(get_lang('Average')).'<br />'.$cat[0]->get_description().' - ('.$cat[0]->get_name().')';
             }
         } else {
             if ($parent_id == 0) {
-                $title = api_strtoupper(get_lang('Average')) . '<br />' . get_lang('Detailed');
+                $title = api_strtoupper(get_lang('Average')).'<br />'.get_lang('Detailed');
             } else {
                 $title = api_strtoupper(get_lang('Average'));
             }
@@ -927,11 +927,11 @@ 
         } else {
             $column = 0;
             $table->setCellContents($row, $column, get_lang('NoResults'));
-            $table->updateCellAttributes($row, $column, 'colspan="' . $columns . '" align="center" class="row_odd"');
+            $table->updateCellAttributes($row, $column, 'colspan="'.$columns.'" align="center" class="row_odd"');
         }
 
         $pdfParams = array(
-            'filename' => get_lang('FlatView') . '_' . api_get_utc_datetime(),
+            'filename' => get_lang('FlatView').'_'.api_get_utc_datetime(),
             'pdf_title' => $title,
             'course_code' => $course_code,
             'add_signatures' => true
@@ -1016,7 +1016,7 @@ 
         $a_students = array();
         while ($user = Database::fetch_array($result)) {
             if (!array_key_exists($user['user_id'], $a_students)) {
-                $a_current_student = array ();
+                $a_current_student = array();
                 $a_current_student[] = $user['user_id'];
                 $a_current_student[] = $user['username'];
                 $a_current_student[] = $user['lastname'];
@@ -1074,7 +1074,7 @@ 
         foreach ($links as $link) {
             // links are always in a course
             $coursecode = $link->get_course_code();
-            if (!array_key_exists($coursecode,$coursecodes)) {
+            if (!array_key_exists($coursecode, $coursecodes)) {
                 $coursecodes[$coursecode] = '1';
                 $users = array_merge($users, GradebookUtils::get_users_in_course($coursecode));
             }
@@ -1087,7 +1087,7 @@ 
      * Search students matching a given last name and/or first name
      * @author Bert Steppé
      */
-    public static function find_students($mask= '')
+    public static function find_students($mask = '')
     {
         // students shouldn't be here // don't search if mask empty
         if (!api_is_allowed_to_edit() || empty ($mask)) {
@@ -1098,23 +1098,23 @@ 
         $tbl_user = Database :: get_main_table(TABLE_MAIN_USER);
         $tbl_cru = Database :: get_main_table(TABLE_MAIN_COURSE_USER);
         $sql = 'SELECT DISTINCT user.user_id, user.lastname, user.firstname, user.email, user.official_code
-                FROM ' . $tbl_user . ' user';
+                FROM ' . $tbl_user.' user';
         if (!api_is_platform_admin()) {
-            $sql .= ', ' . $tbl_cru . ' cru';
+            $sql .= ', '.$tbl_cru.' cru';
         }
 
-        $sql .= ' WHERE user.status = ' . STUDENT;
-        $sql .= ' AND (user.lastname LIKE '."'%" . $mask . "%'";
-        $sql .= ' OR user.firstname LIKE '."'%" . $mask . "%')";
+        $sql .= ' WHERE user.status = '.STUDENT;
+        $sql .= ' AND (user.lastname LIKE '."'%".$mask."%'";
+        $sql .= ' OR user.firstname LIKE '."'%".$mask."%')";
 
         if (!api_is_platform_admin()) {
             $sql .= ' AND user.user_id = cru.user_id AND
                       cru.relation_type <> '.COURSE_RELATION_TYPE_RRHH.' AND
                       cru.c_id in (
-                            SELECT c_id FROM '.$tbl_cru . '
+                            SELECT c_id FROM '.$tbl_cru.'
                             WHERE
-                                user_id = ' . api_get_user_id() . ' AND
-                                status = ' . COURSEMANAGER . '
+                                user_id = ' . api_get_user_id().' AND
+                                status = ' . COURSEMANAGER.'
                         )
                     ';
         }
@@ -1157,7 +1157,7 @@ 
         $sql = 'SELECT ref_id FROM '.$table_link.'
                 WHERE id = '.$linkId.' AND type='.LINK_ATTENDANCE;
 
-        $rs_attendance  = Database::query($sql);
+        $rs_attendance = Database::query($sql);
         if (Database::num_rows($rs_attendance) > 0) {
             $row_attendance = Database::fetch_array($rs_attendance);
             $sql = 'UPDATE '.$tbl_attendance.' SET attendance_weight ='.$weight.'
@@ -1243,7 +1243,7 @@ 
                 'course' => $courseInfo['title'],
                 'score' => $certificateInfo['score_certificate'],
                 'date' => api_format_date($certificateInfo['created_at'], DATE_FORMAT_SHORT),
-                'link' => api_get_path(WEB_PATH) . "certificates/index.php?id={$certificateInfo['id']}"
+                'link' => api_get_path(WEB_PATH)."certificates/index.php?id={$certificateInfo['id']}"
             ];
         }
 
@@ -1307,7 +1307,7 @@ 
                     'course' => $course['title'],
                     'score' => $certificateInfo['score_certificate'],
                     'date' => api_format_date($certificateInfo['created_at'], DATE_FORMAT_SHORT),
-                    'link' => api_get_path(WEB_PATH) . "certificates/index.php?id={$certificateInfo['id']}"
+                    'link' => api_get_path(WEB_PATH)."certificates/index.php?id={$certificateInfo['id']}"
                 ];
             }
         }

main/gradebook/lib/results_data_generator.class.php

Doc Comments +2 added lines

@@ -45,6 +45,7 @@ 
 
     /**
      * Get actual array data
+     * @param integer $count
      * @return array 2-dimensional array - each array contains the elements:
      * 0 ['id']        : user id
      * 1 ['result_id'] : result id
@@ -130,6 +131,7 @@ 
      * @param float Current absolute score (max score is taken from $this->evaluation->get_max()
      * @param bool  Whether we want the real score (2/4 (50 %)) or the transformation (A, B, C, etc)
      * @param bool  Whether we want to ignore the score color
+     * @param boolean $realscore
      * @result string The score as we want to show it
      */
     private function get_score_display ($score, $realscore, $ignore_score_color = false)

Spacing +11 added lines, -11 removed lines

@@ -38,7 +38,7 @@ 
     /**
      * Get total number of results (rows)
      */
-    public function get_total_results_count ()
+    public function get_total_results_count()
     {
         return count($this->results);
     }
@@ -53,12 +53,12 @@ 
      * 4 ['score']     : student's score
      * 5 ['display']   : custom score display (only if custom scoring enabled)
      */
-    public function get_data ($sorting = 0, $start = 0, $count = null, $ignore_score_color = false, $pdf=false)
+    public function get_data($sorting = 0, $start = 0, $count = null, $ignore_score_color = false, $pdf = false)
     {
         // do some checks on count, redefine if invalid value
         $number_decimals = api_get_setting('gradebook_number_decimals');
         if (!isset($count)) {
-            $count = count ($this->results) - $start;
+            $count = count($this->results) - $start;
         }
         if ($count < 0) {
             $count = 0;
@@ -66,11 +66,11 @@ 
         $scoredisplay = ScoreDisplay :: instance();
         // generate actual data array
         $table = array();
-        foreach($this->results as $result) {
+        foreach ($this->results as $result) {
             $user = array();
             $info = api_get_user_info($result->get_user_id());
             $user['id'] = $result->get_user_id();
-            if ($pdf){
+            if ($pdf) {
                 $user['username'] = $info['username'];
             }
             $user['result_id'] = $result->get_id();
@@ -92,7 +92,7 @@ 
                 true
             )
             );
-            if ($pdf && $number_decimals == null){
+            if ($pdf && $number_decimals == null) {
                 $user['scoreletter'] = $result->get_score();
             }
             if ($scoredisplay->is_custom()) {
@@ -132,13 +132,13 @@ 
      * @param bool  Whether we want to ignore the score color
      * @result string The score as we want to show it
      */
-    private function get_score_display ($score, $realscore, $ignore_score_color = false)
+    private function get_score_display($score, $realscore, $ignore_score_color = false)
     {
         if ($score != null) {
             $scoredisplay = ScoreDisplay :: instance();
             $type = SCORE_CUSTOM;
             if ($realscore === true) {
-                $type = SCORE_DIV_PERCENT ;
+                $type = SCORE_DIV_PERCENT;
             }
 
             return $scoredisplay->display_score(
@@ -172,10 +172,10 @@ 
         }
     }
 
-    function sort_by_mask ($item1, $item2)
+    function sort_by_mask($item1, $item2)
     {
-        $score1 = (isset($item1['score']) ? array($item1['score'],$this->evaluation->get_max()) : null);
-        $score2 = (isset($item2['score']) ? array($item2['score'],$this->evaluation->get_max()) : null);
+        $score1 = (isset($item1['score']) ? array($item1['score'], $this->evaluation->get_max()) : null);
+        $score2 = (isset($item2['score']) ? array($item2['score'], $this->evaluation->get_max()) : null);
         return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
     }
 }

main/gradebook/lib/scoredisplay.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -232,7 +232,7 @@ 
 
     /**
      * @param int $category_id
-     * @return bool
+     * @return false|null
      */
     public function insert_defaults($category_id)
     {
@@ -263,7 +263,7 @@ 
     }
 
     /**
-     * @return int|null|string
+     * @return integer
      */
     public function get_number_decimals()
     {
@@ -337,8 +337,8 @@ 
 
     /**
      * @param $score
-     * @param $type
-     * @return float|string
+     * @param integer $type
+     * @return string
      */
     private function display_default($score, $type)
     {

Spacing +18 added lines, -18 removed lines

@@ -34,7 +34,7 @@ 
     /**
      * Compare the custom display of 2 scores, can be useful in sorting
      */
-    public static function compare_scores_by_custom_display ($score1, $score2)
+    public static function compare_scores_by_custom_display($score1, $score2)
     {
         if (!isset($score1)) {
             return (isset($score2) ? 1 : 0);
@@ -47,7 +47,7 @@ 
             if ($custom1 == $custom2) {
                 return 0;
             } else {
-                return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
+                return (($score1[0] / $score1[1]) < ($score2[0] / $score2[1]) ? -1 : 1);
             }
         }
     }
@@ -79,7 +79,7 @@ 
         //Setting custom enabled
         $value = api_get_setting('gradebook_score_display_custom');
         $value = $value['my_display_custom'];
-        $this->custom_enabled  = $value == 'true' ? true : false;
+        $this->custom_enabled = $value == 'true' ? true : false;
 
         if ($this->custom_enabled) {
             $params = array('category = ?' =>  array('Gradebook'));
@@ -96,10 +96,10 @@ 
                 sort($portal_displays);
             }
             $this->custom_display = $portal_displays;
-            if (count($this->custom_display)>0) {
+            if (count($this->custom_display) > 0) {
                 $value = api_get_setting('gradebook_score_display_upperlimit');
                 $value = $value['my_display_upperlimit'];
-                $this->upperlimit_included  = $value == 'true' ? true : false;
+                $this->upperlimit_included = $value == 'true' ? true : false;
                 $this->custom_display_conv = $this->convert_displays($this->custom_display);
             }
         }
@@ -110,7 +110,7 @@ 
             //Load course settings
             if ($this->custom_enabled) {
                 $this->custom_display = $this->get_custom_displays();
-                if (count($this->custom_display)> 0) {
+                if (count($this->custom_display) > 0) {
                     $this->custom_display_conv = $this->convert_displays($this->custom_display);
                 }
             }
@@ -182,7 +182,7 @@ 
         }
 
         $sql = 'SELECT id FROM '.$tbl_gradebook_category.'
-                WHERE course_code = "'.$curr_course_code.'" '. $session_condition;
+                WHERE course_code = "'.$curr_course_code.'" '.$session_condition;
         $rs  = Database::query($sql);
         $category_id = 0;
         if (Database::num_rows($rs) > 0) {
@@ -251,7 +251,7 @@ 
         );
 
         $tbl_display = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_SCORE_DISPLAY);
-        foreach($display as $value => $text) {
+        foreach ($display as $value => $text) {
             $params = array(
                 'score' => $value,
                 'display' => $text,
@@ -307,7 +307,7 @@ 
         $my_score = $score == 0 ? 1 : $score;
 
         if ($type == SCORE_BAR) {
-            $percentage = $my_score[0]/$my_score[1]*100;
+            $percentage = $my_score[0] / $my_score[1] * 100;
 
             return Display::bar_progress($percentage);
         }
@@ -348,7 +348,7 @@ 
             case SCORE_PERCENT :                        // XX %
                 return $this->display_as_percent($score);
             case SCORE_DIV_PERCENT :                    // X / Y (XX %)
-                return $this->display_as_div($score).' (' . $this->display_as_percent($score) . ')';
+                return $this->display_as_div($score).' ('.$this->display_as_percent($score).')';
             case SCORE_AVERAGE :                        // XX %
                 return $this->display_as_percent($score);
             case SCORE_DECIMAL :                        // 0.50  (X/Y)
@@ -358,7 +358,7 @@ 
                 if (!empty($custom)) {
                     $custom = ' - '.$custom;
                 }
-                return $this->display_as_div($score).' (' . $this->display_as_percent($score) . ')'.$custom;
+                return $this->display_as_div($score).' ('.$this->display_as_percent($score).')'.$custom;
             case SCORE_DIV_SIMPLE_WITH_CUSTOM :         // X - Good!
                 $custom = $this->display_custom($score);
 
@@ -410,9 +410,9 @@ 
      */
     private function display_as_decimal($score)
     {
-        $score_denom = ($score[1]==0) ? 1 : $score[1];
+        $score_denom = ($score[1] == 0) ? 1 : $score[1];
 
-        return $this->format_score($score[0]/$score_denom);
+        return $this->format_score($score[0] / $score_denom);
     }
 
     /**
@@ -420,9 +420,9 @@ 
      */
     private function display_as_percent($score)
     {
-        $score_denom = ($score[1]==0) ? 1 : $score[1];
+        $score_denom = ($score[1] == 0) ? 1 : $score[1];
 
-        return $this->format_score($score[0]/$score_denom*100) . ' %';
+        return $this->format_score($score[0] / $score_denom * 100).' %';
     }
 
     /**
@@ -438,7 +438,7 @@ 
         } else {
             $score[0] = isset($score[0]) ? $this->format_score($score[0]) : 0;
             $score[1] = isset($score[1]) ? $this->format_score($score[1]) : 0;
-            return  $score[0] . ' / ' . $score[1];
+            return  $score[0].' / '.$score[1];
         }
     }
 
@@ -448,7 +448,7 @@ 
      */
     private function display_custom($score)
     {
-        $my_score_denom= ($score[1]==0) ? 1 : $score[1];
+        $my_score_denom = ($score[1] == 0) ? 1 : $score[1];
         $scaledscore = $score[0] / $my_score_denom;
         if ($this->upperlimit_included) {
             foreach ($this->custom_display_conv as $displayitem) {
@@ -512,7 +512,7 @@ 
                 ORDER BY score';
         $result = Database::query($sql);
 
-        return Database::store_result($result,'ASSOC');
+        return Database::store_result($result, 'ASSOC');
     }
 
     /**