Issue #2844178 by floretan: Add data to order items

Author: floretan

modules/order/commerce_order.install

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * @file
+ * Install, update and uninstall functions for the Order module.
+ */
+
+use Drupal\Core\Field\BaseFieldDefinition;
+
+/**
+ * Add the 'data' field to 'commerce_order_item' entities.
+ */
+function commerce_order_update_8201() {
+  $storage_definition = BaseFieldDefinition::create('map')
+    ->setLabel(t('Data'))
+    ->setDescription(t('A serialized array of additional data.'));
+
+  $update_manager = \Drupal::entityDefinitionUpdateManager();
+  $update_manager->installFieldStorageDefinition('data', 'commerce_order_item', 'commerce_order', $storage_definition);
+}

modules/order/src/Entity/OrderInterface.php

@@ -294,8 +294,8 @@ public function setRefreshState($refresh_state);
    * @param mixed $default
    *   The default value.
    *
-   * @return array
-   *   The order data.
+   * @return mixed
+   *   The value.
    */
   public function getData($key, $default = NULL);
 

modules/order/src/Entity/OrderItem.php

@@ -166,6 +166,25 @@ public function getTotalPrice() {
     }
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function getData($key, $default = NULL) {
+    $data = [];
+    if (!$this->get('data')->isEmpty()) {
+      $data = $this->get('data')->first()->getValue();
+    }
+    return isset($data[$key]) ? $data[$key] : $default;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setData($key, $value) {
+    $this->get('data')->__set($key, $value);
+    return $this;
+  }
+
   /**
    * {@inheritdoc}
    */
@@ -275,6 +294,10 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
       ->setDisplayConfigurable('form', FALSE)
       ->setDisplayConfigurable('view', TRUE);
 
+    $fields['data'] = BaseFieldDefinition::create('map')
+      ->setLabel(t('Data'))
+      ->setDescription(t('A serialized array of additional data.'));
+
     $fields['created'] = BaseFieldDefinition::create('created')
       ->setLabel(t('Created'))
       ->setDescription(t('The time when the order item was created.'))

modules/order/src/Entity/OrderItemInterface.php

@@ -106,6 +106,33 @@ public function setUnitPrice(Price $unit_price);
    */
   public function getTotalPrice();
 
+  /**
+   * Gets an order item data value with the given key.
+   *
+   * Used to store temporary data during order processing (i.e. checkout).
+   *
+   * @param string $key
+   *   The key.
+   * @param mixed $default
+   *   The default value.
+   *
+   * @return mixed
+   *   The value.
+   */
+  public function getData($key, $default = NULL);
+
+  /**
+   * Sets an order item data value with the given key.
+   *
+   * @param string $key
+   *   The key.
+   * @param mixed $value
+   *   The value.
+   *
+   * @return $this
+   */
+  public function setData($key, $value);
+
   /**
    * Gets the order item creation timestamp.
    *

modules/order/tests/src/Kernel/Entity/OrderItemTest.php

@@ -64,6 +64,8 @@ protected function setUp() {
    * @covers ::removeAdjustment
    * @covers ::recalculateTotalPrice
    * @covers ::getTotalPrice
+   * @covers ::getData
+   * @covers ::setData
    * @covers ::getCreatedTime
    * @covers ::setCreatedTime
    */
@@ -106,6 +108,10 @@ public function testOrderItem() {
     $order_item->setAdjustments($adjustments);
     $this->assertEquals($adjustments, $order_item->getAdjustments());
 
+    $this->assertEquals('default', $order_item->getData('test', 'default'));
+    $order_item->setData('test', 'value');
+    $this->assertEquals('value', $order_item->getData('test', 'default'));
+
     $order_item->setCreatedTime(635879700);
     $this->assertEquals(635879700, $order_item->getCreatedTime());
   }