Composable Commerce PHP SDKPHP SDK
  • Namespace
  • Class
  • Tree

Namespaces

  • Commercetools
    • Commons
      • Helper
    • Core
      • Builder
        • Request
        • Update
      • Cache
      • Client
        • Adapter
        • OAuth
      • Error
      • Helper
        • Annotate
        • State
          • Renderer
        • Subscriber
          • Log
      • Model
        • ApiClient
        • Cart
        • CartDiscount
        • Category
        • Channel
        • Common
        • Customer
        • CustomerGroup
        • CustomField
        • CustomObject
        • DiscountCode
        • Extension
        • Inventory
        • Message
        • Order
        • OrderEdit
        • Payment
        • Product
          • Search
        • ProductDiscount
        • ProductSelection
        • ProductType
        • Project
        • Review
        • ShippingMethod
        • ShoppingList
        • State
        • Store
        • Subscription
        • TaxCategory
        • Type
        • Zone
      • Request
        • ApiClients
        • CartDiscounts
          • Command
        • Carts
          • Command
        • Categories
          • Command
        • Channels
          • Command
        • CustomerGroups
          • Command
        • Customers
          • Command
        • CustomField
          • Command
        • CustomObjects
        • DiscountCodes
          • Command
        • Extensions
          • Command
        • GraphQL
        • InStores
        • Inventory
          • Command
        • Me
          • Command
        • Messages
        • OrderEdits
          • Command
          • StagedOrder
            • Command
        • Orders
          • Command
        • Payments
          • Command
        • ProductDiscounts
          • Command
        • Products
          • Command
        • ProductSelections
          • Command
        • ProductTypes
          • Command
        • Project
          • Command
        • Query
        • Reviews
          • Command
        • ShippingMethods
          • Command
        • ShoppingLists
          • Command
        • States
          • Command
        • Stores
          • Command
        • Subscriptions
          • Command
        • TaxCategories
          • Command
        • Types
          • Command
        • Zones
          • Command
      • Response

Classes

  • CustomerByEmailTokenGetRequest
  • CustomerByIdGetRequest
  • CustomerByKeyGetRequest
  • CustomerByTokenGetRequest
  • CustomerCreateRequest
  • CustomerDeleteByKeyRequest
  • CustomerDeleteRequest
  • CustomerEmailConfirmRequest
  • CustomerEmailTokenRequest
  • CustomerLoginRequest
  • CustomerPasswordChangeRequest
  • CustomerPasswordResetRequest
  • CustomerPasswordTokenRequest
  • CustomerQueryRequest
  • CustomersEndpoint
  • CustomerUpdateByKeyRequest
  • CustomerUpdateRequest
  • LoginEndpoint

Class CustomerLoginRequest

Commercetools\Core\Request\AbstractApiRequest implements Commercetools\Core\Request\ClientRequestInterface, Commercetools\Core\Model\Common\ContextAwareInterface uses Commercetools\Core\Model\Common\ContextTrait
Extended by Commercetools\Core\Request\Customers\CustomerLoginRequest
Namespace: Commercetools\Core\Request\Customers
API documentation: https://docs.commercetools.com/http-api-projects-customers.html#authenticate-customer-sign-in
Located at Core/Request/Customers/CustomerLoginRequest.php

Methods summary

public
# __construct( string $email, string $password, Commercetools\Core\Model\Cart\CartReference|string|null $anonymousCart = null, Commercetools\Core\Model\Common\Context $context = null )

Parameters

$email
$password
$anonymousCart
$context

Overrides

Commercetools\Core\Request\AbstractApiRequest::__construct
public string
# getEmail( )

Returns

string
public Commercetools\Core\Request\Customers\CustomerLoginRequest
# setEmail( string $email )

Parameters

$email

Returns

Commercetools\Core\Request\Customers\CustomerLoginRequest
$this
public string
# getPassword( )

Returns

string
public Commercetools\Core\Request\Customers\CustomerLoginRequest
# setPassword( string $password )

Parameters

$password

Returns

Commercetools\Core\Request\Customers\CustomerLoginRequest
$this
public string
# getAnonymousCartId( )

Deprecated

use $getAnonymousCart instead

Returns

string
public Commercetools\Core\Request\Customers\CustomerLoginRequest
# setAnonymousCartId( string $anonymousCartId )

