How is «Submit Shipment» implemented?

dmitry_fedyuk · April 26, 2016, 10:41am

magento/magento2/blob/958164/app/code/Magento/Shipping/Block/Adminhtml/Create/Items.php#L78-L96


/**
 * Prepare child blocks
 *
 * @return string
 */
protected function _beforeToHtml()
{
    $this->addChild(
        'submit_button',
        'Magento\Backend\Block\Widget\Button',
        [
            'label' => __('Submit Shipment'),
            'class' => 'save submit-button primary',
            'onclick' => 'submitShipment(this);'
        ]
    );


    return parent::_beforeToHtml();
}

github.com

magento/magento2/blob/958164/app/code/Magento/Shipping/view/adminhtml/templates/create/items.phtml#L147-L166


window.submitShipment = function(btn) {
if (!validQtyItems()) {
    alert({
        content: '<?php /* @escapeNotVerified */ echo __('Invalid value(s) for Qty to Ship') ?>'
    });
    return;
}
var checkbox = $(btn).up('.order-totals').select('#create_shipping_label')[0];
if (checkbox && checkbox.checked) {
    packaging.showWindow();
} else {
    disableElements('submit-button');
    // Temporary solution will be replaced after refactoring order functionality
    jQuery('#edit_form').on('invalid-form.validate', function() {
        enableElements('submit-button');
        jQuery('#edit_form').off('invalid-form.validate');
    });
    jQuery('#edit_form').triggerHandler('save');
}
}

github.com

magento/magento2/blob/958164/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php#L75-L83


/**
 * Save shipment
 * We can save only new shipment. Existing shipments are not editable
 *
 * @return void
 * @SuppressWarnings(PHPMD.CyclomaticComplexity)
 * @SuppressWarnings(PHPMD.NPathComplexity)
 */
public function execute()

github.com

magento/magento2/blob/958164/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php#L85-L99


/** @var \Magento\Backend\Model\View\Result\Redirect $resultRedirect */
$resultRedirect = $this->resultRedirectFactory->create();


$formKeyIsValid = $this->_formKeyValidator->validate($this->getRequest());
$isPost = $this->getRequest()->isPost();
if (!$formKeyIsValid || !$isPost) {
    $this->messageManager->addError(__('We can\'t save the shipment right now.'));
    return $resultRedirect->setPath('sales/order/index');
}


$data = $this->getRequest()->getParam('shipment');


if (!empty($data['comment_text'])) {
    $this->_objectManager->get('Magento\Backend\Model\Session')->setCommentText($data['comment_text']);
}

github.com

magento/magento2/blob/958164/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php#L101-L106


try {
    $this->shipmentLoader->setOrderId($this->getRequest()->getParam('order_id'));
    $this->shipmentLoader->setShipmentId($this->getRequest()->getParam('shipment_id'));
    $this->shipmentLoader->setShipment($data);
    $this->shipmentLoader->setTracking($this->getRequest()->getParam('tracking'));
    $shipment = $this->shipmentLoader->load();

Details: How does \Magento\Shipping\Controller\Adminhtml\Order\ShipmentLoader::load() work?

github.com

magento/magento2/blob/958164/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php#L107-L123


if (!$shipment) {
    $this->_forward('noroute');
    return;
}


if (!empty($data['comment_text'])) {
    $shipment->addComment(
        $data['comment_text'],
        isset($data['comment_customer_notify']),
        isset($data['is_visible_on_front'])
    );


    $shipment->setCustomerNote($data['comment_text']);
    $shipment->setCustomerNoteNotify(isset($data['comment_customer_notify']));
}


$shipment->register();

Details: How does \Magento\Sales\Model\Order\Shipment::register() work?

github.com

magento/magento2/blob/958164/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php#L125-L134


$shipment->getOrder()->setCustomerNoteNotify(!empty($data['send_email']));
$responseAjax = new \Magento\Framework\DataObject();
$isNeedCreateLabel = isset($data['create_shipping_label']) && $data['create_shipping_label'];


if ($isNeedCreateLabel) {
    $this->labelGenerator->create($shipment, $this->_request);
    $responseAjax->setOk(true);
}


$this->_saveShipment($shipment);

Details: How does \Magento\Shipping\Controller\Adminhtml\Order\Shipment\Save::_saveShipment() work?

github.com

magento/magento2/blob/958164/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php#L136-L146


if (!empty($data['send_email'])) {
    $this->shipmentSender->send($shipment);
}


$shipmentCreatedMessage = __('The shipment has been created.');
$labelCreatedMessage = __('You created the shipping label.');


$this->messageManager->addSuccess(
    $isNeedCreateLabel ? $shipmentCreatedMessage . ' ' . $labelCreatedMessage : $shipmentCreatedMessage
);
$this->_objectManager->get('Magento\Backend\Model\Session')->getCommentText(true);

github.com

magento/magento2/blob/958164/app/code/Magento/Shipping/Controller/Adminhtml/Order/Shipment/Save.php#L165-L169


if ($isNeedCreateLabel) {
    $this->getResponse()->representJson($responseAjax->toJson());
} else {
    $this->_redirect('sales/order/view', ['order_id' => $shipment->getOrderId()]);
}

dmitry_fedyuk · April 26, 2016, 10:44am