[Summary view]

Differences Between: [Versions 39 and 311]

   1  <?php
   2  
   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/>.
  17  
  18  /**
  19   * @package    mod_choice
  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   */
  24  
  25  /**
  26   * Define all the backup steps that will be used by the backup_choice_activity_task
  27   */
  28  
  29  /**
  30   * Define the complete choice structure for backup, with file and id annotations
  31   */
  32  class backup_choice_activity_structure_step extends backup_activity_structure_step {
  33  
  34      protected function define_structure() {
  35  
  36          // To know if we are including userinfo
  37          $userinfo = $this->get_setting_value('userinfo');
  38  
  39          // Define each element separated
  40          $choice = new backup_nested_element('choice', array('id'), array(
  41              'name', 'intro', 'introformat', 'publish',
  42              'showresults', 'display', 'allowupdate', 'allowmultiple', 'showunanswered',
  43              'limitanswers', 'timeopen', 'timeclose', 'timemodified',
  44              'completionsubmit', 'showpreview', 'includeinactive', 'showavailable'));
  45  
  46          $options = new backup_nested_element('options');
  47  
  48          $option = new backup_nested_element('option', array('id'), array(
  49              'text', 'maxanswers', 'timemodified'));
  50  
  51          $answers = new backup_nested_element('answers');
  52  
  53          $answer = new backup_nested_element('answer', array('id'), array(
  54              'userid', 'optionid', 'timemodified'));
  55  
  56          // Build the tree
  57          $choice->add_child($options);
  58          $options->add_child($option);
  59  
  60          $choice->add_child($answers);
  61          $answers->add_child($answer);
  62  
  63          // Define sources
  64          $choice->set_source_table('choice', array('id' => backup::VAR_ACTIVITYID));
  65  
  66          $option->set_source_table('choice_options', array('choiceid' => backup::VAR_PARENTID), 'id ASC');
  67  
  68          // All the rest of elements only happen if we are including user info
  69          if ($userinfo) {
  70              $answer->set_source_table('choice_answers', array('choiceid' => '../../id'));
  71          }
  72  
  73          // Define id annotations
  74          $answer->annotate_ids('user', 'userid');
  75  
  76          // Define file annotations
  77          $choice->annotate_files('mod_choice', 'intro', null); // This file area hasn't itemid
  78  
  79          // Return the root element (choice), wrapped into standard activity structure
  80          return $this->prepare_activity_structure($choice);
  81      }
  82  }