class EmailDefaultWidget

Plugin implementation of the 'email_default' widget.

Plugin annotation


@Plugin(
  id = "email_default",
  module = "email",
  label = @Translation("E-mail"),
  field_types = {
    "email"
  },
  settings = {
    "placeholder" = ""
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements PluginInspectionInterface
- class \Drupal\field\Plugin\PluginSettingsBase implements PluginSettingsInterface
  - class \Drupal\field\Plugin\Type\Widget\WidgetBase implements WidgetInterface
    class \Drupal\email\Plugin\field\widget\EmailDefaultWidget

Expanded class hierarchy of EmailDefaultWidget

File

drupal/core/modules/email/lib/Drupal/email/Plugin/field/widget/EmailDefaultWidget.php, line 29: Definition of Drupal\email\Plugin\field\widget\EmailDefaultWidget.

Namespace

Drupal\email\Plugin\field\widget

View source

class EmailDefaultWidget extends WidgetBase {

  /**
   * Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::settingsForm().
   */
  public function settingsForm(array $form, array &$form_state) {
    $element['placeholder'] = array(
      '#type' => 'textfield',
      '#title' => t('Placeholder'),
      '#default_value' => $this
        ->getSetting('placeholder'),
      '#description' => t('Text that will be shown inside the field until a value is entered. This hint is usually a sample value or a brief description of the expected format.'),
    );
    return $element;
  }

  /**
   * Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::formElement().
   */
  public function formElement(array $items, $delta, array $element, $langcode, array &$form, array &$form_state) {
    $element['value'] = $element + array(
      '#type' => 'email',
      '#default_value' => isset($items[$delta]['value']) ? $items[$delta]['value'] : NULL,
      '#placeholder' => $this
        ->getSetting('placeholder'),
    );
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EmailDefaultWidget::formElement	public	function	Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::formElement(). Overrides WidgetInterface::formElement
EmailDefaultWidget::settingsForm	public	function	Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::settingsForm(). Overrides WidgetBase::settingsForm
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::getPluginDefinition	public	function	Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::getDefaultSettings	public	function	Implements Drupal\field\Plugin\PluginSettingsInterface::getDefaultSettings(). Overrides PluginSettingsInterface::getDefaultSettings
PluginSettingsBase::getSetting	public	function	Implements Drupal\field\Plugin\PluginSettingsInterface::getSetting(). Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Implements Drupal\field\Plugin\PluginSettingsInterface::getSettings(). Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::setSetting	public	function	Implements Drupal\field\Plugin\PluginSettingsInterface::setSetting(). Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Implements Drupal\field\Plugin\PluginSettingsInterface::setSettings(). Overrides PluginSettingsInterface::setSettings
WidgetBase::$field	protected	property	The field definition.
WidgetBase::$instance	protected	property	The field instance definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::errorElement	public	function	Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::errorElement(). Overrides WidgetInterface::errorElement	5
WidgetBase::extractFormValues	public	function	Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::extractFormValues(). Overrides WidgetBaseInterface::extractFormValues
WidgetBase::flagErrors	public	function	Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::flagErrors(). Overrides WidgetBaseInterface::flagErrors
WidgetBase::form	public	function	Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::form(). Overrides WidgetBaseInterface::form
WidgetBase::formMultipleElements	protected	function	Special handling to create form elements for multiple values.	1
WidgetBase::formSingleElement	protected	function	Generates the form element for a single copy of the widget.
WidgetBase::massageFormValues	public	function	Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::massageFormValues() Overrides WidgetInterface::massageFormValues	2
WidgetBase::sortItems	protected	function	Sorts submitted field values according to drag-n-drop reordering.
WidgetBase::__construct	public	function	Constructs a WidgetBase object. Overrides PluginBase::__construct	3

Main menu

Search Drupal 8.x

API Navigation

class EmailDefaultWidget

Plugin annotation

Hierarchy

File

Namespace

Members

Main menu

You are here

Search Drupal 8.x

API Navigation

class EmailDefaultWidget

Plugin annotation

Hierarchy

File

Namespace

Members