CTP SDK : File Core/Request/Products/ProductImageUploadRequest.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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173

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

namespace Commercetools\Core\Request\Products;

use Commercetools\Core\Client\FileUploadRequest;
use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Request\AbstractApiRequest;
use Commercetools\Core\Request\Query\Parameter;
use Commercetools\Core\Request\StagedTrait;
use Commercetools\Core\Response\ResourceResponse;
use Psr\Http\Message\ResponseInterface;
use Commercetools\Core\Model\Product\Product;
use Commercetools\Core\Response\ApiResponseInterface;
use Psr\Http\Message\UploadedFileInterface;
use Commercetools\Core\Model\MapperInterface;

/**
 * @package Commercetools\Core\Request\Products
 * @link https://docs.commercetools.com/http-api-projects-products.html#upload-a-product-image
 * @method Product mapResponse(ApiResponseInterface $response)
 * @method Product mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
 */
class ProductImageUploadRequest extends AbstractApiRequest
{
    use StagedTrait;

    protected $resultClass = Product::class;

    /**
     * @var UploadedFileInterface
     */
    protected $file;

    /**
     * @var string
     */
    protected $id;

    /**
     * @var int
     */
    protected $variantId;

    /**
     * @var string
     */
    protected $sku;

    /**
     * ProductImageUploadRequest constructor.
     * @param string $id
     * @param UploadedFileInterface $file
     * @param Context|null $context
     */
    public function __construct($id, UploadedFileInterface $file, Context $context = null)
    {
        $this->id = $id;
        $this->file = $file;
        $this->addParamObject(new Parameter('filename', $file->getClientFilename()));

        parent::__construct(ProductsEndpoint::endpoint(), $context);
    }

    public function buildResponse(ResponseInterface $response)
    {
        return new ResourceResponse($response, $this, $this->getContext());
    }

    public function httpRequest()
    {
        return new FileUploadRequest($this->getPath(), $this->file);
    }

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

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

    /**
     * @param string $id
     * @return $this
     */
    protected function setId($id)
    {
        $this->id = $id;

        return $this;
    }

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

    /**
     * @param int $variantId
     * @return $this
     */
    protected function setVariantId($variantId)
    {
        $this->variantId = $variantId;
        $this->addParamObject(new Parameter('variant', $variantId));

        return $this;
    }

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

    /**
     * @param string $sku
     * @return $this
     */
    protected function setSku($sku)
    {
        $this->sku = $sku;
        $this->addParamObject(new Parameter('sku', $sku));

        return $this;
    }

    /**
     * @param string $id
     * @param int $variantId
     * @param UploadedFileInterface $file
     * @param Context $context
     * @return ProductImageUploadRequest
     */
    public static function ofIdVariantIdAndFile($id, $variantId, UploadedFileInterface $file, Context $context = null)
    {
        $request = new static($id, $file, $context);
        $request->setVariantId($variantId);
        return $request;
    }

    /**
     * @param string $id
     * @param string $sku
     * @param UploadedFileInterface $file
     * @param Context $context
     * @return ProductImageUploadRequest
     */
    public static function ofIdSkuAndFile($id, $sku, UploadedFileInterface $file, Context $context = null)
    {
        $request = new static($id, $file, $context);
        $request->setSku($sku);
        return $request;
    }
}

Namespaces

Classes