Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Field/PluginSettingsInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Field\PluginSettingsInterface.
6	*/
7
8	namespace Drupal\Core\Field;
9
10	use Drupal\Component\Plugin\PluginInspectionInterface;
11	use Drupal\Core\Config\Entity\ThirdPartySettingsInterface;
12
13	/**
14	* Interface definition for plugin with settings.
15	*/
16	interface PluginSettingsInterface extends PluginInspectionInterface, ThirdPartySettingsInterface {
17
18	/**
19	* Defines the default settings for this plugin.
20	*
21	* @return array
22	* A list of default settings, keyed by the setting name.
23	*/
24	public static function defaultSettings();
25
26	/**
27	* Returns the array of settings, including defaults for missing settings.
28	*
29	* @return array
30	* The array of settings.
31	*/
32	public function getSettings();
33
34	/**
35	* Returns the value of a setting, or its default value if absent.
36	*
37	* @param string $key
38	* The setting name.
39	*
40	* @return mixed
41	* The setting value.
42	*/
43	public function getSetting($key);
44
45	/**
46	* Sets the settings for the plugin.
47	*
48	* @param array $settings
49	* The array of settings, keyed by setting names. Missing settings will be
50	* assigned their default values.
51	*
52	* @return $this
53	*/
54	public function setSettings(array $settings);
55
56	/**
57	* Sets the value of a setting for the plugin.
58	*
59	* @param string $key
60	* The setting name.
61	* @param mixed $value
62	* The setting value.
63	*
64	* @return $this
65	*/
66	public function setSetting($key, $value);
67
68	/**
69	* Informs the plugin that some configuration it depends on will be deleted.
70	*
71	* This method allows plugins to keep their configuration up-to-date when a
72	* dependency calculated with ::calculateDependencies() is removed. For
73	* example, an entity view display contains a formatter having a setting
74	* pointing to an arbitrary config entity. When that config entity is deleted,
75	* this method is called by the view display to react to the dependency
76	* removal by updating its configuration.
77	*
78	* This method must return TRUE if the removal event updated the plugin
79	* configuration or FALSE otherwise.
80	*
81	* @param array $dependencies
82	* An array of dependencies that will be deleted keyed by dependency type.
83	* Dependency types are 'config', 'content', 'module' and 'theme'.
84	*
85	* @return bool
86	* TRUE if the plugin configuration has changed, FALSE if not.
87	*
88	* @see \Drupal\Core\Entity\EntityDisplayBase
89	*/
90	public function onDependencyRemoval(array $dependencies);
91
92	}