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

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

use Commercetools\Core\Request\Categories\CategoryByIdGetRequest;
use Commercetools\Core\Request\Categories\CategoryByKeyGetRequest;
use Commercetools\Core\Request\Categories\CategoryCreateRequest;
use Commercetools\Core\Model\Category\CategoryDraft;
use Commercetools\Core\Request\Categories\CategoryDeleteByKeyRequest;
use Commercetools\Core\Model\Category\Category;
use Commercetools\Core\Request\Categories\CategoryDeleteRequest;
use Commercetools\Core\Request\Categories\CategoryQueryRequest;
use Commercetools\Core\Request\Categories\CategoryUpdateByKeyRequest;
use Commercetools\Core\Request\Categories\CategoryUpdateRequest;

class CategoryRequestBuilder
{

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

    /**
     * @link https://docs.commercetools.com/http-api-projects-categories.html#get-category-by-key
     * @param string $key
     * @return CategoryByKeyGetRequest
     */
    public function getByKey($key)
    {
        $request = CategoryByKeyGetRequest::ofKey($key);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-categories.html#create-a-category
     * @param CategoryDraft $category
     * @return CategoryCreateRequest
     */
    public function create(CategoryDraft $category)
    {
        $request = CategoryCreateRequest::ofDraft($category);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-categories.html#delete-category
     * @param Category $category
     * @return CategoryDeleteByKeyRequest
     */
    public function deleteByKey(Category $category)
    {
        $request = CategoryDeleteByKeyRequest::ofKeyAndVersion($category->getKey(), $category->getVersion());
        return $request;
    }

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

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

    /**
     * @link https://docs.commercetools.com/http-api-projects-categories.html#update-category
     * @param Category $category
     * @return CategoryUpdateByKeyRequest
     */
    public function updateByKey(Category $category)
    {
        $request = CategoryUpdateByKeyRequest::ofKeyAndVersion($category->getKey(), $category->getVersion());
        return $request;
    }

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

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

Namespaces

Classes