PaymentTokenManagement Class Reference

Inheritance diagram for PaymentTokenManagement:

Public Member Functions
	__construct (PaymentTokenRepositoryInterface $repository, PaymentTokenResourceModel $paymentTokenResourceModel, PaymentTokenFactory $paymentTokenFactory, FilterBuilder $filterBuilder, SearchCriteriaBuilder $searchCriteriaBuilder, PaymentTokenSearchResultsInterfaceFactory $searchResultsFactory, EncryptorInterface $encryptor, DateTimeFactory $dateTimeFactory)
	getListByCustomerId ($customerId)
	getVisibleAvailableTokens ($customerId)
	getByPaymentId ($paymentId)
	getByGatewayToken ($token, $paymentMethodCode, $customerId)
	getByPublicHash ($hash, $customerId)
	saveTokenWithPaymentLink (PaymentTokenInterface $token, OrderPaymentInterface $payment)
	addLinkToOrderPayment ($paymentTokenId, $orderPaymentId)

Protected Attributes
	$paymentTokenRepository
	$paymentTokenResourceModel
	$resourceModel
	$paymentTokenFactory
	$searchResultsFactory
	$filterBuilder
	$searchCriteriaBuilder

Detailed Description

Vault payment token repository @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 25 of file PaymentTokenManagement.php.

Constructor & Destructor Documentation

__construct()

__construct	(	PaymentTokenRepositoryInterface	$repository,
		PaymentTokenResourceModel	$paymentTokenResourceModel,
		PaymentTokenFactory	$paymentTokenFactory,
		FilterBuilder	$filterBuilder,
		SearchCriteriaBuilder	$searchCriteriaBuilder,
		PaymentTokenSearchResultsInterfaceFactory	$searchResultsFactory,
		EncryptorInterface	$encryptor,
		DateTimeFactory	$dateTimeFactory
	)

Parameters

PaymentTokenRepositoryInterface	$repository
PaymentTokenResourceModel	$paymentTokenResourceModel
PaymentTokenFactory	$paymentTokenFactory
FilterBuilder	$filterBuilder
SearchCriteriaBuilder	$searchCriteriaBuilder
PaymentTokenSearchResultsInterfaceFactory	$searchResultsFactory
EncryptorInterface	$encryptor
DateTimeFactory	$dateTimeFactory

Definition at line 82 of file PaymentTokenManagement.php.

      {
        $this->paymentTokenRepository = $repository;
        $this->paymentTokenResourceModel = $paymentTokenResourceModel;
        $this->paymentTokenFactory = $paymentTokenFactory;
        $this->filterBuilder = $filterBuilder;
        $this->searchCriteriaBuilder = $searchCriteriaBuilder;
        $this->searchResultsFactory = $searchResultsFactory;
        $this->encryptor = $encryptor;
        $this->dateTimeFactory = $dateTimeFactory;
    }

Member Function Documentation

addLinkToOrderPayment()

addLinkToOrderPayment	(		$paymentTokenId,
			$orderPaymentId
	)

Add link between payment token and order payment.

Parameters

int	$paymentTokenId	Payment token ID.
int	$orderPaymentId	Order payment ID.

Returns

bool

Implements PaymentTokenManagementInterface.

Definition at line 249 of file PaymentTokenManagement.php.

    {
        return $this->paymentTokenResourceModel->addLinkToOrderPayment($paymentTokenId, $orderPaymentId);
    }

getByGatewayToken()

getByGatewayToken	(		$token,
			$paymentMethodCode,
			$customerId
	)

Get payment token by gateway token.

Parameters

string	$token	The gateway token.
string	$paymentMethodCode
int	$customerId	Customer ID.

Returns

PaymentTokenInterface|null Payment token interface.

Implements PaymentTokenManagementInterface.

Definition at line 187 of file PaymentTokenManagement.php.

    {
        $tokenData = $this->paymentTokenResourceModel->getByGatewayToken($token, $paymentMethodCode, $customerId);
        $tokenModel = !empty($tokenData) ? $this->paymentTokenFactory->create(['data' => $tokenData]) : null;
        return $tokenModel;
    }

getByPaymentId()

getByPaymentId

(

$paymentId

)

Get payment token by token Id.

Parameters

int

$paymentId

The payment token ID.

Returns

PaymentTokenInterface|null Payment token interface.

Implements PaymentTokenManagementInterface.

Definition at line 172 of file PaymentTokenManagement.php.

    {
        $tokenData = $this->paymentTokenResourceModel->getByOrderPaymentId($paymentId);
        $tokenModel = !empty($tokenData) ? $this->paymentTokenFactory->create(['data' => $tokenData]) : null;
        return $tokenModel;
    }

getByPublicHash()

getByPublicHash	(		$hash,
			$customerId
	)

Get payment token by public hash.

Parameters

string	$hash	Public hash.
int	$customerId	Customer ID.

Returns

PaymentTokenInterface|null Payment token interface.

