WishlistPurchaseItem.php in Commerce Wishlist 8.3

Namespace

Drupal\commerce_wishlist\Plugin\Field\FieldType

File

src/Plugin/Field/FieldType/WishlistPurchaseItem.php

<?php

namespace Drupal\commerce_wishlist\Plugin\Field\FieldType;

use Drupal\commerce_wishlist\WishlistPurchase;
use Drupal\Core\Field\FieldItemBase;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\TypedData\DataDefinition;
use Drupal\Core\TypedData\DataReferenceTargetDefinition;

/**
 * Plugin implementation of the 'commerce_wishlist_purchase' field type.
 *
 * @FieldType(
 *   id = "commerce_wishlist_purchase",
 *   label = @Translation("Wishlist purchase"),
 *   description = @Translation("Stores wishlist purchases."),
 *   category = @Translation("Commerce"),
 *   list_class = "\Drupal\commerce_wishlist\Plugin\Field\FieldType\WishlistPurchaseItemList",
 *   default_formatter = "commerce_wishlist_purchase_default",
 * )
 */
class WishlistPurchaseItem extends FieldItemBase {

  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $storage) {
    $properties = [];
    $properties['order_id'] = DataReferenceTargetDefinition::create('integer')
      ->setLabel(t('Order ID'))
      ->setSetting('unsigned', TRUE);
    $properties['quantity'] = DataDefinition::create('string')
      ->setLabel(t('Quantity'))
      ->setRequired(TRUE);
    $properties['purchased'] = DataDefinition::create('timestamp')
      ->setLabel(t('Purchase time'))
      ->setRequired(TRUE);
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public static function mainPropertyName() {
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $storage) {
    $columns = [];
    $columns['order_id'] = [
      'type' => 'int',
      'default' => 0,
      'unsigned' => TRUE,
    ];
    $columns['quantity'] = [
      'type' => 'numeric',
      'default' => 1,
      'unsigned' => TRUE,
    ];
    $columns['purchased'] = [
      'type' => 'int',
      'default' => 0,
      'unsigned' => TRUE,
    ];
    return [
      'columns' => $columns,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    return empty($this->order_id) || empty($this->quantity) || empty($this->purchased);
  }

  /**
   * {@inheritdoc}
   */
  public function setValue($values, $notify = TRUE) {

    // Allow callers to pass a purchase value object as the field item value.
    if ($values instanceof WishlistPurchase) {
      $purchase = $values;
      $values = [
        'order_id' => $purchase
          ->getOrderId(),
        'quantity' => $purchase
          ->getQuantity(),
        'purchased' => $purchase
          ->getPurchasedTime(),
      ];
    }
    parent::setValue($values, $notify);
  }

  /**
   * Gets the purchase value object for the current field item.
   *
   * @return \Drupal\commerce_wishlist\WishlistPurchase
   *   The purchase.
   */
  public function toPurchase() {
    return new WishlistPurchase($this->order_id, $this->quantity, $this->purchased);
  }

}

Classes

Name	Description
WishlistPurchaseItem	Plugin implementation of the 'commerce_wishlist_purchase' field type.