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

dmitry_fedyuk · June 8, 2017, 5:25am

Interface

magento/magento2/blob/2.1.7/app/code/Magento/Vault/Api/PaymentTokenManagementInterface.php#L26-L32


/**
 * Get payment token by token Id.
 *
 * @param int $paymentId The gateway payment token ID.
 * @return \Magento\Vault\Api\Data\PaymentTokenInterface Payment token interface.
 */
public function getByPaymentId($paymentId);

Implementation

github.com

magento/magento2/blob/2.1.7/app/code/Magento/Vault/Model/PaymentTokenManagement.php#L166-L177


/**
 * Get payment token by token Id.
 *
 * @param int $paymentId The payment token ID.
 * @return PaymentTokenInterface|null Payment token interface.
 */
public function getByPaymentId($paymentId)
{
    $tokenData = $this->paymentTokenResourceModel->getByOrderPaymentId($paymentId);
    $tokenModel = !empty($tokenData) ? $this->paymentTokenFactory->create(['data' => $tokenData]) : null;
    return $tokenModel;
}

Usages

1. Magento\Vault\Model\Ui\Adminhtml\TokensConfigProvider::getPaymentTokenEntityId()

github.com

magento/magento2/blob/2.1.7/app/code/Magento/Vault/Model/Ui/Adminhtml/TokensConfigProvider.php#L218-L229


/**
 * Returns payment token entity id by order payment id
 * @return int|null
 */
private function getPaymentTokenEntityId()
{
    $paymentToken = $this->getPaymentTokenManagement()->getByPaymentId($this->getOrderPaymentEntityId());
    if ($paymentToken === null) {
        throw new NoSuchEntityException(__('No available payment tokens for specified order payment.'));
    }
    return $paymentToken->getEntityId();
}

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

Interface

Implementation

Usages

1. Magento\Vault\Model\Ui\Adminhtml\TokensConfigProvider::getPaymentTokenEntityId()

2. Magento\Vault\Plugin\PaymentVaultAttributesLoad::afterGetExtensionAttributes