Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/modules/field/src/FieldStorageConfigInterface.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\field\FieldStorageConfigInterface.
6	*/
7
8	namespace Drupal\field;
9
10	use Drupal\Core\Config\Entity\ConfigEntityInterface;
11	use Drupal\Core\Field\FieldStorageDefinitionInterface;
12
13	/**
14	* Provides an interface defining a field storage entity.
15	*/
16	interface FieldStorageConfigInterface extends ConfigEntityInterface, FieldStorageDefinitionInterface {
17
18	/**
19	* Returns the field type.
20	*
21	* @return string
22	* The field type, i.e. the id of a field type plugin. For example 'text'.
23	*/
24	public function getType();
25
26	/**
27	* Returns the name of the module providing the field type.
28	*
29	* @return string
30	* The name of the module that provides the field type.
31	*/
32	public function getTypeProvider();
33
34	/**
35	* Returns the list of bundles where the field storage has fields.
36	*
37	* @return array
38	* An array of bundle names.
39	*/
40	public function getBundles();
41
42	/**
43	* Returns whether the field is deleted or not.
44	*
45	* @return bool
46	* TRUE if the field is deleted.
47	*/
48	public function isDeleted();
49
50	/**
51	* Checks if the field storage can be deleted.
52	*
53	* @return bool
54	* TRUE if the field storage can be deleted.
55	*/
56	public function isDeletable();
57
58	/**
59	* Returns whether the field storage is locked or not.
60	*
61	* @return bool
62	* TRUE if the field storage is locked.
63	*/
64	public function isLocked();
65
66	/**
67	* Sets the locked flag.
68	*
69	* @param bool $locked
70	* Sets value of locked flag.
71	*
72	* @return $this
73	*/
74	public function setLocked($locked);
75
76	/**
77	* Sets the maximum number of items allowed for the field.
78	*
79	* @param int $cardinality
80	* The cardinality value.
81	*
82	* @return $this
83	*/
84	public function setCardinality($cardinality);
85
86	/**
87	* Sets the value for a field setting by name.
88	*
89	* @param string $setting_name
90	* The name of the setting.
91	* @param mixed $value
92	* The value of the setting.
93	*
94	* @return $this
95	*/
96	public function setSetting($setting_name, $value);
97
98	/**
99	* Sets field storage settings.
100	*
101	* Note that the method does not unset existing settings not specified in the
102	* incoming $settings array.
103	*
104	* For example:
105	* @code
106	* // Given these are the default settings.
107	* $storage_definition->getSettings() === [
108	* 'fruit' => 'apple',
109	* 'season' => 'summer',
110	* ];
111	* // Change only the 'fruit' setting.
112	* $storage_definition->setSettings(['fruit' => 'banana']);
113	* // The 'season' setting persists unchanged.
114	* $storage_definition->getSettings() === [
115	* 'fruit' => 'banana',
116	* 'season' => 'summer',
117	* ];
118	* @endcode
119	*
120	* For clarity, it is preferred to use setSetting() if not all available
121	* settings are supplied.
122	*
123	* @param array $settings
124	* The array of storage settings.
125	*
126	* @return $this
127	*/
128	public function setSettings(array $settings);
129
130	/**
131	* Sets whether the field is translatable.
132	*
133	* @param bool $translatable
134	* Whether the field is translatable.
135	*
136	* @return $this
137	*/
138	public function setTranslatable($translatable);
139
140	/**
141	* Returns the custom storage indexes for the field data storage.
142	*
143	* @return array
144	* An array of custom indexes.
145	*/
146	public function getIndexes();
147
148	/**
149	* Sets the custom storage indexes for the field data storage..
150	*
151	* @param array $indexes
152	* The array of custom indexes.
153	*
154	* @return $this
155	*/
156	public function setIndexes(array $indexes);
157
158	}