Deprecated

use $setAnonymousCart instead

Parameters

$anonymousCartId

Returns

Commercetools\Core\Request\Customers\CustomerLoginRequest
$this
public mixed
# getAnonymousCartSignInMode( )

Returns

mixed
public Commercetools\Core\Request\Customers\CustomerLoginRequest
# setAnonymousCartSignInMode( mixed $anonymousCartSignInMode )

Parameters

$anonymousCartSignInMode

Returns

Commercetools\Core\Request\Customers\CustomerLoginRequest
$this
public boolean
# getUpdateProductData( )

Returns

boolean
public Commercetools\Core\Request\Customers\CustomerLoginRequest
# setUpdateProductData( boolean $updateProductData )

Parameters

$updateProductData

Returns

Commercetools\Core\Request\Customers\CustomerLoginRequest
$this
public Commercetools\Core\Model\Cart\CartReference
# getAnonymousCart( )

Returns

Commercetools\Core\Model\Cart\CartReference
public Commercetools\Core\Request\Customers\CustomerLoginRequest
# setAnonymousCart( Commercetools\Core\Model\Cart\CartReference $anonymousCart )

Parameters

$anonymousCart

Returns

Commercetools\Core\Request\Customers\CustomerLoginRequest
$this
public static Commercetools\Core\Request\Customers\CustomerLoginRequest
# ofEmailAndPassword( string $email, string $password, Commercetools\Core\Model\Cart\CartReference|string $anonymousCart = null, Commercetools\Core\Model\Common\Context $context = null )

Parameters

$email
$password
$anonymousCart
$context

Returns

Commercetools\Core\Request\Customers\CustomerLoginRequest
public static Commercetools\Core\Request\Customers\CustomerLoginRequest
# ofEmailPasswordAndUpdateProductData( string $email, string $password, boolean $updateProductData, Commercetools\Core\Model\Cart\CartReference|string $anonymousCart = null, Commercetools\Core\Model\Common\Context $context = null )

Parameters

$email
$password
$updateProductData
$anonymousCart
$context

Returns

Commercetools\Core\Request\Customers\CustomerLoginRequest

Methods inherited from Commercetools\Core\Request\AbstractApiRequest

addParam(), addParamObject(), executeWithClient(), getIdentifier(), getParamCount(), map(), mapFromResponse(), mapResponse(), setExternalUserId(), setIdentifier()

Methods inherited from Commercetools\Core\Model\Common\ContextAwareInterface

getContext(), getContextCallback(), setContext(), setContextIfNull()

Methods inherited from Commercetools\Core\Request\ClientRequestInterface

mapResult()

Methods used from Commercetools\Core\Model\Common\ContextTrait

getContext(), getContextCallback(), setContext(), setContextIfNull()

Magic methods summary

public Commercetools\Core\Model\Customer\CustomerSigninResult
# mapResponse( Commercetools\Core\Response\ApiResponseInterface $response )

Parameters

$response

Returns

Commercetools\Core\Model\Customer\CustomerSigninResult

Overrides

Commercetools\Core\Request\AbstractApiRequest::mapResponse
public Commercetools\Core\Model\Customer\CustomerSigninResult
# mapFromResponse( Commercetools\Core\Response\ApiResponseInterface $response, Commercetools\Core\Model\MapperInterface $mapper = null )

Parameters

$response
$mapper

Returns

Commercetools\Core\Model\Customer\CustomerSigninResult

Overrides

Commercetools\Core\Request\AbstractApiRequest::mapFromResponse

Constants summary

string EMAIL
# 'email'
string PASSWORD
# 'password'
string ANONYMOUS_CART
# 'anonymousCart'
string ANONYMOUS_CART_ID
# 'anonymousCartId'
string ANONYMOUS_CART_SIGN_IN_MODE
# 'anonymousCartSignInMode'
string SIGN_IN_MODE_MERGE
# 'MergeWithExistingCustomerCart'
string SIGN_IN_MODE_NEW
# 'UseAsNewActiveCustomerCart'
string UPDATE_PRODUCT_DATA
# 'updateProductData'

Constants inherited from Commercetools\Core\Request\AbstractApiRequest

EXTERNAL_USER_HEADER

PHP SDK API documentation generated by ApiGen