[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   * Helper class for question bank and its plugins.
  19   *
  20   * All the functions which has a potential to be used by different features or
  21   * plugins, should go here.
  22   *
  23   * @package    core_question
  24   * @copyright  2021 Catalyst IT Australia Pty Ltd
  25   * @author     Safat Shahin <safatshahin@catalyst-au.net>
  26   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27   */
  28  
  29  namespace core_question\local\bank;
  30  
  31  /**
  32   * Class helper
  33   *
  34   * @package    core_question
  35   * @copyright  2021 Catalyst IT Australia Pty Ltd
  36   * @author     Safat Shahin <safatshahin@catalyst-au.net>
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  class helper {
  40  
  41      /**
  42       * Check the status of a plugin and throw exception if not enabled and called manually.
  43       *
  44       * Any action plugin having a php script, should call this function for a safer enable/disable implementation.
  45       *
  46       * @param string $pluginname
  47       * @return void
  48       */
  49      public static function require_plugin_enabled(string $pluginname): void {
  50          if (!\core\plugininfo\qbank::is_plugin_enabled($pluginname)) {
  51              throw new \moodle_exception('The following plugin is either disabled or missing from disk: ' . $pluginname);
  52          }
  53      }
  54  }