Inheritance diagram for AbstractProduct:

Public Member Functions
	__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
	_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
	$_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

Class AbstractProduct @api

Deprecated:: 102.0.0 @SuppressWarnings(PHPMD.NumberOfChildren) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 16 of file AbstractProduct.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Catalog\Block\Product\Context	$context,
		array	$data = `[]`
	)

Parameters

Context	$context
array	$data

Definition at line 110 of file AbstractProduct.php.

     {
         $this->_imageHelper = $context->getImageHelper();
         $this->imageBuilder = $context->getImageBuilder();
         $this->_compareProduct = $context->getCompareProduct();
         $this->_wishlistHelper = $context->getWishlistHelper();
         $this->_cartHelper = $context->getCartHelper();
         $this->_catalogConfig = $context->getCatalogConfig();
         $this->_coreRegistry = $context->getRegistry();
         $this->_taxData = $context->getTaxData();
         $this->_mathRandom = $context->getMathRandom();
         $this->reviewRenderer = $context->getReviewRenderer();
         $this->stockRegistry = $context->getStockRegistry();
         parent::__construct($context, $data);
     }

Member Function Documentation

◆ _addProductAttributesAndPrices()

_addProductAttributesAndPrices ( \Magento\Catalog\Model\ResourceModel\Product\Collection $collection )

protected

Add all attributes and apply pricing logic to products collection to get correct values in different products lists. E.g. crosssells, upsells, new products, recently viewed

Parameters

\Magento\Catalog\Model\ResourceModel\Product\Collection $collection

Returns: \Magento\Catalog\Model\ResourceModel\Product\Collection

Definition at line 244 of file AbstractProduct.php.

       {
         return $collection
             ->addMinimalPrice()
             ->addFinalPrice()
             ->addTaxPercents()
             ->addAttributeToSelect($this->_catalogConfig->getProductAttributes())
             ->addUrlRewrite();
     }

◆ addColumnCountLayoutDepend()

addColumnCountLayoutDepend	(	$pageLayout,
		$columnCount
	)

Add row size depends on page layout

Parameters

string	$pageLayout
int	$columnCount

Returns: \Magento\Catalog\Block\Product\ListProduct

Definition at line 319 of file AbstractProduct.php.

     {
         $this->_columnCountLayoutDepend[$pageLayout] = $columnCount;
         return $this;
     }

◆ displayProductStockStatus()

displayProductStockStatus ( )

Get if it is necessary to show product stock status

Returns: bool

Definition at line 383 of file AbstractProduct.php.

     {
         $statusInfo = new \Magento\Framework\DataObject(['display_status' => true]);
         $this->_eventManager->dispatch('catalog_block_product_status_display', ['status' => $statusInfo]);
         return (bool) $statusInfo->getDisplayStatus();
     }

◆ getAddToCartUrl()

getAddToCartUrl	(	$product,
		$additional = `[]`
	)

Retrieve url for add product to cart Will return product view page URL if product has required options

Parameters

\Magento\Catalog\Model\Product	$product
array	$additional

Returns: string

Definition at line 134 of file AbstractProduct.php.

     {
         if (!$product->getTypeInstance()->isPossibleBuyFromList($product)) {
             if (!isset($additional['_escape'])) {
                 $additional['_escape'] = true;
             }
             if (!isset($additional['_query'])) {
                 $additional['_query'] = [];
             }
             $additional['_query']['options'] = 'cart';
 
             return $this->getProductUrl($product, $additional);
         }
         return $this->_cartHelper->getAddUrl($product, $additional);
     }

◆ getAddToCompareUrl()

getAddToCompareUrl ( )

Retrieve Add Product to Compare Products List URL

Returns: string

Definition at line 189 of file AbstractProduct.php.

     {
         return $this->_compareProduct->getAddUrl();
     }

◆ getAddToWishlistParams()

getAddToWishlistParams ( $product )

Retrieve add to wishlist params

Parameters

\Magento\Catalog\Model\Product $product

Returns: string

Definition at line 179 of file AbstractProduct.php.

     {
         return $this->_wishlistHelper->getAddParams($product);
     }

◆ getCanShowProductPrice()

getCanShowProductPrice ( $product )

Check whether the price can be shown for the specified product

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 373 of file AbstractProduct.php.

     {
         return $product->getCanShowPrice() !== false;
     }

◆ getColumnCount()

getColumnCount ( )

Retrieve product amount per row

Returns: int

Definition at line 299 of file AbstractProduct.php.

     {
         if (!$this->_getData('column_count')) {
             $pageLayout = $this->getPageLayout();
             if ($pageLayout && $this->getColumnCountLayoutDepend($pageLayout->getCode())) {
                 $this->setData('column_count', $this->getColumnCountLayoutDepend($pageLayout->getCode()));
             } else {
                 $this->setData('column_count', $this->_defaultColumnCount);
             }
         }
         return (int) $this->_getData('column_count');
     }

