c5f6e6919caecbf91dac40ba5e4f01e5c0469c44
[moodle.git] / mod / choice / 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 choice
23  * @copyright  2011 David Mudrak <david@moodle.com>
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Choice conversion handler
31  */
32 class moodle1_mod_choice_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/CHOICE 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                 'choice', '/MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE',
57                 array(
58                     'renamefields' => array(
59                         'text' => 'intro',
60                         'format' => 'introformat',
61                     ),
62                     'newfields' => array(
63                         'completionsubmit' => 0,
64                     ),
65                     'dropfields' => array(
66                         'modtype'
67                     ),
68                 )
69             ),
70             new convert_path('choice_options', '/MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE/OPTIONS'),
71             new convert_path('choice_option', '/MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE/OPTIONS/OPTION'),
72         );
73     }
75     /**
76      * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE
77      * data available
78      */
79     public function process_choice($data) {
81         // get the course module id and context id
82         $instanceid     = $data['id'];
83         $cminfo         = $this->get_cminfo($instanceid);
84         $this->moduleid = $cminfo['id'];
85         $contextid      = $this->converter->get_contextid(CONTEXT_MODULE, $this->moduleid);
87         // get a fresh new file manager for this instance
88         $this->fileman = $this->converter->get_file_manager($contextid, 'mod_choice');
90         // convert course files embedded into the intro
91         $this->fileman->filearea = 'intro';
92         $this->fileman->itemid   = 0;
93         $data['intro'] = moodle1_converter::migrate_referenced_files($data['intro'], $this->fileman);
95         // start writing choice.xml
96         $this->open_xml_writer("activities/choice_{$this->moduleid}/choice.xml");
97         $this->xmlwriter->begin_tag('activity', array('id' => $instanceid, 'moduleid' => $this->moduleid,
98             'modulename' => 'choice', 'contextid' => $contextid));
99         $this->xmlwriter->begin_tag('choice', array('id' => $instanceid));
101         foreach ($data as $field => $value) {
102             if ($field <> 'id') {
103                 $this->xmlwriter->full_tag($field, $value);
104             }
105         }
107         return $data;
108     }
110     /**
111      * This is executed when the parser reaches the <OPTIONS> opening element
112      */
113     public function on_choice_options_start() {
114         $this->xmlwriter->begin_tag('options');
115     }
117     /**
118      * This is executed every time we have one /MOODLE_BACKUP/COURSE/MODULES/MOD/CHOICE/OPTIONS/OPTION
119      * data available
120      */
121     public function process_choice_option($data) {
122         $this->write_xml('option', $data, array('/option/id'));
123     }
125     /**
126      * This is executed when the parser reaches the closing </OPTIONS> element
127      */
128     public function on_choice_options_end() {
129         $this->xmlwriter->end_tag('options');
130     }
132     /**
133      * This is executed when we reach the closing </MOD> tag of our 'choice' path
134      */
135     public function on_choice_end() {
136         // finalize choice.xml
137         $this->xmlwriter->end_tag('choice');
138         $this->xmlwriter->end_tag('activity');
139         $this->close_xml_writer();
141         // write inforef.xml
142         $this->open_xml_writer("activities/choice_{$this->moduleid}/inforef.xml");
143         $this->xmlwriter->begin_tag('inforef');
144         $this->xmlwriter->begin_tag('fileref');
145         foreach ($this->fileman->get_fileids() as $fileid) {
146             $this->write_xml('file', array('id' => $fileid));
147         }
148         $this->xmlwriter->end_tag('fileref');
149         $this->xmlwriter->end_tag('inforef');
150         $this->close_xml_writer();
151     }