[Summary view] [Print] [Text view]

   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.
  34  
  35  /**
  36   * This file contains all the backup steps that will be used
  37   * by the backup_lti_activity_task
  38   *
  39   * @package mod_lti
  40   * @copyright  2009 Marc Alier, Jordi Piguillem, Nikolas Galanis
  41   *  marc.alier@upc.edu
  42   * @copyright  2009 Universitat Politecnica de Catalunya http://www.upc.edu
  43   * @author     Marc Alier
  44   * @author     Jordi Piguillem
  45   * @author     Nikolas Galanis
  46   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  47   */
  48  
  49  defined('MOODLE_INTERNAL') || die;
  50  
  51  /**
  52   * Define the complete assignment structure for backup, with file and id annotations
  53   */
  54  class backup_lti_activity_structure_step extends backup_activity_structure_step {
  55  
  56      protected function define_structure() {
  57  
  58          // TODO: MDL-34161 - Fix restore to support course/site tools & submissions.
  59  
  60          // To know if we are including userinfo.
  61          $userinfo = $this->get_setting_value('userinfo');
  62  
  63          // Define each element separated.
  64          $lti = new backup_nested_element('lti', array('id'), array(
  65              'name',
  66              'intro',
  67              'introformat',
  68              'timecreated',
  69              'timemodified',
  70              'typeid',
  71              'toolurl',
  72              'securetoolurl',
  73              'preferheight',
  74              'launchcontainer',
  75              'instructorchoicesendname',
  76              'instructorchoicesendemailaddr',
  77              'instructorchoiceacceptgrades',
  78              'instructorchoiceallowroster',
  79              'instructorchoiceallowsetting',
  80              'grade',
  81              'instructorcustomparameters',
  82              'debuglaunch',
  83              'showtitlelaunch',
  84              'showdescriptionlaunch',
  85              'icon',
  86              'secureicon',
  87              )
  88          );
  89  
  90          // Build the tree
  91          // (none).
  92  
  93          // Define sources.
  94          $lti->set_source_table('lti', array('id' => backup::VAR_ACTIVITYID));
  95  
  96          // Define id annotations
  97          // (none).
  98  
  99          // Define file annotations.
 100          $lti->annotate_files('mod_lti', 'intro', null); // This file areas haven't itemid.
 101  
 102          // Add support for subplugin structures.
 103          $this->add_subplugin_structure('ltisource', $lti, true);
 104          $this->add_subplugin_structure('ltiservice', $lti, true);
 105  
 106          // Return the root element (lti), wrapped into standard activity structure.
 107          return $this->prepare_activity_structure($lti);
 108      }
 109  }