MDL-44152 mod_chat: unified @package use
[moodle.git] / mod / chat / backup / moodle2 / backup_chat_stepslib.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  * @package    mod_chat
20  * @subpackage backup-moodle2
21  * @copyright 2010 onwards Dongsheng Cai <dongsheng@moodle.com>
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 /**
26  * Define all the backup steps that will be used by the backup_chat_activity_task
27  */
28 class backup_chat_activity_structure_step extends backup_activity_structure_step {
29     protected function define_structure() {
30         $userinfo = $this->get_setting_value('userinfo');
32         // Define each element separated
33         $chat = new backup_nested_element('chat', array('id'), array(
34             'name', 'intro', 'introformat', 'keepdays', 'studentlogs',
35             'chattime', 'schedule', 'timemodified'));
36         $messages = new backup_nested_element('messages');
38         $message = new backup_nested_element('message', array('id'), array(
39             'userid', 'groupid', 'system', 'message_text', 'timestamp'));
41         // it is not cool to have two tags with same name, so we need to rename message field to message_text
42         $message->set_source_alias('message', 'message_text');
44         // Build the tree
45         $chat->add_child($messages);
46             $messages->add_child($message);
48         // Define sources
49         $chat->set_source_table('chat', array('id' => backup::VAR_ACTIVITYID));
51         // User related messages only happen if we are including user info
52         if ($userinfo) {
53             $message->set_source_table('chat_messages', array('chatid'=>backup::VAR_PARENTID));
54         }
56         // Define id annotations
57         $message->annotate_ids('user', 'userid');
58         $message->annotate_ids('group', 'groupid');
60         // Annotate the file areas in chat module
61         $chat->annotate_files('mod_chat', 'intro', null); // chat_intro area don't use itemid
63         // Return the root element (chat), wrapped into standard activity structure
64         return $this->prepare_activity_structure($chat);
65     }
66 }