CTP SDK : File Core/Request/Orders/OrderDeleteByOrderNumberRequest.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

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

namespace Commercetools\Core\Request\Orders;

use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Request\AbstractDeleteRequest;
use Commercetools\Core\Request\DataErasureTrait;
use Commercetools\Core\Request\InStores\InStoreRequestDecorator;
use Commercetools\Core\Request\InStores\InStoreTrait;
use Commercetools\Core\Response\ApiResponseInterface;
use Commercetools\Core\Model\Order\Order;
use Commercetools\Core\Model\MapperInterface;

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

    protected $resultClass = Order::class;

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

    /**
     * @param string $orderNumber
     * @param int $version
     * @param Context $context
     * @return static
     */
    public static function ofOrderNumberAndVersion($orderNumber, $version, Context $context = null)
    {
        return new static($orderNumber, $version, $context);
    }

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

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

    /**
     * @return string
     * @internal
     */
    protected function getPath()
    {
        return (string)$this->getEndpoint() . '/order-number=' . urlencode($this->getId()) . $this->getParamString();
    }
}

Namespaces

Classes