class MobileNumberWidget in Mobile Number 8

Same name and namespace in other branches

2.0.x src/Plugin/Field/FieldWidget/MobileNumberWidget.php \Drupal\mobile_number\Plugin\Field\FieldWidget\MobileNumberWidget

Plugin implementation of the 'mobile_number' widget.

Plugin annotation


@FieldWidget(
  id = "mobile_number_default",
  label = @Translation("Mobile Number"),
  description = @Translation("Mobile number field default widget."),
  field_types = {
    "mobile_number",
    "telephone"
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
    class \Drupal\mobile_number\Plugin\Field\FieldWidget\MobileNumberWidget

Expanded class hierarchy of MobileNumberWidget

File

src/Plugin/Field/FieldWidget/MobileNumberWidget.php, line 26

Namespace

Drupal\mobile_number\Plugin\Field\FieldWidget

View source

class MobileNumberWidget extends WidgetBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {

    /** @var \Drupal\mobile_number\Element\MobileNumberUtilInterface $util */
    $util = \Drupal::service('mobile_number.util');
    return parent::defaultSettings() + [
      'default_country' => 'US',
      'countries' => [],
      'placeholder' => NULL,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $field_settings = $this
      ->getFieldSettings();
    $field_country_validation = isset($field_settings['countries']);

    /** @var \Drupal\mobile_number\Element\MobileNumberUtilInterface $util */
    $util = \Drupal::service('mobile_number.util');

    /** @var ContentEntityInterface $entity */
    $entity = $form_state
      ->getFormObject()
      ->getEntity();
    $form_state
      ->set('field_item', $this);
    $verification_enabled = !empty($this->fieldDefinition) && $this->fieldDefinition
      ->getType() == 'mobile_number';
    $element['default_country'] = [
      '#type' => 'select',
      '#title' => t('Default Country'),
      '#options' => $util
        ->getCountryOptions([], TRUE),
      '#default_value' => $this
        ->getSetting('default_country'),
      '#description' => t('Default country for mobile number input.'),
      '#required' => TRUE,
      '#element_validate' => [
        [
          $this,
          'settingsFormValidate',
        ],
      ],
    ];
    if (!$field_country_validation) {
      $element['countries'] = [
        '#type' => 'select',
        '#title' => t('Allowed Countries'),
        '#options' => $util
          ->getCountryOptions([], TRUE),
        '#default_value' => $this
          ->getSetting('countries'),
        '#description' => t('Allowed countries for the mobile number. If none selected, then all are allowed.'),
        '#multiple' => TRUE,
        '#attached' => [
          'library' => [
            'mobile_number/element',
          ],
        ],
      ];
    }
    $element['placeholder'] = [
      '#type' => 'textfield',
      '#title' => t('Number Placeholder'),
      '#default_value' => $this
        ->getSetting('placeholder') !== NULL ? $this
        ->getSetting('placeholder') : 'Phone number',
      '#description' => t('Number field placeholder.'),
      '#required' => FALSE,
    ];
    if ($verification_enabled) {
    }
    return $element;
  }

  /**
   * Form element validation handler.
   *
   * @param array $element
   *   The form where the settings form is being included in.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state of the (entire) configuration form.
   */
  public function settingsFormValidate(array $element, FormStateInterface $form_state) {
    $parents = $element['#parents'];
    array_pop($parents);
    $settings = $this
      ->getFieldSettings();
    $settings += NestedArray::getValue($form_state
      ->getValues(), $parents);
    $default_country = $settings['default_country'];
    $allowed_countries = $settings['countries'];
    if (!empty($allowed_countries) && !in_array($default_country, $allowed_countries)) {
      $form_state
        ->setError($element, t('Default country is not in one of the allowed countries.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {

    /** @var \Drupal\mobile_number\Element\MobileNumberUtilInterface $util */
    $util = \Drupal::service('mobile_number.util');
    $field_settings = $this
      ->getFieldSettings();
    $field_country_validation = isset($field_settings['countries']);
    $country_options = $util
      ->getCountryOptions();
    $countries = $this
      ->getSetting('countries');
    $countries = !$field_country_validation ? $countries ? implode(', ', $countries) : $this
      ->t('All') : NULL;
    $result = [];
    $result[] = $this
      ->t('Default country: @country', [
      '@country' => $this
        ->getSetting('default_country'),
    ]);
    if ($countries) {
      $result[] = $this
        ->t('Allowed countries: @countries', [
        '@countries' => $countries,
      ]);
    }
    $result[] = $this
      ->t('Number placeholder: @placeholder', [
      '@placeholder' => $this
        ->getSetting('placeholder') !== NULL ? $this
        ->getSetting('placeholder') : 'Phone number',
    ]);
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $item = $items[$delta];

    /** @var ContentEntityInterface $entity */
    $entity = $items
      ->getEntity();

    /** @var \Drupal\mobile_number\Element\MobileNumberUtilInterface $util */
    $util = \Drupal::service('mobile_number.util');
    $settings = $this
      ->getFieldSettings();
    $settings += $this
      ->getSettings() + static::defaultSettings();
    $tfa_field = $util
      ->getTfaField();
    $default_country = empty($settings['countries']) ? $settings['default_country'] : (empty($settings['countries'][$settings['default_country']]) ? key($settings['countries']) : $settings['default_country']);
    $element += [
      '#type' => 'mobile_number',
      '#description' => $element['#description'],
      '#default_value' => [
        'value' => $item->value,
        'country' => !empty($item->country) ? $item->country : $default_country,
        'local_number' => $item->local_number,
        'verified' => $item->verified,
        'tfa' => $item->tfa,
      ],
      '#mobile_number' => [
        'allowed_countries' => array_combine($settings['countries'], $settings['countries']),
        'verify' => $util
          ->isSmsEnabled() && !empty($settings['verify']) ? $settings['verify'] : MobileNumberUtilInterface::MOBILE_NUMBER_VERIFY_NONE,
        'message' => !empty($settings['message']) ? $settings['message'] : NULL,
        'tfa' => $entity
          ->getEntityTypeId() == 'user' && $tfa_field == $items
          ->getFieldDefinition()
          ->getName() && $items
          ->getFieldDefinition()
          ->getFieldStorageDefinition()
          ->getCardinality() == 1 ? TRUE : NULL,
        'token_data' => !empty($entity) ? [
          $entity
            ->getEntityTypeId() => $entity,
        ] : [],
        'placeholder' => isset($settings['placeholder']) ? $settings['placeholder'] : NULL,
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function errorElement(array $element, ConstraintViolationInterface $error, array $form, FormStateInterface $form_state) {

    /** @var \Drupal\mobile_number\Element\MobileNumberUtilInterface $util */
    $util = \Drupal::service('mobile_number.util');
    $op = MobileNumber::getOp($element, $form_state);
    $mobile_number = MobileNumber::getMobileNumber($element);
    if ($op == 'mobile_number_send_verification' && $mobile_number && ($util
      ->checkFlood($mobile_number) || $util
      ->checkFlood($mobile_number, 'sms'))) {
      return FALSE;
    }
    return parent::errorElement($element, $error, $form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AllowedTagsXssTrait::allowedTags	public	function	Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags	public	function	Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss	public	function	Filters an HTML string to prevent XSS vulnerabilities.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
MobileNumberWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
MobileNumberWidget::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetBase::errorElement
MobileNumberWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
MobileNumberWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
MobileNumberWidget::settingsFormValidate	public	function	Form element validation handler.
MobileNumberWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged	protected	property	Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings	protected	property	The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies	6
PluginSettingsBase::getSetting	public	function	Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings	public	function	Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults	protected	function	Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval	3
PluginSettingsBase::setSetting	public	function	Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings	public	function	Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
WidgetBase::$fieldDefinition	protected	property	The field definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax	public static	function	Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit	public static	function	Submission handler for the "Add another item" button.
WidgetBase::afterBuild	public static	function	After-build handler for field elements in a form.
WidgetBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	5
WidgetBase::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues	2
WidgetBase::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
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::getFieldSetting	protected	function	Returns the value of a field setting.
WidgetBase::getFieldSettings	protected	function	Returns the array of field settings.
WidgetBase::getFilteredDescription	protected	function	Returns the filtered field description.
WidgetBase::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents	protected static	function	Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues	protected	function	Returns whether the widget handles multiple values.
WidgetBase::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable	4
WidgetBase::isDefaultValueWidget	protected	function	Returns whether the widget used for default value form.
WidgetBase::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetInterface::massageFormValues	7
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState
WidgetBase::__construct	public	function	Constructs a WidgetBase object. Overrides PluginBase::__construct	5

You are here

class MobileNumberWidget in Mobile Number 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation