Inheritance diagram for Configurable:

Public Member Functions
	__construct (\Magento\Catalog\Block\Product\Context $context, \Magento\Framework\Stdlib\ArrayUtils $arrayUtils, \Magento\Framework\Json\EncoderInterface $jsonEncoder, \Magento\ConfigurableProduct\Helper\Data $helper, \Magento\Catalog\Helper\Product $catalogProduct, CurrentCustomer $currentCustomer, PriceCurrencyInterface $priceCurrency, ConfigurableAttributeData $configurableAttributeData, array $data=[], Format $localeFormat=null, Session $customerSession=null, \Magento\ConfigurableProduct\Model\Product\Type\Configurable\Variations\Prices $variationPrices=null)

	getCacheKeyInfo ()

	getAllowAttributes ()

	getAllowProducts ()

	getCurrentStore ()

	getJsonConfig ()

	showMinimalPrice ()

Public Member Functions inherited from AbstractView
	__construct (\Magento\Catalog\Block\Product\Context $context, \Magento\Framework\Stdlib\ArrayUtils $arrayUtils, array $data=[])

	getProduct ()

	decorateArray ($array, $prefix='decorated_', $forceSetAll=false)

Public Member Functions inherited from AbstractProduct
	__construct (\Magento\Catalog\Block\Product\Context $context, array $data=[])

	getAddToCartUrl ($product, $additional=[])

	getSubmitUrl ($product, $additional=[])

	getAddToWishlistParams ($product)

	getAddToCompareUrl ()

	getMinimalQty ($product)

	getReviewsSummaryHtml (\Magento\Catalog\Model\Product $product, $templateType=false, $displayIfNoReviews=false)

	getProduct ()

	getProductUrl ($product, $additional=[])

	hasProductUrl ($product)

	getColumnCount ()

	addColumnCountLayoutDepend ($pageLayout, $columnCount)

	removeColumnCountLayoutDepend ($pageLayout)

	getColumnCountLayoutDepend ($pageLayout)

	getPageLayout ()

	getCanShowProductPrice ($product)

	displayProductStockStatus ()

	getRandomString ($length, $chars=null)

	getProductPrice (\Magento\Catalog\Model\Product $product)

	isRedirectToCartEnabled ()

	getProductDetailsHtml (\Magento\Catalog\Model\Product $product)

	getDetailsRenderer ($type=null)

	getImage ($product, $imageId, $attributes=[])

Public Member Functions inherited from Template
	__construct (Template\Context $context, array $data=[])

	setTemplateContext ($templateContext)

	getTemplate ()

	setTemplate ($template)

	getTemplateFile ($template=null)

	getArea ()

	assign ($key, $value=null)

	fetchView ($fileName)

	getBaseUrl ()

	getObjectData (\Magento\Framework\DataObject $object, $key)

	getCacheKeyInfo ()

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])

	getJsLayout ()

	getRequest ()

	getParentBlock ()

	setLayout (\Magento\Framework\View\LayoutInterface $layout)

	getLayout ()

	setNameInLayout ($name)

	getChildNames ()

	setAttribute ($name, $value=null)

	setChild ($alias, $block)

	addChild ($alias, $block, $data=[])

	unsetChild ($alias)

	unsetCallChild ($alias, $callback, $result, $params)

	unsetChildren ()

	getChildBlock ($alias)

	getChildHtml ($alias='', $useCache=true)

	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)

	getBlockHtml ($name)

	insert ($element, $siblingName=0, $after=true, $alias='')

	append ($element, $alias='')

	getGroupChildNames ($groupName)

	getChildData ($alias, $key='')

	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getUrl ($route='', $params=[])

	getViewFileUrl ($fileId, array $params=[])

	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)

	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)

	getModuleName ()

	escapeHtml ($data, $allowedTags=null)

	escapeJs ($string)

	escapeHtmlAttr ($string, $escapeSingleQuote=true)

	escapeCss ($string)

	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)

	escapeUrl ($string)

	escapeXssInUrl ($data)

	escapeQuote ($data, $addSlashes=false)

	escapeJsQuote ($data, $quote='\'')

	getNameInLayout ()

	getCacheKeyInfo ()

	getCacheKey ()

	getVar ($name, $module=null)

	isScopePrivate ()

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 BlockInterface
	toHtml ()

