[Summary view]

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