MDL-44152 mod_chat: unified @package use
[moodle.git] / mod / chat / backup / moodle2 / restore_chat_activity_task.class.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 Eloy Lafuente (stronk7) {@link http://stronk7.com}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 require_once($CFG->dirroot . '/mod/chat/backup/moodle2/restore_chat_stepslib.php'); // Because it exists (must)
29 /**
30  * chat restore task that provides all the settings and steps to perform one
31  * complete restore of the activity
32  */
33 class restore_chat_activity_task extends restore_activity_task {
35     /**
36      * Define (add) particular settings this activity can have
37      */
38     protected function define_my_settings() {
39         // No particular settings for this activity
40     }
42     /**
43      * Define (add) particular steps this activity can have
44      */
45     protected function define_my_steps() {
46         // chat only has one structure step
47         $this->add_step(new restore_chat_activity_structure_step('chat_structure', 'chat.xml'));
48     }
50     /**
51      * Define the contents in the activity that must be
52      * processed by the link decoder
53      */
54     static public function define_decode_contents() {
55         $contents = array();
57         $contents[] = new restore_decode_content('chat', array('intro'), 'chat');
58         $contents[] = new restore_decode_content('chat_messages', array('message'), 'chat_message');
60         return $contents;
61     }
63     /**
64      * Define the decoding rules for links belonging
65      * to the activity to be executed by the link decoder
66      */
67     static public function define_decode_rules() {
68         $rules = array();
70         $rules[] = new restore_decode_rule('CHATVIEWBYID', '/mod/chat/view.php?id=$1', 'course_module');
71         $rules[] = new restore_decode_rule('CHATINDEX', '/mod/chat/index.php?id=$1', 'course');
73         return $rules;
75     }
77     /**
78      * Define the restore log rules that will be applied
79      * by the {@link restore_logs_processor} when restoring
80      * chat logs. It must return one array
81      * of {@link restore_log_rule} objects
82      */
83     static public function define_restore_log_rules() {
84         $rules = array();
86         $rules[] = new restore_log_rule('chat', 'add', 'view.php?id={course_module}', '{chat}');
87         $rules[] = new restore_log_rule('chat', 'update', 'view.php?id={course_module}', '{chat}');
88         $rules[] = new restore_log_rule('chat', 'view', 'view.php?id={course_module}', '{chat}');
89         $rules[] = new restore_log_rule('chat', 'talk', 'view.php?id={course_module}', '{chat}');
90         $rules[] = new restore_log_rule('chat', 'report', 'report.php?id={course_module}', '{chat}');
92         return $rules;
93     }
95     /**
96      * Define the restore log rules that will be applied
97      * by the {@link restore_logs_processor} when restoring
98      * course logs. It must return one array
99      * of {@link restore_log_rule} objects
100      *
101      * Note this rules are applied when restoring course logs
102      * by the restore final task, but are defined here at
103      * activity level. All them are rules not linked to any module instance (cmid = 0)
104      */
105     static public function define_restore_log_rules_for_course() {
106         $rules = array();
108         $rules[] = new restore_log_rule('chat', 'view all', 'index.php?id={course}', null);
110         return $rules;
111     }