◆ getColumnCountLayoutDepend()

getColumnCountLayoutDepend ( $pageLayout )

Retrieve row size depends on page layout

Parameters

string $pageLayout

Returns: int|boolean

Definition at line 346 of file AbstractProduct.php.

     {
         if (isset($this->_columnCountLayoutDepend[$pageLayout])) {
             return $this->_columnCountLayoutDepend[$pageLayout];
         }
 
         return false;
     }

◆ getDetailsRenderer()

getDetailsRenderer ( $type = null )

Parameters

null $type

Returns: bool|\Magento\Framework\View\Element\AbstractBlock

Definition at line 479 of file AbstractProduct.php.

     {
         if ($type === null) {
             $type = 'default';
         }
         $rendererList = $this->getDetailsRendererList();
         if ($rendererList) {
             return $rendererList->getRenderer($type, 'default');
         }
         return null;
     }

◆ getDetailsRendererList()

getDetailsRendererList ( )

protected

Returns: \Magento\Framework\View\Element\RendererList

Definition at line 494 of file AbstractProduct.php.

     {
         return $this->getDetailsRendererListName() ? $this->getLayout()->getBlock(
             $this->getDetailsRendererListName()
         ) : $this->getChildBlock(
             'details.renderers'
         );
     }

◆ getImage()

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

Retrieve product image

Parameters

\Magento\Catalog\Model\Product	$product
string	$imageId
array	$attributes

Returns: \Magento\Catalog\Block\Product\Image

Definition at line 511 of file AbstractProduct.php.

     {
         return $this->imageBuilder->create($product, $imageId, $attributes);
     }

◆ getMinimalQty()

getMinimalQty ( $product )

Gets minimal sales quantity

Parameters

\Magento\Catalog\Model\Product $product

Returns: float|null

Definition at line 200 of file AbstractProduct.php.

     {
         $stockItem = $this->stockRegistry->getStockItem($product->getId(), $product->getStore()->getWebsiteId());
         $minSaleQty = $stockItem->getMinSaleQty();
         return $minSaleQty > 0 ? $minSaleQty : null;
     }

◆ getPageLayout()

getPageLayout ( )

Retrieve current page layout

Returns: string

Definition at line 360 of file AbstractProduct.php.

     {
         // TODO: Implement of getting  current page layout
         return '';
     }

◆ getProduct()

getProduct ( )

Retrieve currently viewed product object

Returns: \Magento\Catalog\Model\Product

Definition at line 228 of file AbstractProduct.php.

     {
         if (!$this->hasData('product')) {
             $this->setData('product', $this->_coreRegistry->registry('product'));
         }
         return $this->getData('product');
     }

◆ getProductDetailsHtml()

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

Retrieve product details html

Parameters

\Magento\Catalog\Model\Product $product

Returns: mixed

Definition at line 465 of file AbstractProduct.php.

     {
         $renderer = $this->getDetailsRenderer($product->getTypeId());
         if ($renderer) {
             $renderer->setProduct($product);
             return $renderer->toHtml();
         }
         return '';
     }

◆ getProductPrice()

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

Return HTML block with price

Parameters

\Magento\Catalog\Model\Product $product

Returns: string

Definition at line 408 of file AbstractProduct.php.

     {
         return $this->getProductPriceHtml(
             $product,
             \Magento\Catalog\Pricing\Price\FinalPrice::PRICE_CODE,
             \Magento\Framework\Pricing\Render::ZONE_ITEM_LIST
         );
     }

◆ getProductUrl()

getProductUrl	(	$product,
		$additional = `[]`
	)

Retrieve Product URL using UrlDataObject

Parameters

\Magento\Catalog\Model\Product	$product
array	$additional	the route params

Returns: string

Definition at line 262 of file AbstractProduct.php.

     {
         if ($this->hasProductUrl($product)) {
             if (!isset($additional['_escape'])) {
                 $additional['_escape'] = true;
             }
             return $product->getUrlModel()->getUrl($product, $additional);
         }
 
         return '#';
     }

◆ getRandomString()

getRandomString	(	$length,
		$chars = `null`
	)

Get random string

Parameters

int	$length
string \| null	$chars

Returns: string

Definition at line 397 of file AbstractProduct.php.

     {
         return $this->_mathRandom->getRandomString($length, $chars);
     }

◆ getReviewsSummaryHtml()

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

Get product reviews summary

Parameters

\Magento\Catalog\Model\Product	$product
bool	$templateType
bool	$displayIfNoReviews

Returns: string

Definition at line 215 of file AbstractProduct.php.

       {
         return $this->reviewRenderer->getReviewsSummaryHtml($product, $templateType, $displayIfNoReviews);
     }

◆ getSubmitUrl()

getSubmitUrl	(	$product,
		$additional = `[]`
	)

Retrieves url for form submitting.

Some objects can use setSubmitRouteData() to set route and params for form submitting, otherwise default url will be used

Parameters

\Magento\Catalog\Model\Product	$product
array	$additional

