You are here

Home » API reference » Commerce Core 8.2 » TaxNumberDefaultWidget.php

class TaxNumberDefaultWidget in Commerce Core 8.2

Plugin implementation of the 'commerce_tax_number_default' widget.

Plugin annotation


@FieldWidget(
  id = "commerce_tax_number_default",
  label = @Translation("Tax number"),
  field_types = {
    "commerce_tax_number"
  }
)

Hierarchy

Expanded class hierarchy of TaxNumberDefaultWidget

File

modules/tax/src/Plugin/Field/FieldWidget/TaxNumberDefaultWidget.php, line 29

Namespace

Drupal\commerce_tax\Plugin\Field\FieldWidget
View source 
class TaxNumberDefaultWidget extends WidgetBase implements ContainerFactoryPluginInterface {

  /**
   * The tax number type manager.
   *
   * @var \Drupal\commerce_tax\TaxNumberTypeManagerInterface
   */
  protected $taxNumberTypeManager;

  /**
   * Constructs a new TaxNumberDefaultWidget object.
   *
   * @param string $plugin_id
   *   The plugin_id for the widget.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the widget is associated.
   * @param array $settings
   *   The widget settings.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\commerce_tax\TaxNumberTypeManagerInterface $tax_number_type_manager
   *   The tax number type manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, TaxNumberTypeManagerInterface $tax_number_type_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->taxNumberTypeManager = $tax_number_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('plugin.manager.commerce_tax_number_type'));
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    if ($this
      ->isDefaultValueWidget($form_state)) {
      return [];
    }
    $this
      ->prepareForm($form);

    /** @var \Drupal\commerce_tax\Plugin\Field\FieldType\TaxNumberItemInterface $item */
    $item = $items[$delta];
    $selected_country = $this
      ->getSelectedCountry($item
      ->getEntity(), $form, $form_state);
    $allowed_countries = $item
      ->getAllowedCountries();
    if ($selected_country && !in_array($selected_country, $allowed_countries)) {

      // Tax numbers are not being collected for the selected country.
      $element['#access'] = FALSE;
      $element['value'] = [
        '#type' => 'value',
        '#value' => '',
      ];
      return $element;
    }
    $allowed_types = $item
      ->getAllowedTypes();
    if (count($allowed_types) == 1) {
      $type = reset($allowed_types);
    }
    elseif ($selected_country) {

      // Auto-detect the tax number type based on the selected country.
      $type = $this->taxNumberTypeManager
        ->getPluginId($selected_country);
    }
    else {

      // There are multiple allowed types, but auto-detection is not possible.
      // Fall back to the "Other" plugin, and perform no validation.
      // @todo Allow the user to select the type from a dropdown instead.
      $type = 'other';
    }
    $element['original'] = [
      '#type' => 'value',
      '#value' => $item
        ->getValue() + [
        'type' => NULL,
        'value' => NULL,
        'verification_state' => NULL,
        'verification_timestamp' => NULL,
        'verification_result' => NULL,
      ],
    ];
    $element['type'] = [
      '#type' => 'value',
      '#value' => $type,
    ];
    $element['value'] = [
      '#type' => 'textfield',
      '#title' => $this->fieldDefinition
        ->getLabel(),
      '#description' => $this->fieldDefinition
        ->getDescription(),
      '#required' => $this->fieldDefinition
        ->isRequired(),
      '#default_value' => $item->value,
      '#size' => 20,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    foreach ($values as $delta => $value) {
      if (empty($value['value'])) {
        continue;
      }

      /** @var \Drupal\commerce_tax\Plugin\Commerce\TaxNumberType\TaxNumberTypeInterface $type_plugin */
      $type_plugin = $this->taxNumberTypeManager
        ->createInstance($value['type']);
      $value['value'] = $type_plugin
        ->canonicalize($value['value']);

      // Preserve the previous verification if the number hasn't changed.
      $original = $value['original'];
      if ($original['type'] == $value['type'] && $original['value'] == $value['value']) {
        $value['verification_state'] = $original['verification_state'];
        $value['verification_timestamp'] = $original['verification_timestamp'];
        $value['verification_result'] = $original['verification_result'];
      }
      unset($value['original']);
      $values[$delta] = $value;
    }
    return $values;
  }

