CTP SDK : File Core/Request/Carts/Command/CartAddCustomLineItemAction.php

  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  99 100 101 102 103

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 */

namespace Commercetools\Core\Request\Carts\Command;

use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Model\Common\LocalizedString;
use Commercetools\Core\Model\Common\Money;
use Commercetools\Core\Request\AbstractAction;
use Commercetools\Core\Model\TaxCategory\TaxCategoryReference;
use Commercetools\Core\Model\CustomField\CustomFieldObjectDraft;
use Commercetools\Core\Model\TaxCategory\ExternalTaxRateDraft;

/**
 * @package Commercetools\Core\Request\Carts\Command
 * @link https://docs.commercetools.com/http-api-projects-carts.html#add-customlineitem
 * @method string getAction()
 * @method CartAddCustomLineItemAction setAction(string $action = null)
 * @method LocalizedString getName()
 * @method CartAddCustomLineItemAction setName(LocalizedString $name = null)
 * @method int getQuantity()
 * @method CartAddCustomLineItemAction setQuantity(int $quantity = null)
 * @method Money getMoney()
 * @method CartAddCustomLineItemAction setMoney(Money $money = null)
 * @method string getSlug()
 * @method CartAddCustomLineItemAction setSlug(string $slug = null)
 * @method TaxCategoryReference getTaxCategory()
 * @method CartAddCustomLineItemAction setTaxCategory(TaxCategoryReference $taxCategory = null)
 * @method CustomFieldObjectDraft getCustom()
 * @method CartAddCustomLineItemAction setCustom(CustomFieldObjectDraft $custom = null)
 * @method ExternalTaxRateDraft getExternalTaxRate()
 * @method CartAddCustomLineItemAction setExternalTaxRate(ExternalTaxRateDraft $externalTaxRate = null)
 */
class CartAddCustomLineItemAction extends AbstractAction
{
    public function fieldDefinitions()
    {
        return [
            'action' => [static::TYPE => 'string'],
            'name' => [static::TYPE => LocalizedString::class],
            'quantity' => [static::TYPE => 'int'],
            'money' => [static::TYPE => Money::class],
            'slug' => [static::TYPE => 'string'],
            'taxCategory' => [static::TYPE => TaxCategoryReference::class],
            'custom' => [static::TYPE => CustomFieldObjectDraft::class],
            'externalTaxRate' => [static::TYPE => ExternalTaxRateDraft::class],
        ];
    }

    /**
     * @param array $data
     * @param Context|callable $context
     */
    public function __construct(array $data = [], $context = null)
    {
        parent::__construct($data, $context);
        $this->setAction('addCustomLineItem');
    }

    /**
     * @param LocalizedString $name
     * @param int $quantity
     * @param Money $money
     * @param string $slug
     * @param TaxCategoryReference $taxCategory
     * @param Context|callable $context
     * @return CartAddCustomLineItemAction
     */
    public static function ofNameQuantityMoneySlugAndTaxCategory(
        LocalizedString $name,
        $quantity,
        Money $money,
        $slug,
        TaxCategoryReference $taxCategory,
        $context = null
    ) {
        return static::of($context)
            ->setName($name)
            ->setQuantity($quantity)
            ->setMoney($money)
            ->setSlug($slug)
            ->setTaxCategory($taxCategory);
    }

    public static function ofNameQuantityMoneySlugAndExternalTaxRate(
        LocalizedString $name,
        $quantity,
        Money $money,
        $slug,
        ExternalTaxRateDraft $externalTaxRate,
        $context = null
    ) {
        return static::of($context)
            ->setName($name)
            ->setQuantity($quantity)
            ->setMoney($money)
            ->setSlug($slug)
            ->setExternalTaxRate($externalTaxRate);
    }
}

Namespaces

Classes