Protected Member Functions
	_getAdditionalConfig ()

	getOptionImages ()

	getOptionPrices ()

	_registerJsPrice ($price)

Protected Member Functions inherited from AbstractProduct
	_addProductAttributesAndPrices (\Magento\Catalog\Model\ResourceModel\Product\Collection $collection)

	getDetailsRendererList ()

Protected Member Functions inherited from Template
	_construct ()

	_toHtml ()

	getRootDirectory ()

	getMediaDirectory ()

Protected Member Functions inherited from AbstractBlock
	_construct ()

	_prepareLayout ()

	_beforeToHtml ()

	_afterToHtml ($html)

	_toHtml ()

	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])

	getCacheTags ()

	getCacheLifetime ()

	_loadCache ()

	_saveCache ($data)

	_getSidPlaceholder ($cacheKey=null)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$catalogProduct = null

	$currentCustomer

	$_prices = []

	$jsonEncoder

	$helper

	$priceCurrency

	$configurableAttributeData

Protected Attributes inherited from AbstractView
	$arrayUtils

Protected Attributes inherited from AbstractProduct
	$_priceBlock = []

	$_useLinkForAsLowAs = true

	$_defaultColumnCount = 3

	$_columnCountLayoutDepend = []

	$_coreRegistry

	$_taxData

	$_catalogConfig

	$_mathRandom

	$_cartHelper

	$_wishlistHelper

	$_compareProduct

	$_imageHelper

	$reviewRenderer

	$stockRegistry

	$imageBuilder

Protected Attributes inherited from Template
	$_viewVars = []

	$_baseUrl

	$_jsUrl

	$_allowSymlinks

	$_filesystem

	$_template

	$templateEnginePool

	$_storeManager

	$_appState

	$directory

	$templateContext

	$pageConfig

	$resolver

	$validator

Protected Attributes inherited from AbstractBlock
	$_design

	$_session

	$_sidResolver

	$_nameInLayout

	$_layout

	$jsLayout = []

	$_request

	$_urlBuilder

	$_eventManager

	$_frontController

	$_assetRepo

	$_viewConfig

	$_cacheState

	$_logger

	$_escaper

	$filterManager

	$_localeDate

	$inlineTranslation

	$_isScopePrivate = false

	$_scopeConfig

	$_cache

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)

Data Fields inherited from Template
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'

Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER

const	CACHE_KEY_PREFIX = 'BLOCK_'

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since: 100.0.2

Definition at line 23 of file Configurable.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Catalog\Block\Product\Context	$context,
		\Magento\Framework\Stdlib\ArrayUtils	$arrayUtils,
		\Magento\Framework\Json\EncoderInterface	$jsonEncoder,
		\Magento\ConfigurableProduct\Helper\Data	$helper,
		\Magento\Catalog\Helper\Product	$catalogProduct,
		CurrentCustomer	$currentCustomer,
		PriceCurrencyInterface	$priceCurrency,
		ConfigurableAttributeData	$configurableAttributeData,
		array	$data = `[]`,
		Format	$localeFormat = `null`,
		Session	$customerSession = `null`,
		\Magento\ConfigurableProduct\Model\Product\Type\Configurable\Variations\Prices	$variationPrices = `null`
	)

Parameters

\Magento\Catalog\Block\Product\Context	$context
\Magento\Framework\Stdlib\ArrayUtils	$arrayUtils
\Magento\Framework\Json\EncoderInterface	$jsonEncoder
\Magento\ConfigurableProduct\Helper\Data	$helper
\Magento\Catalog\Helper\Product	$catalogProduct
CurrentCustomer	$currentCustomer
PriceCurrencyInterface	$priceCurrency
ConfigurableAttributeData	$configurableAttributeData
array	$data
Format \| null	$localeFormat
Session \| null	$customerSession
\Magento\ConfigurableProduct\Model\Product\Type\Configurable\Variations\Prices \| null	$variationPrices	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 97 of file Configurable.php.

       {
         $this->priceCurrency = $priceCurrency;
         $this->helper = $helper;
         $this->jsonEncoder = $jsonEncoder;
         $this->catalogProduct = $catalogProduct;
         $this->currentCustomer = $currentCustomer;
         $this->configurableAttributeData = $configurableAttributeData;
         $this->localeFormat = $localeFormat ?: ObjectManager::getInstance()->get(Format::class);
         $this->customerSession = $customerSession ?: ObjectManager::getInstance()->get(Session::class);
         $this->variationPrices = $variationPrices ?: ObjectManager::getInstance()->get(
             \Magento\ConfigurableProduct\Model\Product\Type\Configurable\Variations\Prices::class
         );
 
         parent::__construct(
             $context,
             $arrayUtils,
             $data
         );
     }

