CTP SDK : File Core/Request/Customers/CustomerLoginRequest.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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274

<?php
/**
 * @author @jenschude <jens.schulze@commercetools.de>
 * @created: 11.02.15, 15:53
 */

namespace Commercetools\Core\Request\Customers;

use Commercetools\Core\Model\Cart\Cart;
use Commercetools\Core\Model\Cart\CartReference;
use Commercetools\Core\Model\Common\ResourceIdentifier;
use Commercetools\Core\Model\Customer\CustomerDraft;
use Psr\Http\Message\ResponseInterface;
use Commercetools\Core\Client\HttpMethod;
use Commercetools\Core\Client\JsonRequest;
use Commercetools\Core\Model\Common\Context;
use Commercetools\Core\Request\AbstractApiRequest;
use Commercetools\Core\Response\ResourceResponse;
use Commercetools\Core\Model\Customer\CustomerSigninResult;
use Commercetools\Core\Response\ApiResponseInterface;
use Commercetools\Core\Model\MapperInterface;

/**
 * @package Commercetools\Core\Request\Customers
 * @link https://docs.commercetools.com/http-api-projects-customers.html#authenticate-customer-sign-in
 * @method CustomerSigninResult mapResponse(ApiResponseInterface $response)
 * @method CustomerSigninResult mapFromResponse(ApiResponseInterface $response, MapperInterface $mapper = null)
 */
class CustomerLoginRequest extends AbstractApiRequest
{
    const EMAIL = 'email';
    const PASSWORD = 'password';
    const ANONYMOUS_CART = 'anonymousCart';
    const ANONYMOUS_CART_ID = 'anonymousCartId';
    const ANONYMOUS_CART_SIGN_IN_MODE = 'anonymousCartSignInMode';
    const SIGN_IN_MODE_MERGE = 'MergeWithExistingCustomerCart';
    const SIGN_IN_MODE_NEW = 'UseAsNewActiveCustomerCart';
    const UPDATE_PRODUCT_DATA = 'updateProductData';

    /**
     * @var string
     */
    protected $email;

    /**
     * @var string
     */
    protected $password;

    /**
     * @var CartReference
     */
    protected $anonymousCart;

    /**
     * @deprecated use $anonymousCart instead
     * @var string
     */
    protected $anonymousCartId;

    protected $anonymousCartSignInMode;

    /**
     * @var bool
     */
    protected $updateProductData;

    protected $resultClass = CustomerSigninResult::class;

    /**
     * @param string $email
     * @param string $password
     * @param CartReference|string|null $anonymousCart
     * @param Context $context
     */
    public function __construct($email, $password, $anonymousCart = null, Context $context = null)
    {
        parent::__construct(LoginEndpoint::endpoint(), $context);
        $this->email = $email;
        $this->password = $password;
        if ($anonymousCart instanceof CartReference) {
            $this->anonymousCart = $anonymousCart;
        } elseif ($anonymousCart !== null) {
            $this->anonymousCart = CartReference::ofId($anonymousCart);
        }
    }

    /**
     * @return string
     */
    public function getEmail()
    {
        return $this->email;
    }

    /**
     * @param string $email
     * @return $this
     */
    public function setEmail($email)
    {
        $this->email = $email;

        return $this;
    }

    /**
     * @return string
     */
    public function getPassword()
    {
        return $this->password;
    }

    /**
     * @param string $password
     * @return $this
     */
    public function setPassword($password)
    {
        $this->password = $password;

        return $this;
    }

    /**
     * @deprecated use $getAnonymousCart instead
     * @return string
     */
    public function getAnonymousCartId()
    {
        if ($this->anonymousCart == null) {
            return null;
        }
        return $this->anonymousCart->getId();
    }

    /**
     * @deprecated use $setAnonymousCart instead
     * @param string $anonymousCartId
     * @return $this
     */
    public function setAnonymousCartId($anonymousCartId)
    {
        $this->anonymousCart = CartReference::ofId($anonymousCartId);

        return $this;
    }

    /**
     * @return mixed
     */
    public function getAnonymousCartSignInMode()
    {
        return $this->anonymousCartSignInMode;
    }

    /**
     * @param mixed $anonymousCartSignInMode
     * @return $this
     */
    public function setAnonymousCartSignInMode($anonymousCartSignInMode)
    {
        $this->anonymousCartSignInMode = $anonymousCartSignInMode;

        return $this;
    }

    /**
     * @return bool
     */
    public function getUpdateProductData()
    {
        return $this->updateProductData;
    }

    /**
     * @param bool $updateProductData
     * @return $this
     */
    public function setUpdateProductData($updateProductData)
    {
        $this->updateProductData = $updateProductData;
        return $this;
    }

    /**
     * @return CartReference
     */
    public function getAnonymousCart()
    {
        return $this->anonymousCart;
    }

    /**
     * @param CartReference $anonymousCart
     * @return $this
     */
    public function setAnonymousCart($anonymousCart)
    {
        $this->anonymousCart = $anonymousCart;

        return $this;
    }

    /**
     * @param string $email
     * @param string $password
     * @param CartReference|string $anonymousCart
     * @param Context $context
     * @return static
     */
    public static function ofEmailAndPassword($email, $password, $anonymousCart = null, Context $context = null)
    {
        return new static($email, $password, $anonymousCart, $context);
    }

    /**
     * @param string $email
     * @param string $password
     * @param bool $updateProductData
     * @param CartReference|string $anonymousCart
     * @param Context $context
     * @return static
     */
    public static function ofEmailPasswordAndUpdateProductData(
        $email,
        $password,
        $updateProductData,
        $anonymousCart = null,
        Context $context = null
    ) {
        $request = new static($email, $password, $anonymousCart, $context);
        $request->setUpdateProductData($updateProductData);

        return $request;
    }

    /**
     * @return JsonRequest
     * @internal
     */
    public function httpRequest()
    {
        $payload = [
            static::EMAIL => $this->email,
            static::PASSWORD => $this->password,
        ];
        if (!is_null($this->anonymousCartId)) {
            $payload[static::ANONYMOUS_CART_ID] = $this->anonymousCartId;
        }
        if (!is_null($this->anonymousCart)) {
            $payload[static::ANONYMOUS_CART] = $this->anonymousCart;
        }
        if (!is_null($this->anonymousCartSignInMode)) {
            $payload[static::ANONYMOUS_CART_SIGN_IN_MODE] = $this->anonymousCartSignInMode;
        }
        if (!is_null($this->updateProductData)) {
            $payload[static::UPDATE_PRODUCT_DATA] = $this->updateProductData;
        }
        return new JsonRequest(HttpMethod::POST, $this->getPath(), $payload);
    }

    /**
     * @param ResponseInterface $response
     * @return ResourceResponse
     * @internal
     */
    public function buildResponse(ResponseInterface $response)
    {
        return new ResourceResponse($response, $this, $this->getContext());
    }
}

Namespaces

Classes