[Summary view] [Print] [Text 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   * Defines classes used for plugin info.
  19   *
  20   * @package    core
  21   * @copyright  2011 David Mudrak <david@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core\plugininfo;
  25  
  26  use part_of_admin_tree, admin_settingpage;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  /**
  31   * Class for webservice protocols
  32   */
  33  class webservice extends base {
  34      /**
  35       * Finds all enabled plugins, the result may include missing plugins.
  36       * @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
  37       */
  38      public static function get_enabled_plugins() {
  39          global $CFG;
  40  
  41          if (empty($CFG->enablewebservices) or empty($CFG->webserviceprotocols)) {
  42              return array();
  43          }
  44  
  45          $enabled = array();
  46          foreach (explode(',', $CFG->webserviceprotocols) as $protocol) {
  47              $enabled[$protocol] = $protocol;
  48          }
  49  
  50          return $enabled;
  51      }
  52  
  53      public function get_settings_section_name() {
  54          return 'webservicesetting' . $this->name;
  55      }
  56  
  57      public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
  58          global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them.
  59          $ADMIN = $adminroot; // May be used in settings.php.
  60          $plugininfo = $this; // Also can be used inside settings.php.
  61          $webservice = $this; // Also can be used inside settings.php.
  62  
  63          if (!$this->is_installed_and_upgraded()) {
  64              return;
  65          }
  66  
  67          if (!$hassiteconfig or !file_exists($this->full_path('settings.php'))) {
  68              return;
  69          }
  70  
  71          $section = $this->get_settings_section_name();
  72  
  73          $settings = new admin_settingpage($section, $this->displayname, 'moodle/site:config', $this->is_enabled() === false);
  74          include($this->full_path('settings.php')); // This may also set $settings to null.
  75  
  76          if ($settings) {
  77              $ADMIN->add($parentnodename, $settings);
  78          }
  79      }
  80  
  81      public function is_uninstall_allowed() {
  82          return false;
  83      }
  84  }