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

dmitrii_fediuk · February 12, 2016, 11:01pm

Declaration

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


/**
 * Order payment abstract method
 *
 * @param InfoInterface $payment
 * @param float $amount
 * @return $this
 * 
 */
public function order(\Magento\Payment\Model\InfoInterface $payment, $amount);

Definition

github.com

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


/**
 * Order payment abstract method
 *
 * @param \Magento\Framework\DataObject|InfoInterface $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 * @api
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function order(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    if (!$this->canOrder()) {
        throw new \Magento\Framework\Exception\LocalizedException(__('The order action is not available.'));
    }
    return $this;
}

github.com

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


public function order(InfoInterface $payment, $amount)
{
    $this->executeCommand(
        'order',
        ['payment' => $payment, 'amount' => $amount]
    );


    return $this;
}

github.com

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


/**
 * Order payment
 *
 * @param \Magento\Framework\DataObject|\Magento\Payment\Model\InfoInterface|Payment $payment
 * @param float $amount
 * @return $this
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function order(\Magento\Payment\Model\InfoInterface $payment, $amount)

github.com

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


public function order(\Magento\Payment\Model\InfoInterface $payment, $amount)
{
    throw new \DomainException("Not implemented");
}

Usage

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment/Operations/OrderOperation.php#L15-L35


class OrderOperation extends AbstractOperation
{
/**
 * @param OrderPaymentInterface $payment
 * @param string|float $amount
 * @return OrderPaymentInterface
 */
public function order(OrderPaymentInterface $payment, $amount)
{
    /**
     * @var $payment Payment
     */
    // update totals
    $amount = $payment->formatAmount($amount, true);


    // do ordering
    $order = $payment->getOrder();


    $method = $payment->getMethodInstance();
    $method->setStore($order->getStoreId());
    $method->order($payment, $amount);

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment/Operations/OrderOperation.php#L37-L48


    if ($payment->getSkipOrderProcessing()) {
        return $payment;
    }


    $message = $this->stateCommand->execute($payment, $amount, $order);
    // update transactions, order state and add comments
    $transaction = $payment->addTransaction(Transaction::TYPE_ORDER);
    $message = $payment->prependMessage($message);
    $payment->addTransactionCommentsToOrder($transaction, $message);


    return $payment;
}

Details: How is \Magento\Sales\Model\Order\Payment::addTransaction() implemented and used?

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment/Processor.php#L42-L60


/**
 * Set operations
 *
 * @param AuthorizeOperation $authorizeOperation
 * @param CaptureOperation $captureOperation
 * @param OrderOperation $orderOperation
 * @param RegisterCaptureNotificationOperation $registerCaptureNotification
 */
public function __construct(
    AuthorizeOperation $authorizeOperation,
    CaptureOperation $captureOperation,
    OrderOperation $orderOperation,
    RegisterCaptureNotificationOperation $registerCaptureNotification
) {
    $this->authorizeOperation = $authorizeOperation;
    $this->captureOperation = $captureOperation;
    $this->orderOperation = $orderOperation;
    $this->registerCaptureNotification = $registerCaptureNotification;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment/Processor.php#L88-L98


/**
 * Process order operation
 *
 * @param OrderPaymentInterface $payment
 * @param float $amount
 * @return OrderPaymentInterface|Payment
 */
public function order(OrderPaymentInterface $payment, $amount)
{
    return $this->orderOperation->order($payment, $amount);
}

github.com

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


/**
 * Order payment either online
 * Updates transactions hierarchy, if required
 * Prevents transaction double processing
 * Updates payment totals, updates order status and adds proper comments
 *
 * @param float $amount
 * @return $this
 */
protected function _order($amount)
{
    return $this->orderPaymentProcessor->order($this, $amount);
}

github.com

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


/**
 * Perform actions based on passed action name
 *
 * @param string $action
 * @param Order $order
 * @return void
 */
protected function processAction($action, Order $order)
{
    $totalDue = $order->getTotalDue();
    $baseTotalDue = $order->getBaseTotalDue();


    switch ($action) {
        case \Magento\Payment\Model\Method\AbstractMethod::ACTION_ORDER:
            $this->_order($baseTotalDue);
            break;

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/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/Paypal/etc/adminhtml/system/express_checkout.xml#L297-L302


<field id="payment_action" translate="label" type="select" sortOrder="30" showInDefault="1" showInWebsite="1">
    <label>Payment Action</label>
    <config_path>payment/paypal_express/payment_action</config_path>
    <source_model>Magento\Paypal\Model\System\Config\Source\PaymentActions\Express</source_model>
    <attribute type="shared">1</attribute>
</field>

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/System/Config/Source/PaymentActions/Express.php#L29-L35


public function toOptionArray()
{
    /** @var \Magento\Paypal\Model\Config $configModel */
    $configModel = $this->_configFactory->create();
    $configModel->setMethod(\Magento\Paypal\Model\Config::METHOD_WPP_EXPRESS);
    return $configModel->getPaymentActions();
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Config.php#L1156-L1171


/**
 * Payment actions source getter
 *
 * @return array
 */
public function getPaymentActions()
{
    $paymentActions = [
        self::PAYMENT_ACTION_AUTH => __('Authorization'),
        self::PAYMENT_ACTION_SALE => __('Sale'),
    ];
    if (!is_null($this->_methodCode) && $this->_methodCode == self::METHOD_WPP_EXPRESS) {
        $paymentActions[self::PAYMENT_ACTION_ORDER] = __('Order');
    }
    return $paymentActions;
}

dmitrii_fediuk · February 12, 2016, 11:11pm