Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
100.00% |
1 / 1 |
|
100.00% |
3 / 3 |
CRAP | |
100.00% |
8 / 8 |
DiscoveryTrait | |
100.00% |
1 / 1 |
|
100.00% |
4 / 4 |
6 | |
100.00% |
8 / 8 |
getDefinitions | |
100.00% |
1 / 1 |
1 | |
100.00% |
0 / 0 |
|||
getDefinition | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
doGetDefinition | |
100.00% |
1 / 1 |
3 | |
100.00% |
5 / 5 |
|||
hasDefinition | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
<?php | |
/** | |
* @file | |
* Contains \Drupal\Component\Plugin\Discovery\DiscoveryTrait. | |
*/ | |
namespace Drupal\Component\Plugin\Discovery; | |
use Drupal\Component\Plugin\Exception\PluginNotFoundException; | |
/** | |
* @see Drupal\Component\Plugin\Discovery\DiscoveryInterface | |
*/ | |
trait DiscoveryTrait { | |
/** | |
* {@inheritdoc} | |
*/ | |
abstract public 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); | |
} | |
} |