Flatrate Class Reference

Inheritance diagram for Flatrate:

Public Member Functions
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory, \Psr\Log\LoggerInterface $logger, \Magento\Shipping\Model\Rate\ResultFactory $rateResultFactory, \Magento\Quote\Model\Quote\Address\RateResult\MethodFactory $rateMethodFactory, \Magento\OfflineShipping\Model\Carrier\Flatrate\ItemPriceCalculator $itemPriceCalculator, array $data=[])
	getAllowedMethods ()
Public Member Functions inherited from AbstractCarrier
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory $rateErrorFactory, \Psr\Log\LoggerInterface $logger, array $data=[])
	getConfigData ($field)
	getConfigFlag ($field)
	requestToShipment ($request)
	returnOfShipment ($request)
	getContainerTypes (\Magento\Framework\DataObject $params=null)
	getCustomizableContainerTypes ()
	getDeliveryConfirmationTypes (\Magento\Framework\DataObject $params=null)
	processAdditionalValidation (\Magento\Framework\DataObject $request)
	proccessAdditionalValidation (\Magento\Framework\DataObject $request)
	isActive ()
	isFixed ()
	isTrackingAvailable ()
	isShippingLabelsAvailable ()
	getSortOrder ()
	getFinalPriceWithHandlingFee ($cost)
	getTotalNumOfBoxes ($weight)
	isStateProvinceRequired ()
	isCityRequired ()
	isZipCodeRequired ($countryId=null)
	getDebugFlag ()
	debugData ($debugData)
	getCarrierCode ()
	getContentTypes (\Magento\Framework\DataObject $params)
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)
Public Member Functions inherited from AbstractCarrierInterface
	collectRates (RateRequest $request)
	checkAvailableShipCountries (\Magento\Framework\DataObject $request)
Public Member Functions inherited from CarrierInterface
	isTrackingAvailable ()

Protected Attributes
	$_code = 'flatrate'
	$_isFixed = true
	$_rateResultFactory
	$_rateMethodFactory
Protected Attributes inherited from AbstractCarrier
	$_code
	$_rates
	$_numBoxes = 1
	$_freeMethod = 'free_method'
	$_isFixed = false
	$_customizableContainerTypes = []
	$_debugReplacePrivateDataKeys = []
	$_scopeConfig
	$_rateErrorFactory
	$_logger
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Data Fields inherited from AbstractCarrier
const	DEBUG_KEYS_MASK = '****'
const	USA_COUNTRY_ID = 'US'
const	CANADA_COUNTRY_ID = 'CA'
const	MEXICO_COUNTRY_ID = 'MX'
const	HANDLING_TYPE_PERCENT = 'P'
const	HANDLING_TYPE_FIXED = 'F'
const	HANDLING_ACTION_PERPACKAGE = 'P'
const	HANDLING_ACTION_PERORDER = 'O'
Protected Member Functions inherited from AbstractCarrier
	_getAllowedContainers (\Magento\Framework\DataObject $params=null)
	_updateFreeMethodQuote ($request)
	_getPerpackagePrice ($cost, $handlingType, $handlingFee)
	_getPerorderPrice ($cost, $handlingType, $handlingFee)
	_debug ($debugData)
	filterDebugData ($data)
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Flat rate shipping model

@api

Since

100.0.2

Definition at line 20 of file Flatrate.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory	$rateErrorFactory,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Shipping\Model\Rate\ResultFactory	$rateResultFactory,
		\Magento\Quote\Model\Quote\Address\RateResult\MethodFactory	$rateMethodFactory,
		\Magento\OfflineShipping\Model\Carrier\Flatrate\ItemPriceCalculator	$itemPriceCalculator,
		array	$data = []
	)

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Quote\Model\Quote\Address\RateResult\ErrorFactory	$rateErrorFactory
\Psr\Log\LoggerInterface	$logger
\Magento\Shipping\Model\Rate\ResultFactory	$rateResultFactory
\Magento\Quote\Model\Quote\Address\RateResult\MethodFactory	$rateMethodFactory
ItemPriceCalculator	$itemPriceCalculator
array	$data

Definition at line 56 of file Flatrate.php.

      {
        $this->_rateResultFactory = $rateResultFactory;
        $this->_rateMethodFactory = $rateMethodFactory;
        $this->itemPriceCalculator = $itemPriceCalculator;
        parent::__construct($scopeConfig, $rateErrorFactory, $logger, $data);
    }

Member Function Documentation

getAllowedMethods()

getAllowedMethods

(

)

Returns

array

Implements CarrierInterface.

Definition at line 125 of file Flatrate.php.

    {
        return ['flatrate' => $this->getConfigData('name')];
    }

Field Documentation

$_code

$_code = 'flatrate'

protected

Definition at line 25 of file Flatrate.php.

$_isFixed

$_isFixed = true

protected

Definition at line 30 of file Flatrate.php.

$_rateMethodFactory

$_rateMethodFactory

protected

Definition at line 40 of file Flatrate.php.

$_rateResultFactory

$_rateResultFactory

protected

Definition at line 35 of file Flatrate.php.

---

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

• vendor/magento/module-offline-shipping/Model/Carrier/Flatrate.php