Issue #2898258 by bojanz, Berdir: Sync the ProductForm UX with the 8.4.x NodeForm

Author: berdir

modules/product/commerce_product.post_update.php

@@ -100,3 +100,35 @@ function commerce_product_post_update_3() {
 
   return $message;
 }
+
+/**
+ * Revert the default product form display.
+ */
+function commerce_product_post_update_4() {
+  /** @var \Drupal\commerce\Config\ConfigUpdaterInterface $config_updater */
+  $config_updater = \Drupal::service('commerce.config_updater');
+
+  $views = [
+    'core.entity_form_display.commerce_product.default.default',
+  ];
+  $result = $config_updater->revert($views, TRUE);
+
+  $success_results = $result->getSucceeded();
+  $failure_results = $result->getFailed();
+  $message = '';
+  if ($success_results) {
+    $message = t('Succeeded:') . '<br>';
+    foreach ($success_results as $success_message) {
+      $message .= $success_message . '<br>';
+    }
+    $message .= '<br>';
+  }
+  if ($failure_results) {
+    $message .= t('Failed:') . '<br>';
+    foreach ($failure_results as $failure_message) {
+      $message .= $failure_message . '<br>';
+    }
+  }
+
+  return $message;
+}

modules/product/config/install/core.entity_form_display.commerce_product.default.default.yml

@@ -24,49 +24,70 @@ content:
       summary_rows: 3
       placeholder: ''
     third_party_settings: {  }
+    region: content
   created:
     type: datetime_timestamp
-    weight: 6
+    weight: 5
+    settings: {  }
+    third_party_settings: {  }
+    region: content
+  langcode:
+    type: language_select
+    weight: 3
+    region: content
     settings: {  }
     third_party_settings: {  }
   path:
     type: path
-    weight: 4
+    weight: 7
     settings: {  }
     third_party_settings: {  }
+    region: content
+  status:
+    type: boolean_checkbox
+    weight: 8
+    region: content
+    settings:
+      display_label: true
+    third_party_settings: {  }
   stores:
     type: commerce_entity_select
     weight: 0
     settings:
+      hide_single_entity: true
       autocomplete_threshold: 7
       autocomplete_size: 60
       autocomplete_placeholder: ''
     third_party_settings: {  }
+    region: content
   title:
     type: string_textfield
     weight: 1
     settings:
       size: 60
       placeholder: ''
     third_party_settings: {  }
+    region: content
   uid:
     type: entity_reference_autocomplete
-    weight: 5
+    weight: 4
     settings:
       match_operator: CONTAINS
       size: 60
       placeholder: ''
     third_party_settings: {  }
+    region: content
   variations:
     type: inline_entity_form_complex
-    weight: 3
+    weight: 6
     settings:
       match_operator: CONTAINS
       override_labels: false
       label_singular: ''
       label_plural: ''
       allow_new: true
       allow_existing: false
+      form_mode: default
     third_party_settings: {  }
-hidden:
-  status: true
+    region: content
+hidden: {  }

modules/product/css/product.form.css

@@ -10,6 +10,12 @@
   box-sizing: border-box;
 }
 
+.layout-region-product-footer__content {
+    border-top: 1px solid #bebfb9;
+    padding-top: 0.5em;
+    margin-top: 1.5em;
+}
+
 /* Wide screens */
 @media
   screen and (min-width: 780px),
@@ -23,6 +29,10 @@
     box-sizing: border-box;
   }
 
