f7d8a74d9bd5f4f3bb58588609d6e03c2791039b
[moodle.git] / lib / classes / dataformat / spout_base.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Common Spout class for dataformat.
19  *
20  * @package    core
21  * @subpackage dataformat
22  * @copyright  2016 Brendan Heywood (brendan@catalyst-au.net)
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 namespace core\dataformat;
28 /**
29  * Common Spout class for dataformat.
30  *
31  * @package    core
32  * @subpackage dataformat
33  * @copyright  2016 Brendan Heywood (brendan@catalyst-au.net)
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 abstract class spout_base extends \core\dataformat\base {
38     /** @var $spouttype */
39     protected $spouttype = '';
41     /** @var $writer */
42     protected $writer;
44     /** @var $sheettitle */
45     protected $sheettitle;
47     /** @var $renamecurrentsheet */
48     protected $renamecurrentsheet = false;
50     /**
51      * Output file headers to initialise the download of the file.
52      */
53     public function send_http_headers() {
54         $this->writer = \Box\Spout\Writer\Common\Creator\WriterEntityFactory::createWriter($this->spouttype);
55         if (method_exists($this->writer, 'setTempFolder')) {
56             $this->writer->setTempFolder(make_request_directory());
57         }
58         $filename = $this->filename . $this->get_extension();
59         $this->writer->openToBrowser($filename);
61         // By default one sheet is always created, but we want to rename it when we call start_sheet().
62         $this->renamecurrentsheet = true;
63     }
65     /**
66      * Set the title of the worksheet inside a spreadsheet
67      *
68      * For some formats this will be ignored.
69      *
70      * @param string $title
71      */
72     public function set_sheettitle($title) {
73         $this->sheettitle = $title;
74     }
76     /**
77      * Write the start of the sheet we will be adding data to.
78      *
79      * @param array $columns
80      */
81     public function start_sheet($columns) {
82         if ($this->sheettitle && $this->writer instanceof \Box\Spout\Writer\WriterMultiSheetsAbstract) {
83             if ($this->renamecurrentsheet) {
84                 $sheet = $this->writer->getCurrentSheet();
85                 $this->renamecurrentsheet = false;
86             } else {
87                 $sheet = $this->writer->addNewSheetAndMakeItCurrent();
88             }
89             $sheet->setName($this->sheettitle);
90         }
91         $row = \Box\Spout\Writer\Common\Creator\WriterEntityFactory::createRowFromArray((array)$columns);
92         $this->writer->addRow($row);
93     }
95     /**
96      * Write a single record
97      *
98      * @param object $record
99      * @param int $rownum
100      */
101     public function write_record($record, $rownum) {
102         $row = \Box\Spout\Writer\Common\Creator\WriterEntityFactory::createRowFromArray((array)$record);
103         $this->writer->addRow($row);
104     }
106     /**
107      * Write the end of the file.
108      */
109     public function close_output() {
110         $this->writer->close();
111         $this->writer = null;
112     }