Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Plugin/PluginFormInterface.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\Plugin\PluginFormInterface.
6	*/
7
8	namespace Drupal\Core\Plugin;
9
10	use Drupal\Core\Form\FormStateInterface;
11
12	/**
13	* Provides an interface for an embeddable plugin form.
14	*
15	* @ingroup plugin_api
16	*/
17	interface PluginFormInterface {
18
19	/**
20	* Form constructor.
21	*
22	* Plugin forms are embedded in other forms. In order to know where the plugin
23	* form is located in the parent form, #parents and #array_parents must be
24	* known, but these are not available during the initial build phase. In order
25	* to have these properties available when building the plugin form's
26	* elements, let this method return a form element that has a #process
27	* callback and build the rest of the form in the callback. By the time the
28	* callback is executed, the element's #parents and #array_parents properties
29	* will have been set by the form API. For more documentation on #parents and
30	* #array_parents, see \Drupal\Core\Render\Element\FormElement.
31	*
32	* @param array $form
33	* An associative array containing the initial structure of the plugin form.
34	* @param \Drupal\Core\Form\FormStateInterface $form_state
35	* The current state of the complete form.
36	*
37	* @return array
38	* The form structure.
39	*/
40	public function buildConfigurationForm(array $form, FormStateInterface $form_state);
41
42	/**
43	* Form validation handler.
44	*
45	* @param array $form
46	* An associative array containing the structure of the plugin form as built
47	* by static::buildConfigurationForm().
48	* @param \Drupal\Core\Form\FormStateInterface $form_state
49	* The current state of the complete form.
50	*/
51	public function validateConfigurationForm(array &$form, FormStateInterface $form_state);
52
53	/**
54	* Form submission handler.
55	*
56	* @param array $form
57	* An associative array containing the structure of the plugin form as built
58	* by static::buildConfigurationForm().
59	* @param \Drupal\Core\Form\FormStateInterface $form_state
60	* The current state of the complete form.
61	*/
62	public function submitConfigurationForm(array &$form, FormStateInterface $form_state);
63
64	}