issue #2859570 Create a generic entity bundle delete form (#688)

finnef · bojanz · commit 9131c8fe675c · 2017-04-21T16:09:43.000+02:00
diff --git a/modules/order/src/Entity/OrderItemType.php b/modules/order/src/Entity/OrderItemType.php
@@ -21,7 +21,7 @@
  *     "form" = {
  *       "add" = "Drupal\commerce_order\Form\OrderItemTypeForm",
  *       "edit" = "Drupal\commerce_order\Form\OrderItemTypeForm",
- *       "delete" = "Drupal\commerce_order\Form\OrderItemTypeDeleteForm"
+ *       "delete" = "Drupal\commerce\Form\CommerceBundleEntityDeleteFormBase"
  *     },
  *     "route_provider" = {
  *       "default" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
diff --git a/modules/order/src/Entity/OrderType.php b/modules/order/src/Entity/OrderType.php
@@ -21,7 +21,7 @@
  *     "form" = {
  *       "add" = "Drupal\commerce_order\Form\OrderTypeForm",
  *       "edit" = "Drupal\commerce_order\Form\OrderTypeForm",
- *       "delete" = "Drupal\commerce_order\Form\OrderTypeDeleteForm"
+ *       "delete" = "Drupal\commerce\Form\CommerceBundleEntityDeleteFormBase"
  *     },
  *     "route_provider" = {
  *       "default" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
diff --git a/modules/order/src/Form/OrderItemTypeDeleteForm.php b/modules/order/src/Form/OrderItemTypeDeleteForm.php
diff --git a/modules/order/src/Form/OrderTypeDeleteForm.php b/modules/order/src/Form/OrderTypeDeleteForm.php
diff --git a/modules/order/tests/src/Functional/OrderTypeTest.php b/modules/order/tests/src/Functional/OrderTypeTest.php
@@ -89,7 +89,7 @@ public function testDeleteOrderType() {
 
     // Try to delete the order type.
     $this->drupalGet('admin/commerce/config/order-types/' . $type->id() . '/delete');
-    $this->assertSession()->pageTextContains(t('@type is used by 1 order on your site. You can not remove this order type until you have removed all of the @type orders.', ['@type' => $type->label()]));
+    $this->assertSession()->pageTextContains(t('@type is used by 1 order on your site. You cannot remove this order type until you have removed all of the @type orders.', ['@type' => $type->label()]));
     $this->assertSession()->pageTextNotContains(t('This action cannot be undone.'));
 
     // Deleting the order type when its not being referenced by an order.
diff --git a/modules/product/src/Entity/ProductType.php b/modules/product/src/Entity/ProductType.php
@@ -22,7 +22,7 @@
  *     "form" = {
  *       "add" = "Drupal\commerce_product\Form\ProductTypeForm",
  *       "edit" = "Drupal\commerce_product\Form\ProductTypeForm",
- *       "delete" = "Drupal\commerce_product\Form\ProductTypeDeleteForm"
+ *       "delete" = "Drupal\commerce\Form\CommerceBundleEntityDeleteFormBase"
  *     },
  *     "route_provider" = {
  *       "default" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
diff --git a/modules/product/src/Entity/ProductVariationType.php b/modules/product/src/Entity/ProductVariationType.php
@@ -22,7 +22,7 @@
  *     "form" = {
  *       "add" = "Drupal\commerce_product\Form\ProductVariationTypeForm",
  *       "edit" = "Drupal\commerce_product\Form\ProductVariationTypeForm",
- *       "delete" = "Drupal\commerce_product\Form\ProductVariationTypeDeleteForm"
+ *       "delete" = "Drupal\commerce\Form\CommerceBundleEntityDeleteFormBase"
  *     },
  *     "route_provider" = {
  *       "default" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
diff --git a/modules/product/src/Form/ProductTypeDeleteForm.php b/modules/product/src/Form/ProductTypeDeleteForm.php
diff --git a/modules/product/src/Form/ProductVariationTypeDeleteForm.php b/modules/product/src/Form/ProductVariationTypeDeleteForm.php
diff --git a/modules/product/tests/src/Functional/ProductTypeTest.php b/modules/product/tests/src/Functional/ProductTypeTest.php
@@ -100,7 +100,7 @@ public function testProductTypeDeletion() {
     // a product of that type. Right now the check is done on the form level.
     $this->drupalGet('admin/commerce/config/product-types/' . $product_type->id() . '/delete');
     $this->assertSession()->pageTextContains(
-      t('@type is used by 1 product on your site. You can not remove this product type until you have removed all of the @type products.', ['@type' => $product_type->label()]),
+      t('@type is used by 1 product on your site. You cannot remove this product type until you have removed all of the @type products.', ['@type' => $product_type->label()]),
       'The product type will not be deleted until all products of that type are deleted.'
     );
     $this->assertSession()->pageTextNotContains(t('This action cannot be undone.'));
diff --git a/modules/product/tests/src/Functional/ProductVariationTypeTest.php b/modules/product/tests/src/Functional/ProductVariationTypeTest.php
@@ -93,7 +93,7 @@ public function testProductVariationTypeDeletion() {
     // a variation of that type. Right now the check is done on the form level.
     $this->drupalGet('admin/commerce/config/product-variation-types/' . $variation_type->id() . '/delete');
     $this->assertSession()->pageTextContains(
-      t('@type is used by 1 product variation on your site. You can not remove this product variation type until you have removed all of the @type product variations.', ['@type' => $variation_type->label()]),
+      t('@type is used by 1 product variation on your site. You cannot remove this product variation type until you have removed all of the @type product variations.', ['@type' => $variation_type->label()]),
       'The product variation type will not be deleted until all variations of that type are deleted.'
     );
     $this->assertSession()->pageTextNotContains(t('This action cannot be undone.'), 'The product variation type deletion confirmation form is not available');
diff --git a/modules/store/src/Entity/StoreType.php b/modules/store/src/Entity/StoreType.php
@@ -22,7 +22,7 @@
  *     "form" = {
  *       "add" = "Drupal\commerce_store\Form\StoreTypeForm",
  *       "edit" = "Drupal\commerce_store\Form\StoreTypeForm",
- *       "delete" = "Drupal\commerce_store\Form\StoreTypeDeleteForm"
+ *       "delete" = "Drupal\commerce\Form\CommerceBundleEntityDeleteFormBase"
  *     },
  *     "route_provider" = {
  *       "default" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
diff --git a/modules/store/src/Form/StoreTypeDeleteForm.php b/modules/store/src/Form/StoreTypeDeleteForm.php
diff --git a/modules/store/tests/src/Functional/StoreTypeTest.php b/modules/store/tests/src/Functional/StoreTypeTest.php
@@ -108,7 +108,7 @@ public function testDeleteStoreType() {
 
     // Try to delete the store type.
     $this->drupalGet('admin/commerce/config/store-types/' . $type->id() . '/delete');
-    $this->assertSession()->pageTextContains(t('@type is used by 1 store on your site. You can not remove this store type until you have removed all of the @type stores.', ['@type' => $type->label()]));
+    $this->assertSession()->pageTextContains(t('@type is used by 1 store on your site. You cannot remove this store type until you have removed all of the @type stores.', ['@type' => $type->label()]));
     $this->assertSession()->pageTextNotContains('This action cannot be undone.');
     $this->assertSession()->pageTextNotContains('The store type deletion confirmation form is not available');
 
diff --git a/src/Form/CommerceBundleEntityDeleteFormBase.php b/src/Form/CommerceBundleEntityDeleteFormBase.php
@@ -0,0 +1,44 @@
+<?php
+
+namespace Drupal\commerce\Form;
+
+use Drupal\Core\Entity\EntityDeleteForm;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Provides a generic form for deleting bundle entities.
+ */
+class CommerceBundleEntityDeleteFormBase extends EntityDeleteForm {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state) {
+    /** @var \Drupal\Core\Config\Entity\ConfigEntityType $bundle_entity_type */
+    $bundle_entity_type = $this->entityTypeManager->getDefinition($this->entity->getEntityTypeId());
+    /** @var \Drupal\Core\Entity\ContentEntityType $content_entity_type */
+    $content_entity_type = $this->entityTypeManager->getDefinition($bundle_entity_type->getBundleOf());
+    $usage_count = $this->entityTypeManager->getStorage($content_entity_type->id())
+      ->getQuery()
+      ->condition($content_entity_type->getKey('bundle'), $this->entity->id())
+      ->count()
+      ->execute();
+    if ($usage_count) {
+      $caption = '<p>' . $this->formatPlural($usage_count,
+          '%type is used by 1 %entity on your site. You cannot remove this %entity_type until you have removed all of the %type %entities.',
+          '%type is used by @count %entities on your site. You cannot remove this %entity_type until you have removed all of the %type %entities.',
+          [
+            '%type' => $this->entity->label(),
+            '%entity' => $content_entity_type->getSingularLabel(),
+            '%entities' => $content_entity_type->getPluralLabel(),
+            '%entity_type' => $content_entity_type->getBundleLabel(),
+          ]) . '</p>';
+      $form['#title'] = $this->getQuestion();
+      $form['description'] = ['#markup' => $caption];
+      return $form;
+    }
+
+    return parent::buildForm($form, $form_state);
+  }
+
+}
