interface TypedDiscoveryInterface in Plugin 8.2

An interface defining the minimum requirements of building a plugin discovery component.

Hierarchy

• interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface
  • interface \Drupal\plugin\PluginDiscovery\TypedDiscoveryInterface

3 files declare their use of TypedDiscoveryInterface

MockManager.php in tests/modules/plugin_test_helper/src/Plugin/PluginTestHelper/MockManager.php

PluginHierarchyTrait.php in src/PluginHierarchyTrait.php

PluginHierarchyTraitTest.php in tests/src/Unit/PluginHierarchyTraitTest.php

File

src/PluginDiscovery/TypedDiscoveryInterface.php, line 13

Namespace

Drupal\plugin\PluginDiscovery

interface TypedDiscoveryInterface extends DiscoveryInterface {

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\plugin\PluginDefinition\PluginDefinitionInterface|NULL
   *   A plugin definition, or NULL if the plugin ID is invalid and
   *   $exception_on_invalid is FALSE.
   */
  public function getDefinition($plugin_id, $exception_on_invalid = TRUE);

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\plugin\PluginDefinition\PluginDefinitionInterface[]
   *   An array of plugin definitions (empty array if no definitions were
   *   found). Keys are plugin IDs.
   */
  public function getDefinitions();

}

Members

Name	Modifiers	Type	Description	Overrides
DiscoveryInterface::hasDefinition	public	function	Indicates if a specific plugin definition exists.	2
TypedDiscoveryInterface::getDefinition	public	function	Overrides DiscoveryInterface::getDefinition
TypedDiscoveryInterface::getDefinitions	public	function	Overrides DiscoveryInterface::getDefinitions