public function print_grades()
{
global $CFG;
$export_tracking = $this->track_exports();
$strgrades = get_string('grades');
switch ($this->separator) {
case 'comma':
$separator = ",";
break;
case 'tab':
default:
$separator = "\t";
}
/// Print header to force download
if (strpos($CFG->wwwroot, 'https://') === 0) {
//https sites - watch out for IE! KB812935 and KB316431
@header('Cache-Control: max-age=10');
@header('Expires: ' . gmdate('D, d M Y H:i:s', 0) . ' GMT');
@header('Pragma: ');
} else {
//normal http - prevent caching at all cost
@header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
@header('Expires: ' . gmdate('D, d M Y H:i:s', 0) . ' GMT');
@header('Pragma: no-cache');
}
header("Content-Type: application/download\n");
$downloadfilename = clean_filename("{$this->course->shortname} {$strgrades}");
header("Content-Disposition: attachment; filename=\"{$downloadfilename}.txt\"");
/// Print names of all the fields
echo get_string("firstname") . $separator . get_string("lastname") . $separator . get_string("idnumber") . $separator . get_string("institution") . $separator . get_string("department") . $separator . get_string("email");
foreach ($this->columns as $grade_item) {
echo $separator . $this->format_column_name($grade_item);
/// add a feedback column
if ($this->export_feedback) {
echo $separator . $this->format_column_name($grade_item, true);
}
}
echo "\n";
/// Print all the lines of data.
$geub = new grade_export_update_buffer();
$gui = new graded_users_iterator($this->course, $this->columns, $this->groupid);
$gui->init();
while ($userdata = $gui->next_user()) {
$user = $userdata->user;
echo $user->firstname . $separator . $user->lastname . $separator . $user->idnumber . $separator . $user->institution . $separator . $user->department . $separator . $user->email;
foreach ($userdata->grades as $itemid => $grade) {
if ($export_tracking) {
$status = $geub->track($grade);
}
echo $separator . $this->format_grade($grade);
if ($this->export_feedback) {
echo $separator . $this->format_feedback($userdata->feedbacks[$itemid]);
}
}
echo "\n";
}
$gui->close();
$geub->close();
exit;
}
public function print_grades()
{
global $CFG;
$export_tracking = $this->track_exports();
$strgrades = get_string('grades');
$profilefields = grade_helper::get_user_profile_fields($this->course->id, $this->usercustomfields);
$shortname = format_string($this->course->shortname, true, array('context' => context_course::instance($this->course->id)));
$downloadfilename = clean_filename("{$shortname} {$strgrades}");
$csvexport = new csv_export_writer($this->separator);
$csvexport->set_filename($downloadfilename);
// Print names of all the fields
$exporttitle = array();
foreach ($profilefields as $field) {
$exporttitle[] = $field->fullname;
}
// Add a feedback column.
foreach ($this->columns as $grade_item) {
$exporttitle[] = $this->format_column_name($grade_item);
if ($this->export_feedback) {
$exporttitle[] = $this->format_column_name($grade_item, true);
}
}
$csvexport->add_data($exporttitle);
// Print all the lines of data.
$geub = new grade_export_update_buffer();
$gui = new graded_users_iterator($this->course, $this->columns, $this->groupid);
$gui->require_active_enrolment($this->onlyactive);
$gui->allow_user_custom_fields($this->usercustomfields);
$gui->init();
while ($userdata = $gui->next_user()) {
$exportdata = array();
$user = $userdata->user;
foreach ($profilefields as $field) {
$fieldvalue = grade_helper::get_user_field_value($user, $field);
$exportdata[] = $fieldvalue;
}
foreach ($userdata->grades as $itemid => $grade) {
if ($export_tracking) {
$status = $geub->track($grade);
}
$exportdata[] = $this->format_grade($grade);
if ($this->export_feedback) {
$exportdata[] = $this->format_feedback($userdata->feedbacks[$itemid]);
}
}
$csvexport->add_data($exportdata);
}
$gui->close();
$geub->close();
$csvexport->download_file();
exit;
}
/**
* To be implemented by child classes
*/
public function print_grades()
{
global $CFG;
require_once $CFG->dirroot . '/lib/excellib.class.php';
$export_tracking = $this->track_exports();
$strgrades = get_string('grades');
// Calculate file name
$shortname = format_string($this->course->shortname, true, array('context' => context_course::instance($this->course->id)));
$downloadfilename = clean_filename("{$shortname} {$strgrades}.xls");
// Creating a workbook
$workbook = new MoodleExcelWorkbook("-");
// Sending HTTP headers
$workbook->send($downloadfilename);
// Adding the worksheet
$myxls = $workbook->add_worksheet($strgrades);
// Print names of all the fields
$profilefields = grade_helper::get_user_profile_fields($this->course->id, $this->usercustomfields);
foreach ($profilefields as $id => $field) {
$myxls->write_string(0, $id, $field->fullname);
}
$pos = count($profilefields);
if (!$this->onlyactive) {
$myxls->write_string(0, $pos++, get_string("suspended"));
}
foreach ($this->columns as $grade_item) {
$myxls->write_string(0, $pos++, $this->format_column_name($grade_item));
// Add a column_feedback column
if ($this->export_feedback) {
$myxls->write_string(0, $pos++, $this->format_column_name($grade_item, true));
}
}
// Print all the lines of data.
$i = 0;
$geub = new grade_export_update_buffer();
$gui = new graded_users_iterator($this->course, $this->columns, $this->groupid);
$gui->require_active_enrolment($this->onlyactive);
$gui->allow_user_custom_fields($this->usercustomfields);
$gui->init();
while ($userdata = $gui->next_user()) {
$i++;
$user = $userdata->user;
foreach ($profilefields as $id => $field) {
$fieldvalue = grade_helper::get_user_field_value($user, $field);
$myxls->write_string($i, $id, $fieldvalue);
}
$j = count($profilefields);
if (!$this->onlyactive) {
$issuspended = $user->suspendedenrolment ? get_string('yes') : '';
$myxls->write_string($i, $j++, $issuspended);
}
foreach ($userdata->grades as $itemid => $grade) {
if ($export_tracking) {
$status = $geub->track($grade);
}
$gradestr = $this->format_grade($grade);
if (is_numeric($gradestr)) {
$myxls->write_number($i, $j++, $gradestr);
} else {
$myxls->write_string($i, $j++, $gradestr);
}
// writing feedback if requested
if ($this->export_feedback) {
$myxls->write_string($i, $j++, $this->format_feedback($userdata->feedbacks[$itemid]));
}
}
}
$gui->close();
$geub->close();
/// Close the workbook
$workbook->close();
exit;
}
/**
* Prints preview of exported grades on screen as a feedback mechanism
* @param bool $require_user_idnumber true means skip users without idnumber
*/
function display_preview($require_user_idnumber = false)
{
print_heading(get_string('previewrows', 'grades'));
echo '<table>';
echo '<tr>';
echo '<th>' . get_string("firstname") . "</th>" . '<th>' . get_string("lastname") . "</th>" . '<th>' . get_string("idnumber") . "</th>" . '<th>' . get_string("institution") . "</th>" . '<th>' . get_string("department") . "</th>" . '<th>' . get_string("email") . "</th>";
foreach ($this->columns as $grade_item) {
echo '<th>' . $this->format_column_name($grade_item) . '</th>';
/// add a column_feedback column
if ($this->export_feedback) {
echo '<th>' . $this->format_column_name($grade_item, true) . '</th>';
}
}
echo '</tr>';
/// Print all the lines of data.
$i = 0;
$gui = new graded_users_iterator($this->course, $this->columns, $this->groupid);
$gui->init();
while ($userdata = $gui->next_user()) {
// number of preview rows
if ($this->previewrows and $this->previewrows <= $i) {
break;
}
$user = $userdata->user;
if ($require_user_idnumber and empty($user->idnumber)) {
// some exports require user idnumber
continue;
}
$gradeupdated = false;
// if no grade is update at all for this user, do not display this row
$rowstr = '';
foreach ($this->columns as $itemid => $unused) {
$gradetxt = $this->format_grade($userdata->grades[$itemid]);
// get the status of this grade, and put it through track to get the status
$g = new grade_export_update_buffer();
$grade_grade = new grade_grade(array('itemid' => $itemid, 'userid' => $user->id));
$status = $g->track($grade_grade);
if ($this->updatedgradesonly && ($status == 'nochange' || $status == 'unknown')) {
$rowstr .= '<td>' . get_string('unchangedgrade', 'grades') . '</td>';
} else {
$rowstr .= "<td>{$gradetxt}</td>";
$gradeupdated = true;
}
if ($this->export_feedback) {
$rowstr .= '<td>' . $this->format_feedback($userdata->feedbacks[$itemid]) . '</td>';
}
}
// if we are requesting updated grades only, we are not interested in this user at all
if (!$gradeupdated && $this->updatedgradesonly) {
continue;
}
echo '<tr>';
echo "<td>{$user->firstname}</td><td>{$user->lastname}</td><td>{$user->idnumber}</td><td>{$user->institution}</td><td>{$user->department}</td><td>{$user->email}</td>";
echo $rowstr;
echo "</tr>";
$i++;
// increment the counter
}
echo '</table>';
$gui->close();
}
/**
* To be implemented by child classes
*/
public function print_grades()
{
global $CFG;
require_once $CFG->dirroot . '/lib/excellib.class.php';
$export_tracking = $this->track_exports();
$strgrades = get_string('grades');
/// Calculate file name
$downloadfilename = clean_filename("{$this->course->shortname} {$strgrades}.xls");
/// Creating a workbook
$workbook = new MoodleExcelWorkbook("-");
/// Sending HTTP headers
$workbook->send($downloadfilename);
/// Adding the worksheet
$myxls =& $workbook->add_worksheet($strgrades);
/// Print names of all the fields
$myxls->write_string(0, 0, get_string("firstname"));
$myxls->write_string(0, 1, get_string("lastname"));
$myxls->write_string(0, 2, get_string("idnumber"));
$myxls->write_string(0, 3, get_string("institution"));
$myxls->write_string(0, 4, get_string("department"));
$myxls->write_string(0, 5, get_string("email"));
$pos = 6;
foreach ($this->columns as $grade_item) {
$myxls->write_string(0, $pos++, $this->format_column_name($grade_item));
/// add a column_feedback column
if ($this->export_feedback) {
$myxls->write_string(0, $pos++, $this->format_column_name($grade_item, true));
}
}
/// Print all the lines of data.
$i = 0;
$geub = new grade_export_update_buffer();
$gui = new graded_users_iterator($this->course, $this->columns, $this->groupid);
$gui->init();
while ($userdata = $gui->next_user()) {
$i++;
$user = $userdata->user;
$myxls->write_string($i, 0, $user->firstname);
$myxls->write_string($i, 1, $user->lastname);
$myxls->write_string($i, 2, $user->idnumber);
$myxls->write_string($i, 3, $user->institution);
$myxls->write_string($i, 4, $user->department);
$myxls->write_string($i, 5, $user->email);
$j = 6;
foreach ($userdata->grades as $itemid => $grade) {
if ($export_tracking) {
$status = $geub->track($grade);
}
$gradestr = $this->format_grade($grade);
if (is_numeric($gradestr)) {
$myxls->write_number($i, $j++, $gradestr);
} else {
$myxls->write_string($i, $j++, $gradestr);
}
// writing feedback if requested
if ($this->export_feedback) {
$myxls->write_string($i, $j++, $this->format_feedback($userdata->feedbacks[$itemid]));
}
}
}
$gui->close();
$geub->close();
/// Close the workbook
$workbook->close();
exit;
}
/**
* Prints preview of exported grades on screen as a feedback mechanism
* @param bool $require_user_idnumber true means skip users without idnumber
* @deprecated since 2.8 MDL-46548. Previews are not useful on export.
*/
public function display_preview($require_user_idnumber = false)
{
global $OUTPUT;
debugging('function grade_export::display_preview is deprecated.', DEBUG_DEVELOPER);
$userprofilefields = grade_helper::get_user_profile_fields($this->course->id, $this->usercustomfields);
$formatoptions = new stdClass();
$formatoptions->para = false;
echo $OUTPUT->heading(get_string('previewrows', 'grades'));
echo '<table>';
echo '<tr>';
foreach ($userprofilefields as $field) {
echo '<th>' . $field->fullname . '</th>';
}
if (!$this->onlyactive) {
echo '<th>' . get_string("suspended") . "</th>";
}
foreach ($this->columns as $grade_item) {
echo '<th>' . $this->format_column_name($grade_item) . '</th>';
/// add a column_feedback column
if ($this->export_feedback) {
echo '<th>' . $this->format_column_name($grade_item, true) . '</th>';
}
}
echo '</tr>';
/// Print all the lines of data.
$i = 0;
$gui = new graded_users_iterator($this->course, $this->columns, $this->groupid);
$gui->require_active_enrolment($this->onlyactive);
$gui->allow_user_custom_fields($this->usercustomfields);
$gui->init();
while ($userdata = $gui->next_user()) {
// number of preview rows
if ($this->previewrows and $this->previewrows <= $i) {
break;
}
$user = $userdata->user;
if ($require_user_idnumber and empty($user->idnumber)) {
// some exports require user idnumber so we can match up students when importing the data
continue;
}
$gradeupdated = false;
// if no grade is update at all for this user, do not display this row
$rowstr = '';
foreach ($this->columns as $itemid => $unused) {
$gradetxt = $this->format_grade($userdata->grades[$itemid]);
// get the status of this grade, and put it through track to get the status
$g = new grade_export_update_buffer();
$grade_grade = new grade_grade(array('itemid' => $itemid, 'userid' => $user->id));
$status = $g->track($grade_grade);
if ($this->updatedgradesonly && ($status == 'nochange' || $status == 'unknown')) {
$rowstr .= '<td>' . get_string('unchangedgrade', 'grades') . '</td>';
} else {
$rowstr .= "<td>{$gradetxt}</td>";
$gradeupdated = true;
}
if ($this->export_feedback) {
$rowstr .= '<td>' . $this->format_feedback($userdata->feedbacks[$itemid]) . '</td>';
}
}
// if we are requesting updated grades only, we are not interested in this user at all
if (!$gradeupdated && $this->updatedgradesonly) {
continue;
}
echo '<tr>';
foreach ($userprofilefields as $field) {
$fieldvalue = grade_helper::get_user_field_value($user, $field);
// @see profile_field_base::display_data().
echo '<td>' . format_text($fieldvalue, FORMAT_MOODLE, $formatoptions) . '</td>';
}
if (!$this->onlyactive) {
$issuspended = $user->suspendedenrolment ? get_string('yes') : '';
echo "<td>{$issuspended}</td>";
}
echo $rowstr;
echo "</tr>";
$i++;
// increment the counter
}
echo '</table>';
$gui->close();
}
/**
* To be implemented by child classes
* @param boolean $feedback
* @param boolean $publish Whether to output directly, or send as a file
* @return string
*/
public function print_grades($feedback = false)
{
global $CFG;
require_once $CFG->libdir . '/filelib.php';
$export_tracking = $this->track_exports();
$strgrades = get_string('grades');
/// Calculate file name
$shortname = format_string($this->course->shortname, true, array('context' => context_course::instance($this->course->id)));
$downloadfilename = clean_filename("{$shortname} {$strgrades}.xml");
make_temp_directory('gradeexport');
$tempfilename = $CFG->tempdir . '/gradeexport/' . md5(sesskey() . microtime() . $downloadfilename);
if (!($handle = fopen($tempfilename, 'w+b'))) {
print_error('cannotcreatetempdir');
}
/// time stamp to ensure uniqueness of batch export
fwrite($handle, '<results batch="xml_export_' . time() . '">' . "\n");
$export_buffer = array();
$geub = new grade_export_update_buffer();
$gui = new graded_users_iterator($this->course, $this->columns, $this->groupid);
$gui->require_active_enrolment($this->onlyactive);
$gui->init();
while ($userdata = $gui->next_user()) {
$user = $userdata->user;
if (empty($user->idnumber)) {
//id number must exist otherwise we cant match up students when importing
continue;
}
// studentgrades[] index should match with corresponding $index
foreach ($userdata->grades as $itemid => $grade) {
$grade_item = $this->grade_items[$itemid];
$grade->grade_item =& $grade_item;
$gradestr = $this->format_grade($grade, $this->displaytype);
// no formating for now
// MDL-11669, skip exported grades or bad grades (if setting says so)
if ($export_tracking) {
$status = $geub->track($grade);
if ($this->updatedgradesonly && ($status == 'nochange' || $status == 'unknown')) {
continue;
}
}
fwrite($handle, "\t<result>\n");
if ($export_tracking) {
fwrite($handle, "\t\t<state>{$status}</state>\n");
}
// only need id number
fwrite($handle, "\t\t<assignment>{$grade_item->idnumber}</assignment>\n");
// this column should be customizable to use either student id, idnumber, uesrname or email.
fwrite($handle, "\t\t<student>{$user->idnumber}</student>\n");
fwrite($handle, "\t\t<score>{$gradestr}</score>\n");
if ($this->export_feedback) {
$feedbackstr = $this->format_feedback($userdata->feedbacks[$itemid]);
fwrite($handle, "\t\t<feedback>{$feedbackstr}</feedback>\n");
}
fwrite($handle, "\t</result>\n");
}
}
fwrite($handle, "</results>");
fclose($handle);
$gui->close();
$geub->close();
if (defined('BEHAT_SITE_RUNNING')) {
// If behat is running, we cannot test the output if we force a file download.
include $tempfilename;
} else {
@header("Content-type: text/xml; charset=UTF-8");
send_temp_file($tempfilename, $downloadfilename, false);
}
}
/**
* To be implemented by child classes
* @param boolean $feedback
* @param boolean $publish Whether to output directly, or send as a file
* @return string
*/
function print_grades($feedback = false)
{
global $CFG;
require_once $CFG->libdir . '/filelib.php';
$export_tracking = $this->track_exports();
$strgrades = get_string('grades');
/// Calculate file name
$downloadfilename = clean_filename("{$this->course->shortname} {$strgrades}.xml");
make_upload_directory('temp/gradeexport', false);
$tempfilename = $CFG->dataroot . '/temp/gradeexport/' . md5(sesskey() . microtime() . $downloadfilename);
if (!($handle = fopen($tempfilename, 'w+b'))) {
error("Could not create a temporary file into which to dump the XML data.");
return false;
}
/// time stamp to ensure uniqueness of batch export
fwrite($handle, '<results batch="xml_export_' . time() . '">' . "\n");
$export_buffer = array();
$geub = new grade_export_update_buffer();
$gui = new graded_users_iterator($this->course, $this->columns, $this->groupid);
$gui->init();
while ($userdata = $gui->next_user()) {
$user = $userdata->user;
if (empty($user->idnumber)) {
//id number must exist
continue;
}
// studentgrades[] index should match with corresponding $index
foreach ($userdata->grades as $itemid => $grade) {
$grade_item = $this->grade_items[$itemid];
$grade->grade_item =& $grade_item;
$gradestr = $this->format_grade($grade);
// no formating for now
// MDL-11669, skip exported grades or bad grades (if setting says so)
if ($export_tracking) {
$status = $geub->track($grade);
if ($this->updatedgradesonly && ($status == 'nochange' || $status == 'unknown')) {
continue;
}
}
fwrite($handle, "\t<result>\n");
if ($export_tracking) {
fwrite($handle, "\t\t<state>{$status}</state>\n");
}
// only need id number
fwrite($handle, "\t\t<assignment>{$grade_item->idnumber}</assignment>\n");
// this column should be customizable to use either student id, idnumber, uesrname or email.
fwrite($handle, "\t\t<student>{$user->idnumber}</student>\n");
fwrite($handle, "\t\t<score>{$gradestr}</score>\n");
if ($this->export_feedback) {
$feedbackstr = $this->format_feedback($userdata->feedbacks[$itemid]);
fwrite($handle, "\t\t<feedback>{$feedbackstr}</feedback>\n");
}
fwrite($handle, "\t</result>\n");
}
}
fwrite($handle, "</results>");
fclose($handle);
$gui->close();
$geub->close();
if (strpos($CFG->wwwroot, 'https://') === 0) {
//https sites - watch out for IE! KB812935 and KB316431
@header('Cache-Control: max-age=10');
@header('Expires: ' . gmdate('D, d M Y H:i:s', 0) . ' GMT');
@header('Pragma: ');
} else {
//normal http - prevent caching at all cost
@header('Cache-Control: private, must-revalidate, pre-check=0, post-check=0, max-age=0');
@header('Expires: ' . gmdate('D, d M Y H:i:s', 0) . ' GMT');
@header('Pragma: no-cache');
}
header("Content-type: text/xml; charset=UTF-8");
header("Content-Disposition: attachment; filename=\"{$downloadfilename}\"");
readfile_chunked($tempfilename);
@unlink($tempfilename);
exit;
}
public function display_preview($require_user_idnumber = false)
{
global $OUTPUT;
$userprofilefields = grade_helper::get_user_profile_fields($this->course->id, $this->usercustomfields);
$formatoptions = new stdClass();
$formatoptions->para = false;
$exporttitle = array('Client Code', 'Client Name', 'Qualification Code', 'Unit Code', 'Unit Start Date', 'Unit End Date', 'Outcome Name', 'Outcome Code');
echo $OUTPUT->heading(get_string('previewrows', 'grades'));
echo '<table class="csv-table">';
echo '<tr>';
foreach ($exporttitle as $field) {
echo '<th>' . $field . '</th>';
}
if (!$this->onlyactive) {
echo '<th>' . get_string("suspended") . "</th>";
}
// foreach ($this->columns as $grade_item) {
// echo '<th>'.$this->format_column_name($grade_item).'</th>';
// /// add a column_feedback column
// if ($this->export_feedback) {
// echo '<th>'.$this->format_column_name($grade_item, true).'</th>';
// }
// }
echo '</tr>';
/// Print all the lines of data.
$i = 0;
$gui = new graded_users_iterator($this->course, $this->columns, $this->groupid);
$gui->require_active_enrolment($this->onlyactive);
$gui->allow_user_custom_fields($this->usercustomfields);
$gui->init();
while ($userdata = $gui->next_user()) {
// number of preview rows
if ($this->previewrows and $this->previewrows <= $i) {
break;
}
$user = $userdata->user;
if ($require_user_idnumber and empty($user->idnumber)) {
// some exports require user idnumber so we can match up students when importing the data
continue;
}
$gradeupdated = false;
// if no grade is update at all for this user, do not display this row
$rowstr = '';
foreach ($this->columns as $itemid => $grade_item) {
$gradetxt = $this->format_grade($userdata->grades[$itemid]);
$activity_start_date = $this->get_activity_start_date($this->course, $user, $grade_item);
$grade_modified = $userdata->grades[$itemid]->timemodified;
$client_code = $userdata->user->idnumber;
$client_name = $userdata->user->firstname . ' ' . $userdata->user->lastname;
// $course_code = $this->get_course_short_name($grade_item);
$course_code = $this->course->idnumber;
// $unit_code = $grade_item->itemname;
$unit_code = $grade_item->idnumber;
$unit_start = $activity_start_date ? $activity_start_date->format('d-m-Y') : '-';
$unit_end = $grade_modified ? userdate($grade_modified, '%d-%m-%Y') : '-';
$grade_name = $this->get_grade_name($gradetxt);
if ($grade_item->itemtype == 'category') {
$category_start_date = $this->get_category_start_date($this->course, $user, $grade_item);
$unit_start = $category_start_date ? $category_start_date->format('d-m-Y') : '-';
}
// get the status of this grade, and put it through track to get the status
$g = new grade_export_update_buffer();
$grade_grade = new grade_grade(array('itemid' => $itemid, 'userid' => $user->id));
$status = $g->track($grade_grade);
if ($this->updatedgradesonly && ($status == 'nochange' || $status == 'unknown')) {
$rowstr .= '<td>' . get_string('unchangedgrade', 'grades') . '</td>';
} else {
$rowstr .= "<tr>\n <td>{$client_code}</td>\n <td>{$client_name}</td>\n <td>{$course_code}</td>\n <td>{$unit_code}</td>\n <td>{$unit_start}</td>\n <td>{$unit_end}</td>\n <td>{$grade_name}</td>\n <td>{$gradetxt}</td>\n </tr>";
$gradeupdated = true;
}
if ($this->export_feedback) {
$rowstr .= '<td>' . $this->format_feedback($userdata->feedbacks[$itemid]) . '</td>';
}
}
// if we are requesting updated grades only, we are not interested in this user at all
if (!$gradeupdated && $this->updatedgradesonly) {
continue;
}
echo '<tr>';
echo $rowstr;
echo "</tr>";
$i++;
// increment the counter
}
echo '</table>';
$gui->close();
}