[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   * Define all the backup steps that will be used by the backup_book_activity_task
  19   *
  20   * @package    mod_book
  21   * @copyright  2010 Petr Skoda {@link http://skodak.org}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die;
  26  
  27  /**
  28   * Structure step to backup one book activity
  29   */
  30  class backup_book_activity_structure_step extends backup_activity_structure_step {
  31  
  32      protected function define_structure() {
  33  
  34          // Define each element separated
  35          $book     = new backup_nested_element('book', array('id'), array('name', 'intro', 'introformat', 'numbering', 'customtitles', 'timecreated', 'timemodified'));
  36          $chapters = new backup_nested_element('chapters');
  37          $chapter  = new backup_nested_element('chapter', array('id'), array('pagenum', 'subchapter', 'title', 'content', 'contentformat', 'hidden', 'timemcreated', 'timemodified', 'importsrc',));
  38  
  39          $book->add_child($chapters);
  40          $chapters->add_child($chapter);
  41  
  42          // Define sources
  43          $book->set_source_table('book', array('id' => backup::VAR_ACTIVITYID));
  44          $chapter->set_source_table('book_chapters', array('bookid' => backup::VAR_PARENTID));
  45  
  46          // Define file annotations
  47          $book->annotate_files('mod_book', 'intro', null); // This file area hasn't itemid
  48          $chapter->annotate_files('mod_book', 'chapter', 'id');
  49  
  50          // Return the root element (book), wrapped into standard activity structure
  51          return $this->prepare_activity_structure($book);
  52      }
  53  }