CTP SDK : File Core/Builder/Request/ReviewRequestBuilder.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\Reviews\ReviewByIdGetRequest;
use Commercetools\Core\Request\Reviews\ReviewByKeyGetRequest;
use Commercetools\Core\Request\Reviews\ReviewCreateRequest;
use Commercetools\Core\Model\Review\ReviewDraft;
use Commercetools\Core\Request\Reviews\ReviewDeleteByKeyRequest;
use Commercetools\Core\Model\Review\Review;
use Commercetools\Core\Request\Reviews\ReviewDeleteRequest;
use Commercetools\Core\Request\Reviews\ReviewQueryRequest;
use Commercetools\Core\Request\Reviews\ReviewUpdateByKeyRequest;
use Commercetools\Core\Request\Reviews\ReviewUpdateRequest;

class ReviewRequestBuilder
{

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

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

    /**
     * @link https://docs.commercetools.com/http-api-projects-reviews.html#create-a-review
     * @param ReviewDraft $review
     * @return ReviewCreateRequest
     */
    public function create(ReviewDraft $review)
    {
        $request = ReviewCreateRequest::ofDraft($review);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-reviews.html#delete-review-by-key
     * @param Review $review
     * @return ReviewDeleteByKeyRequest
     */
    public function deleteByKey(Review $review)
    {
        $request = ReviewDeleteByKeyRequest::ofKeyAndVersion($review->getKey(), $review->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-reviews.html#delete-review-by-id
     * @param Review $review
     * @return ReviewDeleteRequest
     */
    public function delete(Review $review)
    {
        $request = ReviewDeleteRequest::ofIdAndVersion($review->getId(), $review->getVersion());
        return $request;
    }

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

    /**
     * @link https://docs.commercetools.com/http-api-projects-reviews.html#update-review-by-key
     * @param Review $review
     * @return ReviewUpdateByKeyRequest
     */
    public function updateByKey(Review $review)
    {
        $request = ReviewUpdateByKeyRequest::ofKeyAndVersion($review->getKey(), $review->getVersion());
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-reviews.html#update-review-by-id
     * @param Review $review
     * @return ReviewUpdateRequest
     */
    public function update(Review $review)
    {
        $request = ReviewUpdateRequest::ofIdAndVersion($review->getId(), $review->getVersion());
        return $request;
    }

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

Namespaces

Classes