[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   * 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 moodle_url, part_of_admin_tree, admin_externalpage;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  /**
  31   * Class for repositories
  32   */
  33  class repository 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 $DB;
  40          return $DB->get_records_menu('repository', null, 'type ASC', 'type, type AS val');
  41      }
  42  
  43      public function get_settings_section_name() {
  44          return 'repositorysettings'.$this->name;
  45      }
  46  
  47      public function load_settings(part_of_admin_tree $adminroot, $parentnodename, $hassiteconfig) {
  48          if (!$this->is_installed_and_upgraded()) {
  49              return;
  50          }
  51  
  52          if ($hassiteconfig && $this->is_enabled()) {
  53              // Completely no access to repository setting when it is not enabled.
  54              $sectionname = $this->get_settings_section_name();
  55              $settingsurl = new moodle_url('/admin/repository.php',
  56                  array('sesskey' => sesskey(), 'action' => 'edit', 'repos' => $this->name));
  57              $settings = new admin_externalpage($sectionname, $this->displayname,
  58                  $settingsurl, 'moodle/site:config', false);
  59              $adminroot->add($parentnodename, $settings);
  60          }
  61      }
  62  
  63      /**
  64       * Return URL used for management of plugins of this type.
  65       * @return moodle_url
  66       */
  67      public static function get_manage_url() {
  68          return new moodle_url('/admin/repository.php');
  69      }
  70  
  71      /**
  72       * Defines if there should be a way to uninstall the plugin via the administration UI.
  73       * @return boolean
  74       */
  75      public function is_uninstall_allowed() {
  76          if ($this->name === 'upload' || $this->name === 'coursefiles' || $this->name === 'user' || $this->name === 'recent') {
  77              return false;
  78          } else {
  79              return true;
  80          }
  81      }
  82  
  83      /**
  84       * Pre-uninstall hook.
  85       * This is intended for disabling of plugin, some DB table purging, etc.
  86       * Converts all linked files to standard files when repository is removed
  87       * and cleans up all records in the DB for that repository.
  88       */
  89      public function uninstall_cleanup() {
  90          global $CFG;
  91          require_once($CFG->dirroot.'/repository/lib.php');
  92  
  93          $repo = \repository::get_type_by_typename($this->name);
  94          if ($repo) {
  95              $repo->delete(true);
  96          }
  97  
  98          parent::uninstall_cleanup();
  99      }
 100  }