Inheritance diagram for Configuration:

Public Member Functions
	__construct (ConfigInterface $config, ScopeConfigInterface $scopeConfig, MinsaleqtyHelper $minsaleqtyHelper, StoreManagerInterface $storeManager)

	getDefaultScopeId ()

	getIsQtyTypeIds ($filter=null)

	isQty ($productTypeId)

	canSubtractQty ($store=null)

	getMinQty ($store=null)

	getMinSaleQty ($store=null, $customerGroupId=null)

	getMaxSaleQty ($store=null)

	getNotifyStockQty ($store=null)

	getEnableQtyIncrements ($store=null)

	getQtyIncrements ($store=null)

	getBackorders ($store=null)

	getManageStock ($store=null)

	getCanBackInStock ($store=null)

	isShowOutOfStock ($store=null)

	isAutoReturnEnabled ($store=null)

	isDisplayProductStockStatus ($store=null)

	getDefaultConfigValue ($field, $store=null)

	getStockThresholdQty ($store=null)

	getConfigItemOptions ()

Data Fields
const	DEFAULT_WEBSITE_ID = 1

const	XML_PATH_GLOBAL = 'cataloginventory/options/'

const	XML_PATH_CAN_SUBTRACT = 'cataloginventory/options/can_subtract'

const	XML_PATH_CAN_BACK_IN_STOCK = 'cataloginventory/options/can_back_in_stock'

const	XML_PATH_ITEM = 'cataloginventory/item_options/'

const	XML_PATH_MIN_QTY = 'cataloginventory/item_options/min_qty'

const	XML_PATH_MIN_SALE_QTY = 'cataloginventory/item_options/min_sale_qty'

const	XML_PATH_MAX_SALE_QTY = 'cataloginventory/item_options/max_sale_qty'

const	XML_PATH_BACKORDERS = 'cataloginventory/item_options/backorders'

const	XML_PATH_NOTIFY_STOCK_QTY = 'cataloginventory/item_options/notify_stock_qty'

const	XML_PATH_MANAGE_STOCK = 'cataloginventory/item_options/manage_stock'

const	XML_PATH_ENABLE_QTY_INCREMENTS = 'cataloginventory/item_options/enable_qty_increments'

const	XML_PATH_QTY_INCREMENTS = 'cataloginventory/item_options/qty_increments'

const	XML_PATH_SHOW_OUT_OF_STOCK = 'cataloginventory/options/show_out_of_stock'

const	XML_PATH_ITEM_AUTO_RETURN = 'cataloginventory/item_options/auto_return'

const	XML_PATH_DISPLAY_PRODUCT_STOCK_STATUS = 'cataloginventory/options/display_product_stock_status'

const	XML_PATH_STOCK_THRESHOLD_QTY = 'cataloginventory/options/stock_threshold_qty'

Protected Attributes
	$config

	$scopeConfig

	$minsaleqtyHelper

	$isQtyTypeIds

	$storeManager

Detailed Description

Class Configuration

Definition at line 17 of file Configuration.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	ConfigInterface	$config,
		ScopeConfigInterface	$scopeConfig,
		MinsaleqtyHelper	$minsaleqtyHelper,
		StoreManagerInterface	$storeManager
	)

Parameters

ConfigInterface	$config
ScopeConfigInterface	$scopeConfig
MinsaleqtyHelper	$minsaleqtyHelper
StoreManagerInterface	$storeManager

Definition at line 139 of file Configuration.php.

       {
         $this->config = $config;
         $this->scopeConfig = $scopeConfig;
         $this->minsaleqtyHelper = $minsaleqtyHelper;
         $this->storeManager = $storeManager;
     }

Member Function Documentation

◆ canSubtractQty()

canSubtractQty ( $store = null )

Check if is possible subtract value from item qty

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: bool

Implements StockConfigurationInterface.

