Inheritance diagram for ListProduct:

Public Member Functions
	__construct (Context $context, PostHelper $postDataHelper, Resolver $layerResolver, CategoryRepositoryInterface $categoryRepository, Data $urlHelper, array $data=[])

	getLayer ()

	getLoadedProductCollection ()

	getMode ()

	getToolbarBlock ()

	getAdditionalHtml ()

	getToolbarHtml ()

	setCollection ($collection)

	addAttribute ($code)

	getPriceBlockTemplate ()

	prepareSortableFieldsByCategory ($category)

	getIdentities ()

	getAddToCartPostParams (Product $product)

	getProductPrice (Product $product)

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
	_getProductCollection ()

	_beforeToHtml ()

	_getConfig ()

	getPriceRender ()

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
	$_defaultToolbarBlock = Toolbar::class

	$_productCollection

	$_catalogLayer

	$_postDataHelper

	$urlHelper

	$categoryRepository

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

Product list @api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 33 of file ListProduct.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Context	$context,
		PostHelper	$postDataHelper,
		Resolver	$layerResolver,
		CategoryRepositoryInterface	$categoryRepository,
		Data	$urlHelper,
		array	$data = `[]`
	)

Parameters

Context	$context
PostHelper	$postDataHelper
Resolver	$layerResolver
CategoryRepositoryInterface	$categoryRepository
Data	$urlHelper
array	$data

Definition at line 79 of file ListProduct.php.

       {
         $this->_catalogLayer = $layerResolver->get();
         $this->_postDataHelper = $postDataHelper;
         $this->categoryRepository = $categoryRepository;
         $this->urlHelper = $urlHelper;
         parent::__construct(
             $context,
             $data
         );
     }

Member Function Documentation

◆ _beforeToHtml()

_beforeToHtml ( )

protected

Need use as _prepareLayout - but problem in declaring collection from another block (was problem with search result)

Returns: $this

Definition at line 185 of file ListProduct.php.

     {
         $collection = $this->_getProductCollection();
 
         $this->addToolbarBlock($collection);
 
         $collection->load();
 
         return parent::_beforeToHtml();
     }

◆ _getConfig()

_getConfig ( )

protected

Retrieve Catalog Config object

Returns: Config

Definition at line 297 of file ListProduct.php.

     {
         return $this->_catalogConfig;
     }

◆ _getProductCollection()

_getProductCollection ( )

protected

Retrieve loaded product collection

The goal of this method is to choose whether the existing collection should be returned or a new one should be initialized.

It is not just a caching logic, but also is a real logical check because there are two ways how collection may be stored inside the block:

Product collection may be passed externally by 'setCollection' method
Product collection may be requested internally from the current Catalog Layer.

And this method will return collection anyway, even when it did not pass externally and therefore isn't cached yet

Returns: AbstractCollection

Definition at line 113 of file ListProduct.php.

     {
         if ($this->_productCollection === null) {
             $this->_productCollection = $this->initializeProductCollection();
         }
 
         return $this->_productCollection;
     }

◆ addAttribute()

addAttribute ( $code )

Parameters

array | string | integer | Element $code

Returns: $this

Definition at line 278 of file ListProduct.php.

     {
         $this->_getProductCollection()->addAttributeToSelect($code);
         return $this;
     }

◆ getAdditionalHtml()

getAdditionalHtml ( )

Retrieve additional blocks html

Returns: string

Definition at line 249 of file ListProduct.php.

     {
         return $this->getChildHtml('additional');
     }

◆ getAddToCartPostParams()

getAddToCartPostParams ( Product $product )

Get post parameters

Parameters

Product $product

Returns: array

Definition at line 361 of file ListProduct.php.

     {
         $url = $this->getAddToCartUrl($product);
         return [
             'action' => $url,
             'data' => [
                 'product' => $product->getEntityId(),
                 ActionInterface::PARAM_NAME_URL_ENCODED => $this->urlHelper->getEncodedUrl($url),
             ]
         ];
     }

◆ getIdentities()

getIdentities ( )

Return identifiers for produced content

Returns: array

Implements IdentityInterface.

Definition at line 334 of file ListProduct.php.

     {
         $identities = [];
 
         $category = $this->getLayer()->getCurrentCategory();
         if ($category) {
             $identities[] = Product::CACHE_PRODUCT_CATEGORY_TAG . '_' . $category->getId();
         }
 
         //Check if category page shows only static block (No products)
         if ($category->getData('display_mode') == Category::DM_PAGE) {
             return $identities;
         }
 
         foreach ($this->_getProductCollection() as $item) {
             $identities = array_merge($identities, $item->getIdentities());
         }
 
         return $identities;
     }

◆ getLayer()

getLayer ( )

Get catalog layer model

Returns: Layer

Definition at line 127 of file ListProduct.php.

     {
         return $this->_catalogLayer;
     }