Implements PaymentTokenManagementInterface.

Definition at line 201 of file PaymentTokenManagement.php.

    {
        $tokenData = $this->paymentTokenResourceModel->getByPublicHash($hash, $customerId);
        $tokenModel = !empty($tokenData) ? $this->paymentTokenFactory->create(['data' => $tokenData]) : null;
        return $tokenModel;
    }

getListByCustomerId()

getListByCustomerId

(

$customerId

)

Lists payment tokens that match specified search criteria.

Parameters

int

$customerId

Customer ID.

Returns

\Magento\Vault\Api\Data\PaymentTokenSearchResultsInterface[] Payment tokens search result interface.

Implements PaymentTokenManagementInterface.

Definition at line 108 of file PaymentTokenManagement.php.

    {
        $filters[] = $this->filterBuilder
            ->setField(PaymentTokenInterface::CUSTOMER_ID)
            ->setValue($customerId)
            ->create();
        $entities = $this->paymentTokenRepository->getList(
            $this->searchCriteriaBuilder
                ->addFilters($filters)
                ->create()
        )->getItems();

        return $entities;
    }

getVisibleAvailableTokens()

getVisibleAvailableTokens

(

$customerId

)

Searches for all visible, non-expired tokens

Parameters

int

$customerId

Returns

Data\PaymentTokenInterface[]

Definition at line 129 of file PaymentTokenManagement.php.

    {
        $customerFilter = [
            $this->filterBuilder->setField(PaymentTokenInterface::CUSTOMER_ID)
                ->setValue($customerId)
                ->create()
            ];
        $visibleFilter = [
            $this->filterBuilder->setField(PaymentTokenInterface::IS_VISIBLE)
                ->setValue(1)
                ->create()
            ];
        $isActiveFilter = [
            $this->filterBuilder->setField(PaymentTokenInterface::IS_ACTIVE)
                ->setValue(1)
                ->create()
            ];
        $expiresAtFilter = [
            $this->filterBuilder->setField(PaymentTokenInterface::EXPIRES_AT)
                ->setConditionType('gt')
                ->setValue(
                    $this->dateTimeFactory->create(
                        'now',
                        new \DateTimeZone('UTC')
                    )->format('Y-m-d 00:00:00')
                )
                ->create()
            ];
        $this->searchCriteriaBuilder->addFilters($customerFilter);
        $this->searchCriteriaBuilder->addFilters($visibleFilter);
        $this->searchCriteriaBuilder->addFilters($isActiveFilter);
        // add filters to different filter groups in order to filter by AND expression
        $searchCriteria = $this->searchCriteriaBuilder->addFilters($expiresAtFilter)->create();

        return $this->paymentTokenRepository->getList($searchCriteria)->getItems();
    }

saveTokenWithPaymentLink()

saveTokenWithPaymentLink	(	PaymentTokenInterface	$token,
		OrderPaymentInterface	$payment
	)

Parameters

PaymentTokenInterface	$token
OrderPaymentInterface	$payment

Returns

bool

Implements PaymentTokenManagementInterface.

Definition at line 213 of file PaymentTokenManagement.php.

    {
        $tokenDuplicate = $this->getByPublicHash(
            $token->getPublicHash(),
            $token->getCustomerId()
        );

        if (!empty($tokenDuplicate)) {
            if ($token->getIsVisible() || $tokenDuplicate->getIsVisible()) {
                $token->setEntityId($tokenDuplicate->getEntityId());
                $token->setIsVisible(true);
            } elseif ($token->getIsVisible() === $tokenDuplicate->getIsVisible()) {
                $token->setEntityId($tokenDuplicate->getEntityId());
            } else {
                $token->setPublicHash(
                    $this->encryptor->getHash(
                        $token->getPublicHash() . $token->getGatewayToken()
                    )
                );
            }
        }

        $this->paymentTokenRepository->save($token);

        $result = $this->addLinkToOrderPayment($token->getEntityId(), $payment->getEntityId());

        return $result;
    }

Field Documentation

$filterBuilder

$filterBuilder

protected

Definition at line 55 of file PaymentTokenManagement.php.

$paymentTokenFactory

$paymentTokenFactory

protected

Definition at line 45 of file PaymentTokenManagement.php.

$paymentTokenRepository

$paymentTokenRepository

protected

Definition at line 30 of file PaymentTokenManagement.php.

$paymentTokenResourceModel

$paymentTokenResourceModel

protected

Definition at line 35 of file PaymentTokenManagement.php.

$resourceModel

$resourceModel

protected

Definition at line 40 of file PaymentTokenManagement.php.

$searchCriteriaBuilder

$searchCriteriaBuilder

protected

Definition at line 60 of file PaymentTokenManagement.php.

$searchResultsFactory

$searchResultsFactory

protected

Definition at line 50 of file PaymentTokenManagement.php.

---

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

• vendor/magento/module-vault/Model/PaymentTokenManagement.php