Issue #2922811 by bradjones1, bojanz: Deprecate BundleFieldDefinition and BundlePluginInterface

bradjones1 · bojanz · commit 654bf3db4c1a · 2017-12-02T21:29:10.000+01:00
diff --git a/modules/order/commerce_order.module b/modules/order/commerce_order.module
@@ -5,7 +5,7 @@
  * Defines the Order entity and associated features.
  */
 
-use Drupal\commerce\BundleFieldDefinition;
+use Drupal\entity\BundleFieldDefinition;
 use Drupal\commerce_order\Entity\OrderTypeInterface;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Render\Element;
diff --git a/modules/payment/src/Plugin/Commerce/PaymentMethodType/CreditCard.php b/modules/payment/src/Plugin/Commerce/PaymentMethodType/CreditCard.php
@@ -2,7 +2,7 @@
 
 namespace Drupal\commerce_payment\Plugin\Commerce\PaymentMethodType;
 
-use Drupal\commerce\BundleFieldDefinition;
+use Drupal\entity\BundleFieldDefinition;
 use Drupal\commerce_payment\CreditCard as CreditCardHelper;
 use Drupal\commerce_payment\Entity\PaymentMethodInterface;
 
diff --git a/modules/payment/src/Plugin/Commerce/PaymentMethodType/PayPal.php b/modules/payment/src/Plugin/Commerce/PaymentMethodType/PayPal.php
@@ -2,7 +2,7 @@
 
 namespace Drupal\commerce_payment\Plugin\Commerce\PaymentMethodType;
 
-use Drupal\commerce\BundleFieldDefinition;
+use Drupal\entity\BundleFieldDefinition;
 use Drupal\commerce_payment\Entity\PaymentMethodInterface;
 
 /**
diff --git a/modules/payment/src/Plugin/Commerce/PaymentMethodType/PaymentMethodTypeInterface.php b/modules/payment/src/Plugin/Commerce/PaymentMethodType/PaymentMethodTypeInterface.php
@@ -2,7 +2,7 @@
 
 namespace Drupal\commerce_payment\Plugin\Commerce\PaymentMethodType;
 
-use Drupal\commerce\BundlePluginInterface;
+use Drupal\entity\BundlePlugin\BundlePluginInterface;
 use Drupal\commerce_payment\Entity\PaymentMethodInterface;
 
 /**
diff --git a/modules/payment/src/Plugin/Commerce/PaymentType/PaymentTypeInterface.php b/modules/payment/src/Plugin/Commerce/PaymentType/PaymentTypeInterface.php
@@ -2,7 +2,7 @@
 
 namespace Drupal\commerce_payment\Plugin\Commerce\PaymentType;
 
-use Drupal\commerce\BundlePluginInterface;
+use Drupal\entity\BundlePlugin\BundlePluginInterface;
 
 /**
  * Defines the interface for payment types.
diff --git a/modules/product/commerce_product.module b/modules/product/commerce_product.module
@@ -5,7 +5,7 @@
  * Defines the Product entity and associated features.
  */
 
-use Drupal\commerce\BundleFieldDefinition;
+use Drupal\entity\BundleFieldDefinition;
 use Drupal\commerce_product\Entity\ProductTypeInterface;
 use Drupal\Core\Cache\Cache;
 use Drupal\Core\Form\FormStateInterface;
diff --git a/src/BundleFieldDefinition.php b/src/BundleFieldDefinition.php
@@ -2,11 +2,15 @@
 
 namespace Drupal\commerce;
 
+@trigger_error('The ' . __NAMESPACE__ . '\BundleFieldDefinition is deprecated. Instead, use \Drupal\entity\BundleFieldDefinition', E_USER_DEPRECATED);
+
 use Drupal\entity\BundleFieldDefinition as BaseBundleFieldDefinition;
 
 /**
  * Provides a field definition class for bundle fields.
  *
  * Note: This code has moved to Entity API, see the parent class.
+ *
+ * @deprecated in Commerce 2.0
  */
 class BundleFieldDefinition extends BaseBundleFieldDefinition {}
diff --git a/src/BundlePluginInterface.php b/src/BundlePluginInterface.php
@@ -2,11 +2,15 @@
 
 namespace Drupal\commerce;
 
+@trigger_error('The ' . __NAMESPACE__ . '\BundlePluginInterface is deprecated. Instead, use \Drupal\entity\BundlePlugin\BundlePluginInterface', E_USER_DEPRECATED);
+
 use Drupal\entity\BundlePlugin\BundlePluginInterface as BaseBundlePluginInterface;
 
 /**
  * Interface for plugins which act as entity bundles.
  *
  * Note: This code has moved to Entity API, see the parent class.
+ *
+ * @deprecated in Commerce 2.0
  */
 interface BundlePluginInterface extends BaseBundlePluginInterface {}
diff --git a/src/ConfigurableFieldManager.php b/src/ConfigurableFieldManager.php
@@ -5,6 +5,7 @@
 use Drupal\Core\Entity\EntityTypeManagerInterface;
 use Drupal\field\Entity\FieldConfig;
 use Drupal\field\Entity\FieldStorageConfig;
