Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Render/Element/FormElementInterface.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Render\Element\FormElementInterface.
6	*/
7
8	namespace Drupal\Core\Render\Element;
9
10	use Drupal\Core\Form\FormStateInterface;
11
12	/**
13	* Provides an interface for form element plugins.
14	*
15	* Form element plugins are a subset of render elements, specifically
16	* representing HTML elements that take input as part of a form. Form element
17	* plugins are discovered via the same mechanism as regular render element
18	* plugins. See \Drupal\Core\Render\Element\ElementInterface for general
19	* information about render element plugins.
20	*
21	* @see \Drupal\Core\Render\ElementInfoManager
22	* @see \Drupal\Core\Render\Element\FormElement
23	* @see \Drupal\Core\Render\Annotation\FormElement
24	* @see plugin_api
25	*
26	* @ingroup theme_render
27	*/
28	interface FormElementInterface extends ElementInterface {
29
30	/**
31	* Determines how user input is mapped to an element's #value property.
32	*
33	* @param array $element
34	* An associative array containing the properties of the element.
35	* @param mixed $input
36	* The incoming input to populate the form element. If this is FALSE,
37	* the element's default value should be returned.
38	* @param \Drupal\Core\Form\FormStateInterface $form_state
39	* The current state of the form.
40	*
41	* @return mixed
42	* The value to assign to the element.
43	*/
44	public static function valueCallback(&$element, $input, FormStateInterface $form_state);
45
46	}