Issue #2870672 by bojanz, vasike, Berdir: Product should implement EntityPublishedInterface

Author: berdir

modules/cart/tests/src/Functional/MultipleCartMultipleVariationTypesTest.php

@@ -43,7 +43,7 @@ class MultipleCartMultipleVariationTypesTest extends CartBrowserTestBase {
   protected function setUp() {
     parent::setUp();
     // Unpublish parent test product.
-    $this->variation->getProduct()->setPublished(FALSE);
+    $this->variation->getProduct()->setUnpublished();
     $this->variation->getProduct()->save();
 
     // Create three variation types.

modules/cart/tests/src/FunctionalJavascript/MultipleCartFormsTest.php

@@ -50,7 +50,7 @@ protected function setUp() {
     $this->maximumMetaRefreshCount = 0;
 
     // Delete parent test product.
-    $this->variation->getProduct()->setPublished(FALSE);
+    $this->variation->getProduct()->setUnpublished();
     $this->variation->getProduct()->save();
 
     /** @var \Drupal\Core\Entity\Entity\EntityFormDisplay $order_item_form_display */

modules/cart/tests/src/FunctionalJavascript/MultipleCartMultipleVariationTypesTest.php

@@ -48,7 +48,7 @@ class MultipleCartMultipleVariationTypesTest extends CartBrowserTestBase {
   protected function setUp() {
     parent::setUp();
     // Unpublish parent test product.
-    $this->variation->getProduct()->setPublished(FALSE);
+    $this->variation->getProduct()->setUnpublished();
     $this->variation->getProduct()->save();
 
     // Create three variation types.
@@ -83,12 +83,16 @@ protected function setUp() {
       $this->sizeAttributes[$key] = $this->createAttributeValue($size_attribute->id(), $value);
     }
 
-    // The error seems to occur when variation with one attribute is first.
-    // So remove title sort. Otherwise if first product has both attributes,
-    // all seems to be fine.
+    // The error seems to occur when the variation with one attribute is first.
+    // So replace the title sort with a product_id one. Otherwise if the first
+    // product has both attributes, all seems to be fine.
     $view = View::load('test_multiple_cart_forms');
     $display =& $view->getDisplay('default');
-    $display['display_options']['sorts'] = [];
+    $display['display_options']['sorts']['product_id'] = $display['display_options']['sorts']['title'];
+    $display['display_options']['sorts']['product_id']['id'] = 'product_id';
+    $display['display_options']['sorts']['product_id']['field'] = 'product_id';
+    $display['display_options']['sorts']['product_id']['entity_field'] = 'product_id';
+    unset($display['display_options']['sorts']['title']);
     $view->save();
 
     // Create products.

modules/product/commerce_product.install

@@ -19,3 +19,16 @@ function commerce_product_update_8201() {
     }
   }
 }
+
+/**
+ * Set the 'published' entity key.
+ */
+function commerce_product_update_8202() {
+  $definition_update_manager = \Drupal::entityDefinitionUpdateManager();
+  $entity_type = $definition_update_manager->getEntityType('commerce_product');
+  $keys = $entity_type->getKeys();
+  $keys['published'] = 'status';
+  unset($keys['status']);
+  $entity_type->set('entity_keys', $keys);
+  $definition_update_manager->updateEntityType($entity_type);
+}

modules/product/src/Entity/Product.php

@@ -2,12 +2,13 @@
 
 namespace Drupal\commerce_product\Entity;
 
-use Drupal\user\UserInterface;
+use Drupal\Core\Entity\EntityPublishedTrait;
 use Drupal\Core\Entity\ContentEntityBase;
 use Drupal\Core\Entity\EntityChangedTrait;
 use Drupal\Core\Entity\EntityStorageInterface;
 use Drupal\Core\Entity\EntityTypeInterface;
 use Drupal\Core\Field\BaseFieldDefinition;
+use Drupal\user\UserInterface;
 
 /**
  * Defines the product entity class.
@@ -55,7 +56,7 @@
  *     "label" = "title",
  *     "langcode" = "langcode",
  *     "uuid" = "uuid",
- *     "status" = "status",
+ *     "published" = "status",
  *   },
  *   links = {
  *     "canonical" = "/product/{commerce_product}",
@@ -73,6 +74,7 @@
 class Product extends ContentEntityBase implements ProductInterface {
 
   use EntityChangedTrait;
+  use EntityPublishedTrait;
 
   /**
    * {@inheritdoc}
@@ -89,21 +91,6 @@ public function setTitle($title) {
     return $this;
   }
 
-  /**
-   * {@inheritdoc}
-   */
-  public function isPublished() {
-    return (bool) $this->getEntityKey('status');
-  }
-
-  /**
-   * {@inheritdoc}
-   */
-  public function setPublished($published) {
-    $this->set('status', (bool) $published);
-    return $this;
-  }
-
   /**
    * {@inheritdoc}
    */
@@ -347,6 +334,7 @@ public static function postDelete(EntityStorageInterface $storage, array $entiti
    */
   public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
     $fields = parent::baseFieldDefinitions($entity_type);
+    $fields += static::publishedBaseFieldDefinitions($entity_type);
 
     $fields['uid'] = BaseFieldDefinition::create('entity_reference')
       ->setLabel(t('Author'))
@@ -393,11 +381,14 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
       ->setDisplayConfigurable('form', TRUE)
       ->setComputed(TRUE);
 
-    $fields['status'] = BaseFieldDefinition::create('boolean')
-      ->setLabel(t('Published'))
-      ->setDescription(t('Whether the product is published.'))
-      ->setDefaultValue(TRUE)
-      ->setTranslatable(TRUE)
+    $fields['status']
+      ->setDisplayOptions('form', [
+        'type' => 'boolean_checkbox',
+        'settings' => [
+          'display_label' => TRUE,
+        ],
+        'weight' => 90,
+      ])
       ->setDisplayConfigurable('form', TRUE);
 
     $fields['created'] = BaseFieldDefinition::create('created')

modules/product/src/Entity/ProductInterface.php

@@ -5,12 +5,13 @@
 use Drupal\commerce_store\Entity\EntityStoresInterface;
 use Drupal\Core\Entity\ContentEntityInterface;
 use Drupal\Core\Entity\EntityChangedInterface;
+use Drupal\Core\Entity\EntityPublishedInterface;
 use Drupal\user\EntityOwnerInterface;
 
 /**
  * Defines the interface for products.
  */
-interface ProductInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface, EntityStoresInterface {
+interface ProductInterface extends ContentEntityInterface, EntityChangedInterface, EntityOwnerInterface, EntityPublishedInterface, EntityStoresInterface {
 
   /**
    * Gets the product title.
@@ -30,26 +31,6 @@ public function getTitle();
    */
   public function setTitle($title);
 
-  /**
-   * Get whether the product is published.
-   *
-   * Unpublished products are only visible to their authors and administrators.
-   *
-   * @return bool
-   *   TRUE if the product is published, FALSE otherwise.
-   */
-  public function isPublished();
-
-  /**
-   * Sets whether the product is published.
-   *
-   * @param bool $published
-   *   Whether the product is published.
-   *
-   * @return $this
-   */
-  public function setPublished($published);
-
   /**
    * Gets the product creation timestamp.
    *

modules/product/src/Plugin/Action/UnpublishProduct.php

@@ -21,7 +21,7 @@ class UnpublishProduct extends ActionBase {
    */
   public function execute($entity = NULL) {
     /** @var \Drupal\commerce_product\Entity\ProductInterface $entity */
-    $entity->setPublished(FALSE);
+    $entity->setUnpublished();
     $entity->save();
   }
 

modules/product/tests/src/Kernel/Entity/ProductTest.php

@@ -49,8 +49,6 @@ protected function setUp() {
   /**
    * @covers ::getTitle
    * @covers ::setTitle
-   * @covers ::isPublished
-   * @covers ::setPublished
    * @covers ::getCreatedTime
    * @covers ::setCreatedTime
    * @covers ::getStores
@@ -71,10 +69,6 @@ public function testProduct() {
     $product->setTitle('My title');
     $this->assertEquals('My title', $product->getTitle());
 
-    $this->assertEquals(TRUE, $product->isPublished());
-    $product->setPublished(FALSE);
-    $this->assertEquals(FALSE, $product->isPublished());
-
     $product->setCreatedTime(635879700);
     $this->assertEquals(635879700, $product->getCreatedTime());