Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Component/Plugin/Discovery/DiscoveryInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Component\Plugin\Discovery\DiscoveryInterface.
6	*/
7
8	namespace Drupal\Component\Plugin\Discovery;
9
10	/**
11	* An interface defining the minimum requirements of building a plugin
12	* discovery component.
13	*
14	* @ingroup plugin_api
15	*/
16	interface DiscoveryInterface {
17
18	/**
19	* Gets a specific plugin definition.
20	*
21	* @param string $plugin_id
22	* A plugin id.
23	* @param bool $exception_on_invalid
24	* (optional) If TRUE, an invalid plugin ID will throw an exception.
25	*
26	* @return mixed
27	* A plugin definition, or NULL if the plugin ID is invalid and
28	* $exception_on_invalid is FALSE.
29	*
30	* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
31	* Thrown if $plugin_id is invalid and $exception_on_invalid is TRUE.
32	*/
33	public function getDefinition($plugin_id, $exception_on_invalid = TRUE);
34
35	/**
36	* Gets the definition of all plugins for this type.
37	*
38	* @return mixed[]
39	* An array of plugin definitions (empty array if no definitions were
40	* found). Keys are plugin IDs.
41	*/
42	public function getDefinitions();
43
44	/**
45	* Indicates if a specific plugin definition exists.
46	*
47	* @param string $plugin_id
48	* A plugin ID.
49	*
50	* @return bool
51	* TRUE if the definition exists, FALSE otherwise.
52	*/
53	public function hasDefinition($plugin_id);
54
55	}