You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
137 lines
3.6 KiB
137 lines
3.6 KiB
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Base class for dataformat.
|
|
*
|
|
* @package core
|
|
* @subpackage dataformat
|
|
* @copyright 2016 Brendan Heywood (brendan@catalyst-au.net)
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core\dataformat;
|
|
|
|
/**
|
|
* Base class for dataformat.
|
|
*
|
|
* @package core
|
|
* @subpackage dataformat
|
|
* @copyright 2016 Brendan Heywood (brendan@catalyst-au.net)
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
abstract class base {
|
|
|
|
/** @var $mimetype */
|
|
protected $mimetype = "text/plain";
|
|
|
|
/** @var $extension */
|
|
protected $extension = ".txt";
|
|
|
|
/** @var $filename */
|
|
protected $filename = '';
|
|
|
|
/**
|
|
* Get the file extension
|
|
*
|
|
* @return string file extension
|
|
*/
|
|
public function get_extension() {
|
|
return $this->extension;
|
|
}
|
|
|
|
/**
|
|
* Set download filename base
|
|
*
|
|
* @param string $filename
|
|
*/
|
|
public function set_filename($filename) {
|
|
$this->filename = $filename;
|
|
}
|
|
|
|
/**
|
|
* Set the title of the worksheet inside a spreadsheet
|
|
*
|
|
* For some formats this will be ignored.
|
|
*
|
|
* @param string $title
|
|
*/
|
|
public function set_sheettitle($title) {
|
|
}
|
|
|
|
/**
|
|
* Output file headers to initialise the download of the file.
|
|
*/
|
|
public function send_http_headers() {
|
|
if (defined('BEHAT_SITE_RUNNING')) {
|
|
// For text based formats - we cannot test the output with behat if we force a file download.
|
|
return;
|
|
}
|
|
if (is_https()) {
|
|
// HTTPS sites - watch out for IE! KB812935 and KB316431.
|
|
header('Cache-Control: max-age=10');
|
|
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('Pragma: no-cache');
|
|
}
|
|
header('Expires: '. gmdate('D, d M Y H:i:s', 0) .' GMT');
|
|
header("Content-Type: $this->mimetype\n");
|
|
$filename = $this->filename . $this->get_extension();
|
|
header("Content-Disposition: attachment; filename=\"$filename\"");
|
|
}
|
|
|
|
/**
|
|
* Write the start of the file.
|
|
*/
|
|
public function start_output() {
|
|
// Override me if needed.
|
|
}
|
|
|
|
/**
|
|
* Write the start of the sheet we will be adding data to.
|
|
*
|
|
* @param array $columns
|
|
*/
|
|
public function start_sheet($columns) {
|
|
// Override me if needed.
|
|
}
|
|
|
|
/**
|
|
* Write a single record
|
|
*
|
|
* @param array $record
|
|
* @param int $rownum
|
|
*/
|
|
abstract public function write_record($record, $rownum);
|
|
|
|
/**
|
|
* Write the end of the sheet containing the data.
|
|
*
|
|
* @param array $columns
|
|
*/
|
|
public function close_sheet($columns) {
|
|
// Override me if needed.
|
|
}
|
|
|
|
/**
|
|
* Write the end of the file.
|
|
*/
|
|
public function close_output() {
|
|
// Override me if needed.
|
|
}
|
|
}
|
|
|