CTP SDK : File Core/Builder/Request/PaymentRequestBuilder.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\Payments\PaymentByIdGetRequest;
use Commercetools\Core\Request\Payments\PaymentByKeyGetRequest;
use Commercetools\Core\Request\Payments\PaymentCreateRequest;
use Commercetools\Core\Model\Payment\PaymentDraft;
use Commercetools\Core\Request\Payments\PaymentDeleteByKeyRequest;
use Commercetools\Core\Model\Payment\Payment;
use Commercetools\Core\Request\Payments\PaymentDeleteRequest;
use Commercetools\Core\Request\Payments\PaymentQueryRequest;
use Commercetools\Core\Request\Payments\PaymentUpdateByKeyRequest;
use Commercetools\Core\Request\Payments\PaymentUpdateRequest;

class PaymentRequestBuilder
{

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

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

    /**
     * @link https://docs.commercetools.com/http-api-projects-payments.html#create-a-payment
     * @param PaymentDraft $payment
     * @return PaymentCreateRequest
     */
    public function create(PaymentDraft $payment)
    {
        $request = PaymentCreateRequest::ofDraft($payment);
        return $request;
    }

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

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

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

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

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

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

Namespaces

Classes