Shipment.php

Go to the documentation of this file.

<?php
namespace Magento\Sales\Model\Order;

use Magento\Framework\Api\AttributeValueFactory;
use Magento\Sales\Api\Data\ShipmentInterface;
use Magento\Sales\Model\AbstractModel;
use Magento\Sales\Model\EntityInterface;
use Magento\Sales\Model\ResourceModel\Order\Shipment\Comment\Collection as CommentsCollection;

class Shipment extends AbstractModel implements EntityInterface, ShipmentInterface
{
    const STATUS_NEW = 1;

    const REPORT_DATE_TYPE_ORDER_CREATED = 'order_created';

    const REPORT_DATE_TYPE_SHIPMENT_CREATED = 'shipment_created';

    const XML_PATH_STORE_ADDRESS1 = 'shipping/origin/street_line1';

    const XML_PATH_STORE_ADDRESS2 = 'shipping/origin/street_line2';

    const XML_PATH_STORE_CITY = 'shipping/origin/city';

    const XML_PATH_STORE_REGION_ID = 'shipping/origin/region_id';

    const XML_PATH_STORE_ZIP = 'shipping/origin/postcode';

    const XML_PATH_STORE_COUNTRY_ID = 'shipping/origin/country_id';

    protected $entityType = 'shipment';

    protected $_order;

    protected $_eventPrefix = 'sales_order_shipment';

    protected $_eventObject = 'shipment';

    protected $_shipmentItemCollectionFactory;

    protected $_trackCollectionFactory;

    protected $_commentFactory;

    protected $_commentCollectionFactory;

    protected $orderRepository;

    private $tracksCollection;

    private $commentsCollection;

    public function __construct(
        \Magento\Framework\Model\Context $context,
        \Magento\Framework\Registry $registry,
        \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory,
        AttributeValueFactory $customAttributeFactory,
        \Magento\Sales\Model\ResourceModel\Order\Shipment\Item\CollectionFactory $shipmentItemCollectionFactory,
        \Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory $trackCollectionFactory,
        \Magento\Sales\Model\Order\Shipment\CommentFactory $commentFactory,
        \Magento\Sales\Model\ResourceModel\Order\Shipment\Comment\CollectionFactory $commentCollectionFactory,
        \Magento\Sales\Api\OrderRepositoryInterface $orderRepository,
        \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
        \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
        array $data = []
    ) {
        $this->_shipmentItemCollectionFactory = $shipmentItemCollectionFactory;
        $this->_trackCollectionFactory = $trackCollectionFactory;
        $this->_commentFactory = $commentFactory;
        $this->_commentCollectionFactory = $commentCollectionFactory;
        $this->orderRepository = $orderRepository;
        parent::__construct(
            $context,
            $registry,
            $extensionFactory,
            $customAttributeFactory,
            $resource,
            $resourceCollection,
            $data
        );
    }

    protected function _construct()
    {
        $this->_init(\Magento\Sales\Model\ResourceModel\Order\Shipment::class);
    }

    public function loadByIncrementId($incrementId)
    {
        $ids = $this->getCollection()->addAttributeToFilter('increment_id', $incrementId)->getAllIds();

        if (!empty($ids)) {
            reset($ids);
            $this->load(current($ids));
        }
        return $this;
    }

    public function setOrder(\Magento\Sales\Model\Order $order)
    {
        $this->_order = $order;
        $this->setOrderId($order->getId())->setStoreId($order->getStoreId());
        return $this;
    }

    public function getProtectCode()
    {
        return (string)$this->getOrder()->getProtectCode();
    }

    public function getOrder()
    {
        if (!$this->_order instanceof \Magento\Sales\Model\Order) {
            $this->_order = $this->orderRepository->get($this->getOrderId());
        }
        return $this->_order->setHistoryEntityName($this->entityType);
    }

    public function getEntityType()
    {
        return $this->entityType;
    }

    public function getBillingAddress()
    {
        return $this->getOrder()->getBillingAddress();
    }

    public function getShippingAddress()
    {
        return $this->getOrder()->getShippingAddress();
    }

