interface DiscoveryInterface
Defines the minimum requirements for a plugin discovery component.
Hierarchy
- interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface
Expanded class hierarchy of DiscoveryInterface
All classes that implement DiscoveryInterface
Related topics
25 files declare their use of DiscoveryInterface
- AnnotatedClassDiscovery.php in core/lib/ Drupal/ Component/ Annotation/ Plugin/ Discovery/ AnnotatedClassDiscovery.php 
- AnnotationBridgeDecorator.php in core/lib/ Drupal/ Component/ Annotation/ Plugin/ Discovery/ AnnotationBridgeDecorator.php 
- AnnotationBridgeDecoratorTest.php in core/tests/ Drupal/ Tests/ Component/ Annotation/ Plugin/ Discovery/ AnnotationBridgeDecoratorTest.php 
- AttributeBridgeDecoratorTest.php in core/tests/ Drupal/ Tests/ Component/ Plugin/ Discovery/ AttributeBridgeDecoratorTest.php 
- BlockManagerTest.php in core/tests/ Drupal/ Tests/ Core/ Block/ BlockManagerTest.php 
File
- 
              core/lib/ Drupal/ Component/ Plugin/ Discovery/ DiscoveryInterface.php, line 10 
Namespace
Drupal\Component\Plugin\DiscoveryView source
interface DiscoveryInterface {
  
  /**
   * Gets a specific plugin definition.
   *
   * @param string $plugin_id
   *   A plugin id.
   * @param bool $exception_on_invalid
   *   (optional) If TRUE, an invalid plugin ID will throw an exception.
   *
   * @return mixed
   *   A plugin definition, or NULL if the plugin ID is invalid and
   *   $exception_on_invalid is FALSE.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   *   Thrown if $plugin_id is invalid and $exception_on_invalid is TRUE.
   */
  public function getDefinition($plugin_id, $exception_on_invalid = TRUE);
  
  /**
   * Gets the definition of all plugins for this type.
   *
   * @return mixed[]
   *   An array of plugin definitions (empty array if no definitions were
   *   found). Keys are plugin IDs.
   *
   * @see \Drupal\Core\Plugin\FilteredPluginManagerInterface::getFilteredDefinitions()
   */
  public function getDefinitions();
  
  /**
   * Indicates if a specific plugin definition exists.
   *
   * @param string $plugin_id
   *   A plugin ID.
   *
   * @return bool
   *   TRUE if the definition exists, FALSE otherwise.
   */
  public function hasDefinition($plugin_id);
}Members
| Title Sort descending | Modifiers | Object type | Summary | Overrides | 
|---|---|---|---|---|
| DiscoveryInterface::getDefinition | public | function | Gets a specific plugin definition. | 4 | 
| DiscoveryInterface::getDefinitions | public | function | Gets the definition of all plugins for this type. | 3 | 
| DiscoveryInterface::hasDefinition | public | function | Indicates if a specific plugin definition exists. | 1 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
