How is Magento\Vault\Api\PaymentTokenManagementInterface::getByPublicHash() implemented and used?

dmitry_fedyuk · June 8, 2017, 4:56am

Interface

magento/magento2/blob/2.1.7/app/code/Magento/Vault/Api/PaymentTokenManagementInterface.php#L44-L51


/**
 * Get payment token by public hash.
 *
 * @param string $hash Public hash.
 * @param int $customerId Customer ID.
 * @return PaymentTokenInterface|null Payment token interface.
 */
public function getByPublicHash($hash, $customerId);

Implementation

github.com

magento/magento2/blob/2.1.7/app/code/Magento/Vault/Model/PaymentTokenManagement.php#L194-L206


/**
 * Get payment token by public hash.
 *
 * @param string $hash Public hash.
 * @param int $customerId Customer ID.
 * @return PaymentTokenInterface|null Payment token interface.
 */
public function getByPublicHash($hash, $customerId)
{
    $tokenData = $this->paymentTokenResourceModel->getByPublicHash($hash, $customerId);
    $tokenModel = !empty($tokenData) ? $this->paymentTokenFactory->create(['data' => $tokenData]) : null;
    return $tokenModel;
}

Usages

1. Magento\Vault\Controller\Cards\DeleteAction::getPaymentToken()

github.com

magento/magento2/blob/2.1.7/app/code/Magento/Vault/Controller/Cards/DeleteAction.php#L141-L157


/**
 * @param Http $request
 * @return PaymentTokenInterface|null
 */
private function getPaymentToken(Http $request)
{
    $publicHash = $request->getPostValue(PaymentTokenInterface::PUBLIC_HASH);


    if ($publicHash === null) {
        return null;
    }


    return $this->paymentTokenManagement->getByPublicHash(
        $publicHash,
        $this->customerSession->getCustomerId()
    );
}

2. Magento\Vault\Model\PaymentTokenManagement::saveTokenWithPaymentLink()

github.com

magento/magento2/blob/2.1.7/app/code/Magento/Vault/Model/PaymentTokenManagement.php#L208-L240


/**
 * @param PaymentTokenInterface $token
 * @param OrderPaymentInterface $payment
 * @return bool
 */
public function saveTokenWithPaymentLink(PaymentTokenInterface $token, OrderPaymentInterface $payment)
{
    $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;
}

3. Magento\Vault\Model\Method\Vault::attachTokenExtensionAttribute()

4. Magento\Vault\Observer\PaymentTokenAssigner::execute

5. Magento\Braintree\Gateway\Command\GetPaymentNonceCommand::execute()

github.com

magento/magento2/blob/2.1.7/app/code/Magento/Braintree/Gateway/Command/GetPaymentNonceCommand.php#L70-L91


/**
 * @inheritdoc
 * @throws \Exception
 */
public function execute(array $commandSubject)
{
    $publicHash = $this->subjectReader->readPublicHash($commandSubject);
    $customerId = $this->subjectReader->readCustomerId($commandSubject);
    $paymentToken = $this->tokenManagement->getByPublicHash($publicHash, $customerId);
    if (!$paymentToken) {
        throw new Exception('No available payment tokens');
    }


    $data = $this->adapter->createNonce($paymentToken->getGatewayToken());
    $result = $this->responseValidator->validate(['response' => ['object' => $data]]);


    if (!$result->isValid()) {
        throw new Exception(__(implode("\n", $result->getFailsDescription())));
    }


    return $this->resultFactory->create(['array' => ['paymentMethodNonce' => $data->paymentMethodNonce->nonce]]);
}

dmitry_fedyuk · June 8, 2017, 5:07am