class ShippingRateWidget in Commerce Shipping 8.2

Plugin implementation of 'commerce_shipping_rate'.

Plugin annotation


@FieldWidget(
  id = "commerce_shipping_rate",
  label = @Translation("Shipping rate"),
  field_types = {
    "entity_reference"
  }
)

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\commerce_shipping\Plugin\Field\FieldWidget\ShippingRateWidget implements ContainerFactoryPluginInterface

Expanded class hierarchy of ShippingRateWidget

File

src/Plugin/Field/FieldWidget/ShippingRateWidget.php, line 33

Namespace

Drupal\commerce_shipping\Plugin\Field\FieldWidget

View source

class ShippingRateWidget extends WidgetBase implements ContainerFactoryPluginInterface {

  /**
   * The currency formatter.
   *
   * @var \CommerceGuys\Intl\Formatter\CurrencyFormatterInterface
   */
  protected $currencyFormatter;

  /**
   * The shipment manager.
   *
   * @var \Drupal\commerce_shipping\ShipmentManagerInterface
   */
  protected $shipmentManager;

  /**
   * Constructs a new ShippingRateWidget 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 \CommerceGuys\Intl\Formatter\CurrencyFormatterInterface $currency_formatter
   *   The currency formatter.
   * @param \Drupal\commerce_shipping\ShipmentManagerInterface $shipment_manager
   *   The shipment manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, CurrencyFormatterInterface $currency_formatter, ShipmentManagerInterface $shipment_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->currencyFormatter = $currency_formatter;
    $this->shipmentManager = $shipment_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('commerce_price.currency_formatter'), $container
      ->get('commerce_shipping.shipment_manager'));
  }

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

    /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
    $shipment = $items[$delta]
      ->getEntity();
    $parents = array_merge($form['#parents'], [
      $this->fieldDefinition
        ->getName(),
      0,
    ]);
    $rates_key = implode('_', $parents);

    // Store the calculated rates in form state, so we don't have to fetch those
    // on each ajax refresh.
    if (!$form_state
      ->has($rates_key) || $form_state
      ->get('recalculate_shipping')) {
      $form_state
        ->set($rates_key, $this->shipmentManager
        ->calculateRates($shipment));
    }
    $rates = $form_state
      ->get($rates_key);
    if (!$rates) {
      $element = [
        '#markup' => $this
          ->t('There are no shipping rates available for this address.'),
      ];
      return $element;
    }
    $default_rate = $this->shipmentManager
      ->selectDefaultRate($shipment, $rates);

    // If we're in checkout, add an ajax callback to the radios so that
    // the order summary is refreshed when selecting a different rate.
    if ($form_state
      ->getFormObject() instanceof CheckoutFlowWithPanesInterface) {
      $element['#ajax'] = [
        'callback' => [
          get_called_class(),
          'ajaxRefresh',
        ],
      ];
      $parents = array_merge($form['#parents'], [
        $this->fieldDefinition
          ->getName(),
        0,
      ]);
      $user_input = (array) NestedArray::getValue($form_state
        ->getUserInput(), $parents);

      // Apply the default rate when no rate is selected.
      if (empty($user_input)) {
        $this->shipmentManager
          ->applyRate($shipment, $default_rate);
      }
    }
    $element['#type'] = 'radios';
    $element['#default_value'] = $default_rate
      ->getId();
    $element['#options'] = [];
    foreach ($rates as $rate_id => $rate) {
      $original_amount = $rate
        ->getOriginalAmount();
      $amount = $rate
        ->getAmount();
      if ($original_amount
        ->greaterThan($amount)) {
        $rate_label = new FormattableMarkup('@service: <s>@original_amount</s> @amount', [
          '@service' => $rate
            ->getService()
            ->getLabel(),
          '@original_amount' => $this->currencyFormatter
            ->format($original_amount
            ->getNumber(), $original_amount
            ->getCurrencyCode()),
          '@amount' => $this->currencyFormatter
            ->format($amount
            ->getNumber(), $amount
            ->getCurrencyCode()),
        ]);
      }
      else {
        $rate_label = new FormattableMarkup('@service: @amount', [
          '@service' => $rate
            ->getService()
            ->getLabel(),
          '@amount' => $this->currencyFormatter
            ->format($amount
            ->getNumber(), $amount
            ->getCurrencyCode()),
        ]);
      }
      $element['#options'][$rate_id] = $rate_label;
      $element[$rate_id]['#description'] = $rate
        ->getDescription();

      // Tell Bootstrap not to turn the description into a tooltip.
      $element[$rate_id]['#smart_description'] = FALSE;

      // Store the rate object for use in extractFormValues().
      $element[$rate_id]['#rate'] = $rate;
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function extractFormValues(FieldItemListInterface $items, array $form, FormStateInterface $form_state) {
    $field_name = $this->fieldDefinition
      ->getName();
    $parents = array_merge($form['#parents'], [
      $field_name,
      0,
    ]);
    $element = NestedArray::getValue($form, [
      $field_name,
      'widget',
      0,
    ]);
    $selected_value = NestedArray::getValue($form_state
      ->getValues(), $parents, $key_exists);

    // Fallback to the default rate if the selected rate is no longer valid.
    if (!isset($element[$selected_value]) && isset($element[$element['#default_value']])) {
      $selected_value = $element['#default_value'];
    }
    if ($selected_value && isset($element[$selected_value])) {

      /** @var \Drupal\commerce_shipping\ShippingRate $rate */
      $rate = $element[$selected_value]['#rate'];

