grade/report/user/lib.php

   1 <?php // $Id$
   2 /**
   3  * File in which the user_report class is defined.
   4  * @package gradebook
   5  */
   6
   7 require_once($CFG->dirroot . '/grade/report/lib.php');
   8 require_once($CFG->libdir.'/tablelib.php');
   9
  10 /**
  11  * Class providing an API for the user report building and displaying.
  12  * @uses grade_report
  13  * @package gradebook
  14  */
  15 class grade_report_user extends grade_report {
  16
  17     /**
  18      * The user.
  19      * @var object $user
  20      */
  21     var $user;
  22
  23     /**
  24      * A flexitable to hold the data.
  25      * @var object $table
  26      */
  27     var $table;
  28
  29     /**
  30      * Constructor. Sets local copies of user preferences and initialises grade_tree.
  31      * @param int $courseid
  32      * @param object $gpr grade plugin return tracking object
  33      * @param string $context
  34      * @param int $userid The id of the user
  35      */
  36     function grade_report_user($courseid, $gpr, $context, $userid) {
  37         global $CFG;
  38         parent::grade_report($courseid, $gpr, $context);
  39
  40         // Grab the grade_tree for this course
  41         $this->gtree = new grade_tree($this->courseid, true, $this->get_pref('aggregationposition'));
  42
  43         // get the user (for full name)
  44         $this->user = get_record('user', 'id', $userid);
  45
  46         // base url for sorting by first/last name
  47         $this->baseurl = $CFG->wwwroot.'/grade/report?id='.$courseid.'&amp;userid='.$userid;
  48         $this->pbarurl = $this->baseurl;
  49
  50         // Setup groups if requested
  51         if ($this->get_pref('showgroups')) {
  52             $this->setup_groups();
  53         }
  54
  55         $this->setup_table();
  56     }
  57
  58     /**
  59      * Prepares the headers and attributes of the flexitable.
  60      */
  61     function setup_table() {
  62         /*
  63         * Table has 6 columns
  64         *| pic  | itemname/description | grade (grade_final) | percentage | rank | feedback |
  65         */
  66
  67         // setting up table headers
  68         $tablecolumns = array('itemname', 'category', 'grade', 'percentage', 'rank', 'feedback');
  69         $tableheaders = array($this->get_lang_string('gradeitem', 'grades'), $this->get_lang_string('category'), $this->get_lang_string('grade'),
  70             $this->get_lang_string('percent', 'grades'), $this->get_lang_string('rank', 'grades'),
  71             $this->get_lang_string('feedback'));
  72
  73         $this->table = new flexible_table('grade-report-user-'.$this->courseid);
  74
  75         $this->table->define_columns($tablecolumns);
  76         $this->table->define_headers($tableheaders);
  77         $this->table->define_baseurl($this->baseurl);
  78
  79         $this->table->set_attribute('cellspacing', '0');
  80         $this->table->set_attribute('id', 'user-grade');
  81         $this->table->set_attribute('class', 'boxaligncenter generaltable');
  82
  83         // not sure tables should be sortable or not, because if we allow it then sorted resutls distort grade category structure and sortorder
  84         $this->table->set_control_variables(array(
  85                 TABLE_VAR_SORT    => 'ssort',
  86                 TABLE_VAR_HIDE    => 'shide',
  87                 TABLE_VAR_SHOW    => 'sshow',
  88                 TABLE_VAR_IFIRST  => 'sifirst',
  89                 TABLE_VAR_ILAST   => 'silast',
  90                 TABLE_VAR_PAGE    => 'spage'
  91                 ));
  92
  93         $this->table->setup();
  94     }
  95
  96     function fill_table() {
  97         global $CFG;
  98         $numusers = $this->get_numusers(false); // total course users
  99
 100         if ($all_grade_items = grade_item::fetch_all(array('courseid'=>$this->courseid))) {
 101             $grade_items = array();
 102             foreach ($all_grade_items as $item) {
 103                 $grade_items[$item->sortorder] = $item;
 104             }
 105             unset($all_grade_items);
 106             ksort($grade_items);
 107
 108             $total = $grade_items[1];
 109             unset($grade_items[1]);
 110             $grade_items[] = $total;
 111
 112             foreach ($grade_items as $grade_item) {
 113
 114                 $decimalpoints = $grade_item->get_decimals();
 115                 $data = array();
 116
 117                 $grade_grade = new grade_grade(array('itemid'=>$grade_item->id, 'userid'=>$this->user->id));
 118
 119                 // TODO: indicate items that "needsupdate" - missing final calculation
 120
 121                 /// prints grade item name
 122                 if ($grade_item->is_course_item() or $grade_item->is_category_item()) {
 123                     $data[] = '<b>'.$grade_item->get_name().'</b>';
 124                 } else {
 125                     $data[] = $this->get_module_link($grade_item->get_name(), $grade_item->itemmodule, $grade_item->iteminstance);;
 126                 }
 127
 128                 /// prints category
 129                 $cat = $grade_item->get_parent_category();
 130                 $data[] = $cat->fullname;
 131
 132
 133                 /// prints the grade
 134
 135                 if ($grade_grade->is_excluded()) {
 136                     $excluded = get_string('excluded', 'grades').' ';
 137                 } else {
 138                     $excluded = '';
 139                 }
 140
 141                 if ($grade_grade->is_hidden() && !has_capability('moodle/grade:viewhidden', get_context_instance(CONTEXT_COURSE, $grade_item->courseid))) {
 142
 143                     if ((int) $grade_grade->finalgrade < 1) {
 144                         $data[] = '-';
 145                     } else {
 146                         $data[] = get_string('gradedon', 'grades', userdate($grade_grade->timemodified));
 147                     }
 148
 149                 } else {
 150                     if ($grade_item->scaleid) {
 151                         // using scales
 152                         if ($scale = get_record('scale', 'id', $grade_item->scaleid)) {
 153                             $scales = explode(",", $scale->scale);
 154                             // reindex because scale is off 1
 155                             // invalid grade if gradeval < 1
 156                             if ((int) $grade_grade->finalgrade < 1) {
 157                                 $data[] = $excluded.'-';
 158                             } else {
 159                                 $data[] = $excluded.$scales[$grade_grade->finalgrade-1];
 160                             }
 161                         }
 162                     } else {
 163                         // normal grade, or text, just display
 164                         if ((int) $grade_grade->finalgrade < 1) {
 165                             $data[] = $excluded.'-';
 166                         } else {
 167                             $data[] = $excluded.format_float($grade_grade->finalgrade, $decimalpoints);
 168                         }
 169                     }
 170                 }
 171                 /// prints percentage
 172
 173                 if ($grade_grade->is_hidden() && !has_capability('moodle/grade:viewhidden', get_context_instance(CONTEXT_COURSE, $grade_item->courseid))) {
 174                     if ((int) $grade_grade->finalgrade < 1) {
 175                         $data[] = '-';
 176                     } else {
 177                         $data[] = get_string('gradedon', 'grades', userdate($grade_grade->timemodified));
 178                     }
 179                 } else {
 180                     if ($grade_item->gradetype == GRADE_TYPE_VALUE) {
 181                         // processing numeric grade
 182                         if ($grade_grade->finalgrade) {
 183                             $percentage = format_float(($grade_grade->finalgrade / $grade_item->grademax) * 100, $decimalpoints).'%';
 184                         } else {
 185                             $percentage = '-';
 186                         }
 187
 188                     } else if ($grade_item->gradetype == GRADE_TYPE_SCALE) {
 189                         // processing scale grade
 190                         $scale = get_record('scale', 'id', $grade_item->scaleid);
 191                         $scalevals = explode(",", $scale->scale);
 192                         $percentage = format_float(($grade_grade->finalgrade) / count($scalevals) * 100, $decimalpoints).'%';
 193
 194                     } else {
 195                         // text grade
 196                         $percentage = '-';
 197                     }
 198
 199                     $data[] = $percentage;
 200                 }
 201                 /// prints rank
 202                 if ($grade_grade->finalgrade) {
 203                     /// find the number of users with a higher grade
 204                     $sql = "SELECT COUNT(DISTINCT(userid))
 205                             FROM {$CFG->prefix}grade_grades
 206                             WHERE finalgrade > $grade_grade->finalgrade
 207                             AND itemid = $grade_item->id";
 208                     $rank = count_records_sql($sql) + 1;
 209
 210                     $data[] = "$rank/$numusers";
 211                 } else {
 212                     // no grade, no rank
 213                     $data[] = "-";
 214                 }
 215
 216                 /// prints notes
 217                 if (!empty($grade_grade->feedback)) {
 218                     $data[] = format_text($grade_grade->feedback, $grade_grade->feedbackformat);
 219                 } else {
 220                     $data[] = '&nbsp;';
 221                 }
 222                 $this->table->add_data($data);
 223             }
 224
 225             return true;
 226         } else {
 227             notify(get_string('nogradeitem', 'grades'));
 228             return false;
 229         }
 230     }
 231
 232     /**
 233      * Prints or returns the HTML from the flexitable.
 234      * @param bool $return Whether or not to return the data instead of printing it directly.
 235      * @return string
 236      */
 237     function print_table($return=false) {
 238         ob_start();
 239         $this->table->print_html();
 240         $html = ob_get_clean();
 241         if ($return) {
 242             return $html;
 243         } else {
 244             echo $html;
 245         }
 246     }
 247
 248     /**
 249      * Processes the data sent by the form (grades and feedbacks).
 250      * @var array $data
 251      * @return bool Success or Failure (array of errors).
 252      */
 253     function process_data($data) {
 254     }
 255
 256 }
 257 ?>