lib/classes/plugininfo/portfolio.php

   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     /**
  52      * Return URL used for management of plugins of this type.
  53      * @return moodle_url
  54      */
  55     public static function get_manage_url() {
  56         return new moodle_url('/admin/portfolio.php');
  57     }
  58
  59     /**
  60      * Defines if there should be a way to uninstall the plugin via the administration UI.
  61      * @return boolean
  62      */
  63     public function is_uninstall_allowed() {
  64         return true;
  65     }
  66
  67     /**
  68      * Pre-uninstall hook.
  69      * This is intended for disabling of plugin, some DB table purging, etc.
  70      */
  71     public function uninstall_cleanup() {
  72         global $DB;
  73
  74         // Get all instances of this portfolio.
  75         $count = $DB->count_records('portfolio_instance', array('plugin' => $this->name));
  76         if ($count > 0) {
  77             // This portfolio is in use, get the it's ID.
  78             $rec = $DB->get_record('portfolio_instance', array('plugin' => $this->name));
  79
  80             // Remove all records from portfolio_instance_config.
  81             $DB->delete_records('portfolio_instance_config', array('instance' => $rec->id));
  82             // Remove all records from portfolio_instance_user.
  83             $DB->delete_records('portfolio_instance_user', array('instance' => $rec->id));
  84             // Remove all records from portfolio_log.
  85             $DB->delete_records('portfolio_log', array('portfolio' => $rec->id));
  86             // Remove all records from portfolio_tempdata.
  87             $DB->delete_records('portfolio_tempdata', array('instance' => $rec->id));
  88
  89             // Remove the record from the portfolio_instance table.
  90             $DB->delete_records('portfolio_instance', array('id' => $rec->id));
  91         }
  92
  93         parent::uninstall_cleanup();
  94     }
  95 }