interface InstallablePluginInterface in Markdown 8.2

Interface for installable plugins.

@method \Drupal\markdown\Annotation\InstallablePlugin getPluginDefinition()

@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

Expanded class hierarchy of InstallablePluginInterface

All classes that implement InstallablePluginInterface

1 file declares its use of InstallablePluginInterface

InstallablePluginManager.php in src/PluginManager/InstallablePluginManager.php

File

src/Plugin/Markdown/InstallablePluginInterface.php, line 15

Namespace

Drupal\markdown\Plugin\Markdown

View source

interface InstallablePluginInterface extends AnnotatedPluginInterface, DependentPluginInterface {

  /**
   * Builds a display for a library.
   *
   * @param \Drupal\markdown\Annotation\InstallableLibrary $library
   *   The library to build.
   *
   * @return \Drupal\Component\Render\MarkupInterface
   */
  public function buildLibrary(InstallableLibrary $library = NULL);

  /**
   * Builds a display status based on the current state of the plugin.
   *
   * @param bool $all
   *   Flag indicating whether to build status for all potential libraries.
   *
   * @return \Drupal\Component\Render\MarkupInterface
   */
  public function buildStatus($all = FALSE);

  /**
   * 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 deprecation message, if any.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup|void
   *   The deprecated message, if set.
   */
  public function getDeprecated();

  /**
   * Retrieves the experimental message.
   *
   * @return bool|\Drupal\Core\StringTranslation\TranslatableMarkup
   *   TRUE if plugin is experimental or a TranslatableMarkup object if plugin
   *   is experimental, but has an additional message; FALSE otherwise.
   */
  public function getExperimental();

  /**
   * Retrieves the composer package name of the installable library, if any.
   *
   * @return string|void
   *   The installed identifier, if any.
   */
  public function getInstalledId();

  /**
   * Retrieves the installed library used by the plugin.
   *
   * @return \Drupal\markdown\Annotation\InstallableLibrary|void
   *   The installed library, if any.
   */
  public function getInstalledLibrary();

  /**
   * Displays the human-readable label of the plugin.
   *
   * @param bool $version
   *   Flag indicating whether to show the version with the label.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The label.
   */
  public function getLabel($version = TRUE);

  /**
   * Retrieves the plugin as a link using its label and URL.
   *
   * @param string|\Drupal\Component\Render\MarkupInterface $label
   *   Optional. A specific label to use for the link. If not specified, it
   *   will default to the label or plugin identifier if present.
   * @param array $options
   *   An array of options to pass to the Url object constructor.
   * @param bool $fallback
   *   Flag indicating whether to fallback to the original label or plugin
   *   identifier if no link could be generated.
   *
   * @return \Drupal\Core\GeneratedLink|mixed|void
   *   The link if one was generated or the label if $fallback was provided.
   */
  public function getLink($label = NULL, array $options = [], $fallback = TRUE);

  /**
   * Instantiates a new instance of the object defined by the installed library.
   *
   * @param mixed $args
   *   An array of arguments.
   * @param mixed $_
   *   Additional arguments.
   *
   * @return mixed
   *   A newly instantiated class.
   *
   * @TODO: Refactor to use variadic parameters.
   */
  public function getObject($args = NULL, $_ = NULL);

  /**
   * Retrieves the class name of the object defined by the installed library.
   *
   * @return string
   *   The object class name.
   */
  public function getObjectClass();

  /**
   * Retrieves the preferred library of the plugin.
   *
   * @return \Drupal\markdown\Annotation\InstallableLibrary|void
   *   The preferred library, if any.
   */
  public function getPreferredLibrary();

  /**
   * Retrieves the configuration for the plugin, but sorted.
   *
   * @return array
   *   The sorted configuration array.
   */
  public function getSortedConfiguration();

  /**
   * Retrieves the URL of the plugin, if set.
   *
   * @param array $options
   *   Optional. An array of \Drupal\Core\Url options.
   *
   * @return \Drupal\Core\Url|void
   *   A Url object of the plugin's URL or NULL if no URL was provided.
   *
   * @see \Drupal\Core\Url::fromUri
   * @see \Drupal\Core\Url::fromUserInput
   */
  public function getUrl(array $options = []);

  /**
   * The current version of the plugin.
   *
   * @return string|null
   *   The plugin version.
   */
  public function getVersion();

  /**
   * Indicates whether plugin has multiple installs to check.
   *
   * @return bool
   *   TRUE or FALSE
   */
  public function hasMultipleLibraries();

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

  /**
   * Indicates whether the plugin is using the preferred library.
   *
   * @return bool
   *   TRUE or FALSE
   */
  public function isPreferred();

  /**
   * Indicates whether the preferred library is installed.
   *
   * @return bool
   *   TRUE or FALSE
   */
  public function isPreferredLibraryInstalled();

  /**
   * Indicates whether the plugin should be shown in the UI.
   *
   * @return bool
   *   TRUE or FALSE
   */
  public function showInUi();

}

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
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

You are here

interface InstallablePluginInterface in Markdown 8.2

Hierarchy

File

Namespace

Members

API Navigation