[Summary view]

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

   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;
  27  
  28  /**
  29   * Class for portfolios
  30   */
  31  class portfolio extends base {
  32  
  33      public static function plugintype_supports_disabling(): bool {
  34          return true;
  35      }
  36  
  37      /**
  38       * Finds all enabled plugins, the result may include missing plugins.
  39       * @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown
  40       */
  41      public static function get_enabled_plugins() {
  42          global $DB;
  43  
  44          $enabled = array();
  45          $rs = $DB->get_recordset('portfolio_instance', array('visible'=>1), 'plugin ASC', 'plugin');
  46          foreach ($rs as $repository) {
  47              $enabled[$repository->plugin] = $repository->plugin;
  48          }
  49          $rs->close();
  50  
  51          return $enabled;
  52      }
  53  
  54      public static function enable_plugin(string $pluginname, int $enabled): bool {
  55          global $DB, $CFG;
  56  
  57          require_once($CFG->libdir . '/portfoliolib.php');
  58  
  59          $haschanged = false;
  60          $oldvalue = null;
  61          $data = ['visible' => $enabled];
  62          if ($plugin = $DB->get_record('portfolio_instance', ['plugin' => $pluginname])) {
  63              $instance = portfolio_instance($plugin->id);
  64              $oldvalue = $instance->get('visible');
  65              if (empty($oldvalue) && $instance->instance_sanity_check()) {
  66                  throw new \moodle_exception('cannotsetvisible', 'portfolio');
  67              }
  68  
  69              // Only set visibility if it's different from the current value.
  70              if ($oldvalue != $enabled) {
  71                  $haschanged = true;
  72                  $instance->set('visible', $enabled);
  73                  $instance->save();
  74              }
  75          } else {
  76              $haschanged = true;
  77              portfolio_static_function($pluginname, 'create_instance', $pluginname, $pluginname, $data);
  78          }
  79  
  80          if ($haschanged) {
  81              // Include this information into config changes table.
  82              add_to_config_log('portfolio_visibility', $oldvalue, $enabled, $pluginname);
  83              \core_plugin_manager::reset_caches();
  84          }
  85  
  86          return $haschanged;
  87      }
  88  
  89      /**
  90       * Return URL used for management of plugins of this type.
  91       * @return moodle_url
  92       */
  93      public static function get_manage_url() {
  94          return new moodle_url('/admin/portfolio.php');
  95      }
  96  
  97      /**
  98       * Defines if there should be a way to uninstall the plugin via the administration UI.
  99       * @return boolean
 100       */
 101      public function is_uninstall_allowed() {
 102          return true;
 103      }
 104  
 105      /**
 106       * Pre-uninstall hook.
 107       * This is intended for disabling of plugin, some DB table purging, etc.
 108       */
 109      public function uninstall_cleanup() {
 110          global $DB;
 111  
 112          // Get all instances of this portfolio.
 113          $count = $DB->count_records('portfolio_instance', array('plugin' => $this->name));
 114          if ($count > 0) {
 115              // This portfolio is in use, get the it's ID.
 116              $rec = $DB->get_record('portfolio_instance', array('plugin' => $this->name));
 117  
 118              // Remove all records from portfolio_instance_config.
 119              $DB->delete_records('portfolio_instance_config', array('instance' => $rec->id));
 120              // Remove all records from portfolio_instance_user.
 121              $DB->delete_records('portfolio_instance_user', array('instance' => $rec->id));
 122              // Remove all records from portfolio_log.
 123              $DB->delete_records('portfolio_log', array('portfolio' => $rec->id));
 124              // Remove all records from portfolio_tempdata.
 125              $DB->delete_records('portfolio_tempdata', array('instance' => $rec->id));
 126  
 127              // Remove the record from the portfolio_instance table.
 128              $DB->delete_records('portfolio_instance', array('id' => $rec->id));
 129          }
 130  
 131          parent::uninstall_cleanup();
 132      }
 133  }