  /**
   * Prepares the given entity form.
   *
   * Ensures that the address widget refreshes the entire entity form, to
   * allow the tax_number widget to hide itself based on the selected country.
   *
   * @param array $form
   *   The entity form.
   *
   * @return array
   *   The prepared form.
   */
  protected function prepareForm(array &$form) {
    if (empty($form['address']['widget'][0]['address']['#required'])) {

      // The address field is missing, optional, or using a non-standard widget.
      return $form;
    }
    $wrapper_id = Html::getUniqueId(implode('-', $form['#parents']) . '-ajax-form');
    $form += [
      '#wrapper_id' => $wrapper_id,
      '#prefix' => '<div id="' . $wrapper_id . '">',
      '#suffix' => '</div>',
    ];
    $form['address']['widget'][0]['address']['#form_wrapper'] = $form['#wrapper_id'];
    $form['address']['widget'][0]['address']['#process'] = [
      // Keep the default #process functions defined in Address::getInfo().
      [
        Address::class,
        'processAddress',
      ],
      [
        Address::class,
        'processGroup',
      ],
      // Add our own #process.
      [
        get_class($this),
        'replaceAjaxCallback',
      ],
    ];
    return $form;
  }

  /**
   * Replaces the country_code #ajax callback in an Address widget.
   *
   * Used as a #process callback because the country_code is a part of the
   * Address form element, added on #process.
   *
   * @param array $element
   *   The form element being processed.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The form element.
   */
  public static function replaceAjaxCallback(array &$element, FormStateInterface $form_state, array &$complete_form) {
    if (isset($element['country_code']['#ajax'])) {
      $element['country_code']['#ajax'] = [
        'callback' => [
          get_called_class(),
          'ajaxRefresh',
        ],
        'wrapper' => $element['#form_wrapper'],
      ];
    }
    return $element;
  }

  /**
   * Ajax callback.
   */
  public static function ajaxRefresh(array $form, FormStateInterface $form_state) {

    // Find the entity form based on the expected address widget structure
    // (e.g. $form['address']['widget'][0]['address']['country_code']).
    $triggering_element = $form_state
      ->getTriggeringElement();
    $parents = array_slice($triggering_element['#array_parents'], 0, -6);
    return NestedArray::getValue($form, $parents);
  }

  /**
   * Gets the selected country from the parent entity's address field.
   *
   * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
   *   The parent entity.
   * @param array $form
   *   The entity form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return string|null
   *   The country code, or NULL if not found.
   */
  protected function getSelectedCountry(FieldableEntityInterface $entity, array $form, FormStateInterface $form_state) {
    if (!$entity
      ->hasField('address')) {
      return NULL;
    }

    // Priority: 1) Submitted value 2) Entity value 3) Default country.
    $parents = array_merge($form['#parents'], [
      'address',
      0,
      'address',
      'country_code',
    ]);
    $selected_country = NestedArray::getValue($form_state
      ->getUserInput(), $parents);
    if (!$selected_country && !$entity
      ->get('address')
      ->isEmpty()) {

      /** @var \Drupal\address\AddressInterface $address */
      $address = $entity
        ->get('address')
        ->first();
      $selected_country = $address
        ->getCountryCode();
    }
    elseif (!$selected_country && !empty($form['address']['widget'][0]['address'])) {
      $address_element = $form['address']['widget'][0]['address'];
      $selected_country = Country::getDefaultCountry($address_element['#available_countries']);
    }
    return $selected_country;
  }

}

Members

Namesort descending 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.
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::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
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.
TaxNumberDefaultWidget::$taxNumberTypeManager protected property The tax number type manager.
TaxNumberDefaultWidget::ajaxRefresh public static function Ajax callback.
TaxNumberDefaultWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
TaxNumberDefaultWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
TaxNumberDefaultWidget::getSelectedCountry protected function Gets the selected country from the parent entity's address field.
TaxNumberDefaultWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
TaxNumberDefaultWidget::prepareForm protected function Prepares the given entity form.
TaxNumberDefaultWidget::replaceAjaxCallback public static function Replaces the country_code #ajax callback in an Address widget.
TaxNumberDefaultWidget::__construct public function Constructs a new TaxNumberDefaultWidget object. Overrides WidgetBase::__construct
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::errorElement public function Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement 8
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::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetInterface::settingsForm 16
WidgetBase::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetInterface::settingsSummary 15
WidgetBase::setWidgetState public static function Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState