[Summary view]

Differences Between: [Versions 400 and 403] [Versions 401 and 403]

   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   * Restore plugin class that provides the necessary information needed to restore comments for questions.
  19   *
  20   * @package     qbank_customfields
  21   * @copyright   2021 Catalyst IT Australia Pty Ltd
  22   * @author      Matt Porritt <mattp@catalyst-au.net>
  23   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  class restore_qbank_customfields_plugin extends restore_qbank_plugin {
  26  
  27      /** @var stdClass|null a fieldset object. */
  28      protected $cachedcategory;
  29  
  30      /**
  31       * Returns the paths to be handled by the plugin at question level.
  32       *
  33       * @return restore_path_element[] The restore path element array.
  34       */
  35      protected function define_question_plugin_structure(): array {
  36          return [new restore_path_element('customfield', $this->get_pathfor('/customfields/customfield'))];
  37      }
  38  
  39      /**
  40       * Process the question custom field element.
  41       *
  42       * @param array $data The custom field data to restore.
  43       */
  44      public function process_customfield(array $data) {
  45          global $DB;
  46  
  47          $newquestion = $this->get_new_parentid('question');
  48  
  49          if (!empty($data->contextid) && $newcontextid = $this->get_mappingid('context', $data->contextid)) {
  50              $fieldcontextid = $newcontextid;
  51          } else {
  52              // Get the category, so we can then later get the context.
  53              $categoryid = $this->get_new_parentid('question_category');
  54              if (empty($this->cachedcategory) || $this->cachedcategory->id != $categoryid) {
  55                  $this->cachedcategory = $DB->get_record('question_categories', ['id' => $categoryid]);
  56              }
  57              $fieldcontextid = $this->cachedcategory->contextid;
  58          }
  59  
  60          $data['newquestion'] = $newquestion;
  61          $data['fieldcontextid'] = $fieldcontextid;
  62  
  63          $customfieldhandler = qbank_customfields\customfield\question_handler::create();
  64          $customfieldhandler->restore_instance_data_from_backup($this->task, $data);
  65      }
  66  }