+  .layout-region-product-footer__content {
+    margin-top: 0.5em;
+  }
+
   [dir="rtl"] .layout-region-product-main,
   [dir="rtl"] .layout-region-product-footer {
     float: right;

modules/product/src/Entity/Product.php

@@ -382,6 +382,7 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
       ->setComputed(TRUE);
 
     $fields['status']
+      ->setLabel(t('Published'))
       ->setDisplayOptions('form', [
         'type' => 'boolean_checkbox',
         'settings' => [

modules/product/src/Form/ProductForm.php

@@ -2,7 +2,6 @@
 
 namespace Drupal\commerce_product\Form;
 
-use Drupal\commerce_product\Entity\ProductInterface;
 use Drupal\Core\Datetime\DateFormatterInterface;
 use Drupal\Component\Datetime\TimeInterface;
 use Drupal\Core\Entity\ContentEntityForm;
@@ -85,13 +84,21 @@ public function form(array $form, FormStateInterface $form_state) {
     $form['#tree'] = TRUE;
     $form['#theme'] = ['commerce_product_form'];
     $form['#attached']['library'][] = 'commerce_product/form';
-    $form['#entity_builders']['update_status'] = [get_class($this), 'updateStatus'];
     // Changed must be sent to the client, for later overwrite error checking.
     $form['changed'] = [
       '#type' => 'hidden',
       '#default_value' => $product->getChangedTime(),
     ];
 
+    $form['footer'] = [
+      '#type' => 'container',
+      '#weight' => 99,
+      '#attributes' => [
+        'class' => ['product-form-footer'],
+      ],
+    ];
+    $form['status']['#group'] = 'footer';
+
     $last_saved = t('Not saved yet');
     if (!$product->isNew()) {
       $last_saved = $this->dateFormatter->format($product->getChangedTime(), 'short');
@@ -208,74 +215,6 @@ public static function hideEmptyVisibilitySettings(array $form) {
     return $form;
   }
 
-  /**
-   * Entity builder: updates the product status with the submitted value.
-   *
-   * @param string $entity_type
-   *   The entity type.
-   * @param \Drupal\commerce_product\Entity\ProductInterface $product
-   *   The product updated with the submitted values.
-   * @param array $form
-   *   The complete form array.
-   * @param \Drupal\Core\Form\FormStateInterface $form_state
-   *   The current state of the form.
-   *
-   * @see \Drupal\node\NodeForm::form()
-   */
-  public static function updateStatus($entity_type, ProductInterface $product, array $form, FormStateInterface $form_state) {
-    $element = $form_state->getTriggeringElement();
-    if (isset($element['#published_status'])) {
-      $product->setPublished($element['#published_status']);
-    }
-  }
-
-  /**
-   * {@inheritdoc}
-   */
-  protected function actions(array $form, FormStateInterface $form_state) {
-    $element = parent::actions($form, $form_state);
-    /** @var \Drupal\commerce_product\Entity\ProductInterface $product */
-    $product = $this->entity;
-
-    $element['delete']['#access'] = $product->access('delete');
-    $element['delete']['#weight'] = 100;
-    // Add a "Publish" button.
-    $element['publish'] = $element['submit'];
-    $element['publish']['#published_status'] = TRUE;
-    $element['publish']['#dropbutton'] = 'save';
-    $element['publish']['#weight'] = 0;
-    // Add an "Unpublish" button.
-    $element['unpublish'] = $element['submit'];
-    $element['unpublish']['#published_status'] = FALSE;
-    $element['unpublish']['#dropbutton'] = 'save';
-    $element['unpublish']['#weight'] = 10;
-    // isNew | prev status » primary   & publish label             & unpublish label
-    // 1     | 1           » publish   & Save and publish          & Save as unpublished
-    // 1     | 0           » unpublish & Save and publish          & Save as unpublished
-    // 0     | 1           » publish   & Save and keep published   & Save and unpublish
-    // 0     | 0           » unpublish & Save and keep unpublished & Save and publish.
-    if ($product->isNew()) {
-      $element['publish']['#value'] = $this->t('Save and publish');
-      $element['unpublish']['#value'] = $this->t('Save as unpublished');
-    }
-    else {
-      $element['publish']['#value'] = $product->isPublished() ? $this->t('Save and keep published') : $this->t('Save and publish');
-      $element['unpublish']['#value'] = !$product->isPublished() ? $this->t('Save and keep unpublished') : $this->t('Save and unpublish');
-    }
-    // Set the primary button based on the published status.
-    if ($product->isPublished()) {
-      unset($element['unpublish']['#button_type']);
-    }
-    else {
-      unset($element['publish']['#button_type']);
-      $element['unpublish']['#weight'] = -10;
-    }
-    // Hide the now unneeded "Save" button.
-    $element['submit']['#access'] = FALSE;
-
-    return $element;
-  }
-
   /**
    * {@inheritdoc}
    */

modules/product/templates/commerce-product-form.html.twig

@@ -11,12 +11,15 @@
 #}
 <div class="layout-product-form clearfix">
   <div class="layout-region layout-region-product-main">
-    {{ form|without('advanced', 'actions') }}
+    {{ form|without('advanced', 'footer', 'actions') }}
   </div>
   <div class="layout-region layout-region-product-secondary">
     {{ form.advanced }}
   </div>
   <div class="layout-region layout-region-product-footer">
-    {{ form.actions }}
+    <div class="layout-region-product-footer__content">
+      {{ form.footer }}
+      {{ form.actions }}
+    </div>
   </div>
 </div>

modules/product/tests/src/Functional/ProductAdminTest.php

@@ -41,7 +41,7 @@ public function testCreateProduct() {
       'variations[form][inline_entity_form][status][value]' => 1,
     ];
     $this->submitForm($variations_edit, t('Create variation'));
-    $this->submitForm($edit, t('Save and publish'));
+    $this->submitForm($edit, t('Save'));
 
     $result = \Drupal::entityQuery('commerce_product')
       ->condition("title", $edit['title[0][value]'])
@@ -108,7 +108,7 @@ public function testEditProduct() {
       'variations[form][inline_entity_form][entities][0][form][status][value]' => 1,
     ];
     $this->submitForm($variations_edit, 'Update variation');
-    $this->submitForm($edit, 'Save and keep published');
+    $this->submitForm($edit, 'Save');
 
     \Drupal::service('entity_type.manager')->getStorage('commerce_product_variation')->resetCache([$variation->id()]);
     $variation = ProductVariation::load($variation->id());

tests/src/Functional/EntitySelectWidgetTest.php

@@ -102,7 +102,7 @@ public function testWidget() {
     // Check store 1.
     $edit['stores[target_id][value][' . $store_ids[0] . ']'] = $store_ids[0];
     $edit['stores[target_id][value][' . $store_ids[1] . ']'] = FALSE;
-    $this->submitForm($edit, t('Save and keep published'));
+    $this->submitForm($edit, t('Save'));
     $this->assertSession()->statusCodeEquals(200);
     \Drupal::entityTypeManager()->getStorage('commerce_product')->resetCache();
     $this->product = Product::load($this->product->id());
@@ -130,7 +130,7 @@ public function testWidget() {
     // Reference both stores 1 and 2.
     $edit = [];
     $edit['stores[target_id][value]'] = $store_labels[0] . ', ' . $store_labels[1];
-    $this->submitForm($edit, t('Save and keep published'));
+    $this->submitForm($edit, t('Save'));
     $this->assertSession()->statusCodeEquals(200);
     \Drupal::entityTypeManager()->getStorage('commerce_product')->resetCache();
     $this->product = Product::load($this->product->id());