Merge branch 'MDL-30279-master' of git://github.com/ankitagarwal/moodle
[moodle.git] / mod / lti / backup / moodle2 / backup_lti_stepslib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 //
17 // This file is part of BasicLTI4Moodle
18 //
19 // BasicLTI4Moodle is an IMS BasicLTI (Basic Learning Tools for Interoperability)
20 // consumer for Moodle 1.9 and Moodle 2.0. BasicLTI is a IMS Standard that allows web
21 // based learning tools to be easily integrated in LMS as native ones. The IMS BasicLTI
22 // specification is part of the IMS standard Common Cartridge 1.1 Sakai and other main LMS
23 // are already supporting or going to support BasicLTI. This project Implements the consumer
24 // for Moodle. Moodle is a Free Open source Learning Management System by Martin Dougiamas.
25 // BasicLTI4Moodle is a project iniciated and leaded by Ludo(Marc Alier) and Jordi Piguillem
26 // at the GESSI research group at UPC.
27 // SimpleLTI consumer for Moodle is an implementation of the early specification of LTI
28 // by Charles Severance (Dr Chuck) htp://dr-chuck.com , developed by Jordi Piguillem in a
29 // Google Summer of Code 2008 project co-mentored by Charles Severance and Marc Alier.
30 //
31 // BasicLTI4Moodle is copyright 2009 by Marc Alier Forment, Jordi Piguillem and Nikolas Galanis
32 // of the Universitat Politecnica de Catalunya http://www.upc.edu
33 // Contact info: Marc Alier Forment granludo @ gmail.com or marc.alier @ upc.edu
35 /**
36  * This file contains all the backup steps that will be used
37  * by the backup_lti_activity_task
38  *
39  * @package    mod
40  * @subpackage lti
41  * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
42  *  marc.alier@upc.edu
43  * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
44  * @author     Marc Alier
45  * @author     Jordi Piguillem
46  * @author     Nikolas Galanis
47  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
48  */
50 defined('MOODLE_INTERNAL') || die;
52 /**
53  * Define the complete assignment structure for backup, with file and id annotations
54  */
55 class backup_lti_activity_structure_step extends backup_activity_structure_step {
57     protected function define_structure() {
59         // To know if we are including userinfo
60         $userinfo = $this->get_setting_value('userinfo');
62         // Define each element separated
63         $basiclti = new backup_nested_element('lti', array('id'), array(
64             'name',
65             'intro',
66             'introformat',
67             'timecreated',
68             'timemodified',
69             'typeid',
70             'toolurl',
71             'preferheight',
72             'launchcontainer',
73             'instructorchoicesendname',
74             'instructorchoicesendemailaddr',
75             'instructorchoiceacceptgrades',
76             'instructorchoiceallowroster',
77             'instructorchoiceallowsetting',
78             'grade',
79             'instructorcustomparameters',
80             'showtitle',
81             'showdescription'
82             )
83         );
85         // Build the tree
86         // (none)
88         // Define sources
89         $basiclti->set_source_table('lti', array('id' => backup::VAR_ACTIVITYID));
91         // Define id annotations
92         // (none)
94         // Define file annotations
95         $basiclti->annotate_files('mod_lti', 'intro', null); // This file areas haven't itemid
97         // Return the root element (basiclti), wrapped into standard activity structure
98         return $this->prepare_activity_structure($basiclti);
99     }