Definition at line 200 of file Configuration.php.

     {
         return $this->scopeConfig->isSetFlag(
             self::XML_PATH_CAN_SUBTRACT,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getBackorders()

getBackorders ( $store = null )

Retrieve backorders status

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: int

Implements StockConfigurationInterface.

Definition at line 293 of file Configuration.php.

     {
         return (int) $this->scopeConfig->getValue(
             self::XML_PATH_BACKORDERS,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getCanBackInStock()

getCanBackInStock ( $store = null )

Retrieve can Back in stock

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements StockConfigurationInterface.

Definition at line 324 of file Configuration.php.

     {
         return $this->scopeConfig->isSetFlag(
             self::XML_PATH_CAN_BACK_IN_STOCK,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getConfigItemOptions()

getConfigItemOptions ( )

Retrieve inventory item options (used in config)

Returns: string[]

Implements StockConfigurationInterface.

Definition at line 411 of file Configuration.php.

     {
         return [
             'min_qty',
             'backorders',
             'min_sale_qty',
             'max_sale_qty',
             'notify_stock_qty',
             'manage_stock',
             'enable_qty_increments',
             'qty_increments',
             'is_decimal_divided'
         ];
     }

◆ getDefaultConfigValue()

getDefaultConfigValue	(	$field,
		$store = `null`
	)

Parameters

string	$field
null \| string \| bool \| int \| \Magento\Store\Model\Store	$store

Returns: string|null

Implements StockConfigurationInterface.

Definition at line 384 of file Configuration.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_ITEM . $field,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getDefaultScopeId()

getDefaultScopeId ( )

{Retrieve Default Scope ID

Returns: int

}

Implements StockConfigurationInterface.

Definition at line 154 of file Configuration.php.

     {
         // TODO: should be fixed in MAGETWO-46043
         // "0" is id of admin website, which is used in backend during save entity
         return 0;
     }

◆ getEnableQtyIncrements()

getEnableQtyIncrements ( $store = null )

Retrieve whether Quantity Increments is enabled

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Implements StockConfigurationInterface.

Definition at line 265 of file Configuration.php.

     {
         return (bool) $this->scopeConfig->getValue(
             self::XML_PATH_ENABLE_QTY_INCREMENTS,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getIsQtyTypeIds()

getIsQtyTypeIds ( $filter = null )

Parameters

int | null $filter

Returns: array

Implements StockConfigurationInterface.

Definition at line 165 of file Configuration.php.

     {
         if (null === $this->isQtyTypeIds) {
             $this->isQtyTypeIds = [];
             foreach ($this->config->getAll() as $typeId => $typeConfig) {
                 $this->isQtyTypeIds[$typeId] = isset($typeConfig['is_qty']) ? $typeConfig['is_qty'] : false;
             }
         }
         $result = $this->isQtyTypeIds;
         if ($filter !== null) {
             foreach ($result as $key => $value) {
                 if ($value !== $filter) {
                     unset($result[$key]);
                 }
             }
         }
         return $result;
     }

◆ getManageStock()

getManageStock ( $store = null )

Retrieve Manage Stock data wrapper

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: int

Implements StockConfigurationInterface.

Definition at line 308 of file Configuration.php.

     {
         return (int) $this->scopeConfig->isSetFlag(
             self::XML_PATH_MANAGE_STOCK,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getMaxSaleQty()

getMaxSaleQty ( $store = null )

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: float|null

Implements StockConfigurationInterface.

Definition at line 236 of file Configuration.php.

     {
         return (float)$this->scopeConfig->getValue(
             self::XML_PATH_MAX_SALE_QTY,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getMinQty()

getMinQty ( $store = null )

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: float

Implements StockConfigurationInterface.

Definition at line 213 of file Configuration.php.

     {
         return (float)$this->scopeConfig->getValue(
             self::XML_PATH_MIN_QTY,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getMinSaleQty()

getMinSaleQty	(	$store = `null`,
		$customerGroupId = `null`
	)

Parameters

null \| string \| bool \| int \| \Magento\Store\Model\Store	$store
int	$customerGroupId

Returns: float

Implements StockConfigurationInterface.

Definition at line 227 of file Configuration.php.

     {
         return (float)$this->minsaleqtyHelper->getConfigValue($customerGroupId, $store);
     }

◆ getNotifyStockQty()

getNotifyStockQty ( $store = null )

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: float

Implements StockConfigurationInterface.

Definition at line 249 of file Configuration.php.

     {
         return (float) $this->scopeConfig->getValue(
             self::XML_PATH_NOTIFY_STOCK_QTY,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getQtyIncrements()

getQtyIncrements ( $store = null )

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: float

Implements StockConfigurationInterface.

Definition at line 278 of file Configuration.php.

     {
         return (float)$this->scopeConfig->getValue(
             self::XML_PATH_QTY_INCREMENTS,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getStockThresholdQty()

getStockThresholdQty ( $store = null )

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: string|null

Definition at line 397 of file Configuration.php.

     {
         return $this->scopeConfig->getValue(
             self::XML_PATH_STOCK_THRESHOLD_QTY,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ isAutoReturnEnabled()

isAutoReturnEnabled ( $store = null )

Check if credit memo items auto return option is enabled

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: bool

Implements StockConfigurationInterface.

Definition at line 354 of file Configuration.php.

     {
         return $this->scopeConfig->isSetFlag(
             self::XML_PATH_ITEM_AUTO_RETURN,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ isDisplayProductStockStatus()

isDisplayProductStockStatus ( $store = null )

Get 'Display product stock status' option value Shows if it is necessary to show product stock status ('in stock'/'out of stock')

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: bool

Implements StockConfigurationInterface.

Definition at line 370 of file Configuration.php.

     {
         return $this->scopeConfig->isSetFlag(
             self::XML_PATH_DISPLAY_PRODUCT_STOCK_STATUS,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ isQty()

isQty ( $productTypeId )

Parameters

int $productTypeId

Returns: bool

Implements StockConfigurationInterface.

Definition at line 188 of file Configuration.php.

     {
         $result = $this->getIsQtyTypeIds();
         return isset($result[$productTypeId]) ? $result[$productTypeId] : false;
     }

◆ isShowOutOfStock()

isShowOutOfStock ( $store = null )

Display out of stock products option

Parameters

null | string | bool | int | \Magento\Store\Model\Store $store

Returns: bool

Implements StockConfigurationInterface.

Definition at line 339 of file Configuration.php.

     {
         return $this->scopeConfig->isSetFlag(
             self::XML_PATH_SHOW_OUT_OF_STOCK,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

Field Documentation

◆ $config

$config

protected

Definition at line 107 of file Configuration.php.

◆ $isQtyTypeIds

$isQtyTypeIds

protected

Definition at line 126 of file Configuration.php.

◆ $minsaleqtyHelper

$minsaleqtyHelper

protected

Definition at line 119 of file Configuration.php.

◆ $scopeConfig

$scopeConfig

protected

Definition at line 114 of file Configuration.php.

◆ $storeManager

$storeManager

protected

Definition at line 131 of file Configuration.php.

◆ DEFAULT_WEBSITE_ID

const DEFAULT_WEBSITE_ID = 1

Default website id

Definition at line 22 of file Configuration.php.

◆ XML_PATH_BACKORDERS

const XML_PATH_BACKORDERS = 'cataloginventory/item_options/backorders'

Back orders config path

Definition at line 62 of file Configuration.php.

◆ XML_PATH_CAN_BACK_IN_STOCK

const XML_PATH_CAN_BACK_IN_STOCK = 'cataloginventory/options/can_back_in_stock'

Back in stock config path

Definition at line 37 of file Configuration.php.

◆ XML_PATH_CAN_SUBTRACT

const XML_PATH_CAN_SUBTRACT = 'cataloginventory/options/can_subtract'

Subtract config path

Definition at line 32 of file Configuration.php.

◆ XML_PATH_DISPLAY_PRODUCT_STOCK_STATUS

const XML_PATH_DISPLAY_PRODUCT_STOCK_STATUS = 'cataloginventory/options/display_product_stock_status'

Path to configuration option 'Display product stock status'

Definition at line 97 of file Configuration.php.

◆ XML_PATH_ENABLE_QTY_INCREMENTS

const XML_PATH_ENABLE_QTY_INCREMENTS = 'cataloginventory/item_options/enable_qty_increments'

Enable qty increments config path

Definition at line 77 of file Configuration.php.

◆ XML_PATH_GLOBAL

const XML_PATH_GLOBAL = 'cataloginventory/options/'

Inventory options config path

Definition at line 27 of file Configuration.php.

◆ XML_PATH_ITEM

const XML_PATH_ITEM = 'cataloginventory/item_options/'

Item options config path

Definition at line 42 of file Configuration.php.

◆ XML_PATH_ITEM_AUTO_RETURN

const XML_PATH_ITEM_AUTO_RETURN = 'cataloginventory/item_options/auto_return'

Auto return config path

Definition at line 92 of file Configuration.php.

◆ XML_PATH_MANAGE_STOCK

const XML_PATH_MANAGE_STOCK = 'cataloginventory/item_options/manage_stock'

Manage stock config path

Definition at line 72 of file Configuration.php.

◆ XML_PATH_MAX_SALE_QTY

const XML_PATH_MAX_SALE_QTY = 'cataloginventory/item_options/max_sale_qty'

Max sale qty config path

Definition at line 57 of file Configuration.php.

◆ XML_PATH_MIN_QTY

const XML_PATH_MIN_QTY = 'cataloginventory/item_options/min_qty'

Max qty config path

Definition at line 47 of file Configuration.php.

◆ XML_PATH_MIN_SALE_QTY

const XML_PATH_MIN_SALE_QTY = 'cataloginventory/item_options/min_sale_qty'

Min sale qty config path

Definition at line 52 of file Configuration.php.

◆ XML_PATH_NOTIFY_STOCK_QTY

const XML_PATH_NOTIFY_STOCK_QTY = 'cataloginventory/item_options/notify_stock_qty'

Notify stock config path

Definition at line 67 of file Configuration.php.

◆ XML_PATH_QTY_INCREMENTS

const XML_PATH_QTY_INCREMENTS = 'cataloginventory/item_options/qty_increments'

Qty increments config path

Definition at line 82 of file Configuration.php.

◆ XML_PATH_SHOW_OUT_OF_STOCK

const XML_PATH_SHOW_OUT_OF_STOCK = 'cataloginventory/options/show_out_of_stock'

Show out of stock config path

Definition at line 87 of file Configuration.php.

◆ XML_PATH_STOCK_THRESHOLD_QTY

const XML_PATH_STOCK_THRESHOLD_QTY = 'cataloginventory/options/stock_threshold_qty'

Threshold qty config path

Definition at line 102 of file Configuration.php.

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

vendor/magento/module-catalog-inventory/Model/Configuration.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canSubtractQty()

◆ getBackorders()

◆ getCanBackInStock()

◆ getConfigItemOptions()

◆ getDefaultConfigValue()

◆ getDefaultScopeId()

◆ getEnableQtyIncrements()

◆ getIsQtyTypeIds()

◆ getManageStock()

◆ getMaxSaleQty()

◆ getMinQty()

◆ getMinSaleQty()

◆ getNotifyStockQty()

◆ getQtyIncrements()

◆ getStockThresholdQty()

◆ isAutoReturnEnabled()

◆ isDisplayProductStockStatus()

◆ isQty()

◆ isShowOutOfStock()

Field Documentation

◆ $config

◆ $isQtyTypeIds

◆ $minsaleqtyHelper

◆ $scopeConfig

◆ $storeManager

◆ DEFAULT_WEBSITE_ID

◆ XML_PATH_BACKORDERS

◆ XML_PATH_CAN_BACK_IN_STOCK

◆ XML_PATH_CAN_SUBTRACT

◆ XML_PATH_DISPLAY_PRODUCT_STOCK_STATUS

◆ XML_PATH_ENABLE_QTY_INCREMENTS

◆ XML_PATH_GLOBAL

◆ XML_PATH_ITEM

◆ XML_PATH_ITEM_AUTO_RETURN

◆ XML_PATH_MANAGE_STOCK

◆ XML_PATH_MAX_SALE_QTY

◆ XML_PATH_MIN_QTY

◆ XML_PATH_MIN_SALE_QTY

◆ XML_PATH_NOTIFY_STOCK_QTY

◆ XML_PATH_QTY_INCREMENTS

◆ XML_PATH_SHOW_OUT_OF_STOCK

◆ XML_PATH_STOCK_THRESHOLD_QTY