Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Entity/EntityFieldManagerInterface.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\Entity\EntityFieldManagerInterface.
6	*/
7
8	namespace Drupal\Core\Entity;
9
10	/**
11	* Provides an interface for an entity field manager.
12	*/
13	interface EntityFieldManagerInterface {
14
15	/**
16	* Gets the base field definitions for a content entity type.
17	*
18	* Only fields that are not specific to a given bundle or set of bundles are
19	* returned. This excludes configurable fields, as they are always attached
20	* to a specific bundle.
21	*
22	* @param string $entity_type_id
23	* The entity type ID. Only entity types that implement
24	* \Drupal\Core\Entity\FieldableEntityInterface are supported.
25	*
26	* @return \Drupal\Core\Field\FieldDefinitionInterface[]
27	* The array of base field definitions for the entity type, keyed by field
28	* name.
29	*
30	* @throws \LogicException
31	* Thrown if one of the entity keys is flagged as translatable.
32	*/
33	public function getBaseFieldDefinitions($entity_type_id);
34
35	/**
36	* Gets the field definitions for a specific bundle.
37	*
38	* @param string $entity_type_id
39	* The entity type ID. Only entity types that implement
40	* \Drupal\Core\Entity\FieldableEntityInterface are supported.
41	* @param string $bundle
42	* The bundle.
43	*
44	* @return \Drupal\Core\Field\FieldDefinitionInterface[]
45	* The array of field definitions for the bundle, keyed by field name.
46	*/
47	public function getFieldDefinitions($entity_type_id, $bundle);
48
49	/**
50	* Gets the field storage definitions for a content entity type.
51	*
52	* This returns all field storage definitions for base fields and bundle
53	* fields of an entity type. Note that field storage definitions of a base
54	* field equal the full base field definition (i.e. they implement
55	* FieldDefinitionInterface), while the storage definitions for bundle fields
56	* may implement FieldStorageDefinitionInterface only.
57	*
58	* @param string $entity_type_id
59	* The entity type ID. Only content entities are supported.
60	*
61	* @return \Drupal\Core\Field\FieldStorageDefinitionInterface[]
62	* The array of field storage definitions for the entity type, keyed by
63	* field name.
64	*
65	* @see \Drupal\Core\Field\FieldStorageDefinitionInterface
66	*/
67	public function getFieldStorageDefinitions($entity_type_id);
68
69	/**
70	* Gets a lightweight map of fields across bundles.
71	*
72	* @return array
73	* An array keyed by entity type. Each value is an array which keys are
74	* field names and value is an array with two entries:
75	* - type: The field type.
76	* - bundles: The bundles in which the field appears.
77	*/
78	public function getFieldMap();
79
80	/**
81	* Sets a lightweight map of fields across bundles.
82	*
83	* @param array[] $field_map
84	* See the return value of self::getFieldMap().
85	*
86	* @return $this
87	*/
88	public function setFieldMap(array $field_map);
89
90	/**
91	* Gets a lightweight map of fields across bundles filtered by field type.
92	*
93	* @param string $field_type
94	* The field type to filter by.
95	*
96	* @return array
97	* An array keyed by entity type. Each value is an array which keys are
98	* field names and value is an array with two entries:
99	* - type: The field type.
100	* - bundles: The bundles in which the field appears.
101	*/
102	public function getFieldMapByFieldType($field_type);
103
104	/**
105	* Clears static and persistent field definition caches.
106	*/
107	public function clearCachedFieldDefinitions();
108
109	/**
110	* Disable the use of caches.
111	*
112	* @param bool $use_caches
113	* FALSE to not use any caches.
114	*
115	* @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
116	*
117	* @todo Remove in https://www.drupal.org/node/2549143.
118	*/
119	public function useCaches($use_caches = FALSE);
120
121	/**
122	* Gets the "extra fields" for a bundle.
123	*
124	* @param string $entity_type_id
125	* The entity type ID.
126	* @param string $bundle
127	* The bundle name.
128	*
129	* @return array
130	* A nested array of 'pseudo-field' elements. Each list is nested within the
131	* following keys: entity type, bundle name, context (either 'form' or
132	* 'display'). The keys are the name of the elements as appearing in the
133	* renderable array (either the entity form or the displayed entity). The
134	* value is an associative array:
135	* - label: The human readable name of the element. Make sure you sanitize
136	* this appropriately.
137	* - description: A short description of the element contents.
138	* - weight: The default weight of the element.
139	* - visible: (optional) The default visibility of the element. Defaults to
140	* TRUE.
141	* - edit: (optional) String containing markup (normally a link) used as the
142	* element's 'edit' operation in the administration interface. Only for
143	* 'form' context.
144	* - delete: (optional) String containing markup (normally a link) used as the
145	* element's 'delete' operation in the administration interface. Only for
146	* 'form' context.
147	*/
148	public function getExtraFields($entity_type_id, $bundle);
149
150	}