ProductVariationTypeForm.php in Commerce Core 8.2

Namespace

Drupal\commerce_product\Form

File

modules/product/src/Form/ProductVariationTypeForm.php

<?php

namespace Drupal\commerce_product\Form;

use Drupal\commerce\EntityHelper;
use Drupal\commerce\EntityTraitManagerInterface;
use Drupal\commerce\Form\CommerceBundleEntityFormBase;
use Drupal\commerce_product\ProductAttributeFieldManagerInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\entity\Form\EntityDuplicateFormTrait;
use Drupal\language\Entity\ContentLanguageSettings;
use Symfony\Component\DependencyInjection\ContainerInterface;
class ProductVariationTypeForm extends CommerceBundleEntityFormBase {
  use EntityDuplicateFormTrait;

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

  /**
   * Constructs a new ProductVariationTypeForm object.
   *
   * @param \Drupal\commerce\EntityTraitManagerInterface $trait_manager
   *   The entity trait manager.
   * @param \Drupal\commerce_product\ProductAttributeFieldManagerInterface $attribute_field_manager
   *   The attribute field manager.
   */
  public function __construct(EntityTraitManagerInterface $trait_manager, ProductAttributeFieldManagerInterface $attribute_field_manager) {
    parent::__construct($trait_manager);
    $this->attributeFieldManager = $attribute_field_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.commerce_entity_trait'), $container
      ->get('commerce_product.attribute_field_manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    /** @var \Drupal\commerce_product\Entity\ProductVariationTypeInterface $variation_type */
    $variation_type = $this->entity;
    $form['label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#maxlength' => 255,
      '#default_value' => $variation_type
        ->label(),
      '#required' => TRUE,
    ];
    $form['id'] = [
      '#type' => 'machine_name',
      '#default_value' => $variation_type
        ->id(),
      '#machine_name' => [
        'exists' => '\\Drupal\\commerce_product\\Entity\\ProductVariationType::load',
      ],
      '#maxlength' => EntityTypeInterface::BUNDLE_MAX_LENGTH,
      '#disabled' => !$variation_type
        ->isNew(),
    ];
    $form['generateTitle'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Generate variation titles based on attribute values.'),
      '#default_value' => $variation_type
        ->shouldGenerateTitle(),
    ];
    $form = $this
      ->buildTraitForm($form, $form_state);
    if ($this->moduleHandler
      ->moduleExists('commerce_order')) {

      // Prepare a list of order item types used to purchase product variations.
      $order_item_type_storage = $this->entityTypeManager
        ->getStorage('commerce_order_item_type');
      $order_item_types = $order_item_type_storage
        ->loadMultiple();
      $order_item_types = array_filter($order_item_types, function ($order_item_type) {

        /** @var \Drupal\commerce_order\Entity\OrderItemTypeInterface $order_item_type */
        return $order_item_type
          ->getPurchasableEntityTypeId() == 'commerce_product_variation';
      });
      $form['orderItemType'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Order item type'),
        '#default_value' => $variation_type
          ->getOrderItemTypeId(),
        '#options' => EntityHelper::extractLabels($order_item_types),
        '#empty_value' => '',
        '#required' => TRUE,
      ];
    }
    $attribute_map = [];
    if ($this->operation == 'edit') {
      $attribute_map = $this->attributeFieldManager
        ->getFieldMap($variation_type
        ->id());
    }
    elseif ($this->operation == 'duplicate') {
      $attribute_map = $this->attributeFieldManager
        ->getFieldMap($this->sourceEntity
        ->id());
    }
    $used_attributes = array_column($attribute_map, 'attribute_id');

    /** @var \Drupal\commerce_product\Entity\ProductAttributeInterface[] $attributes */
    $attributes = $this->entityTypeManager
      ->getStorage('commerce_product_attribute')
      ->loadMultiple();
    $attribute_options = EntityHelper::extractLabels($attributes);
    $form['original_attributes'] = [
      '#type' => 'value',
      '#value' => $used_attributes,
    ];
    $form['attributes'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Attributes'),
      '#options' => $attribute_options,
      '#default_value' => $used_attributes,
      '#access' => !empty($attribute_options),
    ];
    $disabled_attributes = [];
    if (!$variation_type
      ->isNew()) {

      // Disable options which cannot be unset because of existing data.
      foreach ($used_attributes as $attribute_id) {
        if (!$this->attributeFieldManager
          ->canDeleteField($attributes[$attribute_id], $variation_type
          ->id())) {
          $form['attributes'][$attribute_id] = [
            '#disabled' => TRUE,
          ];
          $disabled_attributes[] = $attribute_id;
        }
      }
    }
    $form['disabled_attributes'] = [
      '#type' => 'value',
      '#value' => $disabled_attributes,
    ];
    if ($this->moduleHandler
      ->moduleExists('language')) {
      $form['language'] = [
        '#type' => 'details',
        '#title' => $this
          ->t('Language settings'),
        '#group' => 'additional_settings',
      ];
      $form['language']['language_configuration'] = [
        '#type' => 'language_configuration',
        '#entity_information' => [
          'entity_type' => 'commerce_product_variation',
          'bundle' => $variation_type
            ->id(),
        ],
        '#default_value' => ContentLanguageSettings::loadByEntityTypeBundle('commerce_product_variation', $variation_type
          ->id()),
      ];
      $form['#submit'][] = 'language_configuration_element_submit';
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $this
      ->validateTraitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $this->entity
      ->save();
    $this
      ->postSave($this->entity, $this->operation);
    $this
      ->submitTraitForm($form, $form_state);
    $attribute_storage = $this->entityTypeManager
      ->getStorage('commerce_product_attribute');
    $original_attributes = $form_state
      ->getValue('original_attributes');
    $attributes = array_filter($form_state
      ->getValue('attributes'));
    $disabled_attributes = $form_state
      ->getValue('disabled_attributes');
    $attributes = array_unique(array_merge($disabled_attributes, $attributes));
    $selected_attributes = array_diff($attributes, $original_attributes);
    $unselected_attributes = array_diff($original_attributes, $attributes);
    if ($selected_attributes) {

      /** @var \Drupal\commerce_product\Entity\ProductAttributeInterface[] $selected_attributes */
      $selected_attributes = $attribute_storage
        ->loadMultiple($selected_attributes);
      foreach ($selected_attributes as $attribute) {
        $this->attributeFieldManager
          ->createField($attribute, $this->entity
          ->id());
      }
    }
    if ($unselected_attributes) {

      /** @var \Drupal\commerce_product\Entity\ProductAttributeInterface[] $unselected_attributes */
      $unselected_attributes = $attribute_storage
        ->loadMultiple($unselected_attributes);
      foreach ($unselected_attributes as $attribute) {
        $this->attributeFieldManager
          ->deleteField($attribute, $this->entity
          ->id());
      }
    }
    $this
      ->messenger()
      ->addMessage($this
      ->t('Saved the %label product variation type.', [
      '%label' => $this->entity
        ->label(),
    ]));
    $form_state
      ->setRedirect('entity.commerce_product_variation_type.collection');
  }

}

Classes

Name	Description
ProductVariationTypeForm