chamilo / chamilo-lms

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 +11 added lines, -11 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++;
@@ -121,7 +121,7 @@ 
      */
     public function exportCompleteReportDOC($data)
     {
-        $filename = 'gradebook_results_'.api_get_local_time() . '.docx';
+        $filename = 'gradebook_results_'.api_get_local_time().'.docx';
 
         $doc = new \PhpOffice\PhpWord\PhpWord();
         $section = $doc->addSection(['orientation' => 'landscape']);
@@ -140,7 +140,7 @@ 
             }
         }
 
-        $file = api_get_path(SYS_ARCHIVE_PATH) . api_replace_dangerous_char($filename);
+        $file = api_get_path(SYS_ARCHIVE_PATH).api_replace_dangerous_char($filename);
         $doc->save($file, 'Word2007');
 
         DocumentManager::file_send_for_download($file, true, $filename);

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

@@ -44,7 +44,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'));
@@ -61,10 +61,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);
             }
         }
@@ -75,7 +75,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);
                 }
             }
@@ -103,7 +103,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);
@@ -116,7 +116,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);
             }
         }
     }
@@ -184,7 +184,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) {
@@ -253,7 +253,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,
@@ -309,7 +309,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);
         }
@@ -350,7 +350,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)
@@ -360,7 +360,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);
 
@@ -412,9 +412,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);
     }
 
     /**
@@ -422,9 +422,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).' %';
     }
 
     /**
@@ -440,7 +440,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];
         }
     }
 
@@ -450,7 +450,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) {
@@ -514,7 +514,7 @@ 
                 ORDER BY score';
         $result = Database::query($sql);
 
-        return Database::store_result($result,'ASSOC');
+        return Database::store_result($result, 'ASSOC');
     }
 
     /**

main/gradebook/lib/user_data_generator.class.php

Doc Comments +5 added lines, -4 removed lines

@@ -72,6 +72,7 @@ 
 
 	/**
 	 * Get actual array data
+	 * @param integer $count
 	 * @return array 2-dimensional array - each array contains the elements:
 	 * 0: eval/link object
 	 * 1: item name
@@ -285,7 +286,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_average_column($item, $ignore_score_color)
@@ -306,7 +307,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_result_column($item, $ignore_score_color)
@@ -323,7 +324,7 @@ 
 
 	/**
 	 * @param $item
-	 * @param $ignore_score_color
+	 * @param boolean $ignore_score_color
 	 * @return string
 	 */
 	private function build_mask_column($item, $ignore_score_color)
