trait DiscoveryTrait in Plug 7
Hierarchy
- trait \Drupal\Component\Plugin\Discovery\DiscoveryTrait
See also
Drupal\Component\Plugin\Discovery\DiscoveryInterface
5 files declare their use of DiscoveryTrait
- AnnotatedClassDiscovery.php in lib/
Drupal/ Component/ Annotation/ Plugin/ Discovery/ AnnotatedClassDiscovery.php - Contains \Drupal\Component\Annotation\Plugin\Discovery\AnnotatedClassDiscovery.
- 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.
- PluginManagerBase.php in lib/
Drupal/ Component/ Plugin/ PluginManagerBase.php - Contains \Drupal\Component\Plugin\PluginManagerBase.
- YamlDiscovery.php in lib/
Drupal/ Core/ Plugin/ Discovery/ YamlDiscovery.php - Contains \Drupal\Core\Plugin\Discovery\YamlDiscovery.
File
- lib/
Drupal/ Component/ Plugin/ Discovery/ DiscoveryTrait.php, line 15 - Contains \Drupal\Component\Plugin\Discovery\DiscoveryTrait.
Namespace
Drupal\Component\Plugin\DiscoveryView source
trait DiscoveryTrait {
/**
* {@inheritdoc}
*/
public abstract function getDefinitions();
/**
* {@inheritdoc}
*/
public function getDefinition($plugin_id, $exception_on_invalid = TRUE) {
$definitions = $this
->getDefinitions();
return $this
->doGetDefinition($definitions, $plugin_id, $exception_on_invalid);
}
/**
* Gets a specific plugin definition.
*
* @param array $definitions
* An array of the available plugin definitions.
* @param string $plugin_id
* A plugin id.
* @param bool $exception_on_invalid
* (optional) If TRUE, an invalid plugin ID will throw an exception.
* Defaults to FALSE.
*
* @return array|null
* A plugin definition, or NULL if the plugin ID is invalid and
* $exception_on_invalid is TRUE.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
* Thrown if $plugin_id is invalid and $exception_on_invalid is TRUE.
*/
protected function doGetDefinition(array $definitions, $plugin_id, $exception_on_invalid) {
// Avoid using a ternary that would create a copy of the array.
if (isset($definitions[$plugin_id])) {
return $definitions[$plugin_id];
}
elseif (!$exception_on_invalid) {
return NULL;
}
throw new PluginNotFoundException($plugin_id, sprintf('The "%s" plugin does not exist.', $plugin_id));
}
/**
* {@inheritdoc}
*/
public function hasDefinition($plugin_id) {
return (bool) $this
->getDefinition($plugin_id, FALSE);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DiscoveryTrait:: |
protected | function | Gets a specific plugin definition. | |
DiscoveryTrait:: |
public | function | 3 | |
DiscoveryTrait:: |
abstract public | function | 8 | |
DiscoveryTrait:: |
public | function |