CTP SDK : File Core/Builder/Request/ProductRequestBuilder.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 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190

<?php
// phpcs:disable Generic.Files.LineLength
namespace Commercetools\Core\Builder\Request;

use Commercetools\Core\Request\Products\ProductByIdGetRequest;
use Commercetools\Core\Request\Products\ProductByIdHeadRequest;
use Commercetools\Core\Request\Products\ProductByIdProductSelectionsGetRequest;
use Commercetools\Core\Request\Products\ProductByKeyGetRequest;
use Commercetools\Core\Request\Products\ProductByKeyHeadRequest;
use Commercetools\Core\Request\Products\ProductByKeyProductSelectionsGetRequest;
use Commercetools\Core\Request\Products\ProductCreateRequest;
use Commercetools\Core\Model\Product\ProductDraft;
use Commercetools\Core\Request\Products\ProductDeleteByKeyRequest;
use Commercetools\Core\Model\Product\Product;
use Commercetools\Core\Request\Products\ProductDeleteRequest;
use Commercetools\Core\Request\Products\ProductHeadRequest;
use Commercetools\Core\Request\Products\ProductImageUploadRequest;
use Psr\Http\Message\UploadedFileInterface;
use Commercetools\Core\Request\Products\ProductQueryRequest;
use Commercetools\Core\Request\Products\ProductUpdateByKeyRequest;
use Commercetools\Core\Request\Products\ProductUpdateRequest;

class ProductRequestBuilder
{

    /**
     * @link https://docs.commercetools.com/http-api-projects-products.html#get-product-by-id
     * @param string $id
     * @return ProductByIdGetRequest
     */
    public function getById($id)
    {
        $request = ProductByIdGetRequest::ofId($id);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/api/projects/products#by-id
     * @param string $id
     * @return ProductByIdHeadRequest
     */
    public function getByIdHead($id)
    {
        $request = ProductByIdHeadRequest::ofId($id);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/api/projects/products#query-product-selections-for-a-product-by-id
     * @param string $idProductSelections
     * @return ProductByIdProductSelectionsGetRequest
     */
    public function getByIdProductSelections($idProductSelections)
    {
        $request = ProductByIdProductSelectionsGetRequest::ofIdProductSelections($idProductSelections);
        return $request;
    }

    /**
     *
     * @param string $key
     * @return ProductByKeyGetRequest
     */
    public function getByKey($key)
    {
        $request = ProductByKeyGetRequest::ofKey($key);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/api/projects/products#by-key
     * @param string $key
     * @return ProductByKeyHeadRequest
     */
    public function getByKeyHead($key)
    {
        $request = ProductByKeyHeadRequest::ofKey($key);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/api/projects/products#query-product-selections-for-a-product-by-key
     * @param string $keyProductSelections
     * @return ProductByKeyProductSelectionsGetRequest
     */
    public function getByKeyProductSelections($keyProductSelections)
    {
        $request = ProductByKeyProductSelectionsGetRequest::ofKeyProductSelections($keyProductSelections);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-products.html#create-a-product
     * @param ProductDraft $product
     * @return ProductCreateRequest
     */
    public function create(ProductDraft $product)
    {
        $request = ProductCreateRequest::ofDraft($product);
        return $request;
    }

    /**
     *
     * @param Product $product
     * @return ProductDeleteByKeyRequest
     */
    public function deleteByKey(Product $product)
    {
        $request = ProductDeleteByKeyRequest::ofKeyAndVersion($product->getKey(), $product->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-products.html#delete-product
     * @param Product $product
     * @return ProductDeleteRequest
     */
    public function delete(Product $product)
    {
        $request = ProductDeleteRequest::ofIdAndVersion($product->getId(), $product->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/api/projects/products#by-query-predicate
     *
     * @return ProductHeadRequest
     */
    public function head()
    {
        $request = ProductHeadRequest::of();
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-products.html#upload-a-product-image
     * @param string $id
     * @param string $sku
     * @param UploadedFileInterface $uploadedFile
     * @return ProductImageUploadRequest
     */
    public function uploadImageBySKU($id, $sku, UploadedFileInterface $uploadedFile)
    {
        $request = ProductImageUploadRequest::ofIdSkuAndFile($id, $sku, $uploadedFile);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-products.html#query-products
     *
     * @return ProductQueryRequest
     */
    public function query()
    {
        $request = ProductQueryRequest::of();
        return $request;
    }

    /**
     *
     * @param Product $product
     * @return ProductUpdateByKeyRequest
     */
    public function updateByKey(Product $product)
    {
        $request = ProductUpdateByKeyRequest::ofKeyAndVersion($product->getKey(), $product->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-products.html#update-product
     * @param Product $product
     * @return ProductUpdateRequest
     */
    public function update(Product $product)
    {
        $request = ProductUpdateRequest::ofIdAndVersion($product->getId(), $product->getVersion());
        return $request;
    }

    /**
     * @return ProductRequestBuilder
     */
    public function of()
    {
        return new self();
    }
}

Namespaces

Classes