    public function register()
    {
        if ($this->getId()) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('We cannot register an existing shipment')
            );
        }

        $totalQty = 0;

        foreach ($this->getAllItems() as $item) {
            if ($item->getQty() > 0) {
                $item->register();

                if (!$item->getOrderItem()->isDummy(true)) {
                    $totalQty += $item->getQty();
                }
            }
        }

        $this->setTotalQty($totalQty);

        return $this;
    }

    public function getItemsCollection()
    {
        if (!$this->hasData(ShipmentInterface::ITEMS)) {
            $this->setItems($this->_shipmentItemCollectionFactory->create()->setShipmentFilter($this->getId()));

            if ($this->getId()) {
                foreach ($this->getItems() as $item) {
                    $item->setShipment($this);
                }
            }
        }

        return $this->getItems();
    }

    public function getAllItems()
    {
        $items = [];
        foreach ($this->getItemsCollection() as $item) {
            if (!$item->isDeleted()) {
                $items[] = $item;
            }
        }
        return $items;
    }

    public function getItemById($itemId)
    {
        foreach ($this->getItemsCollection() as $item) {
            if ($item->getId() == $itemId) {
                return $item;
            }
        }
        return false;
    }

    public function addItem(\Magento\Sales\Model\Order\Shipment\Item $item)
    {
        $item->setShipment($this)->setParentId($this->getId())->setStoreId($this->getStoreId());
        if (!$item->getId()) {
            $this->setItems(array_merge(
                $this->getItems() ?? [],
                [$item]
            ));
        }
        return $this;
    }

    public function getTracksCollection()
    {
        if ($this->tracksCollection === null) {
            $this->tracksCollection = $this->_trackCollectionFactory->create()->setShipmentFilter($this->getId());
        }

        return $this->tracksCollection;
    }

    public function getAllTracks()
    {
        $tracks = [];
        foreach ($this->getTracksCollection() as $track) {
            if (!$track->isDeleted()) {
                $tracks[] = $track;
            }
        }
        return $tracks;
    }

    public function getTrackById($trackId)
    {
        foreach ($this->getTracksCollection() as $track) {
            if ($track->getId() == $trackId) {
                return $track;
            }
        }
        return false;
    }

    public function addTrack(\Magento\Sales\Model\Order\Shipment\Track $track)
    {
        $track->setShipment(
            $this
        )->setParentId(
            $this->getId()
        )->setOrderId(
            $this->getOrderId()
        )->setStoreId(
            $this->getStoreId()
        );
        if (!$track->getId()) {
            $this->getTracksCollection()->addItem($track);
        }

        $this->_hasDataChanges = true;

        return $this;
    }

    public function addComment($comment, $notify = false, $visibleOnFront = false)
    {
        if (!$comment instanceof \Magento\Sales\Model\Order\Shipment\Comment) {
            $comment = $this->_commentFactory->create()
                ->setComment($comment)
                ->setIsCustomerNotified($notify)
                ->setIsVisibleOnFront($visibleOnFront);
        }
        $comment->setShipment($this)
            ->setParentId($this->getId())
            ->setStoreId($this->getStoreId());
        if (!$comment->getId()) {
            $this->getCommentsCollection()->addItem($comment);
        }
        $comments = $this->getComments();
        $comments[] = $comment;
        $this->setComments($comments);
        $this->_hasDataChanges = true;
        return $this;
    }

    public function getCommentsCollection($reload = false)
    {
        if ($this->commentsCollection === null || $reload) {
            $this->commentsCollection = $this->_commentCollectionFactory->create();
            if ($this->getId()) {
                $this->commentsCollection->setShipmentFilter($this->getId())
                    ->setCreatedAtOrder();

                foreach ($this->commentsCollection as $comment) {
                    $comment->setShipment($this);
                }
            }
        }

        return $this->commentsCollection;
    }

    public function getStore()
    {
        return $this->getOrder()->getStore();
    }

    public function setShippingLabel($label)
    {
        $this->setData('shipping_label', $label);
        return $this;
    }

    public function getShippingLabel()
    {
        $label = $this->getData('shipping_label');
        if ($label) {
            return $this->getResource()->getConnection()->decodeVarbinary($label);
        }
        return $label;
    }

    public function getIncrementId()
    {
        return $this->getData('increment_id');
    }

    public function getPackages()
    {
        return $this->getData(ShipmentInterface::PACKAGES);
    }

    public function setPackages(array $packages = null)
    {
        return $this->setData(ShipmentInterface::PACKAGES, $packages);
    }

    public function getItems()
    {
        if ($this->getData(ShipmentInterface::ITEMS) === null) {
            $collection =  $this->_shipmentItemCollectionFactory->create()->setShipmentFilter($this->getId());
            if ($this->getId()) {
                foreach ($collection as $item) {
                    $item->setShipment($this);
                }
                $this->setData(ShipmentInterface::ITEMS, $collection->getItems());
            }
        }
        $shipmentItems = $this->getData(ShipmentInterface::ITEMS);
        if ($shipmentItems !== null && !is_array($shipmentItems)) {
            $shipmentItems = $shipmentItems->getItems();
        }
        return $shipmentItems;
    }

    public function setItems($items)
    {
        return $this->setData(ShipmentInterface::ITEMS, $items);
    }

    public function getTracks()
    {
        if ($this->getData(ShipmentInterface::TRACKS) === null) {
            foreach ($this->getTracksCollection() as $item) {
                $item->setShipment($this);
            }
            $this->setData(ShipmentInterface::TRACKS, $this->getTracksCollection()->getItems());
        }
        return $this->getData(ShipmentInterface::TRACKS);
    }

    //@codeCoverageIgnoreStart

    public function setTracks($tracks)
    {
        return $this->setData(ShipmentInterface::TRACKS, $tracks);
    }

    public function getBillingAddressId()
    {
        return $this->getData(ShipmentInterface::BILLING_ADDRESS_ID);
    }

    public function getCreatedAt()
    {
        return $this->getData(ShipmentInterface::CREATED_AT);
    }

    public function setCreatedAt($createdAt)
    {
        return $this->setData(ShipmentInterface::CREATED_AT, $createdAt);
    }

    public function getCustomerId()
    {
        return $this->getData(ShipmentInterface::CUSTOMER_ID);
    }

    public function getEmailSent()
    {
        return $this->getData(ShipmentInterface::EMAIL_SENT);
    }

    public function getOrderId()
    {
        return $this->getData(ShipmentInterface::ORDER_ID);
    }

    public function getShipmentStatus()
    {
        return $this->getData(ShipmentInterface::SHIPMENT_STATUS);
    }

    public function getShippingAddressId()
    {
        return $this->getData(ShipmentInterface::SHIPPING_ADDRESS_ID);
    }

    public function getStoreId()
    {
        return $this->getData(ShipmentInterface::STORE_ID);
    }

    public function getTotalQty()
    {
        return $this->getData(ShipmentInterface::TOTAL_QTY);
    }

    public function getTotalWeight()
    {
        return $this->getData(ShipmentInterface::TOTAL_WEIGHT);
    }

    public function getUpdatedAt()
    {
        return $this->getData(ShipmentInterface::UPDATED_AT);
    }

    public function getComments()
    {
        if (!$this->getId()) {
            return $this->getData(ShipmentInterface::COMMENTS);
        }

        if ($this->getData(ShipmentInterface::COMMENTS) == null) {
            $collection = $this->_commentCollectionFactory->create()
                ->setShipmentFilter($this->getId());

            foreach ($collection as $item) {
                $item->setShipment($this);
            }
            $this->setData(ShipmentInterface::COMMENTS, $collection->getItems());
        }
        return $this->getData(ShipmentInterface::COMMENTS);
    }

    public function setComments($comments = null)
    {
        return $this->setData(ShipmentInterface::COMMENTS, $comments);
    }

    public function setStoreId($id)
    {
        return $this->setData(ShipmentInterface::STORE_ID, $id);
    }

    public function setTotalWeight($totalWeight)
    {
        return $this->setData(ShipmentInterface::TOTAL_WEIGHT, $totalWeight);
    }

    public function setTotalQty($qty)
    {
        return $this->setData(ShipmentInterface::TOTAL_QTY, $qty);
    }

    public function setEmailSent($emailSent)
    {
        return $this->setData(ShipmentInterface::EMAIL_SENT, $emailSent);
    }

    public function setOrderId($id)
    {
        return $this->setData(ShipmentInterface::ORDER_ID, $id);
    }

    public function setCustomerId($id)
    {
        return $this->setData(ShipmentInterface::CUSTOMER_ID, $id);
    }

    public function setShippingAddressId($id)
    {
        return $this->setData(ShipmentInterface::SHIPPING_ADDRESS_ID, $id);
    }

    public function setBillingAddressId($id)
    {
        return $this->setData(ShipmentInterface::BILLING_ADDRESS_ID, $id);
    }

    public function setShipmentStatus($shipmentStatus)
    {
        return $this->setData(ShipmentInterface::SHIPMENT_STATUS, $shipmentStatus);
    }

    public function setIncrementId($id)
    {
        return $this->setData(ShipmentInterface::INCREMENT_ID, $id);
    }

    public function setUpdatedAt($timestamp)
    {
        return $this->setData(ShipmentInterface::UPDATED_AT, $timestamp);
    }

    public function getExtensionAttributes()
    {
        return $this->_getExtensionAttributes();
    }

    public function setExtensionAttributes(\Magento\Sales\Api\Data\ShipmentExtensionInterface $extensionAttributes)
    {
        return $this->_setExtensionAttributes($extensionAttributes);
    }

    //@codeCoverageIgnoreEnd
}