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

dmitry_fedyuk · April 27, 2016, 8:05pm

Implementation

magento/magento2/blob/958164/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::isPaymentReview() implemented and used?

Usages

1. \Magento\Sales\Block\Adminhtml\Order\View::_construct()

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Block/Adminhtml/Order/View.php#L231-L243


if ($this->_isAllowedAction(
    'Magento_Sales::ship'
) && $order->canShip() && !$order->getForcedShipmentWithInvoice()
) {
    $this->buttonList->add(
        'order_ship',
        [
            'label' => __('Ship'),
            'onclick' => 'setLocation(\'' . $this->getShipUrl() . '\')',
            'class' => 'ship'
        ]
    );
}

2. \Magento\Sales\Model\ResourceModel\Order\Handler\State::check()

github.com

magento/magento2/blob/958164/app/code/Magento/Sales/Model/ResourceModel/Order/Handler/State.php#L29-L29


if (!$order->isCanceled() && !$order->canUnhold() && !$order->canInvoice() && !$order->canShip()) {

3. \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader::load()

github.com

magento/magento2/blob/958164/app/code/Magento/Shipping/Controller/Adminhtml/Order/ShipmentLoader.php#L125-L131


/**
 * Check shipment create availability
 */
if (!$order->canShip()) {
    $this->messageManager->addError(__('Cannot do shipment for the order.'));
    return false;
}

dmitry_fedyuk · April 27, 2016, 8:10pm