interface PluginInterface in Markdown 8.2

Interface for markdown plugins.

Hierarchy

• interface \Drupal\markdown\BcSupport\ConfigurableInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\markdown\Plugin\Markdown\PluginInterface extends \Symfony\Component\DependencyInjection\ContainerAwareInterface

Deprecated

in markdown:8.x-2.0 and is removed from markdown:3.0.0. Use \Drupal\markdown\Plugin\Markdown\InstallablePluginInterface instead.

See also

https://www.drupal.org/project/markdown/issues/3142418

File

src/Plugin/Markdown/PluginInterface.php, line 18

Namespace

Drupal\markdown\Plugin\Markdown

interface PluginInterface extends ConfigurableInterface, ContainerAwareInterface, ContainerFactoryPluginInterface, DependentPluginInterface, PluginInspectionInterface {

  /**
   * Retrieves the config instance for this plugin.
   *
   * @return \Drupal\Core\Config\ImmutableConfig
   *   An immutable config instance for this plugin's configuration.
   */
  public function config();

  /**
   * Retrieves the description of the plugin, if set.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The description.
   */
  public function getDescription();

  /**
   * Displays the human-readable label of the plugin.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The label.
   */
  public function getLabel();

  /**
   * Returns the provider (extension name) of the plugin.
   *
   * @return string
   *   The provider of the plugin.
   */
  public function getProvider();

  /**
   * Retrieves the URL of the plugin, if set.
   *
   * @return \Drupal\Core\Url|null
   *   A Url object or NULL if not set.
   */
  public function getUrl();

  /**
   * Returns the weight of the plugin (used for sorting).
   *
   * @return int
   *   The plugin weight.
   */
  public function getWeight();

}

Members

Name	Modifiers	Type	Description	Overrides
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
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
PluginInterface::config	public	function	Retrieves the config instance for this plugin.
PluginInterface::getDescription	public	function	Retrieves the description of the plugin, if set.
PluginInterface::getLabel	public	function	Displays the human-readable label of the plugin.
PluginInterface::getProvider	public	function	Returns the provider (extension name) of the plugin.
PluginInterface::getUrl	public	function	Retrieves the URL of the plugin, if set.
PluginInterface::getWeight	public	function	Returns the weight of the plugin (used for sorting).