Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, StoreManagerInterface $storeManager, UrlInterface $url=null)
	decodeTrackingHash ($hash)
	getTrackingPopupUrlBySalesModel ($model)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Protected Member Functions
	_getTrackingUrl ($key, $model, $method='getId')
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Protected Attributes
	$_allowedHashKeys = ['ship_id', 'order_id', 'track_id']
	$_storeManager
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Definition at line 16 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		StoreManagerInterface	$storeManager,
		UrlInterface	$url = null
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
StoreManagerInterface	$storeManager
UrlInterface | null	$url

Definition at line 40 of file Data.php.

      {
        $this->_storeManager = $storeManager;
        $this->url = $url ?: ObjectManager::getInstance()->get(UrlInterface::class);

        parent::__construct($context);
    }

Member Function Documentation

_getTrackingUrl()

_getTrackingUrl (   $key,   $model,   $method = 'getId'  )

protected

Retrieve tracking url with params

Parameters

string	$key

Definition at line 75 of file Data.php.

    {
        $urlPart = "{$key}:{$model->{$method}()}:{$model->getProtectCode()}";
        $params = [
            '_scope' => $model->getStoreId(),
            '_nosid' => true,
            '_direct' => 'shipping/tracking/popup',
            '_query' => ['hash' => $this->urlEncoder->encode($urlPart)]
        ];

        return $this->url->getUrl('', $params);
    }

decodeTrackingHash()

decodeTrackingHash

(

$hash

)

Decode url hash

Parameters

string

$hash

Returns

array

Definition at line 57 of file Data.php.

    {
        $hash = explode(':', $this->urlDecoder->decode($hash));
        if (count($hash) === 3 && in_array($hash[0], $this->_allowedHashKeys)) {
            return ['key' => $hash[0], 'id' => (int)$hash[1], 'hash' => $hash[2]];
        }
        return [];
    }

getTrackingPopupUrlBySalesModel()

getTrackingPopupUrlBySalesModel

(

$model

)

Shipping tracking popup URL getter

Parameters

\Magento\Sales\Model\AbstractModel

$model

Returns

string

Definition at line 94 of file Data.php.

    {
        if ($model instanceof \Magento\Sales\Model\Order) {
            return $this->_getTrackingUrl('order_id', $model);
        } elseif ($model instanceof \Magento\Sales\Model\Order\Shipment) {
            return $this->_getTrackingUrl('ship_id', $model);
        } elseif ($model instanceof \Magento\Sales\Model\Order\Shipment\Track) {
            return $this->_getTrackingUrl('track_id', $model, 'getEntityId');
        }
        return '';
    }

Field Documentation

$_allowedHashKeys

$_allowedHashKeys = ['ship_id', 'order_id', 'track_id']

protected

Definition at line 23 of file Data.php.

$_storeManager

$_storeManager

protected

Definition at line 28 of file Data.php.

---

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

• vendor/magento/module-shipping/Helper/Data.php