Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Entity/EntityFormInterface.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\EntityFormInterface.
6	*/
7
8	namespace Drupal\Core\Entity;
9
10	use Drupal\Core\Extension\ModuleHandlerInterface;
11	use Drupal\Core\Form\BaseFormIdInterface;
12	use Drupal\Core\Form\FormStateInterface;
13	use Drupal\Core\Routing\RouteMatchInterface;
14	use Drupal\Core\StringTranslation\TranslationInterface;
15
16	/**
17	* Defines an interface for entity form classes.
18	*/
19	interface EntityFormInterface extends BaseFormIdInterface {
20
21	/**
22	* Sets the operation for this form.
23	*
24	* @param string $operation
25	* The name of the current operation.
26	*
27	* @return $this
28	*/
29	public function setOperation($operation);
30
31	/**
32	* Gets the operation identifying the form.
33	*
34	* @return string
35	* The name of the operation.
36	*/
37	public function getOperation();
38
39	/**
40	* Gets the form entity.
41	*
42	* The form entity which has been used for populating form element defaults.
43	*
44	* @return \Drupal\Core\Entity\EntityInterface
45	* The current form entity.
46	*/
47	public function getEntity();
48
49	/**
50	* Sets the form entity.
51	*
52	* Sets the form entity which will be used for populating form element
53	* defaults. Usually, the form entity gets updated by
54	* \Drupal\Core\Entity\EntityFormInterface::submit(), however this may
55	* be used to completely exchange the form entity, e.g. when preparing the
56	* rebuild of a multi-step form.
57	*
58	* @param \Drupal\Core\Entity\EntityInterface $entity
59	* The entity the current form should operate upon.
60	*
61	* @return $this
62	*/
63	public function setEntity(EntityInterface $entity);
64
65	/**
66	* Determines which entity will be used by this form from a RouteMatch object.
67	*
68	* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
69	* The route match.
70	* @param string $entity_type_id
71	* The entity type identifier.
72	*
73	* @return \Drupal\Core\Entity\EntityInterface
74	* The entity object as determined from the passed-in route match.
75	*/
76	public function getEntityFromRouteMatch(RouteMatchInterface $route_match, $entity_type_id);
77
78	/**
79	* Builds an updated entity object based upon the submitted form values.
80	*
81	* For building the updated entity object the form's entity is cloned and
82	* the submitted form values are copied to entity properties. The form's
83	* entity remains unchanged.
84	*
85	* @see \Drupal\Core\Entity\EntityFormInterface::getEntity()
86	*
87	* @param array $form
88	* A nested array form elements comprising the form.
89	* @param \Drupal\Core\Form\FormStateInterface $form_state
90	* The current state of the form.
91	*
92	* @return \Drupal\Core\Entity\EntityInterface
93	* An updated copy of the form's entity object.
94	*/
95	public function buildEntity(array $form, FormStateInterface $form_state);
96
97	/**
98	* Form submission handler for the 'save' action.
99	*
100	* Normally this method should be overridden to provide specific messages to
101	* the user and redirect the form after the entity has been saved.
102	*
103	* @param array $form
104	* An associative array containing the structure of the form.
105	* @param \Drupal\Core\Form\FormStateInterface $form_state
106	* The current state of the form.
107	*
108	* @return int
109	* Either SAVED_NEW or SAVED_UPDATED, depending on the operation performed.
110	*/
111	public function save(array $form, FormStateInterface $form_state);
112
113	/**
114	* Sets the string translation service for this form.
115	*
116	* @param \Drupal\Core\StringTranslation\TranslationInterface $string_translation
117	* The translation manager.
118	*
119	* @return $this
120	*/
121	public function setStringTranslation(TranslationInterface $string_translation);
122
123	/**
124	* Sets the module handler for this form.
125	*
126	* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
127	* The module handler.
128	*
129	* @return $this
130	*/
131	public function setModuleHandler(ModuleHandlerInterface $module_handler);
132
133	/**
134	* Sets the entity manager for this form.
135	*
136	* @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
137	* The entity manager.
138	*
139	* @return $this
140	*
141	* @deprecated in Drupal 8.0.0, will be removed before Drupal 9.0.0.
142	*
143	* @todo Remove this set call in https://www.drupal.org/node/2603542.
144	*/
145	public function setEntityManager(EntityManagerInterface $entity_manager);
146
147	/**
148	* Sets the entity type manager for this form.
149	*
150	* @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
151	* The entity type manager.
152	*
153	* @return $this
154	*/
155	public function setEntityTypeManager(EntityTypeManagerInterface $entity_type_manager);
156
157	}