interface DiscoveryInterface in Plug 7
An interface defining the minimum requirements of building a plugin discovery component.
Hierarchy
- interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface
Expanded class hierarchy of DiscoveryInterface
All classes that implement DiscoveryInterface
7 files declare their use of DiscoveryInterface
- AnnotatedClassDiscovery.php in lib/
Drupal/ Component/ Annotation/ Plugin/ Discovery/ AnnotatedClassDiscovery.php - Contains \Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery.
- DefaultFactory.php in lib/
Drupal/ Component/ Plugin/ Factory/ DefaultFactory.php - Contains \Drupal\Component\Plugin\Factory\DefaultFactory.
- HookDiscovery.php in lib/
Drupal/ Core/ Plugin/ Discovery/ HookDiscovery.php - Contains \Drupal\Core\Plugin\Discovery\HookDiscovery.
- InfoHookDecorator.php in lib/
Drupal/ Core/ Plugin/ Discovery/ InfoHookDecorator.php - Contains \Drupal\Core\Plugin\Discovery\InfoHookDecorator.
- PluginManagerInterface.php in lib/
Drupal/ Component/ Plugin/ PluginManagerInterface.php - Contains \Drupal\Component\Plugin\PluginManagerInterface.
File
- lib/
Drupal/ Component/ Plugin/ Discovery/ DiscoveryInterface.php, line 16 - Contains \Drupal\Component\Plugin\Discovery\DiscoveryInterface.
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.
*/
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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DiscoveryInterface:: |
public | function | Gets a specific plugin definition. | |
DiscoveryInterface:: |
public | function | Gets the definition of all plugins for this type. | |
DiscoveryInterface:: |
public | function | Indicates if a specific plugin definition exists. |