backup/moodle2/restore_plagiarism_plugin.class.php

   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  * Defines restore_plagiarism_plugin class
  20  *
  21  * @package     core_backup
  22  * @subpackage  moodle2
  23  * @category    backup
  24  * @copyright   2011 onwards Eloy Lafuente (stronk7) {@link http://stronk7.com}
  25  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  26  */
  27
  28 defined('MOODLE_INTERNAL') || die();
  29
  30 /**
  31  * Class extending standard restore_plugin in order to implement some
  32  * helper methods related with the plagiarism plugins
  33  *
  34  * TODO: Finish phpdocs
  35  */
  36 abstract class restore_plagiarism_plugin extends restore_plugin {
  37     public function define_plugin_structure($connectionpoint) {
  38         global $CFG;
  39         if (!$connectionpoint instanceof restore_path_element) {
  40             throw new restore_step_exception('restore_path_element_required', $connectionpoint);
  41         }
  42
  43         //check if enabled at site level and plugin is enabled.
  44         require_once($CFG->libdir . '/plagiarismlib.php');
  45         $enabledplugins = plagiarism_load_available_plugins();
  46         if (!array_key_exists($this->pluginname, $enabledplugins)) {
  47             return array();
  48         }
  49         return parent::define_plugin_structure($connectionpoint);
  50     }
  51 }