Returns: string

Definition at line 160 of file AbstractProduct.php.

     {
         $submitRouteData = $this->getData('submit_route_data');
         if ($submitRouteData) {
             $route = $submitRouteData['route'];
             $params = isset($submitRouteData['params']) ? $submitRouteData['params'] : [];
             $submitUrl = $this->getUrl($route, array_merge($params, $additional));
         } else {
             $submitUrl = $this->getAddToCartUrl($product, $additional);
         }
         return $submitUrl;
     }

◆ hasProductUrl()

hasProductUrl ( $product )

Check Product has URL

Parameters

\Magento\Catalog\Model\Product $product

Returns: bool

Definition at line 280 of file AbstractProduct.php.

     {
         if ($product->getVisibleInSiteVisibilities()) {
             return true;
         }
         if ($product->hasUrlDataObject()) {
             if (in_array($product->hasUrlDataObject()->getVisibility(), $product->getVisibleInSiteVisibilities())) {
                 return true;
             }
         }
 
         return false;
     }

◆ isRedirectToCartEnabled()

isRedirectToCartEnabled ( )

Whether redirect to cart enabled

Returns: bool

Definition at line 451 of file AbstractProduct.php.

     {
         return $this->_scopeConfig->getValue(
             'checkout/cart/redirect_to_cart',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
     }

◆ removeColumnCountLayoutDepend()

removeColumnCountLayoutDepend ( $pageLayout )

Remove row size depends on page layout

Parameters

string $pageLayout

Returns: \Magento\Catalog\Block\Product\ListProduct

Definition at line 331 of file AbstractProduct.php.

     {
         if (isset($this->_columnCountLayoutDepend[$pageLayout])) {
             unset($this->_columnCountLayoutDepend[$pageLayout]);
         }
 
         return $this;
     }

Field Documentation

◆ $_cartHelper

$_cartHelper

protected

Definition at line 73 of file AbstractProduct.php.

◆ $_catalogConfig

$_catalogConfig

protected

Definition at line 63 of file AbstractProduct.php.

◆ $_columnCountLayoutDepend

$_columnCountLayoutDepend = []

protected

Definition at line 42 of file AbstractProduct.php.

◆ $_compareProduct

$_compareProduct

protected

Definition at line 83 of file AbstractProduct.php.

◆ $_coreRegistry

$_coreRegistry

protected

Definition at line 49 of file AbstractProduct.php.

◆ $_defaultColumnCount

$_defaultColumnCount = 3

protected

Definition at line 35 of file AbstractProduct.php.

◆ $_imageHelper

$_imageHelper

protected

Definition at line 88 of file AbstractProduct.php.

◆ $_mathRandom

$_mathRandom

protected

Definition at line 68 of file AbstractProduct.php.

◆ $_priceBlock

$_priceBlock = []

protected

Definition at line 21 of file AbstractProduct.php.

◆ $_taxData

$_taxData

protected

Definition at line 56 of file AbstractProduct.php.

◆ $_useLinkForAsLowAs

$_useLinkForAsLowAs = true

protected

Definition at line 28 of file AbstractProduct.php.

◆ $_wishlistHelper

$_wishlistHelper

protected

Definition at line 78 of file AbstractProduct.php.

◆ $imageBuilder

$imageBuilder

protected

Definition at line 104 of file AbstractProduct.php.

◆ $reviewRenderer

$reviewRenderer

protected

Definition at line 93 of file AbstractProduct.php.

◆ $stockRegistry

$stockRegistry

protected

Definition at line 98 of file AbstractProduct.php.

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

vendor/magento/module-catalog/Block/Product/AbstractProduct.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addProductAttributesAndPrices()

◆ addColumnCountLayoutDepend()

◆ displayProductStockStatus()

◆ getAddToCartUrl()

◆ getAddToCompareUrl()

◆ getAddToWishlistParams()

◆ getCanShowProductPrice()

◆ getColumnCount()

◆ getColumnCountLayoutDepend()

◆ getDetailsRenderer()

◆ getDetailsRendererList()

◆ getImage()

◆ getMinimalQty()

◆ getPageLayout()

◆ getProduct()

◆ getProductDetailsHtml()

◆ getProductPrice()

◆ getProductUrl()

◆ getRandomString()

◆ getReviewsSummaryHtml()

◆ getSubmitUrl()

◆ hasProductUrl()

◆ isRedirectToCartEnabled()

◆ removeColumnCountLayoutDepend()

Field Documentation

◆ $_cartHelper

◆ $_catalogConfig

◆ $_columnCountLayoutDepend

◆ $_compareProduct

◆ $_coreRegistry

◆ $_defaultColumnCount

◆ $_imageHelper

◆ $_mathRandom

◆ $_priceBlock

◆ $_taxData

◆ $_useLinkForAsLowAs

◆ $_wishlistHelper

◆ $imageBuilder

◆ $reviewRenderer

◆ $stockRegistry