[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  /**
  18   * @package    mod_feedback
  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   * Define all the backup steps that will be used by the backup_feedback_activity_task
  26   */
  27  
  28  /**
  29   * Define the complete feedback structure for backup, with file and id annotations
  30   */
  31  class backup_feedback_activity_structure_step extends backup_activity_structure_step {
  32  
  33      protected function define_structure() {
  34  
  35          // To know if we are including userinfo
  36          $userinfo = $this->get_setting_value('userinfo');
  37  
  38          // Define each element separated
  39          $feedback = new backup_nested_element('feedback', array('id'), array(
  40                                                  'name',
  41                                                  'intro',
  42                                                  'introformat',
  43                                                  'anonymous',
  44                                                  'email_notification',
  45                                                  'multiple_submit',
  46                                                  'autonumbering',
  47                                                  'site_after_submit',
  48                                                  'page_after_submit',
  49                                                  'page_after_submitformat',
  50                                                  'publish_stats',
  51                                                  'timeopen',
  52                                                  'timeclose',
  53                                                  'timemodified',
  54                                                  'completionsubmit'));
  55  
  56          $completeds = new backup_nested_element('completeds');
  57  
  58          $completed = new backup_nested_element('completed', array('id'), array(
  59                                                  'userid',
  60                                                  'timemodified',
  61                                                  'random_response',
  62                                                  'anonymous_response'));
  63  
  64          $items = new backup_nested_element('items');
  65  
  66          $item = new backup_nested_element('item', array('id'), array(
  67                                                  'template',
  68                                                  'name',
  69                                                  'label',
  70                                                  'presentation',
  71                                                  'typ',
  72                                                  'hasvalue',
  73                                                  'position',
  74                                                  'required',
  75                                                  'dependitem',
  76                                                  'dependvalue',
  77                                                  'options'));
  78  
  79          $trackings = new backup_nested_element('trackings');
  80  
  81          $tracking = new backup_nested_element('tracking', array('id'), array(
  82                                                  'userid',
  83                                                  'completed'));
  84  
  85          $values = new backup_nested_element('values');
  86  
  87          $value = new backup_nested_element('value', array('id'), array(
  88                                                  'item',
  89                                                  'template',
  90                                                  'completed',
  91                                                  'value'));
  92  
  93          // Build the tree
  94          $feedback->add_child($items);
  95          $items->add_child($item);
  96  
  97          $feedback->add_child($completeds);
  98          $completeds->add_child($completed);
  99  
 100          $completed->add_child($values);
 101          $values->add_child($value);
 102  
 103          $feedback->add_child($trackings);
 104          $trackings->add_child($tracking);
 105  
 106          // Define sources
 107          $feedback->set_source_table('feedback', array('id' => backup::VAR_ACTIVITYID));
 108  
 109          $item->set_source_table('feedback_item', array('feedback' => backup::VAR_PARENTID));
 110  
 111          // All these source definitions only happen if we are including user info
 112          if ($userinfo) {
 113              $completed->set_source_sql('
 114                  SELECT *
 115                    FROM {feedback_completed}
 116                   WHERE feedback = ?',
 117                  array(backup::VAR_PARENTID));
 118  
 119              $value->set_source_table('feedback_value', array('completed' => backup::VAR_PARENTID));
 120  
 121              $tracking->set_source_table('feedback_tracking', array('feedback' => backup::VAR_PARENTID));
 122          }
 123  
 124          // Define id annotations
 125  
 126          $completed->annotate_ids('user', 'userid');
 127  
 128          $tracking->annotate_ids('user', 'userid');
 129  
 130          // Define file annotations
 131  
 132          $feedback->annotate_files('mod_feedback', 'intro', null); // This file area hasn't itemid
 133          $feedback->annotate_files('mod_feedback', 'page_after_submit', null); // This file area hasn't itemid
 134  
 135          $item->annotate_files('mod_feedback', 'item', 'id');
 136  
 137          // Return the root element (feedback), wrapped into standard activity structure
 138          return $this->prepare_activity_structure($feedback);
 139      }
 140  
 141  }