grade/export/lib.php

   1 <?php
   2
   3 ///////////////////////////////////////////////////////////////////////////
   4 //                                                                       //
   5 // NOTICE OF COPYRIGHT                                                   //
   6 //                                                                       //
   7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
   8 //          http://moodle.com                                            //
   9 //                                                                       //
  10 // Copyright (C) 1999 onwards  Martin Dougiamas  http://moodle.com       //
  11 //                                                                       //
  12 // This program is free software; you can redistribute it and/or modify  //
  13 // it under the terms of the GNU General Public License as published by  //
  14 // the Free Software Foundation; either version 2 of the License, or     //
  15 // (at your option) any later version.                                   //
  16 //                                                                       //
  17 // This program is distributed in the hope that it will be useful,       //
  18 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
  19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
  20 // GNU General Public License for more details:                          //
  21 //                                                                       //
  22 //          http://www.gnu.org/copyleft/gpl.html                         //
  23 //                                                                       //
  24 ///////////////////////////////////////////////////////////////////////////
  25
  26 require_once($CFG->dirroot.'/lib/gradelib.php');
  27 require_once($CFG->dirroot.'/grade/lib.php');
  28 /**
  29  * Prints all grade items for selection
  30  * @input int id - course id
  31  */
  32 function print_gradeitem_selections($id, $params = NULL) {
  33     global $CFG;
  34     // print all items for selections
  35     // make this a standard function in lib maybe
  36     include_once('grade_export_form.php');
  37     $mform = new grade_export_form(qualified_me(), array('id'=>$id));
  38     $mform->display();
  39
  40 }
  41 /**
  42  * Base export class
  43  */
  44 class grade_export {
  45
  46     var $format = ''; // export format
  47     var $id; // course id
  48     var $itemids; // comma separated grade_item ids;
  49     var $grades = array();    // Collect all grades in this array
  50     var $gradeshtml= array(); // Collect all grades html formatted in this array
  51     var $comments = array(); // Collect all comments for each grade
  52     var $totals = array();    // Collect all totals in this array
  53     var $columns = array();     // Accumulate column names in this array.
  54     var $columnhtml = array();  // Accumulate column html in this array.
  55     var $columnidnumbers = array(); // Collect all gradeitem id numbers
  56     var $students = array();
  57     var $course; // course
  58
  59     // common strings
  60     var $strgrades;
  61     var $strgrade;
  62
  63     /**
  64      * Constructor should set up all the private variables ready to be pulled
  65      * @input int id - course id
  66      * @input string itemids - comma separated value of itemids to process for this export
  67      */
  68     function grade_export($id, $itemids = '') {
  69
  70         $this->strgrades = get_string("grades");
  71         $this->strgrade = get_string("grade");
  72         $this->itemids = $itemids;
  73
  74         $strmax = get_string("maximumshort");
  75
  76         if (! $course = get_record("course", "id", $id)) {
  77             error("Course ID was incorrect");
  78         }
  79         $context = get_context_instance(CONTEXT_COURSE, $id);
  80         require_capability('moodle/grade:view', $context);
  81
  82         $this->id = $id;
  83         $this->course = $course;
  84
  85         // first make sure we have all final grades
  86         // TODO: check that no grade_item has needsupdate set
  87         grade_regrade_final_grades($id);
  88
  89         /// Check to see if groups are being used in this course
  90         if ($groupmode = groupmode($course)) {   // Groups are being used
  91
  92             if (isset($_GET['group'])) {
  93                 $changegroup = $_GET['group'];  /// 0 or higher
  94             } else {
  95                 $changegroup = -1;              /// This means no group change was specified
  96             }
  97
  98             $currentgroup = get_and_set_current_group($course, $groupmode, $changegroup);
  99
 100         } else {
 101             $currentgroup = false;
 102         }
 103
 104         if ($currentgroup) {
 105             $this->students = get_group_students($currentgroup, "u.lastname ASC");
 106         } else {
 107             $this->students = get_role_users(@implode(',', $CFG->gradebookroles), $context);
 108         }
 109
 110         if (!empty($this->students)) {
 111             foreach ($this->students as $student) {
 112                 $this->grades[$student->id] = array();    // Collect all grades in this array
 113                 $this->gradeshtml[$student->id] = array(); // Collect all grades html formatted in this array
 114                 $this->totals[$student->id] = array();    // Collect all totals in this array
 115                 $this->comments[$student->id] = array(); // Collect all comments in tihs array
 116             }
 117         }
 118
 119         // if grade_item ids are specified
 120         if ($itemids) {
 121             foreach ($itemids as $iid) {
 122
 123                 if ($iid) {
 124                     $params->id = clean_param($iid, PARAM_INT);
 125                     $gradeitems[] = new grade_item($params);
 126                 }
 127             }
 128         } else {
 129             // else we get all items for this course
 130             $gradeitems = grade_grade::fetch_all(array('courseid'=>$this->id));
 131         }
 132
 133         if ($gradeitems) {
 134             foreach ($gradeitems as $gradeitem) {
 135
 136                 // load as an array of grade_final objects
 137                 if ($itemgrades = $gradeitem -> get_final()) {
 138
 139                     $this->columns[$gradeitem->id] = "$gradeitem->itemmodule: ".$gradeitem->get_name()." - $gradeitem->grademax";
 140
 141                     $this->columnidnumbers[$gradeitem->id] = $gradeitem->idnumber; // this might be needed for some export plugins
 142
 143                     if (!empty($gradeitem->grademax)) {
 144                         $maxgrade = "$strmax: $gradeitem->grademax";
 145                     } else {
 146                         $maxgrade = "";
 147                     }
 148
 149                     if (!empty($this->students)) {
 150                         foreach ($this->students as $student) {
 151                             unset($studentgrade);
 152                             // add support for comment here MDL-9634
 153
 154                             if (!empty($itemgrades[$student->id])) {
 155                                 $studentgrade = $itemgrades[$student->id];
 156                             }
 157
 158                             if (!empty($studentgrade->finalgrade)) {
 159                                 $this->grades[$student->id][$gradeitem->id] = $currentstudentgrade = $studentgrade->finalgrade;
 160                             } else {
 161                                 $this->grades[$student->id][$gradeitem->id] = $currentstudentgrade = "";
 162                                 $this->gradeshtml[$student->id][$gradeitem->id] = "";
 163                             }
 164                             if (!empty($maxgrade)) {
 165                                 $this->totals[$student->id] = (float)($this->totals[$student->id]) + (float)($currentstudentgrade);
 166                             } else {
 167                                 $this->totals[$student->id] = (float)($this->totals[$student->id]) + 0;
 168                             }
 169
 170                             if (!empty($comment)) {
 171                                 // load comments here
 172                                 if ($studentgrade) {
 173                                     $studentgrade->load_text();
 174                                     // get the actual comment
 175                                     $comment = $studentgrade->grade_grade_text->feedback;
 176                                     $this->comments[$student->id][$gradeitem->id] = $comment;
 177                                 }
 178                             } else {
 179                                 $this->comments[$student->id][$gradeitem->id] = '';
 180                             }
 181                         }
 182                     }
 183                 }
 184             }
 185         }
 186     }
 187
 188     /**
 189      * To be implemented by child classes
 190      */
 191     function print_grades() { }
 192
 193     /**
 194      * Displays all the grades on screen as a feedback mechanism
 195      */
 196     function display_grades($feedback=false) {
 197         echo '<table>';
 198         echo '<tr>';
 199         echo '<th>'.get_string("firstname")."</th>".
 200              '<th>'.get_string("lastname")."</th>".
 201              '<th>'.get_string("idnumber")."</th>".
 202              '<th>'.get_string("institution")."</th>".
 203              '<th>'.get_string("department")."</th>".
 204              '<th>'.get_string("email")."</th>";
 205         foreach ($this->columns as $column) {
 206             $column = strip_tags($column);
 207             echo "<th>$column</th>";
 208
 209             /// add a column_feedback column
 210             if ($feedback) {
 211                 echo "<th>{$column}_feedback</th>";
 212             }
 213         }
 214         echo '<th>'.get_string("total")."</th>";
 215         echo '</tr>';
 216         /// Print all the lines of data.
 217
 218
 219         foreach ($this->grades as $studentid => $studentgrades) {
 220
 221             echo '<tr>';
 222             $student = $this->students[$studentid];
 223             if (empty($this->totals[$student->id])) {
 224                 $this->totals[$student->id] = '';
 225             }
 226
 227
 228             echo "<td>$student->firstname</td><td>$student->lastname</td><td>$student->idnumber</td><td>$student->institution</td><td>$student->department</td><td>$student->email</td>";
 229             foreach ($studentgrades as $grade) {
 230                 $grade = strip_tags($grade);
 231                 echo "<td>$grade</td>";
 232
 233                 if ($feedback) {
 234                     echo '<td>'.array_shift($this->comments[$student->id]).'</td>';
 235                 }
 236             }
 237             echo '<td>'.$this->totals[$student->id].'</td>';
 238             echo "</tr>";
 239         }
 240         echo '</table>';
 241     }
 242 }
 243
 244 ?>