ShipOrder Class Reference

Inheritance diagram for ShipOrder:

Public Member Functions
	__construct (ResourceConnection $resourceConnection, OrderRepositoryInterface $orderRepository, ShipmentDocumentFactory $shipmentDocumentFactory, OrderStateResolverInterface $orderStateResolver, OrderConfig $config, ShipmentRepositoryInterface $shipmentRepository, ShipOrderValidator $shipOrderValidator, NotifierInterface $notifierInterface, OrderRegistrarInterface $orderRegistrar, LoggerInterface $logger)
	execute ( $orderId, array $items=[], $notify=false, $appendComment=false, \Magento\Sales\Api\Data\ShipmentCommentCreationInterface $comment=null, array $tracks=[], array $packages=[], \Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface $arguments=null)

Detailed Description

Class ShipOrder @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 24 of file ShipOrder.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceConnection	$resourceConnection,
		OrderRepositoryInterface	$orderRepository,
		ShipmentDocumentFactory	$shipmentDocumentFactory,
		OrderStateResolverInterface	$orderStateResolver,
		OrderConfig	$config,
		ShipmentRepositoryInterface	$shipmentRepository,
		ShipOrderValidator	$shipOrderValidator,
		NotifierInterface	$notifierInterface,
		OrderRegistrarInterface	$orderRegistrar,
		LoggerInterface	$logger
	)

Parameters

ResourceConnection	$resourceConnection
OrderRepositoryInterface	$orderRepository
ShipmentDocumentFactory	$shipmentDocumentFactory
OrderStateResolverInterface	$orderStateResolver
OrderConfig	$config
ShipmentRepositoryInterface	$shipmentRepository
ShipOrderValidator	$shipOrderValidator
NotifierInterface	$notifierInterface
OrderRegistrarInterface	$orderRegistrar
LoggerInterface	$logger	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 89 of file ShipOrder.php.

      {
        $this->resourceConnection = $resourceConnection;
        $this->orderRepository = $orderRepository;
        $this->shipmentDocumentFactory = $shipmentDocumentFactory;
        $this->orderStateResolver = $orderStateResolver;
        $this->config = $config;
        $this->shipmentRepository = $shipmentRepository;
        $this->shipOrderValidator = $shipOrderValidator;
        $this->notifierInterface = $notifierInterface;
        $this->logger = $logger;
        $this->orderRegistrar = $orderRegistrar;
    }

Member Function Documentation

execute()

execute	(		$orderId,
		array	$items = [],
			$notify = false,
			$appendComment = false,
		\Magento\Sales\Api\Data\ShipmentCommentCreationInterface	$comment = null,
		array	$tracks = [],
		array	$packages = [],
		\Magento\Sales\Api\Data\ShipmentCreationArgumentsInterface	$arguments = null
	)

Parameters

int	$orderId

Implements ShipOrderInterface.

Definition at line 129 of file ShipOrder.php.

      {
        $connection = $this->resourceConnection->getConnection('sales');
        $order = $this->orderRepository->get($orderId);
        $shipment = $this->shipmentDocumentFactory->create(
            $order,
            $items,
            $tracks,
            $comment,
            ($appendComment && $notify),
            $packages,
            $arguments
        );
        $validationMessages = $this->shipOrderValidator->validate(
            $order,
            $shipment,
            $items,
            $notify,
            $appendComment,
            $comment,
            $tracks,
            $packages
        );
        if ($validationMessages->hasMessages()) {
            throw new \Magento\Sales\Exception\DocumentValidationException(
                __("Shipment Document Validation Error(s):\n" . implode("\n", $validationMessages->getMessages()))
            );
        }
        $connection->beginTransaction();
        try {
            $this->orderRegistrar->register($order, $shipment);
            $order->setState(
                $this->orderStateResolver->getStateForOrder($order, [OrderStateResolverInterface::IN_PROGRESS])
            );
            $order->setStatus($this->config->getStateDefaultStatus($order->getState()));
            $this->shipmentRepository->save($shipment);
            $this->orderRepository->save($order);
            $connection->commit();
        } catch (\Exception $e) {
            $this->logger->critical($e);
            $connection->rollBack();
            throw new \Magento\Sales\Exception\CouldNotShipException(
                __('Could not save a shipment, see error log for details')
            );
        }
        if ($notify) {
            if (!$appendComment) {
                $comment = null;
            }
            $this->notifierInterface->notify($order, $shipment, $comment);
        }
        return $shipment->getEntityId();
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/module-sales/Model/ShipOrder.php