From 4fb047dd596f073af2aeddec8db2e4f6f2ec14e3 Mon Sep 17 00:00:00 2001 From: Yannick Warnier Date: Sun, 31 Mar 2013 10:53:58 -0500 Subject: [PATCH] Minor - Coding conventions spacing --- main/gradebook/lib/scoredisplay.class.php | 492 +++++++++++----------- 1 file changed, 245 insertions(+), 247 deletions(-) diff --git a/main/gradebook/lib/scoredisplay.class.php b/main/gradebook/lib/scoredisplay.class.php index 75cf809924..7b85e848d3 100644 --- a/main/gradebook/lib/scoredisplay.class.php +++ b/main/gradebook/lib/scoredisplay.class.php @@ -41,51 +41,51 @@ class ScoreDisplay { // Singleton stuff - /** - * Get the instance of this class - */ - public static function instance($category_id = 0) { - static $instance; - if (!isset ($instance)) { - $instance = new ScoreDisplay($category_id); - } - return $instance; - } + /** + * Get the instance of this class + */ + public static function instance($category_id = 0) { + static $instance; + if (!isset ($instance)) { + $instance = new ScoreDisplay($category_id); + } + return $instance; + } // Static methods - /** - * Compare the custom display of 2 scores, can be useful in sorting - */ - public static function compare_scores_by_custom_display ($score1, $score2) { - if (!isset($score1)) { - return (isset($score2) ? 1 : 0); - } elseif (!isset($score2)) { - return -1; - } else { - $scoredisplay = ScoreDisplay :: instance(); - $custom1 = $scoredisplay->display_custom($score1); - $custom2 = $scoredisplay->display_custom($score2); - if ($custom1 == $custom2) { - return 0; - } else { - return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1); - } + /** + * Compare the custom display of 2 scores, can be useful in sorting + */ + public static function compare_scores_by_custom_display ($score1, $score2) { + if (!isset($score1)) { + return (isset($score2) ? 1 : 0); + } elseif (!isset($score2)) { + return -1; + } else { + $scoredisplay = ScoreDisplay :: instance(); + $custom1 = $scoredisplay->display_custom($score1); + $custom2 = $scoredisplay->display_custom($score2); + if ($custom1 == $custom2) { + return 0; + } else { + return (($score1[0]/$score1[1]) < ($score2[0]/$score2[1]) ? -1 : 1); + } - } - } - - private $coloring_enabled; - private $color_split_value; - private $custom_enabled; - private $upperlimit_included; - private $custom_display; - private $custom_display_conv; + } + } + + private $coloring_enabled; + private $color_split_value; + private $custom_enabled; + private $upperlimit_included; + private $custom_display; + private $custom_display_conv; - /** - * Protected constructor - call instance() to instantiate - */ + /** + * Protected constructor - call instance() to instantiate + */ protected function ScoreDisplay($category_id = 0) { if (!empty($category_id)) { $this->category_id = $category_id; @@ -101,7 +101,7 @@ class ScoreDisplay if ($this->coloring_enabled) { $value = api_get_setting('gradebook_score_display_colorsplit'); - if (isset($value)) { + if (isset($value)) { $this->color_split_value = $value; } } @@ -131,7 +131,7 @@ class ScoreDisplay $this->upperlimit_included = $value == 'true' ? true : false; $this->custom_display_conv = $this->convert_displays($this->custom_display); } - } + } //If teachers can override the portal parameters @@ -150,43 +150,43 @@ class ScoreDisplay } } - /** - * Is coloring enabled ? - */ - public function is_coloring_enabled () { - return $this->coloring_enabled; - } + /** + * Is coloring enabled ? + */ + public function is_coloring_enabled () { + return $this->coloring_enabled; + } - /** - * Is custom score display enabled ? - */ - public function is_custom() { - return $this->custom_enabled; - } + /** + * Is custom score display enabled ? + */ + public function is_custom() { + return $this->custom_enabled; + } - /** - * Is upperlimit included ? - */ - public function is_upperlimit_included () { - return $this->upperlimit_included; - } + /** + * Is upperlimit included ? + */ + public function is_upperlimit_included () { + return $this->upperlimit_included; + } - /** - * If custom score display is enabled, this will return the current settings. - * See also update_custom_score_display_settings - * @return array current settings (or null if feature not enabled) - */ - public function get_custom_score_display_settings() { - return $this->custom_display; - } + /** + * If custom score display is enabled, this will return the current settings. + * See also update_custom_score_display_settings + * @return array current settings (or null if feature not enabled) + */ + public function get_custom_score_display_settings() { + return $this->custom_display; + } - /** - * If coloring is enabled, scores below this value will be displayed in red. - * @return int color split value, in percent (or null if feature not enabled) - */ - public function get_color_split_value() { - return $this->color_split_value; - } + /** + * If coloring is enabled, scores below this value will be displayed in red. + * @return int color split value, in percent (or null if feature not enabled) + */ + public function get_color_split_value() { + return $this->color_split_value; + } /** * Get current gradebook category id @@ -215,15 +215,15 @@ class ScoreDisplay return $category_id; } - /** - * Update custom score display settings - * @param array $displays 2-dimensional array - every subarray must have keys (score, display) + /** + * Update custom score display settings + * @param array $displays 2-dimensional array - every subarray must have keys (score, display) * @param int score color percent (optional) * @param int gradebook category id (optional) - */ - public function update_custom_score_display_settings ($displays, $scorecolpercent = 0, $category_id = null) { - $this->custom_display = $displays; - $this->custom_display_conv = $this->convert_displays($this->custom_display); + */ + public function update_custom_score_display_settings ($displays, $scorecolpercent = 0, $category_id = null) { + $this->custom_display = $displays; + $this->custom_display_conv = $this->convert_displays($this->custom_display); if (isset($category_id)) { $category_id = intval($category_id); @@ -231,23 +231,23 @@ class ScoreDisplay $category_id = $this->get_current_gradebook_category_id(); } - // remove previous settings + // remove previous settings $tbl_display = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_SCORE_DISPLAY); - $sql = 'DELETE FROM '.$tbl_display.' WHERE category_id = '.$category_id; - Database::query($sql); + $sql = 'DELETE FROM '.$tbl_display.' WHERE category_id = '.$category_id; + Database::query($sql); - // add new settings - $sql = 'INSERT INTO '.$tbl_display.' (id, score, display, category_id, score_color_percent) VALUES '; - $count = 0; - foreach ($displays as $display) { - if ($count > 0) { - $sql .= ','; - } - $sql .= "(NULL, '".$display['score']."', '".Database::escape_string($display['display'])."', ".$category_id.", ".intval($scorecolpercent).")"; - $count++; - } - Database::query($sql); - } + // add new settings + $sql = 'INSERT INTO '.$tbl_display.' (id, score, display, category_id, score_color_percent) VALUES '; + $count = 0; + foreach ($displays as $display) { + if ($count > 0) { + $sql .= ','; + } + $sql .= "(NULL, '".$display['score']."', '".Database::escape_string($display['display'])."', ".$category_id.", ".intval($scorecolpercent).")"; + $count++; + } + Database::query($sql); + } public function insert_defaults($category_id) { if (empty($category_id)) { @@ -295,16 +295,14 @@ class ScoreDisplay return floatval(number_format($score, $this->get_number_decimals())); } - /** - * Display a score according to the current settings - * @param array $score score data structure, as returned by the calc_score functions - * @param int $type one of the following constants: SCORE_DIV, SCORE_PERCENT, SCORE_DIV_PERCENT, SCORE_AVERAGE - * (ignored for student's view if custom score display is enabled) - * @param int $what one of the following constants: SCORE_BOTH, SCORE_ONLY_DEFAULT, SCORE_ONLY_CUSTOM (default: SCORE_BOTH) - * (only taken into account if custom score display is enabled and for course/platform admin) - */ - public function display_score($score, $type = SCORE_DIV_PERCENT, $what = SCORE_BOTH, $no_color = false) { - $my_score = $score == 0 ? 1 : $score; + /** + * Display a score according to the current settings + * @param array $score score data structure, as returned by the calc_score functions + * @param int $type one of the following constants: SCORE_DIV, SCORE_PERCENT, SCORE_DIV_PERCENT, SCORE_AVERAGE (ignored for student's view if custom score display is enabled) + * @param int $what one of the following constants: SCORE_BOTH, SCORE_ONLY_DEFAULT, SCORE_ONLY_CUSTOM (default: SCORE_BOTH) (only taken into account if custom score display is enabled and for course/platform admin) + */ + public function display_score($score, $type = SCORE_DIV_PERCENT, $what = SCORE_BOTH, $no_color = false) { + $my_score = $score == 0 ? 1 : $score; if ($type == SCORE_BAR) { $percentage = $my_score[0]/$my_score[1]*100; @@ -316,54 +314,54 @@ class ScoreDisplay return $simple_score; } - if ($this->custom_enabled && isset($this->custom_display_conv)) { - $display = $this->display_default($my_score, $type); - } else { - // if no custom display set, use default display - $display = $this->display_default($my_score, $type); - } + if ($this->custom_enabled && isset($this->custom_display_conv)) { + $display = $this->display_default($my_score, $type); + } else { + // if no custom display set, use default display + $display = $this->display_default($my_score, $type); + } - if ($this->coloring_enabled && $no_color == false) { - $my_score_denom = ($score[1]==0)?1:$score[1]; - if (($score[0] / $my_score_denom) < ($this->color_split_value / 100)) { - $display = Display::tag('font', $display, array('color'=>'red')); + if ($this->coloring_enabled && $no_color == false) { + $my_score_denom = ($score[1]==0)?1:$score[1]; + if (($score[0] / $my_score_denom) < ($this->color_split_value / 100)) { + $display = Display::tag('font', $display, array('color'=>'red')); //$display = Display::label($display, 'important'); - } - } - return $display; - } - + } + } + return $display; + } + // Internal functions - private function display_default ($score, $type) { - switch ($type) { - case SCORE_DIV : // X / Y - return $this->display_as_div($score); - 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) . ')'; - case SCORE_AVERAGE : // XX % - return $this->display_as_percent($score); - case SCORE_DECIMAL : // 0.50 (X/Y) - return $this->display_as_decimal($score); - case SCORE_DIV_PERCENT_WITH_CUSTOM : // X / Y (XX %) - Good! - $custom = $this->display_custom($score); - if (!empty($custom)) { - $custom = ' - '.$custom; - } - return $this->display_as_div($score).' (' . $this->display_as_percent($score) . ')'.$custom; - case SCORE_DIV_SIMPLE_WITH_CUSTOM : // X - Good! + private function display_default ($score, $type) { + switch ($type) { + case SCORE_DIV : // X / Y + return $this->display_as_div($score); + 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) . ')'; + case SCORE_AVERAGE : // XX % + return $this->display_as_percent($score); + case SCORE_DECIMAL : // 0.50 (X/Y) + return $this->display_as_decimal($score); + case SCORE_DIV_PERCENT_WITH_CUSTOM : // X / Y (XX %) - Good! $custom = $this->display_custom($score); - if (!empty($custom)) { - $custom = ' - '.$custom; - } - return $this->display_simple_score($score).$custom; + if (!empty($custom)) { + $custom = ' - '.$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); + if (!empty($custom)) { + $custom = ' - '.$custom; + } + return $this->display_simple_score($score).$custom; break; case SCORE_DIV_SIMPLE_WITH_CUSTOM_LETTERS: $custom = $this->display_custom($score); - if (!empty($custom)) { - $custom = ' - '.$custom; - } + if (!empty($custom)) { + $custom = ' - '.$custom; + } $score = $this->display_simple_score($score); //needs sudo apt-get install php5-intl @@ -375,76 +373,76 @@ class ScoreDisplay $letters = " ($letters) "; } - return $score.$letters.$custom; + return $score.$letters.$custom; break; - case SCORE_CUSTOM: // Good! - return $this->display_custom($score); - } - } - - private function display_simple_score($score) { - if (isset($score[0])) { - return $this->format_score($score[0]); - } - return ''; - } - + case SCORE_CUSTOM: // Good! + return $this->display_custom($score); + } + } + + private function display_simple_score($score) { + if (isset($score[0])) { + return $this->format_score($score[0]); + } + return ''; + } + /** * Returns "1" for array("100", "100"); */ - private function display_as_decimal($score) { - $score_denom = ($score[1]==0) ? 1 : $score[1]; - return $this->format_score($score[0]/$score_denom); - } - - /** - * Returns "100 %" for array("100", "100"); - */ - private function display_as_percent($score) { - $score_denom = ($score[1]==0) ? 1 : $score[1]; - return $this->format_score($score[0]/$score_denom*100) . ' %'; - } - + private function display_as_decimal($score) { + $score_denom = ($score[1]==0) ? 1 : $score[1]; + return $this->format_score($score[0]/$score_denom); + } + + /** + * Returns "100 %" for array("100", "100"); + */ + private function display_as_percent($score) { + $score_denom = ($score[1]==0) ? 1 : $score[1]; + return $this->format_score($score[0]/$score_denom*100) . ' %'; + } + /** * * Returns 10.00 / 10.00 for array("100", "100"); * @param array $score - */ + */ private function display_as_div($score) { - if ($score == 1) { - return '0/0'; - } else { + if ($score == 1) { + return '0/0'; + } else { $score[0] =$this->format_score($score[0]); $score[1] =$this->format_score($score[1]); - return $score[0] . ' / ' . $score[1]; - } - } + return $score[0] . ' / ' . $score[1]; + } + } /** * * Depends in the user selections [0 50] Bad [50:100] Good * @param array $score - */ - private function display_custom ($score) { - $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) { - if ($scaledscore <= $displayitem['score']) { - return $displayitem['display']; - } - } - } else { - if (!empty($this->custom_display_conv)) { - foreach ($this->custom_display_conv as $displayitem) { - if ($scaledscore < $displayitem['score'] || $displayitem['score'] == 1) { - return $displayitem['display']; - } - } - } - } - } - + */ + private function display_custom ($score) { + $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) { + if ($scaledscore <= $displayitem['score']) { + return $displayitem['display']; + } + } + } else { + if (!empty($this->custom_display_conv)) { + foreach ($this->custom_display_conv as $displayitem) { + if ($scaledscore < $displayitem['score'] || $displayitem['score'] == 1) { + return $displayitem['display']; + } + } + } + } + } + /** * Get score color percent by category @@ -469,66 +467,66 @@ class ScoreDisplay return $score; } - /** - * Get current custom score display settings + /** + * Get current custom score display settings * @param int Gradebook category id - * @return array 2-dimensional array - every element contains 3 subelements (id, score, display) - */ - private function get_custom_displays($category_id = null) { + * @return array 2-dimensional array - every element contains 3 subelements (id, score, display) + */ + private function get_custom_displays($category_id = null) { $tbl_display = Database :: get_main_table(TABLE_MAIN_GRADEBOOK_SCORE_DISPLAY); if (isset($category_id)) { $category_id = intval($category_id); } else { $category_id = $this->get_current_gradebook_category_id(); } - $sql = 'SELECT * FROM '.$tbl_display.' WHERE category_id = '.$category_id.' ORDER BY score'; - $result = Database::query($sql); - return Database::store_result($result,'ASSOC'); - } + $sql = 'SELECT * FROM '.$tbl_display.' WHERE category_id = '.$category_id.' ORDER BY score'; + $result = Database::query($sql); + return Database::store_result($result,'ASSOC'); + } - /** - * Convert display settings to internally used values - */ - private function convert_displays($custom_display) { - if (isset($custom_display)) { - // get highest score entry, and copy each element to a new array - $converted = array(); - $highest = 0; - foreach ($custom_display as $element) { - if ($element['score'] > $highest) { - $highest = $element['score']; - } - $converted[] = $element; - } - // sort the new array (ascending) - usort($converted, array('ScoreDisplay', 'sort_display')); + /** + * Convert display settings to internally used values + */ + private function convert_displays($custom_display) { + if (isset($custom_display)) { + // get highest score entry, and copy each element to a new array + $converted = array(); + $highest = 0; + foreach ($custom_display as $element) { + if ($element['score'] > $highest) { + $highest = $element['score']; + } + $converted[] = $element; + } + // sort the new array (ascending) + usort($converted, array('ScoreDisplay', 'sort_display')); - // adjust each score in such a way that - // each score is scaled between 0 and 1 - // the highest score in this array will be equal to 1 - $converted2 = array(); - foreach ($converted as $element) { - $newelement = array(); + // adjust each score in such a way that + // each score is scaled between 0 and 1 + // the highest score in this array will be equal to 1 + $converted2 = array(); + foreach ($converted as $element) { + $newelement = array(); if (!empty($highest)) { $newelement['score'] = $element['score'] / $highest; } else { $newelement['score'] = 0; } - $newelement['display'] = $element['display']; - $converted2[] = $newelement; - } - return $converted2; - } else { - return null; - } - } + $newelement['display'] = $element['display']; + $converted2[] = $newelement; + } + return $converted2; + } else { + return null; + } + } - private function sort_display($item1, $item2) { - if ($item1['score'] == $item2['score']) { - return 0; - } else { - return ($item1['score'] < $item2['score'] ? -1 : 1); - } - } + private function sort_display($item1, $item2) { + if ($item1['score'] == $item2['score']) { + return 0; + } else { + return ($item1['score'] < $item2['score'] ? -1 : 1); + } + } }