Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
   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 moodlecore
  20   * @subpackage backup-helper
  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  require_once($CFG->dirroot.'/backup/util/xml/parser/processors/grouped_parser_processor.class.php');
  26  
  27  /**
  28   * helper implementation of grouped_parser_processor that will
  29   * load all the contents of one inforef.xml file to the backup_ids table
  30  *
  31   * TODO: Complete phpdocs
  32   */
  33  class restore_inforef_parser_processor extends grouped_parser_processor {
  34  
  35      protected $restoreid;
  36  
  37      public function __construct($restoreid) {
  38          $this->restoreid = $restoreid;
  39          parent::__construct(array());
  40          // Get itemnames handled by inforef files
  41          $items = backup_helper::get_inforef_itemnames();
  42          // Let's add all them as target paths for the processor
  43          foreach($items as $itemname) {
  44              $pathvalue = '/inforef/' . $itemname . 'ref/' . $itemname;
  45              $this->add_path($pathvalue);
  46          }
  47      }
  48  
  49      protected function dispatch_chunk($data) {
  50          // Received one inforef chunck, we are going to store it into backup_ids
  51          // table, with name = itemname + "ref" for later use
  52          $itemname = basename($data['path']). 'ref';
  53          $itemid   = $data['tags']['id'];
  54          restore_dbops::set_backup_ids_record($this->restoreid, $itemname, $itemid);
  55      }
  56  
  57      protected function notify_path_start($path) {
  58          // nothing to do
  59      }
  60  
  61      protected function notify_path_end($path) {
  62          // nothing to do
  63      }
  64  }