[Summary 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  /**
  18   * @package    moodlecore
  19   * @subpackage backup-moodle2
  20   * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  21   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  22   */
  23  
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  
  28  /**
  29   * Provides the information to backup calculated questions
  30   *
  31   * @copyright  2010 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  32   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  class backup_qtype_calculated_plugin extends backup_qtype_plugin {
  35  
  36      /**
  37       * Returns the qtype information to attach to question element
  38       */
  39      protected function define_question_plugin_structure() {
  40  
  41          // Define the virtual plugin element with the condition to fulfill.
  42          // Note: we use $this->pluginname so for extended plugins this will work
  43          // automatically: calculatedsimple and calculatedmulti.
  44          $plugin = $this->get_plugin_element(null, '../../qtype', $this->pluginname);
  45  
  46          // Create one standard named plugin element (the visible container).
  47          $pluginwrapper = new backup_nested_element($this->get_recommended_name());
  48  
  49          // Connect the visible container ASAP.
  50          $plugin->add_child($pluginwrapper);
  51  
  52          // This qtype uses standard question_answers, add them here
  53          // to the tree before any other information that will use them.
  54          $this->add_question_question_answers($pluginwrapper);
  55  
  56          // This qtype uses standard numerical units, add them here.
  57          $this->add_question_numerical_units($pluginwrapper);
  58  
  59          // This qtype uses standard numerical options, add them here.
  60          $this->add_question_numerical_options($pluginwrapper);
  61  
  62          // This qtype uses standard datasets, add them here.
  63          $this->add_question_datasets($pluginwrapper);
  64  
  65          // Now create the qtype own structures.
  66          $calculatedrecords = new backup_nested_element('calculated_records');
  67          $calculatedrecord = new backup_nested_element('calculated_record', array('id'), array(
  68              'answer', 'tolerance', 'tolerancetype', 'correctanswerlength',
  69              'correctanswerformat'));
  70  
  71          $calculatedoptions = new backup_nested_element('calculated_options');
  72          $calculatedoption = new backup_nested_element('calculated_option', array('id'), array(
  73              'synchronize', 'single', 'shuffleanswers', 'correctfeedback',
  74              'correctfeedbackformat', 'partiallycorrectfeedback', 'partiallycorrectfeedbackformat',
  75              'incorrectfeedback', 'incorrectfeedbackformat', 'answernumbering'));
  76  
  77          // Now the own qtype tree.
  78          $pluginwrapper->add_child($calculatedrecords);
  79          $calculatedrecords->add_child($calculatedrecord);
  80  
  81          $pluginwrapper->add_child($calculatedoptions);
  82          $calculatedoptions->add_child($calculatedoption);
  83  
  84          // Set source to populate the data.
  85          $calculatedrecord->set_source_table('question_calculated',
  86                  array('question' => backup::VAR_PARENTID));
  87          $calculatedoption->set_source_table('question_calculated_options',
  88                  array('question' => backup::VAR_PARENTID));
  89  
  90          // Don't need to annotate ids nor files.
  91  
  92          return $plugin;
  93      }
  94  
  95      /**
  96       * Returns one array with filearea => mappingname elements for the qtype
  97       *
  98       * Used by {@link get_components_and_fileareas} to know about all the qtype
  99       * files to be processed both in backup and restore.
 100       */
 101      public static function get_qtype_fileareas() {
 102          return array(
 103              'instruction' => 'question_created',
 104              'correctfeedback' => 'question_created',
 105              'partiallycorrectfeedback' => 'question_created',
 106              'incorrectfeedback' => 'question_created');
 107      }
 108  }