Info Class Reference

Inheritance diagram for Info:

Public Member Functions
	__construct (\Magento\Shipping\Helper\Data $shippingData, \Magento\Sales\Model\OrderFactory $orderFactory, \Magento\Sales\Api\ShipmentRepositoryInterface $shipmentRepository, \Magento\Shipping\Model\Order\TrackFactory $trackFactory, \Magento\Shipping\Model\ResourceModel\Order\Track\CollectionFactory $trackCollectionFactory, array $data=[])
	loadByHash ($hash)
	getTrackingInfo ()
	getTrackingInfoByOrder ()
	getTrackingInfoByShip ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Protected Member Functions
	_initShipment ()
	_getTracksCollection (Shipment $shipment)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$_trackingInfo = []
	$_shippingData
	$_orderFactory
	$shipmentRepository
	$_trackFactory
	$_trackCollectionFactory
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Definition at line 11 of file Info.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Shipping\Helper\Data	$shippingData,
		\Magento\Sales\Model\OrderFactory	$orderFactory,
		\Magento\Sales\Api\ShipmentRepositoryInterface	$shipmentRepository,
		\Magento\Shipping\Model\Order\TrackFactory	$trackFactory,
		\Magento\Shipping\Model\ResourceModel\Order\Track\CollectionFactory	$trackCollectionFactory,
		array	$data = []
	)

Parameters

\Magento\Shipping\Helper\Data	$shippingData
\Magento\Sales\Model\OrderFactory	$orderFactory
\Magento\Sales\Api\ShipmentRepositoryInterface	$shipmentRepository
\Magento\Shipping\Model\Order\TrackFactory	$trackFactory
\Magento\Shipping\Model\ResourceModel\Order\Track\CollectionFactory	$trackCollectionFactory
array	$data

Definition at line 55 of file Info.php.

      {
        $this->_shippingData = $shippingData;
        $this->_orderFactory = $orderFactory;
        $this->shipmentRepository = $shipmentRepository;
        $this->_trackFactory = $trackFactory;
        $this->_trackCollectionFactory = $trackCollectionFactory;
        parent::__construct($data);
    }

Member Function Documentation

_getTracksCollection()

_getTracksCollection ( Shipment  $shipment )

protected

Parameters

Shipment

$shipment

Returns

\Magento\Shipping\Model\ResourceModel\Order\Track\Collection

Definition at line 208 of file Info.php.

    {
        $tracks = $this->_trackCollectionFactory->create()->setShipmentFilter($shipment->getId());

        if ($shipment->getId()) {
            foreach ($tracks as $track) {
                $track->setShipment($shipment);
            }
        }
        return $tracks;
    }

_initShipment()

_initShipment ( )

protected

Instantiate ship model

Returns

Shipment|bool

Definition at line 129 of file Info.php.

    {
        /* @var $model Shipment */
        $ship = $this->shipmentRepository->get($this->getShipId());
        if (!$ship->getEntityId() || $this->getProtectCode() !== $ship->getProtectCode()) {
            return false;
        }

        return $ship;
    }

getTrackingInfo()

getTrackingInfo

(

)

Retrieve tracking info

Returns

array

Definition at line 102 of file Info.php.

    {
        return $this->_trackingInfo;
    }

getTrackingInfoByOrder()

getTrackingInfoByOrder

(

)

Retrieve all tracking by order id

Returns

array

Definition at line 145 of file Info.php.

    {
        $shipTrack = [];
        $order = $this->_initOrder();
        if ($order) {
            $shipments = $order->getShipmentsCollection();
            foreach ($shipments as $shipment) {
                $increment_id = $shipment->getIncrementId();
                $tracks = $this->_getTracksCollection($shipment);

                $trackingInfos = [];
                foreach ($tracks as $track) {
                    $trackingInfos[] = $track->getNumberDetail();
                }
                $shipTrack[$increment_id] = $trackingInfos;
            }
        }
        $this->_trackingInfo = $shipTrack;
        return $this->_trackingInfo;
    }

getTrackingInfoByShip()

getTrackingInfoByShip

(

)

Retrieve all tracking by ship id

Returns

array

Definition at line 171 of file Info.php.

    {
        $shipTrack = [];
        $shipment = $this->_initShipment();
        if ($shipment) {
            $increment_id = $shipment->getIncrementId();
            $tracks = $this->_getTracksCollection($shipment);

            $trackingInfos = [];
            foreach ($tracks as $track) {
                $trackingInfos[] = $track->getNumberDetail();
            }
            $shipTrack[$increment_id] = $trackingInfos;
        }
        $this->_trackingInfo = $shipTrack;
        return $this->_trackingInfo;
    }

loadByHash()

loadByHash

(

$hash

)

Generating tracking info

Parameters

array

$hash

Returns

$this

Definition at line 77 of file Info.php.

    {
        /* @var $helper \Magento\Shipping\Helper\Data */
        $helper = $this->_shippingData;
        $data = $helper->decodeTrackingHash($hash);
        if (!empty($data)) {
            $this->setData($data['key'], $data['id']);
            $this->setProtectCode($data['hash']);

            if ($this->getOrderId() > 0) {
                $this->getTrackingInfoByOrder();
            } elseif ($this->getShipId() > 0) {
                $this->getTrackingInfoByShip();
            } else {
                $this->getTrackingInfoByTrackId();
            }
        }
        return $this;
    }

Field Documentation

$_orderFactory

$_orderFactory

protected

Definition at line 30 of file Info.php.

$_shippingData

$_shippingData

protected

Definition at line 25 of file Info.php.

$_trackCollectionFactory

$_trackCollectionFactory

protected

Definition at line 45 of file Info.php.

$_trackFactory

$_trackFactory

protected

Definition at line 40 of file Info.php.

$_trackingInfo

$_trackingInfo = []

protected

Definition at line 18 of file Info.php.

$shipmentRepository

$shipmentRepository

protected

Definition at line 35 of file Info.php.

---

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

• vendor/magento/module-shipping/Model/Info.php