[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   * This file contains the class for backup of this submission plugin
  19   *
  20   * @package assignsubmission_file
  21   * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
  22   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  /**
  28   * Provides the information to backup submission files
  29   *
  30   * This just adds its filearea to the annotations and records the number of files
  31   *
  32   * @package assignsubmission_file
  33   * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
  34   * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class backup_assignsubmission_file_subplugin extends backup_subplugin {
  37  
  38      /**
  39       * Returns the subplugin information to attach to submission element
  40       * @return backup_subplugin_element
  41       */
  42      protected function define_submission_subplugin_structure() {
  43  
  44          // Create XML elements.
  45          $subplugin = $this->get_subplugin_element();
  46          $subpluginwrapper = new backup_nested_element($this->get_recommended_name());
  47          $subpluginelement = new backup_nested_element('submission_file',
  48                                                        null,
  49                                                        array('numfiles', 'submission'));
  50  
  51          // Connect XML elements into the tree.
  52          $subplugin->add_child($subpluginwrapper);
  53          $subpluginwrapper->add_child($subpluginelement);
  54  
  55          // Set source to populate the data.
  56          $subpluginelement->set_source_table('assignsubmission_file',
  57                                              array('submission' => backup::VAR_PARENTID));
  58  
  59          // The parent is the submission.
  60          $subpluginelement->annotate_files('assignsubmission_file',
  61                                            'submission_files',
  62                                            'submission');
  63          return $subplugin;
  64      }
  65  
  66  }