1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
<?php
/**
* @author @jenschude <jens.schulze@commercetools.de>
*/
namespace Commercetools\Core\Request\Carts\Command;
use Commercetools\Core\Model\Cart\ExternalLineItemTotalPrice;
use Commercetools\Core\Model\Cart\ItemShippingDetailsDraft;
use Commercetools\Core\Model\Channel\ChannelReference;
use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Model\Common\Money;
use Commercetools\Core\Model\CustomField\CustomFieldObjectDraft;
use Commercetools\Core\Model\TaxCategory\ExternalTaxRateDraft;
use Commercetools\Core\Request\AbstractAction;
/**
* @package Commercetools\Core\Request\Carts\Command
* @link https://docs.commercetools.com/http-api-projects-carts.html#add-lineitem
* @method string getAction()
* @method CartAddLineItemAction setAction(string $action = null)
* @method string getProductId()
* @method CartAddLineItemAction setProductId(string $productId = null)
* @method int getVariantId()
* @method CartAddLineItemAction setVariantId(int $variantId = null)
* @method int getQuantity()
* @method CartAddLineItemAction setQuantity(int $quantity = null)
* @method ChannelReference getSupplyChannel()
* @method CartAddLineItemAction setSupplyChannel(ChannelReference $supplyChannel = null)
* @method ChannelReference getDistributionChannel()
* @method CartAddLineItemAction setDistributionChannel(ChannelReference $distributionChannel = null)
* @method CustomFieldObjectDraft getCustom()
* @method CartAddLineItemAction setCustom(CustomFieldObjectDraft $custom = null)
* @method ExternalTaxRateDraft getExternalTaxRate()
* @method CartAddLineItemAction setExternalTaxRate(ExternalTaxRateDraft $externalTaxRate = null)
* @method Money getExternalPrice()
* @method CartAddLineItemAction setExternalPrice(Money $externalPrice = null)
* @method ExternalLineItemTotalPrice getExternalTotalPrice()
* @method CartAddLineItemAction setExternalTotalPrice(ExternalLineItemTotalPrice $externalTotalPrice = null)
* @method string getSku()
* @method CartAddLineItemAction setSku(string $sku = null)
* @method ItemShippingDetailsDraft getShippingDetails()
* @method CartAddLineItemAction setShippingDetails(ItemShippingDetailsDraft $shippingDetails = null)
*/
class CartAddLineItemAction extends AbstractAction
{
public function fieldDefinitions()
{
return [
'action' => [static::TYPE => 'string'],
'productId' => [static::TYPE => 'string'],
'variantId' => [static::TYPE => 'int'],
'sku' => [static::TYPE => 'string'],
'quantity' => [static::TYPE => 'int'],
'supplyChannel' => [static::TYPE => ChannelReference::class],
'distributionChannel' => [static::TYPE => ChannelReference::class],
'custom' => [static::TYPE => CustomFieldObjectDraft::class],
'externalTaxRate' => [static::TYPE => ExternalTaxRateDraft::class],
'externalPrice' => [static::TYPE => Money::class],
'externalTotalPrice' => [static::TYPE => ExternalLineItemTotalPrice::class],
'shippingDetails' => [static::TYPE => ItemShippingDetailsDraft::class],
];
}
/**
* @param string $productId
* @param int $variantId
* @param Context|callable $context
* @param int $quantity
* @return CartAddLineItemAction
*/
public static function ofProductIdVariantIdAndQuantity($productId, $variantId, $quantity, $context = null)
{
return static::of($context)->setProductId($productId)->setVariantId($variantId)->setQuantity($quantity);
}
/**
* @param string $sku
* @param Context|callable $context
* @param int $quantity
* @return CartAddLineItemAction
*/
public static function ofSkuAndQuantity($sku, $quantity, $context = null)
{
return static::of($context)->setSku($sku)->setQuantity($quantity);
}
/**
* @param array $data
* @param Context|callable $context
*/
public function __construct(array $data = [], $context = null)
{
parent::__construct($data, $context);
$this->setAction('addLineItem');
}
}