Type Class Reference

Inheritance diagram for Type:

Public Member Functions
	__construct (\Magento\Catalog\Model\ProductTypes\ConfigInterface $config, \Magento\Catalog\Model\Product\Type\Pool $productTypePool, \Magento\Catalog\Model\Product\Type\Price\Factory $priceFactory, \Magento\Framework\Pricing\PriceInfo\Factory $priceInfoFactory)
	factory ($product)
	priceFactory ($productType)
	getPriceInfo (Product $saleableItem)
	getOptionArray ()
	getAllOption ()
	getAllOptions ()
	getOptions ()
	getOptionText ($optionId)
	getTypes ()
	getCompositeTypes ()
	getTypesByPriority ()
	toOptionArray ()

Data Fields
const	TYPE_SIMPLE = 'simple'
const	TYPE_BUNDLE = 'bundle'
const	TYPE_VIRTUAL = 'virtual'
const	DEFAULT_TYPE = 'simple'
const	DEFAULT_TYPE_MODEL = \Magento\Catalog\Model\Product\Type\Simple::class
const	DEFAULT_PRICE_MODEL = \Magento\Catalog\Model\Product\Type\Price::class

Protected Attributes
	$_config
	$_types
	$_compositeTypes
	$_priceModels
	$_typesPriority
	$_productTypePool
	$_priceFactory
	$_priceInfoFactory

Detailed Description

Product type model

@api

Since

100.0.2

Definition at line 17 of file Type.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Catalog\Model\ProductTypes\ConfigInterface	$config,
		\Magento\Catalog\Model\Product\Type\Pool	$productTypePool,
		\Magento\Catalog\Model\Product\Type\Price\Factory	$priceFactory,
		\Magento\Framework\Pricing\PriceInfo\Factory	$priceInfoFactory
	)

Construct

Parameters

\Magento\Catalog\Model\ProductTypes\ConfigInterface	$config
\Magento\Catalog\Model\Product\Type\Pool	$productTypePool
\Magento\Catalog\Model\Product\Type\Price\Factory	$priceFactory
\Magento\Framework\Pricing\PriceInfo\Factory	$priceInfoFactory

Definition at line 104 of file Type.php.

      {
        $this->_config = $config;
        $this->_productTypePool = $productTypePool;
        $this->_priceFactory = $priceFactory;
        $this->_priceInfoFactory = $priceInfoFactory;
    }

Member Function Documentation

factory()

factory

(

$product

)

Factory to product singleton product type instances

Parameters

\Magento\Catalog\Model\Product

$product

Returns

\Magento\Catalog\Model\Product\Type\AbstractType

Definition at line 122 of file Type.php.

    {
        $types = $this->getTypes();
        $typeId = $product->getTypeId();

        if (!empty($types[$typeId]['model'])) {
            $typeModelName = $types[$typeId]['model'];
        } else {
            $typeModelName = self::DEFAULT_TYPE_MODEL;
            $typeId = self::DEFAULT_TYPE;
        }

        $typeModel = $this->_productTypePool->get($typeModelName);
        $typeModel->setConfig($types[$typeId]);
        return $typeModel;
    }

getAllOption()

getAllOption

(

)

Get product type labels array with empty value

Returns

array

Definition at line 193 of file Type.php.

    {
        $options = $this->getOptionArray();
        array_unshift($options, ['value' => '', 'label' => '']);
        return $options;
    }

getAllOptions()

getAllOptions

(

)

Get product type labels array with empty value for option element

Returns

array

Definition at line 205 of file Type.php.

    {
        $res = $this->getOptions();
        array_unshift($res, ['value' => '', 'label' => '']);
        return $res;
    }

getCompositeTypes()

getCompositeTypes

(

)

Return composite product type Ids

Returns

array

Definition at line 260 of file Type.php.

    {
        if ($this->_compositeTypes === null) {
            $this->_compositeTypes = [];
            $types = $this->getTypes();
            foreach ($types as $typeId => $typeInfo) {
                if (array_key_exists('composite', $typeInfo) && $typeInfo['composite']) {
                    $this->_compositeTypes[] = $typeId;
                }
            }
        }
        return $this->_compositeTypes;
    }

getOptionArray()

getOptionArray

(

)

Get product type labels array

Returns

array

Definition at line 179 of file Type.php.

    {
        $options = [];
        foreach ($this->getTypes() as $typeId => $type) {
            $options[$typeId] = (string)$type['label'];
        }
        return $options;
    }

getOptions()

getOptions

(

)

Get product type labels array for option element

Returns

array

Definition at line 217 of file Type.php.

    {
        $res = [];
        foreach ($this->getOptionArray() as $index => $value) {
            $res[] = ['value' => $index, 'label' => $value];
        }
        return $res;
    }

