[Summary view]

Differences Between: [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 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   * Class for availability plugins.
  19   *
  20   * @package core
  21   * @copyright 2014 The Open University
  22   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core\plugininfo;
  25  
  26  use admin_settingpage;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  /**
  31   * Class for availability plugins.
  32   *
  33   * @package core
  34   * @copyright 2014 The Open University
  35   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class availability extends base {
  38      public static function get_enabled_plugins() {
  39          global $DB;
  40  
  41          // Get all available plugins.
  42          $plugins = \core_plugin_manager::instance()->get_installed_plugins('availability');
  43          if (!$plugins) {
  44              return array();
  45          }
  46  
  47          // Check they are enabled using get_config (which is cached and hopefully fast).
  48          $enabled = array();
  49          foreach ($plugins as $plugin => $version) {
  50              $disabled = get_config('availability_' . $plugin, 'disabled');
  51              if (empty($disabled)) {
  52                  $enabled[$plugin] = $plugin;
  53              }
  54          }
  55  
  56          return $enabled;
  57      }
  58  
  59      /**
  60       * Defines if there should be a way to uninstall the plugin via the administration UI.
  61       *
  62       * @return bool
  63       */
  64      public function is_uninstall_allowed() {
  65          return true;
  66      }
  67  
  68      /**
  69       * Get the name for the settings section.
  70       *
  71       * @return string
  72       */
  73      public function get_settings_section_name() {
  74          return 'availabilitysetting' . $this->name;
  75      }
  76  
  77      /**
  78       * Load the global settings for a particular availability plugin (if there are any)
  79       *
  80       * @param \part_of_admin_tree $adminroot
  81       * @param string $parentnodename
  82       * @param bool $hassiteconfig
  83       */
  84      public function load_settings(\part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
  85          global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them.
  86          $ADMIN = $adminroot; // May be used in settings.php.
  87          $plugininfo = $this; // Also can be used inside settings.php
  88          $availability = $this; // Also to be used inside settings.php.
  89  
  90          if (!$this->is_installed_and_upgraded()) {
  91              return;
  92          }
  93  
  94          if (!$hassiteconfig) {
  95              return;
  96          }
  97  
  98          $section = $this->get_settings_section_name();
  99  
 100          $settings = null;
 101          if (file_exists($this->full_path('settings.php'))) {
 102              $settings = new admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false);
 103              include($this->full_path('settings.php')); // This may also set $settings to null.
 104          }
 105          if ($settings) {
 106              $ADMIN->add($parentnodename, $settings);
 107          }
 108      }
 109  }