OrderCreateFromCartRequest::setState() - Code Metrics - Inspection of "PHP SDK maintainance" - commercetools/commercetools-php-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Pull Request — develop (#678)

by Jens
created 2022-01-11 13:19 UTC
OrderCreateFromCartRequest::setState() A

↳ Parent: OrderCreateFromCartRequest
Complexity

Conditions	1
Paths	1
Size

Total Lines	5
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
eloc	2
c	0
b	0
f	0
dl	0
loc	5
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1
<?php
/**
 * @author @jenschude <[email protected]>
 */

namespace Commercetools\Core\Request\Orders;

use Commercetools\Core\Model\Cart\CartReference;
use Commercetools\Core\Model\State\StateReference;
use Commercetools\Core\Request\InStores\InStoreRequestDecorator;
use Commercetools\Core\Request\InStores\InStoreTrait;
use Psr\Http\Message\ResponseInterface;
use Commercetools\Core\Client\HttpMethod;
use Commercetools\Core\Client\JsonRequest;
use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Request\AbstractApiRequest;
use Commercetools\Core\Response\AbstractApiResponse;
use Commercetools\Core\Response\ResourceResponse;
use Commercetools\Core\Model\Order\Order;
use Commercetools\Core\Response\ApiResponseInterface;
use Commercetools\Core\Model\MapperInterface;

/**
 * @package Commercetools\Core\Request\Orders
 * @link https://docs.commercetools.com/http-api-projects-orders.html#create-order-from-cart
 * @method Order mapResponse(ApiResponseInterface $response)
 * @method Order mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
 * @method OrderCreateFromCartRequest|InStoreRequestDecorator inStore($storeKey)
 */
class OrderCreateFromCartRequest extends AbstractApiRequest
{
    use InStoreTrait;

    const ID = 'id';
    const CART = 'cart';
    const VERSION = 'version';
    const ORDER_NUMBER = 'orderNumber';
    const PAYMENT_STATE = 'paymentState';
    const ORDER_STATE = 'orderState';
    const STATE = 'state';
    const SHIPMENT_STATE = 'shipmentState';

    /**
     * @deprecated use $cart instead
     */
    protected $cartId;
    protected $cart;
    protected $version;
    protected $orderNumber;
    protected $paymentState;
    protected $orderState;
    protected $state;
    protected $shipmentState;

    protected $resultClass = Order::class;

    /**
     * @param CartReference|string $cart
     * @param int $version
     * @param Context $context
     */
    public function __construct($cart, $version = null, Context $context = null)
    {
        parent::__construct(OrdersEndpoint::endpoint(), $context);

        if ($cart instanceof CartReference) {
            $this->setCart($cart)->setVersion($version);
        } else {
            $this->setCart(CartReference::ofId($cart))->setVersion($version);
        }
    }

    /**
     * @return string
     */
    public function getCart()
    {
        return $this->cart;
    }

    /**
     * @param CartReference $cart
     * @return $this
     */
    public function setCart($cart)
    {
        $this->cart = $cart;

        return $this;
    }

    /**
     * @deprecated use getCart instead
     * @return string
     */
    public function getCartId()
    {
        return $this->cartId;
        return /** @scrutinizer ignore-deprecated */ $this->cartId;
    }

    /**
     * @deprecated use setCart instead
     * @param string $cartId
     * @return $this
     */
    public function setCartId($cartId)
    {
        $this->cartId = $cartId;
        /** @scrutinizer ignore-deprecated */ $this->cartId = $cartId;

        return $this;
    }

    /**
     * @return int
     */
    public function getVersion()
    {
        return $this->version;
    }

    /**
     * @param int $version
     * @return $this
     */
    public function setVersion($version)
    {
        $this->version = $version;

        return $this;
    }

    /**
     * @return string
     */
    public function getOrderNumber()
    {
        return $this->orderNumber;
    }

    /**
     * @param string $orderNumber
     * @return $this
     */
    public function setOrderNumber($orderNumber)
    {
        $this->orderNumber = $orderNumber;

        return $this;
    }

    /**
     * @return string
     */
    public function getPaymentState()
    {
        return $this->paymentState;
    }

    /**
     * @param string $paymentState
     * @return $this
     */
    public function setPaymentState($paymentState)
    {
        $this->paymentState = $paymentState;

        return $this;
    }

    /**
     * @return string
     */
    public function getOrderState()
    {
        return $this->orderState;
    }

    /**
     * @param string $orderState
     * @return $this
     */
    public function setOrderState($orderState)
    {
        $this->orderState = $orderState;

        return $this;
    }

    /**
     * @return StateReference
     */
    public function getState()
    {
        return $this->state;
    }

    /**
     * @param StateReference $state
     * @return $this
     */
    public function setState(StateReference $state)
    {
        $this->state = $state;

        return $this;
    }

    /**
     * @return string
     */
    public function getShipmentState()
    {
        return $this->shipmentState;
    }

    /**
     * @param string $shipmentState
     * @return $this
     */
    public function setShipmentState($shipmentState)
    {
        $this->shipmentState = $shipmentState;

        return $this;
    }

    /**
     * @deprecated use ofCartAndVersion instead
     * @param string $cartId
     * @param int $version
     * @param Context $context
     * @return static
     */
    public static function ofCartIdAndVersion($cartId, $version, Context $context = null)
    {
        return new static($cartId, $version, $context);
    }

    /**
     * @param CartReference|string $cart
     * @param int $version
     * @param Context $context
     * @return static
     */
    public static function ofCartAndVersion($cart, $version, Context $context = null)
    {
        return new static($cart, $version, $context);
    }

    /**
     * @param ResponseInterface $response
     * @return AbstractApiResponse
     * @internal
     */
    public function buildResponse(ResponseInterface $response)
    {
        return new ResourceResponse($response, $this, $this->getContext());
    }

    /**
     * @return JsonRequest
     * @internal
     */
    public function httpRequest()
    {
        $payload = [
            static::ID => $this->getCart()->getId(),
            static::CART => $this->getCart(),
            static::VERSION => $this->getVersion(),
        ];
        if (!is_null($this->paymentState)) {
            $payload[static::PAYMENT_STATE] = $this->getPaymentState();
        }
        if (!is_null($this->orderNumber)) {
            $payload[static::ORDER_NUMBER] = $this->getOrderNumber();
        }
        if (!is_null($this->orderState)) {
            $payload[static::ORDER_STATE] = $this->getOrderState();
        }
        if (!is_null($this->state)) {
            $payload[static::STATE] = $this->getState();
        }
        if (!is_null($this->shipmentState)) {
            $payload[static::SHIPMENT_STATE] = $this->getShipmentState();
        }
        return new JsonRequest(HttpMethod::POST, $this->getPath(), $payload);
    }
}

commercetools / commercetools-php-sdk

Pull Request — develop (#678)

OrderCreateFromCartRequest::setState() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