getOptionText()

getOptionText

(

$optionId

)

Get product type label

Parameters

string

$optionId

Returns

null|string

Definition at line 232 of file Type.php.

    {
        $options = $this->getOptionArray();
        return $options[$optionId] ?? null;
    }

getPriceInfo()

getPriceInfo

(

Product

$saleableItem

)

Get Product Price Info object

Parameters

Product

$saleableItem

Returns

\Magento\Framework\Pricing\PriceInfoInterface

Definition at line 169 of file Type.php.

    {
        return $this->_priceInfoFactory->create($saleableItem);
    }

getTypes()

getTypes

(

)

Get product types

Returns

array

Definition at line 243 of file Type.php.

    {
        if ($this->_types === null) {
            $productTypes = $this->_config->getAll();
            foreach ($productTypes as $productTypeKey => $productTypeConfig) {
                $productTypes[$productTypeKey]['label'] = __($productTypeConfig['label']);
            }
            $this->_types = $productTypes;
        }
        return $this->_types;
    }

getTypesByPriority()

getTypesByPriority

(

)

Return product types by type indexing priority

Returns

array

Definition at line 279 of file Type.php.

    {
        if ($this->_typesPriority === null) {
            $this->_typesPriority = [];
            $simplePriority = [];
            $compositePriority = [];

            $types = $this->getTypes();
            foreach ($types as $typeId => $typeInfo) {
                $priority = isset($typeInfo['index_priority']) ? abs(intval($typeInfo['index_priority'])) : 0;
                if (!empty($typeInfo['composite'])) {
                    $compositePriority[$typeId] = $priority;
                } else {
                    $simplePriority[$typeId] = $priority;
                }
            }

            asort($simplePriority, SORT_NUMERIC);
            asort($compositePriority, SORT_NUMERIC);

            foreach (array_keys($simplePriority) as $typeId) {
                $this->_typesPriority[$typeId] = $types[$typeId];
            }
            foreach (array_keys($compositePriority) as $typeId) {
                $this->_typesPriority[$typeId] = $types[$typeId];
            }
        }
        return $this->_typesPriority;
    }

priceFactory()

priceFactory

(

$productType

)

Product type price model factory

Parameters

string

$productType

Returns

\Magento\Catalog\Model\Product\Type\Price

Definition at line 145 of file Type.php.

    {
        if (isset($this->_priceModels[$productType])) {
            return $this->_priceModels[$productType];
        }

        $types = $this->getTypes();

        if (!empty($types[$productType]['price_model'])) {
            $priceModelName = $types[$productType]['price_model'];
        } else {
            $priceModelName = self::DEFAULT_PRICE_MODEL;
        }

        $this->_priceModels[$productType] = $this->_priceFactory->create($priceModelName);
        return $this->_priceModels[$productType];
    }

toOptionArray()

toOptionArray

(

)

{Return array of options as value-label pairs

Returns

array Format: array(array('value' => '

', 'label' => '<label>'), ...)}

Implements OptionSourceInterface.

Definition at line 312 of file Type.php.

    {
        return $this->getOptions();
    }

Field Documentation

$_compositeTypes

$_compositeTypes

protected

Definition at line 61 of file Type.php.

$_config

$_config

protected

Definition at line 47 of file Type.php.

$_priceFactory

$_priceFactory

protected

Definition at line 89 of file Type.php.

$_priceInfoFactory

$_priceInfoFactory

protected

Definition at line 94 of file Type.php.

$_priceModels

$_priceModels

protected

Definition at line 68 of file Type.php.

$_productTypePool

$_productTypePool

protected

Definition at line 82 of file Type.php.

$_types

$_types

protected

Definition at line 54 of file Type.php.

$_typesPriority

$_typesPriority

protected

Definition at line 75 of file Type.php.

DEFAULT_PRICE_MODEL

const DEFAULT_PRICE_MODEL = \Magento\Catalog\Model\Product\Type\Price::class

Default price model

Definition at line 42 of file Type.php.

DEFAULT_TYPE

const DEFAULT_TYPE = 'simple'

#- Default product type

Definition at line 32 of file Type.php.

DEFAULT_TYPE_MODEL

const DEFAULT_TYPE_MODEL = \Magento\Catalog\Model\Product\Type\Simple::class

Default product type model

Definition at line 37 of file Type.php.

TYPE_BUNDLE

const TYPE_BUNDLE = 'bundle'

Definition at line 24 of file Type.php.

TYPE_SIMPLE

const TYPE_SIMPLE = 'simple'

#+ Available product types

Definition at line 22 of file Type.php.

TYPE_VIRTUAL

const TYPE_VIRTUAL = 'virtual'

Definition at line 26 of file Type.php.

---

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

• vendor/magento/module-catalog/Model/Product/Type.php