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

dmitry_fedyuk · February 15, 2016, 12:15pm

Declaration

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


/**
 * Method that will be executed instead of authorize or capture
 * if flag isInitializeNeeded set to true
 *
 * @param string $paymentAction
 * @param object $stateObject
 *
 * @return $this
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 * 
 */
public function initialize($paymentAction, $stateObject);

Definition

github.com

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


/**
 * Method that will be executed instead of authorize or capture
 * if flag isInitializeNeeded set to true
 *
 * @param string $paymentAction
 * @param object $stateObject
 *
 * @return $this
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 * @api
 */
public function initialize($paymentAction, $stateObject)
{
    return $this;
}

github.com

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


public function initialize($paymentAction, $stateObject)
{
    $requestType = null;
    switch ($paymentAction) {
        case self::ACTION_AUTHORIZE:
            $requestType = self::REQUEST_TYPE_AUTH_ONLY;
            //intentional
        case self::ACTION_AUTHORIZE_CAPTURE:
            $requestType = $requestType ?: self::REQUEST_TYPE_AUTH_CAPTURE;
            $payment = $this->getInfoInstance();
            $order = $payment->getOrder();
            $order->setCanSendNewEmailFlag(false);
            $payment->setBaseAmountAuthorized($order->getBaseTotalDue());
            $payment->setAmountAuthorized($order->getTotalDue());
            $payment->setAnetTransType($requestType);
            break;
        default:
            break;
    }
}

github.com

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


public function initialize($paymentAction, $stateObject)
{
    $this->executeCommand(
        'initialize',
        [
            'payment' => $this->getInfoInstance(),
            'paymentAction' => $paymentAction,
            'stateObject' => $stateObject
        ]
    );
    return $this;
}

github.com

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


/**
 * Instantiate state and set it to state object
 *
 * @param string $paymentAction
 * @param \Magento\Framework\DataObject $stateObject
 * @return void
 */
public function initialize($paymentAction, $stateObject)

github.com

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


/**
 * Instantiate state and set it to state object
 *
 * @param string $paymentAction
 * @param \Magento\Framework\DataObject $stateObject
 * @return void
 */
public function initialize($paymentAction, $stateObject)

github.com

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


public function initialize($paymentAction, $stateObject)
{
    throw new \DomainException("Not implemented");
}

Usage

github.com

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


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 {

dmitry_fedyuk · February 15, 2016, 1:43pm