CarrierFactory Class Reference

Inheritance diagram for CarrierFactory:

Public Member Functions
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\ObjectManagerInterface $objectManager)
	get ($carrierCode)
	create ($carrierCode, $storeId=null)
	getIfActive ($carrierCode)
	createIfActive ($carrierCode, $storeId=null)

Protected Attributes
	$_scopeConfig
	$_objectManager

Detailed Description

Class CarrierFactory

Definition at line 11 of file CarrierFactory.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\ObjectManagerInterface	$objectManager
	)

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\ObjectManagerInterface	$objectManager

Definition at line 29 of file CarrierFactory.php.

      {
        $this->_scopeConfig = $scopeConfig;
        $this->_objectManager = $objectManager;
    }

Member Function Documentation

create()

create	(		$carrierCode,
			$storeId = null
	)

Create carrier instance

Parameters

string	$carrierCode
int | null	$storeId

Returns

bool|Carrier\AbstractCarrier

Implements CarrierFactoryInterface.

Definition at line 64 of file CarrierFactory.php.

    {
        $className = $this->_scopeConfig->getValue(
            'carriers/' . $carrierCode . '/model',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $storeId
        );
        if (!$className) {
            return false;
        }
        $carrier = $this->_objectManager->create($className);
        $carrier->setId($carrierCode);
        if ($storeId) {
            $carrier->setStore($storeId);
        }
        return $carrier;
    }

createIfActive()

createIfActive	(		$carrierCode,
			$storeId = null
	)

Create carrier by its code if it is active

Parameters

string	$carrierCode
null | int	$storeId

Returns

bool|Carrier\AbstractCarrier

Implements CarrierFactoryInterface.

Definition at line 105 of file CarrierFactory.php.

    {
        return $this->_scopeConfig->isSetFlag(
            'carriers/' . $carrierCode . '/active',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $storeId
        ) ? $this->create(
            $carrierCode,
            $storeId
        ) : false;
    }

get()

get

(

$carrierCode

)

Get carrier instance

Parameters

string

$carrierCode

Returns

bool|Carrier\AbstractCarrier

Implements CarrierFactoryInterface.

Definition at line 43 of file CarrierFactory.php.

    {
        $className = $this->_scopeConfig->getValue(
            'carriers/' . $carrierCode . '/model',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        );
        if (!$className) {
            return false;
        }
        $carrier = $this->_objectManager->get($className);
        $carrier->setId($carrierCode);
        return $carrier;
    }

getIfActive()

getIfActive

(

$carrierCode

)

Get carrier by its code if it is active

Parameters

string

$carrierCode

Returns

bool|Carrier\AbstractCarrier

Implements CarrierFactoryInterface.

Definition at line 88 of file CarrierFactory.php.

    {
        return $this->_scopeConfig->isSetFlag(
            'carriers/' . $carrierCode . '/active',
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
        ) ? $this->get(
            $carrierCode
        ) : false;
    }

Field Documentation

$_objectManager

$_objectManager

protected

Definition at line 23 of file CarrierFactory.php.

$_scopeConfig

$_scopeConfig

protected

Definition at line 18 of file CarrierFactory.php.

---

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

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