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

dmitry_fedyuk · February 11, 2016, 1:42am

Declaration

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


/**
 * Flag if we need to run payment initialize while order place
 *
 * @return bool
 * 
 */
public function isInitializeNeeded();

Definition

github.com

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


 * Flag if we need to run payment initialize while order place
 *
 * @return bool
 * @api
 */
public function isInitializeNeeded()
{
    return $this->_isInitializeNeeded;
}

Usages

github.com

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


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 {
    $order->setState($orderState)
        ->setStatus($orderStatus);
}

dmitry_fedyuk · February 11, 2016, 1:44am