How is \Magento\Sales\Model\Order::isPaymentReview() implemented and used?

dmitry_fedyuk · May 6, 2016, 8:29pm

Context: How is \Magento\Sales\Model\Order::canReviewPayment() implemented and used?

Implementation

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L821-L832


/**
 * Check whether the payment is in payment review state
 * In this state order cannot be normally processed. Possible actions can be:
 * - accept or deny payment
 * - fetch transaction information
 *
 * @return bool
 */
public function isPaymentReview()
{
    return $this->getState() === self::STATE_PAYMENT_REVIEW;
}

Usages

1. \Magento\Sales\Model\Order::_canVoidOrder()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L558-L566


/**
 * Check whether order could be canceled by states and flags
 *
 * @return bool
 */
protected function _canVoidOrder()
{
    return !($this->isCanceled() || $this->canUnhold() || $this->isPaymentReview());
}

2. \Magento\Sales\Model\Order::canInvoice()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L576-L578


if ($this->canUnhold() || $this->isPaymentReview()) {
    return false;
}

3. \Magento\Sales\Model\Order::canCreditmemo()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L607-L609


if ($this->canUnhold() || $this->isPaymentReview()) {
    return false;
}

4. \Magento\Sales\Model\Order::canUnhold()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L654-L665


/**
 * Retrieve order unhold availability
 *
 * @return bool
 */
public function canUnhold()
{
    if ($this->getActionFlag(self::ACTION_FLAG_UNHOLD) === false || $this->isPaymentReview()) {
        return false;
    }
    return $this->getState() === self::STATE_HOLDED;
}

5. \Magento\Sales\Model\Order::canShip()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L686-L706


public function canShip()
{
    if ($this->canUnhold() || $this->isPaymentReview()) {
        return false;
    }


    if ($this->getIsVirtual() || $this->isCanceled()) {
        return false;
    }


    if ($this->getActionFlag(self::ACTION_FLAG_SHIP) === false) {
        return false;
    }


    foreach ($this->getAllItems() as $item) {
        if ($item->getQtyToShip() > 0 && !$item->getIsVirtual() && !$item->getLockedDoShip()) {
            return true;
        }
    }
    return false;
}

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

6. \Magento\Sales\Model\Order::canEdit()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L720-L726


if ($this->isCanceled() ||
    $this->isPaymentReview() ||
    $state === self::STATE_COMPLETE ||
    $state === self::STATE_CLOSED
) {
    return false;
}

How is \Magento\Sales\Model\Order::canEdit() implemented and used?

7. \Magento\Sales\Model\Order::_canReorder()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L772-L774


if ($this->canUnhold() || $this->isPaymentReview() || !$this->getCustomerId()) {
    return false;
}

8. \Magento\Sales\Model\Order::canReviewPayment()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L834-L842


/**
 * Check whether payment can be accepted or denied
 *
 * @return bool
 */
public function canReviewPayment()
{
    return $this->isPaymentReview() && $this->getPayment()->canReviewPayment();
}

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

9. \Magento\Sales\Model\Order::canFetchPaymentReviewUpdate()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L844-L852


/**
 * Check whether there can be a transaction update fetched for payment in review state
 *
 * @return bool
 */
public function canFetchPaymentReviewUpdate()
{
    return $this->isPaymentReview() && $this->getPayment()->canFetchTransactionInfo();
}

10. \Magento\Sales\Model\Order::registerCancellation()

github.com

magento/magento2/blob/135f967/app/code/Magento/Sales/Model/Order.php#L1137-L1139


public function registerCancellation($comment = '', $graceful = true)
{
    if ($this->canCancel() || $this->isPaymentReview() || $this->isFraudDetected()) {

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