75340cbff9cdf29d3ffaa37b8d6fc2c25160052e
[moodle.git] / mod / survey / backup / moodle1 / lib.php
1 <?php
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/>.
18 /**
19  * Provides support for the conversion of moodle1 backup to the moodle2 format
20  *
21  * @package    mod
22  * @subpackage survey
23  * @copyright  2011 Rossiani Wijaya <rwijaya@moodle.com>
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Survey conversion handler
31  */
32 class moodle1_mod_survey_handler extends moodle1_mod_handler {
34     /** @var moodle1_file_manager */
35     protected $fileman = null;
37     /** @var int cmid */
38     protected $moduleid = null;
40     /**
41      * Declare the paths in moodle.xml we are able to convert
42      *
43      * The method returns list of {@link convert_path} instances.
44      * For each path returned, the corresponding conversion method must be
45      * defined.
46      *
47      * Note that the path /MOODLE_BACKUP/COURSE/MODULES/MOD/SURVEY does not
48      * actually exist in the file. The last element with the module name was
49      * appended by the moodle1_converter class.
50      *
51      * @return array of {@link convert_path} instances
52      */
53     public function get_paths() {
54         return array(
55             new convert_path(
56                 'survey', '/MOODLE_BACKUP/COURSE/MODULES/MOD/SURVEY',
57                 array(
58                     'newfields' => array(
59                         'introformat' => 0,
60                     ),
61                 )
62             ),
63         );
64     }
66     /**
67      * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/SURVEY
68      * data available
69      */
70     public function process_survey($data) {
71         global $CFG;
73         // get the course module id and context id
74         $instanceid     = $data['id'];
75         $cminfo         = $this->get_cminfo($instanceid);
76         $this->moduleid = $cminfo['id'];
77         $contextid      = $this->converter->get_contextid(CONTEXT_MODULE, $this->moduleid);
79         // replay upgrade step 2009042002
80         if ($CFG->texteditors !== 'textarea') {
81             $data['intro']       = text_to_html($data['intro'], false, false, true);
82             $data['introformat'] = FORMAT_HTML;
83         }
85         // get a fresh new file manager for this instance
86         $this->fileman = $this->converter->get_file_manager($contextid, 'mod_survey');
88         // convert course files embedded into the intro
89         $this->fileman->filearea = 'intro';
90         $this->fileman->itemid   = 0;
91         $data['intro'] = moodle1_converter::migrate_referenced_files($data['intro'], $this->fileman);
93         // write survey.xml
94         $this->open_xml_writer("activities/survey_{$this->moduleid}/survey.xml");
95         $this->xmlwriter->begin_tag('activity', array('id' => $instanceid, 'moduleid' => $this->moduleid,
96             'modulename' => 'survey', 'contextid' => $contextid));
97         $this->xmlwriter->begin_tag('survey', array('id' => $instanceid));
99         foreach ($data as $field => $value) {
100             if ($field <> 'id') {
101                 $this->xmlwriter->full_tag($field, $value);
102             }
103         }
105         return $data;
106     }
108     /**
109      * This is executed when we reach the closing </MOD> tag of our 'survey' path
110      */
111     public function on_survey_end() {
112         // finish survey.xml
113         $this->xmlwriter->end_tag('survey');
114         $this->xmlwriter->end_tag('activity');
115         $this->close_xml_writer();
117         // write inforef.xml
118         $this->open_xml_writer("activities/survey_{$this->moduleid}/inforef.xml");
119         $this->xmlwriter->begin_tag('inforef');
120         $this->xmlwriter->begin_tag('fileref');
121         foreach ($this->fileman->get_fileids() as $fileid) {
122             $this->write_xml('file', array('id' => $fileid));
123         }
124         $this->xmlwriter->end_tag('fileref');
125         $this->xmlwriter->end_tag('inforef');
126         $this->close_xml_writer();
127     }