[Summary view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401]

   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  /**
  18   * Defines the backup_enrol_lti_plugin class.
  19   *
  20   * @package   enrol_lti
  21   * @copyright 2016 Mark Nelson <markn@moodle.com>
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  /**
  28   * Define all the backup steps.
  29   *
  30   * @package   enrol_lti
  31   * @copyright 2016 Mark Nelson <markn@moodle.com>
  32   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  class backup_enrol_lti_plugin extends backup_enrol_plugin {
  35  
  36      /**
  37       * Defines the other LTI enrolment structures to append.
  38       *
  39       * @return backup_plugin_element
  40       */
  41      public function define_enrol_plugin_structure() {
  42          // Get the parent we will be adding these elements to.
  43          $plugin = $this->get_plugin_element();
  44  
  45          // Define our elements.
  46          $tool = new backup_nested_element('tool', array('id'), array(
  47              'enrolid', 'contextid', 'institution', 'lang', 'timezone', 'maxenrolled', 'maildisplay', 'city',
  48              'country', 'gradesync', 'gradesynccompletion', 'membersync', 'membersyncmode',  'roleinstructor',
  49              'rolelearner', 'secret', 'ltiversion', 'timecreated', 'timemodified'));
  50  
  51          $users = new backup_nested_element('users');
  52  
  53          $user = new backup_nested_element('user', array('id'), array(
  54              'userid', 'toolid', 'serviceurl', 'sourceid', 'consumerkey', 'consumersecret', 'membershipurl',
  55              'membershipsid'));
  56  
  57          // Build elements hierarchy.
  58          $plugin->add_child($tool);
  59          $tool->add_child($users);
  60          $users->add_child($user);
  61  
  62          // Set sources to populate the data.
  63          $tool->set_source_table('enrol_lti_tools',
  64              array('enrolid' => backup::VAR_PARENTID));
  65  
  66          // Users are only added only if users included.
  67          if ($this->task->get_setting_value('users')) {
  68              $user->set_source_table('enrol_lti_users', array('toolid' => backup::VAR_PARENTID));
  69          }
  70      }
  71  }