Member Function Documentation

◆ _getAdditionalConfig()

_getAdditionalConfig ( )

protected

Returns additional values for js config, con be overridden by descendants

Returns: array

Definition at line 209 of file Configurable.php.

     {
         return [];
     }

◆ _registerJsPrice()

_registerJsPrice ( $price )

protected

Replace ',' on '.' for js

Deprecated:: 100.1.10 Will be removed in major release

Parameters

float $price

Returns: string

Definition at line 329 of file Configurable.php.

     {
         return str_replace(',', '.', $price);
     }

◆ getAllowAttributes()

getAllowAttributes ( )

Get allowed attributes

Returns: array

Definition at line 149 of file Configurable.php.

     {
         return $this->getProduct()->getTypeInstance()->getConfigurableAttributes($this->getProduct());
     }

◆ getAllowProducts()

getAllowProducts ( )

Get Allowed Products

Returns: \Magento\Catalog\Model\Product[]

Definition at line 178 of file Configurable.php.

     {
         if (!$this->hasAllowProducts()) {
             $products = [];
             $skipSaleableCheck = $this->catalogProduct->getSkipSaleableCheck();
             $allProducts = $this->getProduct()->getTypeInstance()->getUsedProducts($this->getProduct(), null);
             foreach ($allProducts as $product) {
                 if ($product->isSaleable() || $skipSaleableCheck) {
                     $products[] = $product;
                 }
             }
             $this->setAllowProducts($products);
         }
         return $this->getData('allow_products');
     }

◆ getCacheKeyInfo()

getCacheKeyInfo ( )

Get cache key informative items.

Returns: array

Since: 100.1.10

Definition at line 136 of file Configurable.php.

     {
         $parentData = parent::getCacheKeyInfo();
         $parentData[] = $this->priceCurrency->getCurrency()->getCode();
         $parentData[] = $this->customerSession->getCustomerGroupId();
         return $parentData;
     }

◆ getCurrentStore()

getCurrentStore ( )

Retrieve current store

Returns: \Magento\Store\Model\Store

Definition at line 199 of file Configurable.php.

     {
         return $this->_storeManager->getStore();
     }

◆ getJsonConfig()

getJsonConfig ( )

Composes configuration for js

Returns: string

Definition at line 219 of file Configurable.php.

     {
         $store = $this->getCurrentStore();
         $currentProduct = $this->getProduct();
 
         $options = $this->helper->getOptions($currentProduct, $this->getAllowProducts());
         $attributesData = $this->configurableAttributeData->getAttributesData($currentProduct, $options);
 
         $config = [
             'attributes' => $attributesData['attributes'],
             'template' => str_replace('%s', '<%- data.price %>', $store->getCurrentCurrency()->getOutputFormat()),
             'currencyFormat' => $store->getCurrentCurrency()->getOutputFormat(),
             'optionPrices' => $this->getOptionPrices(),
             'priceFormat' => $this->localeFormat->getPriceFormat(),
             'prices' => $this->variationPrices->getFormattedPrices($this->getProduct()->getPriceInfo()),
             'productId' => $currentProduct->getId(),
             'chooseText' => __('Choose an Option...'),
             'images' => $this->getOptionImages(),
             'index' => isset($options['index']) ? $options['index'] : [],
         ];
 
         if ($currentProduct->hasPreconfiguredValues() && !empty($attributesData['defaultValues'])) {
             $config['defaultValues'] = $attributesData['defaultValues'];
         }
 
         $config = array_merge($config, $this->_getAdditionalConfig());
 
         return $this->jsonEncoder->encode($config);
     }