@@ -339,7 +340,7 @@ 
 
 	/**
 	 * @param $coursecode
-	 * @return mixed
+	 * @return string
 	 */
 	private function get_course_name_from_code_cached($coursecode)
 	{

Indentation +346 added lines, -346 removed lines

@@ -10,28 +10,28 @@ 
  */
 class UserDataGenerator
 {
-	// Sorting types constants
-	const UDG_SORT_TYPE = 1;
-	const UDG_SORT_NAME = 2;
-	const UDG_SORT_COURSE = 4;
-	const UDG_SORT_CATEGORY = 8;
-	const UDG_SORT_AVERAGE = 16;
-	const UDG_SORT_SCORE = 32;
-	const UDG_SORT_MASK = 64;
-
-	const UDG_SORT_ASC = 128;
-	const UDG_SORT_DESC = 256;
-
-	private $items;
-	private $userid;
-
-	private $coursecodecache;
-	private $categorycache;
-	private $scorecache;
-	private $avgcache;
-
-	public function UserDataGenerator($userid, $evals = array(), $links = array())
-	{
+    // Sorting types constants
+    const UDG_SORT_TYPE = 1;
+    const UDG_SORT_NAME = 2;
+    const UDG_SORT_COURSE = 4;
+    const UDG_SORT_CATEGORY = 8;
+    const UDG_SORT_AVERAGE = 16;
+    const UDG_SORT_SCORE = 32;
+    const UDG_SORT_MASK = 64;
+
+    const UDG_SORT_ASC = 128;
+    const UDG_SORT_DESC = 256;
+
+    private $items;
+    private $userid;
+
+    private $coursecodecache;
+    private $categorycache;
+    private $scorecache;
+    private $avgcache;
+
+    public function UserDataGenerator($userid, $evals = array(), $links = array())
+    {
         $this->userid = $userid;
         $evals_filtered = array();
         $result = array();
@@ -62,330 +62,330 @@ 
         $this->avgcache = null;
     }
 
-	/**
-	 * Get total number of items (rows)
-	 */
-	public function get_total_items_count()
-	{
-		return count($this->items);
-	}
-
-	/**
-	 * Get actual array data
-	 * @return array 2-dimensional array - each array contains the elements:
-	 * 0: eval/link object
-	 * 1: item name
-	 * 2: course name
-	 * 3: category name
-	 * 4: average score
-	 * 5: student's score
-	 * 6: student's score as custom display (only if custom scoring enabled)
-	 */
-	public function get_data($sorting = 0, $start = 0, $count = null, $ignore_score_color = false)
-	{
-		// do some checks on count, redefine if invalid value
-		if (!isset($count)) {
-			$count = count ($this->items) - $start;
-		}
-		if ($count < 0) {
-			$count = 0;
-		}
-		$allitems = $this->items;
-
-		// sort users array
-		if ($sorting & self :: UDG_SORT_TYPE) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_type'));
-		}elseif ($sorting & self :: UDG_SORT_NAME) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_name'));
-		} elseif ($sorting & self :: UDG_SORT_COURSE) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_course'));
-		} elseif ($sorting & self :: UDG_SORT_CATEGORY) {
-			usort($allitems, array('UserDataGenerator', 'sort_by_category'));
-		} elseif ($sorting & self :: UDG_SORT_AVERAGE) {
-			// if user sorts on average scores, first calculate them and cache them
-			foreach ($allitems as $item) {
-				$this->avgcache[$item->get_item_type() . $item->get_id()]= $item->calc_score();
-			}
-			usort($allitems, array('UserDataGenerator', 'sort_by_average'));
-		} elseif ($sorting & self :: UDG_SORT_SCORE) {
-			// if user sorts on student's scores, first calculate them and cache them
-			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
-					= $item->calc_score($this->userid);
-			}
-			usort($allitems, array('UserDataGenerator', 'sort_by_score'));
-		} elseif ($sorting & self :: UDG_SORT_MASK) {
-			// if user sorts on student's masks, first calculate scores and cache them
-			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
-					= $item->calc_score($this->userid);
-			}
-			usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
-		}
-
-		if ($sorting & self :: UDG_SORT_DESC) {
-			$allitems = array_reverse($allitems);
-		}
-		// select the items we have to display
-		$visibleitems = array_slice($allitems, $start, $count);
-
-		// fill score cache if not done yet
-		if (!isset ($this->scorecache)) {
-			foreach ($visibleitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
-					= $item->calc_score($this->userid);
-			}
-
-		}
-		// generate the data to display
-		$scoredisplay = ScoreDisplay :: instance();
-		$data = array();
-		foreach ($visibleitems as $item) {
-			$row = array ();
-			$row[] = $item;
-			$row[] = $item->get_name();
-			$row[] = $this->build_course_name($item);
-			$row[] = $this->build_category_name($item);
-			$row[] = $this->build_average_column($item, $ignore_score_color);
-			$row[] = $this->build_result_column($item, $ignore_score_color);
-			if ($scoredisplay->is_custom())
-				$row[] = $this->build_mask_column($item, $ignore_score_color);
-			$data[] = $row;
-		}
-		return $data;
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_type($item1, $item2)
-	{
-		if ($item1->get_item_type() == $item2->get_item_type()) {
-			return $this->sort_by_name($item1,$item2);
-		} else {
-			return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
-		}
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_course($item1, $item2)
-	{
-		$name1 = api_strtolower($this->get_course_name_from_code_cached($item1->get_course_code()));
-		$name2 = api_strtolower($this->get_course_name_from_code_cached($item2->get_course_code()));
-		return api_strnatcmp($name1, $name2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_category($item1, $item2)
-	{
-		$cat1 = $this->get_category_cached($item1->get_category_id());
-		$cat2 = $this->get_category_cached($item2->get_category_id());
-		$name1 = api_strtolower($this->get_category_name_to_display($cat1));
-		$name2 = api_strtolower($this->get_category_name_to_display($cat2));
-
-		return api_strnatcmp($name1, $name2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_name($item1, $item2)
-	{
-		return api_strnatcmp($item1->get_name(),$item2->get_name());
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_average($item1, $item2)
-	{
-		$score1 = $this->avgcache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->avgcache[$item2->get_item_type() . $item2->get_id()];
-
-		return $this->compare_scores($score1, $score2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_score($item1, $item2)
-	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
-
-		return $this->compare_scores($score1, $score2);
-	}
-
-	/**
-	 * @param $item1
-	 * @param $item2
-	 * @return int
-	 */
-	function sort_by_mask($item1, $item2)
-	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
-
-		return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
-	}
-
-	/**
-	 * @param $score1
-	 * @param $score2
-	 * @return int
-	 */
-	function compare_scores($score1, $score2)
-	{
-		if (!isset($score1)) {
-			return (isset($score2) ? 1 : 0);
-		} elseif (!isset($score2)) {
-			return -1;
-		} elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
-			return 0;
-		} else {
-			return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
-		}
-	}
-
-	/**
-	 * @param $item
-	 * @return mixed
-	 */
-	private function build_course_name($item)
-	{
-		return $this->get_course_name_from_code_cached($item->get_course_code());
-	}
-
-	/**
-	 * @param $item
-	 * @return string
-	 */
-	private function build_category_name($item)
-	{
-		$cat = $this->get_category_cached($item->get_category_id());
-
-		return $this->get_category_name_to_display($cat);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_average_column($item, $ignore_score_color)
-	{
-		if (isset($this->avgcache)) {
-			$avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
-		} else {
-			$avgscore = $item->calc_score();
-		}
-
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_AVERAGE;
-		/*if ($ignore_score_color)
+    /**
+     * Get total number of items (rows)
+     */
+    public function get_total_items_count()
+    {
+        return count($this->items);
+    }
+
+    /**
+     * Get actual array data
+     * @return array 2-dimensional array - each array contains the elements:
+     * 0: eval/link object
+     * 1: item name
+     * 2: course name
+     * 3: category name
+     * 4: average score
+     * 5: student's score
+     * 6: student's score as custom display (only if custom scoring enabled)
+     */
+    public function get_data($sorting = 0, $start = 0, $count = null, $ignore_score_color = false)
+    {
+        // do some checks on count, redefine if invalid value
+        if (!isset($count)) {
+            $count = count ($this->items) - $start;
+        }
+        if ($count < 0) {
+            $count = 0;
+        }
+        $allitems = $this->items;
+
+        // sort users array
+        if ($sorting & self :: UDG_SORT_TYPE) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_type'));
+        }elseif ($sorting & self :: UDG_SORT_NAME) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_name'));
+        } elseif ($sorting & self :: UDG_SORT_COURSE) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_course'));
+        } elseif ($sorting & self :: UDG_SORT_CATEGORY) {
+            usort($allitems, array('UserDataGenerator', 'sort_by_category'));
+        } elseif ($sorting & self :: UDG_SORT_AVERAGE) {
+            // if user sorts on average scores, first calculate them and cache them
+            foreach ($allitems as $item) {
+                $this->avgcache[$item->get_item_type() . $item->get_id()]= $item->calc_score();
+            }
+            usort($allitems, array('UserDataGenerator', 'sort_by_average'));
+        } elseif ($sorting & self :: UDG_SORT_SCORE) {
+            // if user sorts on student's scores, first calculate them and cache them
+            foreach ($allitems as $item) {
+                $this->scorecache[$item->get_item_type() . $item->get_id()]
+                    = $item->calc_score($this->userid);
+            }
+            usort($allitems, array('UserDataGenerator', 'sort_by_score'));
+        } elseif ($sorting & self :: UDG_SORT_MASK) {
+            // if user sorts on student's masks, first calculate scores and cache them
+            foreach ($allitems as $item) {
+                $this->scorecache[$item->get_item_type() . $item->get_id()]
+                    = $item->calc_score($this->userid);
+            }
+            usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
+        }
+
+        if ($sorting & self :: UDG_SORT_DESC) {
+            $allitems = array_reverse($allitems);
+        }
+        // select the items we have to display
+        $visibleitems = array_slice($allitems, $start, $count);
+
+        // fill score cache if not done yet
+        if (!isset ($this->scorecache)) {
+            foreach ($visibleitems as $item) {
+                $this->scorecache[$item->get_item_type() . $item->get_id()]
+                    = $item->calc_score($this->userid);
+            }
+
+        }
+        // generate the data to display
+        $scoredisplay = ScoreDisplay :: instance();
+        $data = array();
+        foreach ($visibleitems as $item) {
+            $row = array ();
+            $row[] = $item;
+            $row[] = $item->get_name();
+            $row[] = $this->build_course_name($item);
+            $row[] = $this->build_category_name($item);
+            $row[] = $this->build_average_column($item, $ignore_score_color);
+            $row[] = $this->build_result_column($item, $ignore_score_color);
+            if ($scoredisplay->is_custom())
+                $row[] = $this->build_mask_column($item, $ignore_score_color);
+            $data[] = $row;
+        }
+        return $data;
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_type($item1, $item2)
+    {
+        if ($item1->get_item_type() == $item2->get_item_type()) {
+            return $this->sort_by_name($item1,$item2);
+        } else {
+            return ($item1->get_item_type() < $item2->get_item_type() ? -1 : 1);
+        }
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_course($item1, $item2)
+    {
+        $name1 = api_strtolower($this->get_course_name_from_code_cached($item1->get_course_code()));
+        $name2 = api_strtolower($this->get_course_name_from_code_cached($item2->get_course_code()));
+        return api_strnatcmp($name1, $name2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_category($item1, $item2)
+    {
+        $cat1 = $this->get_category_cached($item1->get_category_id());
+        $cat2 = $this->get_category_cached($item2->get_category_id());
+        $name1 = api_strtolower($this->get_category_name_to_display($cat1));
+        $name2 = api_strtolower($this->get_category_name_to_display($cat2));
+
+        return api_strnatcmp($name1, $name2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_name($item1, $item2)
+    {
+        return api_strnatcmp($item1->get_name(),$item2->get_name());
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_average($item1, $item2)
+    {
+        $score1 = $this->avgcache[$item1->get_item_type() . $item1->get_id()];
+        $score2 = $this->avgcache[$item2->get_item_type() . $item2->get_id()];
+
+        return $this->compare_scores($score1, $score2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_score($item1, $item2)
+    {
+        $score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
+        $score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+
+        return $this->compare_scores($score1, $score2);
+    }
+
+    /**
+     * @param $item1
+     * @param $item2
+     * @return int
+     */
+    function sort_by_mask($item1, $item2)
+    {
+        $score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
+        $score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+
+        return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
+    }
+
+    /**
+     * @param $score1
+     * @param $score2
+     * @return int
+     */
+    function compare_scores($score1, $score2)
+    {
+        if (!isset($score1)) {
+            return (isset($score2) ? 1 : 0);
+        } elseif (!isset($score2)) {
+            return -1;
+        } elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
+            return 0;
+        } else {
+            return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1);
+        }
+    }
+
+    /**
+     * @param $item
+     * @return mixed
+     */
+    private function build_course_name($item)
+    {
+        return $this->get_course_name_from_code_cached($item->get_course_code());
+    }
+
+    /**
+     * @param $item
+     * @return string
+     */
+    private function build_category_name($item)
+    {
+        $cat = $this->get_category_cached($item->get_category_id());
+
+        return $this->get_category_name_to_display($cat);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_average_column($item, $ignore_score_color)
+    {
+        if (isset($this->avgcache)) {
+            $avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
+        } else {
+            $avgscore = $item->calc_score();
+        }
+
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_AVERAGE;
+        /*if ($ignore_score_color)
 			$displaytype |= SCORE_IGNORE_SPLIT;
         */
-		return $scoredisplay->display_score($avgscore, $displaytype);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_result_column($item, $ignore_score_color)
-	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_DIV_PERCENT;
-		if ($ignore_score_color) {
-			$displaytype |= SCORE_IGNORE_SPLIT;
-		}
-
-		return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_DEFAULT);
-	}
-
-	/**
-	 * @param $item
-	 * @param $ignore_score_color
-	 * @return string
-	 */
-	private function build_mask_column($item, $ignore_score_color)
-	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
-		$scoredisplay = ScoreDisplay :: instance();
-		$displaytype = SCORE_DIV_PERCENT;
-		if ($ignore_score_color) {
-			$displaytype |= SCORE_IGNORE_SPLIT;
-		}
-		return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_CUSTOM);
-	}
-
-	/**
-	 * @param $coursecode
-	 * @return mixed
-	 */
-	private function get_course_name_from_code_cached($coursecode)
-	{
-		if (isset ($this->coursecodecache)
-			&& isset ($this->coursecodecache[$coursecode])) {
-			return $this->coursecodecache[$coursecode];
-		} else {
-			$name = CourseManager::getCourseNameFromCode($coursecode);
-			$this->coursecodecache[$coursecode] = $name;
-			return $name;
-		}
-	}
-
-	/**
-	 * @param $category_id
-	 * @return null
-	 */
-	private function get_category_cached($category_id)
-	{
-		if (isset ($this->categorycache)
-			&& isset ($this->categorycache[$category_id])) {
-			return $this->categorycache[$category_id];
-		}else {
-			$cat = Category::load($category_id);
-			if (isset($cat)){
-				$this->categorycache[$category_id] = $cat[0];
-				return $cat[0];
-			}else
-				return null;
-		}
-	}
-
-	/**
-	 * @param $cat
-	 * @return string
-	 */
-	private function get_category_name_to_display($cat)
-	{
-		if (isset($cat)) {
-			if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
-				return '';
-			} else {
-				return $cat->get_name();
-			}
-		} else {
-			return '';
-		}
-	}
+        return $scoredisplay->display_score($avgscore, $displaytype);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_result_column($item, $ignore_score_color)
+    {
+        $studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_DIV_PERCENT;
+        if ($ignore_score_color) {
+            $displaytype |= SCORE_IGNORE_SPLIT;
+        }
+
+        return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_DEFAULT);
+    }
+
+    /**
+     * @param $item
+     * @param $ignore_score_color
+     * @return string
+     */
+    private function build_mask_column($item, $ignore_score_color)
+    {
+        $studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+        $scoredisplay = ScoreDisplay :: instance();
+        $displaytype = SCORE_DIV_PERCENT;
+        if ($ignore_score_color) {
+            $displaytype |= SCORE_IGNORE_SPLIT;
+        }
+        return $scoredisplay->display_score($studscore, $displaytype, SCORE_ONLY_CUSTOM);
+    }
+
+    /**
+     * @param $coursecode
+     * @return mixed
+     */
+    private function get_course_name_from_code_cached($coursecode)
+    {
+        if (isset ($this->coursecodecache)
+            && isset ($this->coursecodecache[$coursecode])) {
+            return $this->coursecodecache[$coursecode];
+        } else {
+            $name = CourseManager::getCourseNameFromCode($coursecode);
+            $this->coursecodecache[$coursecode] = $name;
+            return $name;
+        }
+    }
+
+    /**
+     * @param $category_id
+     * @return null
+     */
+    private function get_category_cached($category_id)
+    {
+        if (isset ($this->categorycache)
+            && isset ($this->categorycache[$category_id])) {
+            return $this->categorycache[$category_id];
+        }else {
+            $cat = Category::load($category_id);
+            if (isset($cat)){
+                $this->categorycache[$category_id] = $cat[0];
+                return $cat[0];
+            }else
+                return null;
+        }
+    }
+
+    /**
+     * @param $cat
+     * @return string
+     */
+    private function get_category_name_to_display($cat)
+    {
+        if (isset($cat)) {
+            if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
+                return '';
+            } else {
+                return $cat->get_name();
+            }
+        } else {
+            return '';
+        }
+    }
 }

Spacing +25 added lines, -25 removed lines

@@ -50,9 +50,9 @@ 
 
         }
         if (count($result) == 0) {
-            $evals_filtered=$evals;
+            $evals_filtered = $evals;
         } else {
-            $evals_filtered=$evals_filtered_copy;
+            $evals_filtered = $evals_filtered_copy;
         }
         $this->items = array_merge($evals_filtered, $links);
 
@@ -85,7 +85,7 @@ 
 	{
 		// 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;
@@ -104,20 +104,20 @@ 
 		} elseif ($sorting & self :: UDG_SORT_AVERAGE) {
 			// if user sorts on average scores, first calculate them and cache them
 			foreach ($allitems as $item) {
-				$this->avgcache[$item->get_item_type() . $item->get_id()]= $item->calc_score();
+				$this->avgcache[$item->get_item_type().$item->get_id()] = $item->calc_score();
 			}
 			usort($allitems, array('UserDataGenerator', 'sort_by_average'));
 		} elseif ($sorting & self :: UDG_SORT_SCORE) {
 			// if user sorts on student's scores, first calculate them and cache them
 			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
+				$this->scorecache[$item->get_item_type().$item->get_id()]
 					= $item->calc_score($this->userid);
 			}
 			usort($allitems, array('UserDataGenerator', 'sort_by_score'));
 		} elseif ($sorting & self :: UDG_SORT_MASK) {
 			// if user sorts on student's masks, first calculate scores and cache them
 			foreach ($allitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
+				$this->scorecache[$item->get_item_type().$item->get_id()]
 					= $item->calc_score($this->userid);
 			}
 			usort($allitems, array('UserDataGenerator', 'sort_by_mask'));
@@ -132,7 +132,7 @@ 
 		// fill score cache if not done yet
 		if (!isset ($this->scorecache)) {
 			foreach ($visibleitems as $item) {
-				$this->scorecache[$item->get_item_type() . $item->get_id()]
+				$this->scorecache[$item->get_item_type().$item->get_id()]
 					= $item->calc_score($this->userid);
 			}
 
@@ -141,7 +141,7 @@ 
 		$scoredisplay = ScoreDisplay :: instance();
 		$data = array();
 		foreach ($visibleitems as $item) {
-			$row = array ();
+			$row = array();
 			$row[] = $item;
 			$row[] = $item->get_name();
 			$row[] = $this->build_course_name($item);
@@ -163,7 +163,7 @@ 
 	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);
 		}
@@ -203,7 +203,7 @@ 
 	 */
 	function sort_by_name($item1, $item2)
 	{
-		return api_strnatcmp($item1->get_name(),$item2->get_name());
+		return api_strnatcmp($item1->get_name(), $item2->get_name());
 	}
 
 	/**
@@ -213,8 +213,8 @@ 
 	 */
 	function sort_by_average($item1, $item2)
 	{
-		$score1 = $this->avgcache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->avgcache[$item2->get_item_type() . $item2->get_id()];
+		$score1 = $this->avgcache[$item1->get_item_type().$item1->get_id()];
+		$score2 = $this->avgcache[$item2->get_item_type().$item2->get_id()];
 
 		return $this->compare_scores($score1, $score2);
 	}
@@ -226,8 +226,8 @@ 
 	 */
 	function sort_by_score($item1, $item2)
 	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+		$score1 = $this->scorecache[$item1->get_item_type().$item1->get_id()];
+		$score2 = $this->scorecache[$item2->get_item_type().$item2->get_id()];
 
 		return $this->compare_scores($score1, $score2);
 	}
@@ -239,8 +239,8 @@ 
 	 */
 	function sort_by_mask($item1, $item2)
 	{
-		$score1 = $this->scorecache[$item1->get_item_type() . $item1->get_id()];
-		$score2 = $this->scorecache[$item2->get_item_type() . $item2->get_id()];
+		$score1 = $this->scorecache[$item1->get_item_type().$item1->get_id()];
+		$score2 = $this->scorecache[$item2->get_item_type().$item2->get_id()];
 
 		return ScoreDisplay :: compare_scores_by_custom_display($score1, $score2);
 	}
@@ -256,10 +256,10 @@ 
 			return (isset($score2) ? 1 : 0);
 		} elseif (!isset($score2)) {
 			return -1;
-		} elseif (($score1[0]/$score1[1]) == ($score2[0]/$score2[1])) {
+		} elseif (($score1[0] / $score1[1]) == ($score2[0] / $score2[1])) {
 			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);
 		}
 	}
 
