[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   * Restore plugin class that provides the necessary information needed to restore comments for questions.
  19   *
  20   * @package    qbank_comment
  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_comment_plugin extends restore_qbank_plugin {
  26  
  27      /**
  28       * Returns the paths to be handled by the plugin at question level.
  29       */
  30      protected function define_question_plugin_structure() {
  31          return [
  32              new restore_path_element('comment', $this->get_pathfor('/comments/comment'))
  33          ];
  34      }
  35  
  36      /**
  37       * Process the question comments element.
  38       *
  39       * @param array $data The comment data to restore.
  40       */
  41      public function process_comment($data) {
  42          global $DB, $CFG;
  43  
  44          $data = (object)$data;
  45  
  46          $newquestionid = $this->get_new_parentid('question');
  47          $questioncreated = (bool) $this->get_mappingid('question_created', $this->get_old_parentid('question'));
  48          if (!$questioncreated) {
  49              // This question already exists in the question bank. Nothing for us to do.
  50              return;
  51          }
  52  
  53          if ($CFG->usecomments) {
  54              $data->itemid = $newquestionid;
  55              $DB->insert_record('comments', $data);
  56          }
  57      }
  58  }