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

dmitry_fedyuk · February 15, 2016, 1:48pm

Declaration

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


/**
 * Get config payment action url
 * Used to universalize payment actions when processing payment place
 *
 * @return string
 * 
 */
public function getConfigPaymentAction();

Definition

github.com

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


/**
 * Get config payment action url
 * Used to universalize payment actions when processing payment place
 *
 * @return string
 * @api
 */
public function getConfigPaymentAction()
{
    return $this->getConfigData('payment_action');
}

github.com

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


public function getConfigPaymentAction()
{
    return $this->getConfiguredValue('payment_action');
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Free.php#L114-L122


/**
 * Get config payment action, do nothing if status is pending
 *
 * @return string|null
 */
public function getConfigPaymentAction()
{
    return $this->getConfigData('order_status') == 'pending' ? null : parent::getConfigPaymentAction();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Direct.php#L232-L241


/**
 * Payment action getter compatible with payment model
 *
 * @see \Magento\Sales\Model\Payment::place()
 * @return string
 */
public function getConfigPaymentAction()
{
    return $this->_pro->getConfig()->getPaymentAction();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Express.php#L321-L330


/**
 * Payment action getter compatible with payment model
 *
 * @see \Magento\Sales\Model\Payment::place()
 * @return string
 */
public function getConfigPaymentAction()
{
    return $this->_pro->getConfig()->getPaymentAction();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Payflowpro.php#L349-L357


/**
 * Payment action getter compatible with payment model
 *
 * @return string
 */
public function getConfigPaymentAction()
{
    return $this->getConfig()->getPaymentAction();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Method/Agreement.php#L455-L464


/**
 * Payment action getter compatible with payment model
 *
 * @see \Magento\Sales\Model\Payment::place()
 * @return string
 */
public function getConfigPaymentAction()
{
    return $this->_pro->getConfig()->getPaymentAction();
}

github.com

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


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

Usage

github.com

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


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


if ($action) {
    if ($methodInstance->isInitializeNeeded()) {
        $stateObject = new \Magento\Framework\DataObject();
        // For method initialization we have to use original config value for payment action
        $methodInstance->initialize($methodInstance->getConfigData('payment_action'), $stateObject);
        $orderState = $stateObject->getData('state') ?: $orderState;
        $orderStatus = $stateObject->getData('status') ?: $orderStatus;
        $isCustomerNotified = $stateObject->hasData('is_notified')
            ? $stateObject->getData('is_notified')
            : $isCustomerNotified;
    } else {
        $orderState = Order::STATE_PROCESSING;
        $this->processAction($action, $order);
        $orderState = $order->getState() ? $order->getState() : $orderState;
        $orderStatus = $order->getStatus() ? $order->getStatus() : $orderStatus;
    }
} else {

github.com

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


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

dmitry_fedyuk · February 15, 2016, 2:06pm