CustomerTokenService Class Reference

Inheritance diagram for CustomerTokenService:

Public Member Functions
	__construct (TokenModelFactory $tokenModelFactory, AccountManagementInterface $accountManagement, TokenCollectionFactory $tokenModelCollectionFactory, CredentialsValidator $validatorHelper)
	createCustomerAccessToken ($username, $password)
	revokeCustomerAccessToken ($customerId)

Detailed Description

Definition at line 18 of file CustomerTokenService.php.

Constructor & Destructor Documentation

__construct()

__construct	(	TokenModelFactory	$tokenModelFactory,
		AccountManagementInterface	$accountManagement,
		TokenCollectionFactory	$tokenModelCollectionFactory,
		CredentialsValidator	$validatorHelper
	)

Initialize service

Parameters

TokenModelFactory	$tokenModelFactory
AccountManagementInterface	$accountManagement
TokenCollectionFactory	$tokenModelCollectionFactory
\Magento\Integration\Model\CredentialsValidator	$validatorHelper

Definition at line 59 of file CustomerTokenService.php.

      {
        $this->tokenModelFactory = $tokenModelFactory;
        $this->accountManagement = $accountManagement;
        $this->tokenModelCollectionFactory = $tokenModelCollectionFactory;
        $this->validatorHelper = $validatorHelper;
    }

Member Function Documentation

createCustomerAccessToken()

createCustomerAccessToken	(		$username,
			$password
	)

{Create access token for admin given the customer credentials.

Parameters

string	$username
string	$password

Returns

string Token created

Exceptions

}

Implements CustomerTokenServiceInterface.

Definition at line 74 of file CustomerTokenService.php.

    {
        $this->validatorHelper->validate($username, $password);
        $this->getRequestThrottler()->throttle($username, RequestThrottler::USER_TYPE_CUSTOMER);
        try {
            $customerDataObject = $this->accountManagement->authenticate($username, $password);
        } catch (\Exception $e) {
            $this->getRequestThrottler()->logAuthenticationFailure($username, RequestThrottler::USER_TYPE_CUSTOMER);
            throw new AuthenticationException(
                __(
                    'The account sign-in was incorrect or your account is disabled temporarily. '
                    . 'Please wait and try again later.'
                )
            );
        }
        $this->getRequestThrottler()->resetAuthenticationFailuresCount($username, RequestThrottler::USER_TYPE_CUSTOMER);
        return $this->tokenModelFactory->create()->createCustomerToken($customerDataObject->getId())->getToken();
    }

revokeCustomerAccessToken()

revokeCustomerAccessToken

(

$customerId

)

Revoke token by customer id.

The function will delete the token from the oauth_token table.

Parameters

int

$customerId

Returns

bool

Exceptions

Implements CustomerTokenServiceInterface.

Definition at line 102 of file CustomerTokenService.php.

    {
        $tokenCollection = $this->tokenModelCollectionFactory->create()->addFilterByCustomerId($customerId);
        if ($tokenCollection->getSize() == 0) {
            throw new LocalizedException(__('This customer has no tokens.'));
        }
        try {
            foreach ($tokenCollection as $token) {
                $token->delete();
            }
        } catch (\Exception $e) {
            throw new LocalizedException(__("The tokens couldn't be revoked."));
        }
        return true;
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/module-integration/Model/CustomerTokenService.php