WebSVN – Moodle – Diff – /lib/classes/plugininfo/base.php

 use core_plugin_manager;
 use moodle_url;
 /**
- * Base class providing access to the information about a plugin
- *
- * @property-read string component the component name, type_name
+ * Base class providing access to the information about a plugin
  */
 abstract class base {
     public $incompatible;
     /** @var string Name of the plugin */
+    public $component = '';
+    /** @var bool whether the plugin is that of a phase 1 deprecated type or subplugin type. */
+    public $deprecatedtype = false;
+    /** @var bool whether the plugin is that of a phase 2 deprecated (deleted) type or subplugin type. */
-    public $component = '';
+    public $deletedtype = false;
     /**
      * Whether this plugintype supports its plugins being disabled.
+     *
      * @param string $typeclass the name of the actually called class
      * @param core_plugin_manager $pluginman the plugin manager calling this method
      * @return array of plugintype classes, indexed by the plugin name
      */
     public static function get_plugins($type, $typerootdir, $typeclass, $pluginman) {
-        // Get the information about plugins at the disk.
+        // Get the information about plugins at the disk, including deprecated plugins.
-        $plugins = core_component::get_plugin_list($type);
+        $plugins = core_component::get_all_plugins_list($type);
+        // Also included deleted plugins.
         $return = array();
         foreach ($plugins as $pluginname => $pluginrootdir) {
             $return[$pluginname] = self::make_plugin_instance($type, $typerootdir,
                 $pluginname, $pluginrootdir, $typeclass, $pluginman);
+        }
-        // Fetch missing incorrectly uninstalled plugins.
+        // Fetch missing incorrectly uninstalled plugins, including deprecated plugins which are not included above.
         $plugins = $pluginman->get_installed_plugins($type);
         foreach ($plugins as $name => $version) {
             $plugin->rootdir     = null;
             $plugin->displayname = $name;
             $plugin->versiondb   = $version;
             $plugin->pluginman   = $pluginman;
             $plugin->init_is_standard();
+            $plugin->init_is_deprecated();
             $return[$name] = $plugin;
+        }
         $plugin->init_display_name();
         $plugin->load_disk_version();
         $plugin->load_db_version();
+        $plugin->init_is_standard();
-        $plugin->init_is_standard();
+        $plugin->init_is_deprecated();
         return $plugin;
      * If the value is null after calling this method, either the plugin
      * does not use versioning (typically does not have any database
      * data) or is missing from disk.
      */
     public function load_disk_version() {
+        // Note: this includes deprecated plugins.
         $versions = $this->pluginman->get_present_plugins($this->type);
         $this->versiondisk = null;
         $this->versionrequires = null;
      * If I am a subplugin, return the name of my parent plugin.
+     *
      * @return string|bool false if not a subplugin, name of the parent otherwise
      */
     public function get_parent_plugin() {
-        return $this->pluginman->get_parent_of_subplugin($this->type);
+        return $this->pluginman->get_parent_of_subplugin($this->type, true);
+    }
     /**
      * Sets {@link $versiondb} property to a numerical value representing the
+            }
+        }
+    }
+    /**
+     * Init some instance props denoting the deprecation state of the plugin.
+     *
+     * Sets {@see $deprecatedtype} property, indicating whether the plugintype is phase 1 deprecated.
+     * Sets {@see $deletedtype} property, indicating whether the plugintype is phase 2 deprecated.
+     * Sets {@see $displayname} property to the plugin name phase 2 deprecated plugins since lang string support has then ended.
+     *
+     * @return void
+     */
+    final public function init_is_deprecated(): void {
+        $this->deprecatedtype = \core_component::is_deprecated_plugin_type($this->type);
+        $this->deletedtype = \core_component::is_deleted_plugin_type($this->type);
+        $this->displayname = $this->deletedtype ? $this->name : $this->displayname;
+    }
     /**
      * Returns true if the plugin is shipped with the official distribution
      * of the current Moodle version, false otherwise.
+     *
      * @return bool
         return isset($enabled[$this->name]);
+    }
+    /**
+     * Return whether this plugin is deprecated (i.e. the plugin type to which it belongs is deprecated).
+     *
+     * @return bool
+     */
+    public function is_deprecated(): bool {
+        return $this->deprecatedtype;
+    }
+    /**
+     * Return whether this plugin is deleted (i.e. the plugin type to which it belongs is deleted).
+     *
+     * @return bool
+     */
+    public function is_deleted(): bool {
+        return $this->deletedtype;
+    }
     /**
      * If there are updates for this plugin available, returns them.
+     *
      * Returns array of {@link \core\update\info} objects, if some update

Proyectos de Subversion Moodle

(root)/lib/classes/plugininfo/base.php – Rev 1 → 1441