You are here

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

class ProductVariationAttributesWidget in Commerce Core 8.2

Plugin implementation of the 'commerce_product_variation_attributes' widget.

Plugin annotation


@FieldWidget(
  id = "commerce_product_variation_attributes",
  label = @Translation("Product variation attributes"),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of ProductVariationAttributesWidget

File

modules/product/src/Plugin/Field/FieldWidget/ProductVariationAttributesWidget.php, line 28

Namespace

Drupal\commerce_product\Plugin\Field\FieldWidget
View source 
class ProductVariationAttributesWidget extends ProductVariationWidgetBase implements ContainerFactoryPluginInterface {

  /**
   * The product attribute field manager.
   *
   * @var \Drupal\commerce_product\ProductAttributeFieldManagerInterface
   */
  protected $attributeFieldManager;

  /**
   * The product variation attribute mapper.
   *
   * @var \Drupal\commerce_product\ProductVariationAttributeMapperInterface
   */
  protected $variationAttributeMapper;

  /**
   * Constructs a new ProductVariationAttributesWidget 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\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityRepositoryInterface $entity_repository
   *   The entity repository.
   * @param \Drupal\commerce_product\ProductAttributeFieldManagerInterface $attribute_field_manager
   *   The product attribute field manager.
   * @param \Drupal\commerce_product\ProductVariationAttributeMapperInterface $variation_attribute_mapper
   *   The product variation attribute mapper.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EntityTypeManagerInterface $entity_type_manager, EntityRepositoryInterface $entity_repository, ProductAttributeFieldManagerInterface $attribute_field_manager, ProductVariationAttributeMapperInterface $variation_attribute_mapper) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings, $entity_type_manager, $entity_repository);
    $this->attributeFieldManager = $attribute_field_manager;
    $this->variationAttributeMapper = $variation_attribute_mapper;
  }

  /**
   * {@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('entity_type.manager'), $container
      ->get('entity.repository'), $container
      ->get('commerce_product.attribute_field_manager'), $container
      ->get('commerce_product.variation_attribute_mapper'));
  }

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

    /** @var \Drupal\commerce_product\Entity\ProductInterface $product */
    $product = $form_state
      ->get('product');
    $variations = $this
      ->loadEnabledVariations($product);
    if (count($variations) === 0) {

      // Nothing to purchase, tell the parent form to hide itself.
      $form_state
        ->set('hide_form', TRUE);
      $element['variation'] = [
        '#type' => 'value',
        '#value' => 0,
      ];
      return $element;
    }
    elseif (count($variations) === 1) {

      /** @var \Drupal\commerce_product\Entity\ProductVariationInterface $selected_variation */
      $selected_variation = reset($variations);

      // If there is 1 variation but there are attribute fields, then the
      // customer should still see the attribute widgets, to know what they're
      // buying (e.g a product only available in the Small size).
      if (empty($this->attributeFieldManager
        ->getFieldDefinitions($selected_variation
        ->bundle()))) {
        $element['variation'] = [
          '#type' => 'value',
          '#value' => $selected_variation
            ->id(),
        ];
        return $element;
      }
    }

    // Build the full attribute form.
    $wrapper_id = Html::getUniqueId('commerce-product-add-to-cart-form');
    $form += [
      '#wrapper_id' => $wrapper_id,
      '#prefix' => '<div id="' . $wrapper_id . '">',
      '#suffix' => '</div>',
    ];

    // If an operation caused the form to rebuild, select the variation from
    // the user's current input.
    $selected_variation = NULL;
    if ($form_state
      ->isRebuilding()) {
      $parents = array_merge($element['#field_parents'], [
        $items
          ->getName(),
        $delta,
        'attributes',
      ]);
      $attribute_values = (array) NestedArray::getValue($form_state
        ->getUserInput(), $parents);
      $selected_variation = $this->variationAttributeMapper
        ->selectVariation($variations, $attribute_values);
    }

    // Otherwise fallback to the default.
    if (!$selected_variation) {

      /** @var \Drupal\commerce_order\Entity\OrderItemInterface $order_item */
      $order_item = $items
        ->getEntity();
      if ($order_item
        ->isNew()) {
        $selected_variation = $this
          ->getDefaultVariation($product, $variations);
      }
      else {
        $selected_variation = $order_item
          ->getPurchasedEntity();
      }
    }
    $element['variation'] = [
      '#type' => 'value',
      '#value' => $selected_variation
        ->id(),
    ];

    // Set the selected variation in the form state for our AJAX callback.
    $form_state
      ->set('selected_variation', $selected_variation
      ->id());
    $element['attributes'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'attribute-widgets',
        ],
      ],
    ];
    foreach ($this->variationAttributeMapper
      ->prepareAttributes($selected_variation, $variations) as $field_name => $attribute) {
      $attribute_element = [
        '#type' => $attribute
          ->getElementType(),
        '#title' => $attribute
          ->getLabel(),
        '#options' => $attribute
          ->getValues(),
        '#required' => $attribute
          ->isRequired(),
        '#default_value' => $selected_variation
          ->getAttributeValueId($field_name),
        '#limit_validation_errors' => [],
        '#ajax' => [
          'callback' => [
            get_class($this),
            'ajaxRefresh',
          ],
          'wrapper' => $form['#wrapper_id'],
          // Prevent a jump to the top of the page.
          'disable-refocus' => TRUE,
        ],
      ];

      // Convert the _none option into #empty_value.
      if (isset($attribute_element['#options']['_none'])) {
        if (!$attribute_element['#required']) {
          $attribute_element['#empty_value'] = '';
        }
        unset($attribute_element['#options']['_none']);
      }

      // Optimize the UX of optional attributes:
      // - Hide attributes that have no values.
      // - Require attributes that have a value on each variation.
      if (empty($attribute_element['#options'])) {
        $attribute_element['#access'] = FALSE;
      }
      if (!isset($element['attributes'][$field_name]['#empty_value'])) {
        $attribute_element['#required'] = TRUE;
      }
      $element['attributes'][$field_name] = $attribute_element;
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {

    /** @var \Drupal\commerce_product\Entity\ProductInterface $product */
    $product = $form_state
      ->get('product');
    $default_variation = $product
      ->getDefaultVariation();
    $variations = $this->variationStorage
      ->loadEnabled($product);
    foreach ($values as &$value) {
      $attribute_values = isset($value['attributes']) ? $value['attributes'] : [];
      $selected_variation = $this->variationAttributeMapper
        ->selectVariation($variations, $attribute_values);
      if ($selected_variation) {
        $value['variation'] = $selected_variation
          ->id();
      }
      else {
        $value['variation'] = $default_variation
          ->id();
      }
    }
    return parent::massageFormValues($values, $form, $form_state);
  }

}

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
ProductVariationAttributesWidget::$attributeFieldManager protected property The product attribute field manager.
ProductVariationAttributesWidget::$variationAttributeMapper protected property The product variation attribute mapper.
ProductVariationAttributesWidget::create public static function Creates an instance of the plugin. Overrides ProductVariationWidgetBase::create
ProductVariationAttributesWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
ProductVariationAttributesWidget::massageFormValues public function Massages the form values into the format expected for field values. Overrides ProductVariationWidgetBase::massageFormValues
ProductVariationAttributesWidget::__construct public function Constructs a new ProductVariationAttributesWidget object. Overrides ProductVariationWidgetBase::__construct
ProductVariationWidgetBase::$entityRepository protected property The entity repository service.
ProductVariationWidgetBase::$variationStorage protected property The product variation storage.
ProductVariationWidgetBase::ajaxRefresh public static function #ajax callback: Replaces the rendered fields on variation change.
ProductVariationWidgetBase::getDefaultVariation protected function Gets the default variation for the widget.
ProductVariationWidgetBase::isApplicable public static function Returns if the widget can be used for the provided field. Overrides WidgetBase::isApplicable
ProductVariationWidgetBase::loadEnabledVariations protected function Gets the enabled variations for the product.
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::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::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