@@ -291,7 +291,7 @@ 
 	private function build_average_column($item, $ignore_score_color)
 	{
 		if (isset($this->avgcache)) {
-			$avgscore = $this->avgcache[$item->get_item_type() . $item->get_id()];
+			$avgscore = $this->avgcache[$item->get_item_type().$item->get_id()];
 		} else {
 			$avgscore = $item->calc_score();
 		}
@@ -311,7 +311,7 @@ 
 	 */
 	private function build_result_column($item, $ignore_score_color)
 	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+		$studscore = $this->scorecache[$item->get_item_type().$item->get_id()];
 		$scoredisplay = ScoreDisplay :: instance();
 		$displaytype = SCORE_DIV_PERCENT;
 		if ($ignore_score_color) {
@@ -328,7 +328,7 @@ 
 	 */
 	private function build_mask_column($item, $ignore_score_color)
 	{
-		$studscore = $this->scorecache[$item->get_item_type() . $item->get_id()];
+		$studscore = $this->scorecache[$item->get_item_type().$item->get_id()];
 		$scoredisplay = ScoreDisplay :: instance();
 		$displaytype = SCORE_DIV_PERCENT;
 		if ($ignore_score_color) {
@@ -362,12 +362,12 @@ 
 		if (isset ($this->categorycache)
 			&& isset ($this->categorycache[$category_id])) {
 			return $this->categorycache[$category_id];
-		}else {
+		} else {
 			$cat = Category::load($category_id);
-			if (isset($cat)){
+			if (isset($cat)) {
 				$this->categorycache[$category_id] = $cat[0];
 				return $cat[0];
-			}else
+			} else
 				return null;
 		}
 	}
@@ -379,7 +379,7 @@ 
 	private function get_category_name_to_display($cat)
 	{
 		if (isset($cat)) {
-			if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null){
+			if ($cat->get_parent_id() == '0' || $cat->get_parent_id() == null) {
 				return '';
 			} else {
 				return $cat->get_name();

Braces +8 added lines, -6 removed lines

@@ -95,7 +95,7 @@ 
 		// sort users array
 		if ($sorting & self :: UDG_SORT_TYPE) {
 			usort($allitems, array('UserDataGenerator', 'sort_by_type'));
-		}elseif ($sorting & self :: UDG_SORT_NAME) {
+		} elseif ($sorting & self :: UDG_SORT_NAME) {
 			usort($allitems, array('UserDataGenerator', 'sort_by_name'));
 		} elseif ($sorting & self :: UDG_SORT_COURSE) {
 			usort($allitems, array('UserDataGenerator', 'sort_by_course'));
@@ -148,8 +148,9 @@ 
 			$row[] = $this->build_category_name($item);
 			$row[] = $this->build_average_column($item, $ignore_score_color);
 			$row[] = $this->build_result_column($item, $ignore_score_color);
-			if ($scoredisplay->is_custom())
-				$row[] = $this->build_mask_column($item, $ignore_score_color);
+			if ($scoredisplay->is_custom()) {
+							$row[] = $this->build_mask_column($item, $ignore_score_color);
+			}
 			$data[] = $row;
 		}
 		return $data;
@@ -362,13 +363,14 @@ 
 		if (isset ($this->categorycache)
 			&& isset ($this->categorycache[$category_id])) {
 			return $this->categorycache[$category_id];
-		}else {
+		} else {
 			$cat = Category::load($category_id);
 			if (isset($cat)){
 				$this->categorycache[$category_id] = $cat[0];
 				return $cat[0];
-			}else
-				return null;
+			} else {
+							return null;
+			}
 		}
 	}
 

main/group/group_space.php

Doc Comments +1 added lines, -1 removed lines

@@ -471,7 +471,7 @@
  * Display a user icon that links to the user page
  *
  * @param integer $user_id the id of the user
- * @return html code
+ * @return string code
  *
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
  * @version April 2008

Spacing +9 added lines, -9 removed lines

@@ -10,7 +10,7 @@ 
  */
 
 require_once '../inc/global.inc.php';
-$current_course_tool  = TOOL_GROUP;
+$current_course_tool = TOOL_GROUP;
 
 // Notice for unauthorized people.
 api_protect_course_script(true);
@@ -69,7 +69,7 @@ 
 
 echo '<div class="actions">';
 echo '<a href="group.php">'.
-    Display::return_icon('back.png',get_lang('BackToGroupList'),'',ICON_SIZE_MEDIUM).
+    Display::return_icon('back.png', get_lang('BackToGroupList'), '', ICON_SIZE_MEDIUM).
     '</a>';
 
 /*
@@ -86,7 +86,7 @@ 
  */
 $unsubscribe_group = '';
 if (GroupManager :: is_self_unregistration_allowed($user_id, $current_group['id'])) {
-    $unsubscribe_group = '<a class="btn btn-default" href="'.api_get_self().'?selfUnReg=1" onclick="javascript: if(!confirm('."'".addslashes(api_htmlentities(get_lang("ConfirmYourChoice"),ENT_QUOTES))."'".')) return false;">'.
+    $unsubscribe_group = '<a class="btn btn-default" href="'.api_get_self().'?selfUnReg=1" onclick="javascript: if(!confirm('."'".addslashes(api_htmlentities(get_lang("ConfirmYourChoice"), ENT_QUOTES))."'".')) return false;">'.
         get_lang("StudentUnsubscribe").'</a>';
 }
 echo '&nbsp;</div>';
@@ -98,8 +98,8 @@ 
     GroupManager::is_tutor_of_group(api_get_user_id(), api_get_group_id())
 ) {
     $my_origin = isset($origin) ? $origin : '';
-    $edit_url =  '<a href="'.api_get_path(WEB_CODE_PATH).'group/settings.php?'.api_get_cidreq().'&origin='.$my_origin.'">'.
-        Display::return_icon('edit.png', get_lang('EditGroup'),'',ICON_SIZE_SMALL).'</a>';
+    $edit_url = '<a href="'.api_get_path(WEB_CODE_PATH).'group/settings.php?'.api_get_cidreq().'&origin='.$my_origin.'">'.
+        Display::return_icon('edit.png', get_lang('EditGroup'), '', ICON_SIZE_SMALL).'</a>';
 }
 
 echo Display::page_header(
@@ -216,7 +216,7 @@ 
     $forums_of_groups = get_forums_of_group($current_group['id']);
 
     if (is_array($forums_of_groups)) {
-        if ( $current_group['forum_state'] == GroupManager::TOOL_PUBLIC) {
+        if ($current_group['forum_state'] == GroupManager::TOOL_PUBLIC) {
             foreach ($forums_of_groups as $key => $value) {
                 if ($value['forum_group_public_private'] == 'public') {
                     $actions_array[] = array(
@@ -298,7 +298,7 @@ 
 if (count($tutors) == 0) {
     $tutor_info = get_lang('GroupNoneMasc');
 } else {
-    isset($origin) ? $my_origin = $origin:$my_origin='';
+    isset($origin) ? $my_origin = $origin : $my_origin = '';
     $tutor_info .= '<ul class="thumbnails">';
     foreach ($tutors as $index => $tutor) {
         $userInfo = api_get_user_info($tutor['user_id']);
@@ -404,8 +404,8 @@ 
     global $current_group;
 
     // Database table definition
-    $table_group_user 	= Database :: get_course_table(TABLE_GROUP_USER);
-    $table_user 		= Database :: get_main_table(TABLE_MAIN_USER);
+    $table_group_user = Database :: get_course_table(TABLE_GROUP_USER);
+    $table_user = Database :: get_main_table(TABLE_MAIN_USER);
 
     $course_id = api_get_course_int_id();