◆ getOptionImages()

getOptionImages ( )

protected

Get product images for configurable variations

Returns: array

Since: 100.1.10

Definition at line 255 of file Configurable.php.

     {
         $images = [];
         foreach ($this->getAllowProducts() as $product) {
             $productImages = $this->helper->getGalleryImages($product) ?: [];
             foreach ($productImages as $image) {
                 $images[$product->getId()][] =
                     [
                         'thumb' => $image->getData('small_image_url'),
                         'img' => $image->getData('medium_image_url'),
                         'full' => $image->getData('large_image_url'),
                         'caption' => $image->getLabel(),
                         'position' => $image->getPosition(),
                         'isMain' => $image->getFile() == $product->getImage(),
                         'type' => str_replace('external-', '', $image->getMediaType()),
                         'videoUrl' => $image->getVideoUrl(),
                     ];
             }
         }
 
         return $images;
     }

◆ getOptionPrices()

getOptionPrices ( )

protected

Returns: array

Definition at line 281 of file Configurable.php.

     {
         $prices = [];
         foreach ($this->getAllowProducts() as $product) {
             $tierPrices = [];
             $priceInfo = $product->getPriceInfo();
             $tierPriceModel =  $priceInfo->getPrice('tier_price');
             $tierPricesList = $tierPriceModel->getTierPriceList();
             foreach ($tierPricesList as $tierPrice) {
                 $tierPrices[] = [
                     'qty' => $this->localeFormat->getNumber($tierPrice['price_qty']),
                     'price' => $this->localeFormat->getNumber($tierPrice['price']->getValue()),
                     'percentage' => $this->localeFormat->getNumber(
                         $tierPriceModel->getSavePercent($tierPrice['price'])
                     ),
                 ];
             }
 
             $prices[$product->getId()] =
                 [
                     'oldPrice' => [
                         'amount' => $this->localeFormat->getNumber(
                             $priceInfo->getPrice('regular_price')->getAmount()->getValue()
                         ),
                     ],
                     'basePrice' => [
                         'amount' => $this->localeFormat->getNumber(
                             $priceInfo->getPrice('final_price')->getAmount()->getBaseAmount()
                         ),
                     ],
                     'finalPrice' => [
                         'amount' => $this->localeFormat->getNumber(
                             $priceInfo->getPrice('final_price')->getAmount()->getValue()
                         ),
                     ],
                     'tierPrices' => $tierPrices,
                  ];
         }
         return $prices;
     }

◆ showMinimalPrice()

showMinimalPrice ( )

Should we generate "As low as" block or not

Returns: bool

Since: 100.1.10

Definition at line 340 of file Configurable.php.

     {
         return true;
     }

Field Documentation

◆ $_prices

$_prices = []

protected

Definition at line 45 of file Configurable.php.

◆ $catalogProduct

$catalogProduct = null

protected

Definition at line 30 of file Configurable.php.

◆ $configurableAttributeData

$configurableAttributeData

protected

Definition at line 65 of file Configurable.php.

◆ $currentCustomer

$currentCustomer

protected

Definition at line 38 of file Configurable.php.

◆ $helper

$helper

protected

Definition at line 55 of file Configurable.php.

◆ $jsonEncoder

$jsonEncoder

protected

Definition at line 50 of file Configurable.php.

◆ $priceCurrency

$priceCurrency

protected

Definition at line 60 of file Configurable.php.

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

vendor/magento/module-configurable-product/Block/Product/View/Type/Configurable.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getAdditionalConfig()

◆ _registerJsPrice()

◆ getAllowAttributes()

◆ getAllowProducts()

◆ getCacheKeyInfo()

◆ getCurrentStore()

◆ getJsonConfig()

◆ getOptionImages()

◆ getOptionPrices()

◆ showMinimalPrice()

Field Documentation

◆ $_prices

◆ $catalogProduct

◆ $configurableAttributeData

◆ $currentCustomer

◆ $helper

◆ $jsonEncoder

◆ $priceCurrency