◆ getLoadedProductCollection()

getLoadedProductCollection ( )

Retrieve loaded category collection

Returns: AbstractCollection

Definition at line 137 of file ListProduct.php.

     {
         return $this->_getProductCollection();
     }

◆ getMode()

getMode ( )

Retrieve current view mode

Returns: string

Definition at line 147 of file ListProduct.php.

     {
         if ($this->getChildBlock('toolbar')) {
             return $this->getChildBlock('toolbar')->getCurrentMode();
         }
 
         return $this->getDefaultListingMode();
     }

◆ getPriceBlockTemplate()

getPriceBlockTemplate ( )

Returns: mixed

Definition at line 287 of file ListProduct.php.

     {
         return $this->_getData('price_block_template');
     }

◆ getPriceRender()

getPriceRender ( )

protected

Specifies that price rendering should be done for the list of products i.e. rendering happens in the scope of product list, but not single product

Returns: Render

Definition at line 404 of file ListProduct.php.

     {
         return $this->getLayout()->getBlock('product.price.render.default')
             ->setData('is_product_list', true);
     }

◆ getProductPrice()

getProductPrice ( Product $product )

Parameters

Product $product

Returns: string

Definition at line 377 of file ListProduct.php.

     {
         $priceRender = $this->getPriceRender();
 
         $price = '';
         if ($priceRender) {
             $price = $priceRender->render(
                 FinalPrice::PRICE_CODE,
                 $product,
                 [
                     'include_container' => true,
                     'display_minimal_price' => true,
                     'zone' => Render::ZONE_ITEM_LIST,
                     'list_category_page' => true
                 ]
             );
         }
 
         return $price;
     }

◆ getToolbarBlock()

getToolbarBlock ( )

Retrieve Toolbar block from layout or a default Toolbar

Returns: Toolbar

Definition at line 215 of file ListProduct.php.

     {
         $block = $this->getToolbarFromLayout();
 
         if (!$block) {
             $block = $this->getLayout()->createBlock($this->_defaultToolbarBlock, uniqid(microtime()));
         }
 
         return $block;
     }

◆ getToolbarHtml()

getToolbarHtml ( )

Retrieve list toolbar HTML

Returns: string

Definition at line 259 of file ListProduct.php.

     {
         return $this->getChildHtml('toolbar');
     }

◆ prepareSortableFieldsByCategory()

prepareSortableFieldsByCategory ( $category )

Prepare Sort By fields from Category Data

Parameters

Category $category

Returns: $this

Definition at line 308 of file ListProduct.php.

     {
         if (!$this->getAvailableOrders()) {
             $this->setAvailableOrders($category->getAvailableSortByOptions());
         }
         $availableOrders = $this->getAvailableOrders();
         if (!$this->getSortBy()) {
             $categorySortBy = $this->getDefaultSortBy() ?: $category->getDefaultSortBy();
             if ($categorySortBy) {
                 if (!$availableOrders) {
                     $availableOrders = $this->_getConfig()->getAttributeUsedForSortByArray();
                 }
                 if (isset($availableOrders[$categorySortBy])) {
                     $this->setSortBy($categorySortBy);
                 }
             }
         }
 
         return $this;
     }

◆ setCollection()

setCollection ( $collection )

Parameters

AbstractCollection $collection

Returns: $this

Definition at line 268 of file ListProduct.php.

     {
         $this->_productCollection = $collection;
         return $this;
     }

Field Documentation

◆ $_catalogLayer

$_catalogLayer

protected

Definition at line 54 of file ListProduct.php.

◆ $_defaultToolbarBlock

$_defaultToolbarBlock = Toolbar::class

protected

Definition at line 40 of file ListProduct.php.

◆ $_postDataHelper

$_postDataHelper

protected

Definition at line 59 of file ListProduct.php.

◆ $_productCollection

$_productCollection

protected

Definition at line 47 of file ListProduct.php.

◆ $categoryRepository

$categoryRepository

protected

Definition at line 69 of file ListProduct.php.

◆ $urlHelper

$urlHelper

protected

Definition at line 64 of file ListProduct.php.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _beforeToHtml()

◆ _getConfig()

◆ _getProductCollection()

◆ addAttribute()

◆ getAdditionalHtml()

◆ getAddToCartPostParams()

◆ getIdentities()

◆ getLayer()

◆ getLoadedProductCollection()

◆ getMode()

◆ getPriceBlockTemplate()

◆ getPriceRender()

◆ getProductPrice()

◆ getToolbarBlock()

◆ getToolbarHtml()

◆ prepareSortableFieldsByCategory()

◆ setCollection()

Field Documentation

◆ $_catalogLayer

◆ $_defaultToolbarBlock

◆ $_postDataHelper

◆ $_productCollection

◆ $categoryRepository

◆ $urlHelper