+use Drupal\entity\BundleFieldDefinition;
 
 class ConfigurableFieldManager implements ConfigurableFieldManagerInterface {
 
diff --git a/src/ConfigurableFieldManagerInterface.php b/src/ConfigurableFieldManagerInterface.php
@@ -2,6 +2,8 @@
 
 namespace Drupal\commerce;
 
+use Drupal\entity\BundleFieldDefinition;
+
 /**
  * Manages configurable fields based on field definitions.
  *
@@ -12,7 +14,7 @@ interface ConfigurableFieldManagerInterface {
   /**
    * Creates a configurable field from the given field definition.
    *
-   * @param \Drupal\commerce\BundleFieldDefinition $field_definition
+   * @param \Drupal\entity\BundleFieldDefinition $field_definition
    *   The field definition.
    * @param bool $lock
    *   Whether the created field should be locked.
@@ -28,7 +30,7 @@ public function createField(BundleFieldDefinition $field_definition, $lock = TRU
   /**
    * Deletes the configurable field created from the given field definition.
    *
-   * @param \Drupal\commerce\BundleFieldDefinition $field_definition
+   * @param \Drupal\entity\BundleFieldDefinition $field_definition
    *   The field definition.
    *
    * @throws \InvalidArgumentException
@@ -42,7 +44,7 @@ public function deleteField(BundleFieldDefinition $field_definition);
   /**
    * Checks whether the configurable field has data.
    *
-   * @param \Drupal\commerce\BundleFieldDefinition $field_definition
+   * @param \Drupal\entity\BundleFieldDefinition $field_definition
    *   The field definition.
    *
    * @return bool
diff --git a/src/Plugin/Commerce/EntityTrait/EntityTraitInterface.php b/src/Plugin/Commerce/EntityTrait/EntityTraitInterface.php
@@ -38,7 +38,7 @@ public function getEntityTypeIds();
    * THe provided field definitions will be created as configurable
    * fields when the entity trait is installed for an entity type/bundle.
    *
-   * @return \Drupal\commerce\BundleFieldDefinition[]
+   * @return \Drupal\entity\BundleFieldDefinition[]
    *   An array of field definitions, keyed by field name.
    */
   public function buildFieldDefinitions();
diff --git a/tests/modules/commerce_test/src/Plugin/Commerce/EntityTrait/First.php b/tests/modules/commerce_test/src/Plugin/Commerce/EntityTrait/First.php
@@ -2,7 +2,7 @@
 
 namespace Drupal\commerce_test\Plugin\Commerce\EntityTrait;
 
-use Drupal\commerce\BundleFieldDefinition;
+use Drupal\entity\BundleFieldDefinition;
 use Drupal\commerce\Plugin\Commerce\EntityTrait\EntityTraitBase;
 
 /**
diff --git a/tests/modules/commerce_test/src/Plugin/Commerce/EntityTrait/Second.php b/tests/modules/commerce_test/src/Plugin/Commerce/EntityTrait/Second.php
@@ -2,7 +2,7 @@
 
 namespace Drupal\commerce_test\Plugin\Commerce\EntityTrait;
 
-use Drupal\commerce\BundleFieldDefinition;
+use Drupal\entity\BundleFieldDefinition;
 use Drupal\commerce\Plugin\Commerce\EntityTrait\EntityTraitBase;
 
 /**
diff --git a/tests/src/Kernel/ConfigurableFieldManagerTest.php b/tests/src/Kernel/ConfigurableFieldManagerTest.php
@@ -2,7 +2,7 @@
 
 namespace Drupal\Tests\commerce\Kernel;
 
-use Drupal\commerce\BundleFieldDefinition;
+use Drupal\entity\BundleFieldDefinition;
 use Drupal\entity_test\Entity\EntityTest;
 use Drupal\field\Entity\FieldConfig;
 

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,8 @@`
`2`	`2`
`3`	`3`	`namespace Drupal\commerce;`
`4`	`4`
	`5`	`+use Drupal\entity\BundleFieldDefinition;`
	`6`	`+`
`5`	`7`	`/**`
`6`	`8`	`* Manages configurable fields based on field definitions.`
`7`	`9`	`*`
`@@ -12,7 +14,7 @@ interface ConfigurableFieldManagerInterface {`
`12`	`14`	`/**`
`13`	`15`	`* Creates a configurable field from the given field definition.`
`14`	`16`	`*`
`15`		`- * @param \Drupal\commerce\BundleFieldDefinition $field_definition`
	`17`	`+ * @param \Drupal\entity\BundleFieldDefinition $field_definition`
`16`	`18`	`* The field definition.`
`17`	`19`	`* @param bool $lock`
`18`	`20`	`* Whether the created field should be locked.`
`@@ -28,7 +30,7 @@ public function createField(BundleFieldDefinition $field_definition, $lock = TRU`
`28`	`30`	`/**`
`29`	`31`	`* Deletes the configurable field created from the given field definition.`
`30`	`32`	`*`
`31`		`- * @param \Drupal\commerce\BundleFieldDefinition $field_definition`
	`33`	`+ * @param \Drupal\entity\BundleFieldDefinition $field_definition`
`32`	`34`	`* The field definition.`
`33`	`35`	`*`
`34`	`36`	`* @throws \InvalidArgumentException`
`@@ -42,7 +44,7 @@ public function deleteField(BundleFieldDefinition $field_definition);`
`42`	`44`	`/**`
`43`	`45`	`* Checks whether the configurable field has data.`
`44`	`46`	`*`
`45`		`- * @param \Drupal\commerce\BundleFieldDefinition $field_definition`
	`47`	`+ * @param \Drupal\entity\BundleFieldDefinition $field_definition`
`46`	`48`	`* The field definition.`
`47`	`49`	`*`
`48`	`50`	`* @return bool`