1<?php
2
3// This file is part of Moodle - http://moodle.org/
4//
5// Moodle is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9//
10// Moodle is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13// GNU General Public License for more details.
14//
15// You should have received a copy of the GNU General Public License
16// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17
18/**
19 * @package    moodlecore
20 * @subpackage backup-xml
21 * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
22 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23 */
24
25/**
26 * This class implements one @xml_output able to store and return output in memory
27 *
28 * Although possible to use, has been defined as not supporting buffering for
29 * testing purposes. get_allcontents() will return the contents after ending.
30 *
31 * TODO: Finish phpdocs
32 */
33class memory_xml_output extends xml_output{
34
35    protected $allcontents; // Here we'll store all the written contents
36
37    public function __construct() {
38        $this->allcontents = '';
39        parent::__construct(false); // disable buffering
40    }
41
42    public function get_allcontents() {
43        if ($this->running !== false) {
44            throw new xml_output_exception('xml_output_not_stopped');
45        }
46        return $this->allcontents;
47    }
48
49// Private API starts here
50
51    protected function init() {
52        // Easy :-)
53    }
54
55    protected function finish() {
56        // Trivial :-)
57    }
58
59    protected function send($content) {
60        // Accumulate contents
61        $this->allcontents .= $content;
62    }
63
64}
65