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

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

use Commercetools\Core\Request\CustomObjects\CustomObjectByIdGetRequest;
use Commercetools\Core\Request\CustomObjects\CustomObjectByKeyGetRequest;
use Commercetools\Core\Request\CustomObjects\CustomObjectCreateRequest;
use Commercetools\Core\Model\CustomObject\CustomObjectDraft;
use Commercetools\Core\Request\CustomObjects\CustomObjectDeleteByKeyRequest;
use Commercetools\Core\Request\CustomObjects\CustomObjectDeleteRequest;
use Commercetools\Core\Model\CustomObject\CustomObject;
use Commercetools\Core\Request\CustomObjects\CustomObjectQueryRequest;

class CustomObjectRequestBuilder
{

    /**
     *
     * @param string $id
     * @return CustomObjectByIdGetRequest
     */
    public function getById($id)
    {
        $request = CustomObjectByIdGetRequest::ofId($id);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-custom-objects.html#get-customobject-by-container-and-key
     * @param string $container
     * @param string $key
     * @return CustomObjectByKeyGetRequest
     */
    public function getByContainerAndKey($container, $key)
    {
        $request = CustomObjectByKeyGetRequest::ofContainerAndKey($container, $key);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-custom-objects.html#create-a-customobject
     * @param CustomObjectDraft|CustomObject $customObject
     * @return CustomObjectCreateRequest
     */
    public function create($customObject)
    {
        $request = CustomObjectCreateRequest::ofObject($customObject);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-custom-objects.html#delete-customobject-by-container-and-key
     * @param CustomObject $customObject
     * @return CustomObjectDeleteByKeyRequest
     */
    public function deleteByContainerAndKey(CustomObject $customObject)
    {
        $request = CustomObjectDeleteByKeyRequest::ofContainerAndKey($customObject->getContainer(), $customObject->getKey());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-custom-objects.html#delete-customobject-by-id
     * @param CustomObject $customObject
     * @return CustomObjectDeleteRequest
     */
    public function delete(CustomObject $customObject)
    {
        $request = CustomObjectDeleteRequest::ofIdAndVersion($customObject->getId(), $customObject->getVersion());
        return $request;
    }

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

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

Namespaces

Classes