class Email in Zircon Profile 8
Same name in this branch
- 8 vendor/symfony/validator/Constraints/Email.php \Symfony\Component\Validator\Constraints\Email
- 8 core/lib/Drupal/Core/Render/Element/Email.php \Drupal\Core\Render\Element\Email
- 8 core/lib/Drupal/Core/TypedData/Plugin/DataType/Email.php \Drupal\Core\TypedData\Plugin\DataType\Email
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/Render/Element/Email.php \Drupal\Core\Render\Element\Email
Provides a form input element for entering an email address.
Properties:
- #default_value: An RFC-compliant email address.
Example usage:
$form['email'] = array(
'#type' => 'email',
'#title' => t('Email'),
);
@end
<h3>Plugin annotation</h3>
@code
@FormElement("email")
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\Email
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
Expanded class hierarchy of Email
See also
\Drupal\Core\Render\Element\Render\Textfield
3 files declare their use of Email
- EmailItem.php in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ EmailItem.php - Contains \Drupal\Core\Field\Plugin\Field\FieldType\EmailItem.
- UserPasswordForm.php in core/
modules/ user/ src/ Form/ UserPasswordForm.php - Contains \Drupal\user\Form\UserPasswordForm.
- UserValidationTest.php in core/
modules/ user/ src/ Tests/ UserValidationTest.php - Contains \Drupal\user\Tests\UserValidationTest.
13 string references to 'Email'
- CommentForm::form in core/
modules/ comment/ src/ CommentForm.php - Gets the actual form array to be built.
- ConstraintManager::registerDefinitions in core/
lib/ Drupal/ Core/ Validation/ ConstraintManager.php - Callback for registering definitions for constraints shipped with Symfony.
- contact_entity_extra_field_info in core/
modules/ contact/ contact.module - Implements hook_entity_extra_field_info().
- core.data_types.schema.yml in core/
config/ schema/ core.data_types.schema.yml - core/config/schema/core.data_types.schema.yml
- MailCaptureTest::testMailSend in core/
modules/ simpletest/ src/ Tests/ MailCaptureTest.php - Test to see if the wrapper function is executed correctly.
10 #type uses of Email
- AccountForm::form in core/
modules/ user/ src/ AccountForm.php - Gets the actual form array to be built.
- AccountSettingsForm::buildForm in core/
modules/ user/ src/ AccountSettingsForm.php - Form constructor.
- CommentForm::form in core/
modules/ comment/ src/ CommentForm.php - Gets the actual form array to be built.
- EmailDefaultWidget::formElement in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldWidget/ EmailDefaultWidget.php - Returns the form for a single field widget.
- FormTestDisabledElementsForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestDisabledElementsForm.php - Form constructor.
File
- core/
lib/ Drupal/ Core/ Render/ Element/ Email.php, line 31 - Contains \Drupal\Core\Render\Element\Email.
Namespace
Drupal\Core\Render\ElementView source
class Email extends FormElement {
/**
* Defines the max length for an email address
*
* The maximum length of an email address is 254 characters. RFC 3696
* specifies a total length of 320 characters, but mentions that
* addresses longer than 256 characters are not normally useful. Erratum
* 1690 was then released which corrected this value to 254 characters.
* @see http://tools.ietf.org/html/rfc3696#section-3
* @see http://www.rfc-editor.org/errata_search.php?rfc=3696&eid=1690
*/
const EMAIL_MAX_LENGTH = 254;
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return array(
'#input' => TRUE,
'#size' => 60,
'#maxlength' => self::EMAIL_MAX_LENGTH,
'#autocomplete_route_name' => FALSE,
'#process' => array(
array(
$class,
'processAutocomplete',
),
array(
$class,
'processAjaxForm',
),
array(
$class,
'processPattern',
),
),
'#element_validate' => array(
array(
$class,
'validateEmail',
),
),
'#pre_render' => array(
array(
$class,
'preRenderEmail',
),
),
'#theme' => 'input__email',
'#theme_wrappers' => array(
'form_element',
),
);
}
/**
* Form element validation handler for #type 'email'.
*
* Note that #maxlength and #required is validated by _form_validate() already.
*/
public static function validateEmail(&$element, FormStateInterface $form_state, &$complete_form) {
$value = trim($element['#value']);
$form_state
->setValueForElement($element, $value);
if ($value !== '' && !\Drupal::service('email.validator')
->isValid($value)) {
$form_state
->setError($element, t('The email address %mail is not valid.', array(
'%mail' => $value,
)));
}
}
/**
* Prepares a #type 'email' render element for input.html.twig.
*
* @param array $element
* An associative array containing the properties of the element.
* Properties used: #title, #value, #description, #size, #maxlength,
* #placeholder, #required, #attributes.
*
* @return array
* The $element with prepared variables ready for input.html.twig.
*/
public static function preRenderEmail($element) {
$element['#attributes']['type'] = 'email';
Element::setAttributes($element, array(
'id',
'name',
'value',
'size',
'maxlength',
'placeholder',
));
static::setAttributes($element, array(
'form-email',
));
return $element;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
Email:: |
constant | Defines the max length for an email address | ||
Email:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
Email:: |
public static | function | Prepares a #type 'email' render element for input.html.twig. | |
Email:: |
public static | function | Form element validation handler for #type 'email'. | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
FormElement:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElementInterface:: |
15 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 2 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Constructs a Drupal\Component\Plugin\PluginBase object. | 69 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |