How is a payment method's validate() used?

dmitry_fedyuk · February 12, 2016, 5:05am

Declaration

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/MethodInterface.php#L230-L237


/**
 * Validate payment method information object
 *
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * 
 */
public function validate();

Definition

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L566-L583


public function validate()
{
    /**
     * to validate payment method is allowed for billing country or not
     */
    $paymentInfo = $this->getInfoInstance();
    if ($paymentInfo instanceof Payment) {
        $billingCountry = $paymentInfo->getOrder()->getBillingAddress()->getCountryId();
    } else {
        $billingCountry = $paymentInfo->getQuote()->getBillingAddress()->getCountryId();
    }
    if (!$this->canUseForCountry($billingCountry)) {
        throw new \Magento\Framework\Exception\LocalizedException(
            __('You can\'t use the payment type you selected to make payments to the billing country.')
        );
    }
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Authorizenet/Model/Directpost.php#L211-L219


/**
 * Do not validate payment form using server methods
 *
 * @return bool
 */
public function validate()
{
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/PaymentMethod.php#L275-L304


public function validate()
{
    $info = $this->getInfoInstance();
    if ($info instanceof \Magento\Sales\Model\Order\Payment) {
        $billingCountry = $info->getOrder()->getBillingAddress()->getCountryId();
    } else {
        $billingCountry = $info->getQuote()->getBillingAddress()->getCountryId();
    }


    if (!$this->config->canUseForCountry($billingCountry)) {
        throw new LocalizedException(__('Selected payment type is not allowed for billing country.'));
    }


    $ccType = $info->getCcType();
    if (!$ccType) {
        $token = $this->getInfoInstance()->getAdditionalInformation('cc_token');
        if ($token) {
            $ccType = $this->vault->getSavedCardType($token);
        }
    }


    if ($ccType) {
        $error = $this->config->canUseCcTypeForCountry($billingCountry, $ccType);
        if ($error) {
            throw new LocalizedException($error);
        }
    }


    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/PaymentMethod/PayPal.php#L160-L179


/**
 * Validate data
 *
 * @return $this
 * @throws LocalizedException
 */
public function validate()
{
    $info = $this->getInfoInstance();
    if ($info instanceof \Magento\Sales\Model\Order\Payment) {
        $billingCountry = $info->getOrder()->getBillingAddress()->getCountryId();
    } else {
        $billingCountry = $info->getQuote()->getBillingAddress()->getCountryId();
    }


    if (!$this->payPalConfig->canUseForCountry($billingCountry)) {
        throw new LocalizedException(__('Selected payment type is not allowed for billing country.'));
    }
    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Adapter.php#L377-L396


public function validate()
{
    try {
        $validator = $this->getValidatorPool()->get('global');
    } catch (\Exception $e) {
        return $this;
    }


    $result = $validator->validate(
        ['payment' => $this->getInfoInstance(), 'storeId' => $this->getStore()]
    );


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


    return $this;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Cc.php#L84-L92


/**
 * Validate payment method information object
 *
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 * @SuppressWarnings(PHPMD.NPathComplexity)
 */
public function validate()

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Hostedpro.php#L163-L171


/**
 * Do not validate payment form using server methods
 *
 * @return true
 */
public function validate()
{
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflowlink.php#L197-L205


/**
 * Do not validate payment form using server methods
 *
 * @return true
 */
public function validate()
{
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflow/Transparent.php#L135-L143


/**
 * Do not validate payment form using server methods
 *
 * @return bool
 */
public function validate()
{
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Vault/Model/Method/Vault.php#L375-L378


public function validate()
{
    return $this->getVaultProvider()->validate();
}

Usages

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Controller/PayPal/Review.php#L62-L69


if ($paymentMethodNonce && $details) {
    if (!$this->braintreePayPalConfig->isBillingAddressEnabled()) {
        unset($details['billingAddress']);
    }
    $this->getCheckout()->initializeQuoteForReview($paymentMethodNonce, $details);
    $paymentMethod = $this->getQuote()->getPayment()->getMethodInstance();
    $paymentMethod->validate();
} else {

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Quote/Model/Quote/Payment.php#L168-L173




$method->assignData($data);
/*
 * validating the payment data
 */
$method->validate();

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/AdminOrder/Create.php#L1929-L1938


$method = $this->getQuote()->getPayment()->getMethodInstance();
if (!$method->isAvailable($this->getQuote())) {
    $this->_errors[] = __('This payment method is not available.');
} else {
    try {
        $method->validate();
    } catch (\Magento\Framework\Exception\LocalizedException $e) {
        $this->_errors[] = $e->getMessage();
    }
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment.php#L325-L334


$methodInstance = $this->getMethodInstance();
$methodInstance->setStore($order->getStoreId());


$orderState = Order::STATE_NEW;
$orderStatus = $methodInstance->getConfigData('order_status');
$isCustomerNotified = $order->getCustomerNoteNotify();


// Do order payment validation on payment method level
$methodInstance->validate();
$action = $methodInstance->getConfigPaymentAction();

dmitry_fedyuk · February 12, 2016, 10:16pm