interface EnabledPluginInterface in Markdown 8.2

Interface for plugins with an "enabled" state.

@todo Move upstream to https://www.drupal.org/project/installable_plugins.

Hierarchy

• interface \Drupal\markdown\Plugin\Markdown\AnnotatedPluginInterface extends \Symfony\Component\DependencyInjection\ContainerAwareInterface; interface \Drupal\Component\Plugin\DependentPluginInterface
  • interface \Drupal\markdown\Plugin\Markdown\InstallablePluginInterface
    • interface \Drupal\markdown\Plugin\Markdown\EnabledPluginInterface

1 file declares its use of EnabledPluginInterface

EnableAwarePluginManagerTrait.php in src/Traits/EnableAwarePluginManagerTrait.php

File

src/Plugin/Markdown/EnabledPluginInterface.php, line 10

Namespace

Drupal\markdown\Plugin\Markdown

interface EnabledPluginInterface extends InstallablePluginInterface {

  /**
   * Indicates the default "enabled" state.
   *
   * The plugin will default to this value when not overridden by passed
   * configuration.
   *
   * @return bool
   *   TRUE or FALSE
   */
  public function enabledByDefault();

  /**
   * Indicates whether the plugin is enabled.
   *
   * @return bool
   *   TRUE or FALSE
   */
  public function isEnabled();

}

Members

Name	Modifiers	Type	Description	Overrides
AnnotatedPluginInterface::getConfigurationOverrides	public	function	Retrieves the configuration overrides for the plugin.	1
AnnotatedPluginInterface::getDescription	public	function	Retrieves the description of the plugin, if set.	1
AnnotatedPluginInterface::getOriginalPluginId	public	function	Retrieves the original plugin identifier.	1
AnnotatedPluginInterface::getProvider	public	function	Returns the provider (extension name) of the plugin.	1
AnnotatedPluginInterface::getWeight	public	function	Returns the weight of the plugin (used for sorting).	1
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	1
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration	1
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration	1
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
EnabledPluginInterface::enabledByDefault	public	function	Indicates the default "enabled" state.
EnabledPluginInterface::isEnabled	public	function	Indicates whether the plugin is enabled.
InstallablePluginInterface::buildLibrary	public	function	Builds a display for a library.	1
InstallablePluginInterface::buildStatus	public	function	Builds a display status based on the current state of the plugin.	1
InstallablePluginInterface::config	public	function	Retrieves the config instance for this plugin.	1
InstallablePluginInterface::getDeprecated	public	function	Retrieves the deprecation message, if any.	1
InstallablePluginInterface::getExperimental	public	function	Retrieves the experimental message.	1
InstallablePluginInterface::getInstalledId	public	function	Retrieves the composer package name of the installable library, if any.	1
InstallablePluginInterface::getInstalledLibrary	public	function	Retrieves the installed library used by the plugin.	1
InstallablePluginInterface::getLabel	public	function	Displays the human-readable label of the plugin. Overrides AnnotatedPluginInterface::getLabel
InstallablePluginInterface::getLink	public	function	Retrieves the plugin as a link using its label and URL.	1
InstallablePluginInterface::getObject	public	function	Instantiates a new instance of the object defined by the installed library.	1
InstallablePluginInterface::getObjectClass	public	function	Retrieves the class name of the object defined by the installed library.	1
InstallablePluginInterface::getPreferredLibrary	public	function	Retrieves the preferred library of the plugin.	1
InstallablePluginInterface::getSortedConfiguration	public	function	Retrieves the configuration for the plugin, but sorted.	1
InstallablePluginInterface::getUrl	public	function	Retrieves the URL of the plugin, if set.	1
InstallablePluginInterface::getVersion	public	function	The current version of the plugin.	1
InstallablePluginInterface::hasMultipleLibraries	public	function	Indicates whether plugin has multiple installs to check.	1
InstallablePluginInterface::isInstalled	public	function	Indicates whether the plugin is installed.	1
InstallablePluginInterface::isPreferred	public	function	Indicates whether the plugin is using the preferred library.	1
InstallablePluginInterface::isPreferredLibraryInstalled	public	function	Indicates whether the preferred library is installed.	1
InstallablePluginInterface::showInUi	public	function	Indicates whether the plugin should be shown in the UI.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2