3 namespace Drupal\Component\Plugin\Discovery;
5 use Drupal\Component\Plugin\Exception\PluginNotFoundException;
8 * @see Drupal\Component\Plugin\Discovery\DiscoveryInterface
10 trait DiscoveryTrait {
15 abstract public function getDefinitions();
20 public function getDefinition($plugin_id, $exception_on_invalid = TRUE) {
21 $definitions = $this->getDefinitions();
22 return $this->doGetDefinition($definitions, $plugin_id, $exception_on_invalid);
26 * Gets a specific plugin definition.
28 * @param array $definitions
29 * An array of the available plugin definitions.
30 * @param string $plugin_id
32 * @param bool $exception_on_invalid
33 * If TRUE, an invalid plugin ID will cause an exception to be thrown; if
34 * FALSE, NULL will be returned.
37 * A plugin definition, or NULL if the plugin ID is invalid and
38 * $exception_on_invalid is TRUE.
40 * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
41 * Thrown if $plugin_id is invalid and $exception_on_invalid is TRUE.
43 protected function doGetDefinition(array $definitions, $plugin_id, $exception_on_invalid) {
44 // Avoid using a ternary that would create a copy of the array.
45 if (isset($definitions[$plugin_id])) {
46 return $definitions[$plugin_id];
48 elseif (!$exception_on_invalid) {
52 throw new PluginNotFoundException($plugin_id, sprintf('The "%s" plugin does not exist.', $plugin_id));
58 public function hasDefinition($plugin_id) {
59 return (bool) $this->getDefinition($plugin_id, FALSE);