      /** @var \Drupal\commerce_shipping\Entity\ShipmentInterface $shipment */
      $shipment = $items
        ->getEntity();
      if ($rate) {
        $this->shipmentManager
          ->applyRate($shipment, $rate);
      }

      // Put delta mapping in $form_state, so that flagErrors() can use it.
      $field_state = static::getWidgetState($form['#parents'], $field_name, $form_state);
      foreach ($items as $delta => $item) {
        $field_state['original_deltas'][$delta] = $delta;
      }
      static::setWidgetState($form['#parents'], $field_name, $form_state, $field_state);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    $entity_type = $field_definition
      ->getTargetEntityTypeId();
    $field_name = $field_definition
      ->getName();
    return $entity_type == 'commerce_shipment' && $field_name == 'shipping_method';
  }

  /**
   * {@inheritdoc}
   */
  public function flagErrors(FieldItemListInterface $items, ConstraintViolationListInterface $violations, array $form, FormStateInterface $form_state) {
    foreach ($violations as $offset => $violation) {

      /** @var \Symfony\Component\Validator\ConstraintViolationInterface $violation */
      if ($violation
        ->getCode() == NotNullConstraint::IS_NULL_ERROR) {

        // There are no setters on ConstraintValidation.
        $new = new ConstraintViolation($this
          ->t('A valid shipping method must be selected in order to check out.'), $violation
          ->getMessageTemplate(), $violation
          ->getParameters(), $violation
          ->getRoot(), $violation
          ->getPropertyPath(), $violation
          ->getInvalidValue(), $violation
          ->getPlural(), $violation
          ->getCode(), new NotNullConstraint());
        $violations
          ->remove($offset);
        $violations
          ->add($new);
      }
    }
    return parent::flagErrors($items, $violations, $form, $form_state);
  }

  /**
   * Ajax callback.
   */
  public static function ajaxRefresh(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();

    // Refresh the order summary if present.
    if (isset($form['sidebar']['order_summary'])) {
      $selector = sprintf('[data-drupal-selector="%s"]', $form['sidebar']['order_summary']['#attributes']['data-drupal-selector']);
      $response
        ->addCommand(new ReplaceCommand($selector, $form['sidebar']['order_summary']));
    }
    return $response;
  }

}

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.
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
ShippingRateWidget::$currencyFormatter	protected	property	The currency formatter.
ShippingRateWidget::$shipmentManager	protected	property	The shipment manager.
ShippingRateWidget::ajaxRefresh	public static	function	Ajax callback.
ShippingRateWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
ShippingRateWidget::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBase::extractFormValues
ShippingRateWidget::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBase::flagErrors
ShippingRateWidget::formElement	public	function	Returns the form for a single field widget. Overrides WidgetInterface::formElement
ShippingRateWidget::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
ShippingRateWidget::__construct	public	function	Constructs a new ShippingRateWidget object. Overrides WidgetBase::__construct
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::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
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::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::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

You are here

class ShippingRateWidget in Commerce Shipping 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation