CTP SDK : File Core/Builder/Request/CustomerRequestBuilder.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 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229

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

use Commercetools\Core\Request\Customers\CustomerByEmailTokenGetRequest;
use Commercetools\Core\Request\Customers\CustomerByIdGetRequest;
use Commercetools\Core\Request\Customers\CustomerByKeyGetRequest;
use Commercetools\Core\Request\Customers\CustomerByTokenGetRequest;
use Commercetools\Core\Request\Customers\CustomerCreateRequest;
use Commercetools\Core\Model\Customer\CustomerDraft;
use Commercetools\Core\Request\Customers\CustomerDeleteByKeyRequest;
use Commercetools\Core\Model\Customer\Customer;
use Commercetools\Core\Request\Customers\CustomerDeleteRequest;
use Commercetools\Core\Request\Customers\CustomerEmailConfirmRequest;
use Commercetools\Core\Request\Customers\CustomerEmailTokenRequest;
use Commercetools\Core\Request\Customers\CustomerLoginRequest;
use Commercetools\Core\Model\Cart\CartReference;
use Commercetools\Core\Request\Customers\CustomerPasswordChangeRequest;
use Commercetools\Core\Request\Customers\CustomerPasswordResetRequest;
use Commercetools\Core\Request\Customers\CustomerPasswordTokenRequest;
use Commercetools\Core\Request\Customers\CustomerQueryRequest;
use Commercetools\Core\Request\Customers\CustomerUpdateByKeyRequest;
use Commercetools\Core\Request\Customers\CustomerUpdateRequest;

class CustomerRequestBuilder
{

    /**
     * @link https://docs.commercetools.com/http-api-projects-customers.html#get-customer-by-email-token
     * @param string $token
     * @return CustomerByEmailTokenGetRequest
     */
    public function getByEmailToken($token)
    {
        $request = CustomerByEmailTokenGetRequest::ofToken($token);
        return $request;
    }

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

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

    /**
     * @link https://docs.commercetools.com/http-api-projects-customers.html#get-customer-by-password-token
     * @param string $tokenValue
     * @return CustomerByTokenGetRequest
     */
    public function getByPasswordToken($tokenValue)
    {
        $request = CustomerByTokenGetRequest::ofToken($tokenValue);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-customers.html#create-customer-sign-up
     * @param CustomerDraft $customer
     * @return CustomerCreateRequest
     */
    public function create(CustomerDraft $customer)
    {
        $request = CustomerCreateRequest::ofDraft($customer);
        return $request;
    }

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

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

    /**
     * @link https://docs.commercetools.com/http-api-projects-customers.html#verify-customers-email
     * @param string $tokenValue
     * @return CustomerEmailConfirmRequest
     */
    public function confirmEmail($tokenValue)
    {
        $request = CustomerEmailConfirmRequest::ofToken($tokenValue);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-customers.html#create-a-token-for-verifying-the-customers-email
     * @param Customer $customer
     * @param int $ttlMinutes
     * @return CustomerEmailTokenRequest
     */
    public function createEmailVerificationToken(Customer $customer, $ttlMinutes)
    {
        $request = CustomerEmailTokenRequest::ofIdVersionAndTtl($customer->getId(), $customer->getVersion(), $ttlMinutes);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-customers.html#authenticate-customer-sign-in
     * @param string $email
     * @param string $password
     * @param bool $updateProductData
     * @param CartReference|string $anonymousCart
     * @return CustomerLoginRequest
     */
    public function login($email, $password, $updateProductData = false, $anonymousCart = null)
    {
        $request = CustomerLoginRequest::ofEmailPasswordAndUpdateProductData(
            $email,
            $password,
            $updateProductData,
            $anonymousCart
        );
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-customers.html#change-customers-password
     * @param Customer $customer
     * @param string $currentPassword
     * @param string $newPassword
     * @return CustomerPasswordChangeRequest
     */
    public function changePassword(Customer $customer, $currentPassword, $newPassword)
    {
        $request = CustomerPasswordChangeRequest::ofIdVersionAndPasswords(
            $customer->getId(),
            $customer->getVersion(),
            $currentPassword,
            $newPassword
        );
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-customers.html#customers-password-reset
     * @param string $tokenValue
     * @param string $newPassword
     * @return CustomerPasswordResetRequest
     */
    public function resetPassword($tokenValue, $newPassword)
    {
        $request = CustomerPasswordResetRequest::ofTokenAndPassword($tokenValue, $newPassword);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-customers.html#create-a-token-for-resetting-the-customers-password
     * @param string $email
     * @return CustomerPasswordTokenRequest
     */
    public function createResetPasswordToken($email)
    {
        $request = CustomerPasswordTokenRequest::ofEmail($email);
        return $request;
    }

    /**
     * @link https://docs.commercetools.com/http-api-projects-customers.html#get-customer-by-id
     *
     * @return CustomerQueryRequest
     */
    public function query()
    {
        $request = CustomerQueryRequest::of();
        return $request;
    }

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

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

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

Namespaces

Classes