Inheritance diagram for Collection:

Public Member Functions
	__construct (\Magento\Framework\Data\Collection\EntityFactory $entityFactory, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Eav\Model\Config $eavConfig, \Magento\Framework\App\ResourceConnection $resource, \Magento\Eav\Model\EntityFactory $eavEntityFactory, \Magento\Catalog\Model\ResourceModel\Helper $resourceHelper, \Magento\Framework\Validator\UniversalFactory $universalFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Module\Manager $moduleManager, \Magento\Catalog\Model\Indexer\Product\Flat\State $catalogProductFlatState, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Catalog\Model\Product\OptionFactory $productOptionFactory, \Magento\Catalog\Model\ResourceModel\Url $catalogUrl, \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Customer\Model\Session $customerSession, \Magento\Framework\Stdlib\DateTime $dateTime, GroupManagementInterface $groupManagement, \Magento\Framework\DB\Adapter\AdapterInterface $connection=null, ProductLimitationFactory $productLimitationFactory=null, MetadataPool $metadataPool=null, TableMaintainer $tableMaintainer=null, PriceTableResolver $priceTableResolver=null, DimensionFactory $dimensionFactory=null)

	getCatalogPreparedSelect ()

	getPriceExpression ($select)

	getAdditionalPriceExpression ($select)

	getCurrencyRate ()

	getFlatState ()

	isEnabledFlat ()

	getNewEmptyItem ()

	setEntity ($entity)

	setStore ($store)

	_loadAttributes ($printQuery=false, $logQuery=false)

	addAttributeToSelect ($attribute, $joinType=false)

	addIdFilter ($productId, $exclude=false)

	addWebsiteNamesToResult ()

	load ($printQuery=false, $logQuery=false)

	addStoreFilter ($store=null)

	addWebsiteFilter ($websites=null)

	getLimitationFilters ()

	addCategoryFilter (\Magento\Catalog\Model\Category $category)

	addCategoriesFilter (array $categoriesFilter)

	joinMinimalPrice ()

	getMaxAttributeValue ($attribute)

	getAttributeValueCountByRange ($attribute, $range)

	getAttributeValueCount ($attribute)

	getSelectCountSql ()

	getAllIds ($limit=null, $offset=null)

	getProductCountSelect ()

	unsProductCountSelect ()

	addCountToCategories ($categoryCollection)

	joinUrlRewrite ()

	addUrlRewrite ($categoryId='')

	addMinimalPrice ()

	addFinalPrice ()

	getAllIdsCache ($resetCache=false)

	setAllIdsCache ($value)

	addPriceData ($customerGroupId=null, $websiteId=null)

	addAttributeToFilter ($attribute, $condition=null, $joinType='inner')

	addTaxPercents ()

	requireTaxPercent ()

	addOptionsToResult ()

	addFilterByRequiredOptions ()

	setVisibility ($visibility)

	addAttributeToSort ($attribute, $dir=self::SORT_ORDER_ASC)

	applyFrontendPriceLimitations ()

	addCategoryIds ()

	addTierPriceData ()

	addTierPriceDataByGroupId ($customerGroupId)

	addPriceDataFieldFilter ($comparisonFormat, $fields)

	addMediaGalleryData ()

	getProductEntityMetadata ()

	clear ()

	setOrder ($attribute, $dir=Select::SQL_DESC)

	getMaxPrice ()

	getMinPrice ()

	getPriceStandardDeviation ()

	getPricesCount ()

Public Member Functions inherited from AbstractCollection
	__construct (\Magento\Framework\Data\Collection\EntityFactory $entityFactory, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Eav\Model\Config $eavConfig, \Magento\Framework\App\ResourceConnection $resource, \Magento\Eav\Model\EntityFactory $eavEntityFactory, \Magento\Eav\Model\ResourceModel\Helper $resourceHelper, \Magento\Framework\Validator\UniversalFactory $universalFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\DB\Adapter\AdapterInterface $connection=null)

	setStore ($store)

	setStoreId ($storeId)

	getStoreId ()

	getDefaultStoreId ()

Public Member Functions inherited from AbstractCollection
	__construct (\Magento\Framework\Data\Collection\EntityFactory $entityFactory, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Eav\Model\Config $eavConfig, \Magento\Framework\App\ResourceConnection $resource, \Magento\Eav\Model\EntityFactory $eavEntityFactory, \Magento\Eav\Model\ResourceModel\Helper $resourceHelper, \Magento\Framework\Validator\UniversalFactory $universalFactory, \Magento\Framework\DB\Adapter\AdapterInterface $connection=null)

	getTable ($table)

	setEntity ($entity)

	getEntity ()

	getResource ()

	setObject ($object=null)

	addItem (\Magento\Framework\DataObject $object)

	getAttribute ($attributeCode)

	addAttributeToFilter ($attribute, $condition=null, $joinType='inner')

	addFieldToFilter ($attribute, $condition=null)

	addAttributeToSort ($attribute, $dir=self::SORT_ORDER_ASC)

	addAttributeToSelect ($attribute, $joinType=false)

	addEntityTypeToSelect ($entityType, $prefix)

	addStaticField ($field)

	addExpressionAttributeToSelect ($alias, $expression, $attribute)

	groupByAttribute ($attribute)

	joinAttribute ($alias, $attribute, $bind, $filter=null, $joinType='inner', $storeId=null)

	joinField ($alias, $table, $field, $bind, $cond=null, $joinType='inner')

	joinTable ($table, $bind, $fields=null, $cond=null, $joinType='inner')

	removeAttributeToSelect ($attribute=null)

	setPage ($pageNum, $pageSize)

	load ($printQuery=false, $logQuery=false)

	getAllIds ($limit=null, $offset=null)

	getAllIdsSql ()

	save ()

	delete ()

	importFromArray ($arr)

	exportToArray ()

	getRowIdFieldName ()

	getIdFieldName ()

	setRowIdFieldName ($fieldName)

	_loadAttributes ($printQuery=false, $logQuery=false)

	setOrder ($attribute, $dir=self::SORT_ORDER_ASC)

	toArray ($arrAttributes=[])

	isAttributeAdded ($attributeCode)

	getLoadedIds ()

	clear ()

	removeAllItems ()

	removeItemByKey ($key)

	getMainTable ()

	addFieldToSelect ($field, $alias=null)

	removeFieldFromSelect ($field)

	removeAllFieldsFromSelect ()

Public Member Functions inherited from AbstractDb
	__construct (EntityFactoryInterface $entityFactory, Logger $logger, FetchStrategyInterface $fetchStrategy, \Magento\Framework\DB\Adapter\AdapterInterface $connection=null)

	getResource ()

	addBindParam ($name, $value)

	getIdFieldName ()

	setConnection (\Magento\Framework\DB\Adapter\AdapterInterface $conn)

	getSelect ()

	getConnection ()

	getSize ()

	getSelectCountSql ()

	getSelectSql ($stringMode=false)

	setOrder ($field, $direction=self::SORT_ORDER_DESC)

	addOrder ($field, $direction=self::SORT_ORDER_DESC)

	unshiftOrder ($field, $direction=self::SORT_ORDER_DESC)

	addFieldToFilter ($field, $condition=null)

	distinct ($flag)

	load ($printQuery=false, $logQuery=false)

	loadWithFilter ($printQuery=false, $logQuery=false)

	fetchItem ()

	getData ()

	resetData ()

	loadData ($printQuery=false, $logQuery=false)

	printLogQuery ($printQuery=false, $logQuery=false, $sql=null)

	addFilterToMap ($filter, $alias, $group='fields')

	__clone ()

	joinExtensionAttribute (JoinDataInterface $join, JoinProcessorInterface $extensionAttributesJoinProcessor)

	getItemObjectClass ()

	__sleep ()

	__wakeup ()

Public Member Functions inherited from Collection
	__construct (EntityFactoryInterface $entityFactory)

	addFilter ($field, $value, $type='and')

	addFieldToFilter ($field, $condition)

	getFilter ($field)

	isLoaded ()

	getCurPage ($displacement=0)

	getLastPageNumber ()

	getPageSize ()

	getSize ()

	getFirstItem ()

	getLastItem ()

	getItems ()

	getColumnValues ($colName)

	getItemsByColumnValue ($column, $value)

	getItemByColumnValue ($column, $value)

	addItem (\Magento\Framework\DataObject $item)

	getAllIds ()

	removeItemByKey ($key)

	removeAllItems ()

	clear ()

	walk ($callback, array $args=[])

	each ($objMethod, $args=[])

	setDataToAll ($key, $value=null)

	setCurPage ($page)

	setPageSize ($size)

	setOrder ($field, $direction=self::SORT_ORDER_DESC)

	setItemObjectClass ($className)

	getNewEmptyItem ()

	distinct ($flag)

	loadData ($printQuery=false, $logQuery=false)

	load ($printQuery=false, $logQuery=false)

	loadWithFilter ($printQuery=false, $logQuery=false)

	toXml ()

	toArray ($arrRequiredFields=[])

	toOptionArray ()

	toOptionHash ()

	getItemById ($idValue)

	getIterator ()

	count ()

	getFlag ($flag)

	setFlag ($flag, $value=null)

	hasFlag ($flag)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from SourceProviderInterface
	getSelect ()

Data Fields
const	INDEX_TABLE_ALIAS = 'price_index'

const	MAIN_TABLE_ALIAS = 'e'

Data Fields inherited from AbstractCollection
const	ATTRIBUTE_TABLE_ALIAS_PREFIX = 'at_'

Data Fields inherited from Collection
const	SORT_ORDER_ASC = 'ASC'

const	SORT_ORDER_DESC = 'DESC'

Protected Member Functions
	_preparePriceExpressionParameters ($select)

	_construct ()

	_init ($model, $entityModel)

	_initTables ()

	_prepareStaticFields ()

	_initSelect ()

	_afterLoad ()

	doAddWebsiteNamesToResult ()

	_getSelectCountSql (?Select $select=null, $resetLeftJoins=true)

	_prepareStatisticsData ()

	_getClearSelect ()

	_buildClearSelect ($select=null)

	_addUrlRewrite ()

	getEntityPkName (\Magento\Eav\Model\Entity\AbstractEntity $entity)

	_prepareProductLimitationFilters ()

	_productLimitationJoinWebsite ()

	_productLimitationJoinStore ()

	_productLimitationJoinPrice ()

	_productLimitationPrice ($joinLeft=false)

	_applyProductLimitations ()

	_applyZeroStoreProductLimitations ()

Protected Member Functions inherited from AbstractCollection
	getEntityPkName (\Magento\Eav\Model\Entity\AbstractEntity $entity)

	_getLoadAttributesSelect ($table, $attributeIds=[])

	_addLoadAttributesSelectValues ($select, $table, $type)

	_joinAttributeToSelect ($method, $attribute, $tableAlias, $condition, $fieldCode, $fieldAlias)

Protected Member Functions inherited from AbstractCollection
	_construct ()

	_prepareStaticFields ()

	_initSelect ()

	_init ($model, $entityModel)

	_prepareOrderExpression ($field)

	_getAllIdsSelect ($limit=null, $offset=null)

	_getLoadAttributesSelect ($table, $attributeIds=[])

	_addLoadAttributesSelectValues ($select, $table, $type)

	_setItemAttributeValue ($valueInfo)

	_getAttributeTableAlias ($attributeCode)

	_getAttributeFieldName ($attributeCode)

	_addAttributeJoin ($attributeCode, $joinType='inner')

	getEntityPkName (\Magento\Eav\Model\Entity\AbstractEntity $entity)

	_joinAttributeToSelect ($method, $attribute, $tableAlias, $condition, $fieldCode, $fieldAlias)

	_getAttributeConditionSql ($attribute, $condition, $joinType='inner')

	_renderOrders ()

	_afterLoad ()

	_reset ()

Protected Member Functions inherited from AbstractDb
	_setIdFieldName ($fieldName)

	_getItemId (\Magento\Framework\DataObject $item)

	_renderFilters ()

	_renderFiltersBefore ()

	_translateCondition ($field, $condition)

	_getMappedField ($field)

	_getMapper ()

	_getConditionSql ($fieldName, $condition)

	_getConditionFieldName ($fieldName)

	_renderOrders ()

	_renderLimit ()

	_beforeLoad ()

	beforeAddLoadedItem (\Magento\Framework\DataObject $item)

	_toOptionArray ($valueField=null, $labelField='name', $additional=[])

	_toOptionHash ($valueField=null, $labelField='name')

	_afterLoadData ()

	_afterLoad ()

	_logQuery ($sql)

	_reset ()

	_fetchAll (Select $select)

	_initSelect ()

Protected Member Functions inherited from Collection
	_setIsLoaded ($flag=true)

	_addItem ($item)

	_getItemId (\Magento\Framework\DataObject $item)

	_renderFilters ()

	_renderOrders ()

	_renderLimit ()

	_toOptionArray ($valueField='id', $labelField='name', $additional=[])

	_toOptionHash ($valueField='id', $labelField='name')

Protected Attributes
	$_idFieldName = 'entity_id'

	$_flatEnabled = []

	$_productWebsiteTable

	$_productCategoryTable

	$_addUrlRewrite = false

	$_urlRewriteCategory = ''

	$_addFinalPrice = false

	$_allIdsCache = null

	$_addTaxPercents = false

	$_productLimitationFilters

	$_productCountSelect = null

	$_isWebsiteFilter = false

	$_priceDataFieldFilters = []

	$_priceExpression

	$_additionalPriceExpression

	$_maxPrice

	$_minPrice

	$_priceStandardDeviation

	$_pricesCount = null

	$_catalogPreparePriceSelect = null

	$_catalogProductFlatState = null

	$moduleManager = null

	$_scopeConfig

	$_customerSession

	$_localeDate

	$_catalogUrl

	$_productOptionFactory

	$_resourceHelper

	$dateTime

	$_groupManagement

	$needToAddWebsiteNamesToResult

Protected Attributes inherited from AbstractCollection
	$_storeId

	$_storeManager

Protected Attributes inherited from AbstractCollection
	$_itemsById = []

	$_staticFields = []

	$_entity

	$_selectEntityTypes = []

	$_selectAttributes = []

	$_filterAttributes = []

	$_joinEntities = []

	$_joinAttributes = []

	$_joinFields = []

	$_castToIntMap = ['validate-digits']

	$_eventManager = null

	$_eavConfig

	$_resource

	$_eavEntityFactory

	$_resourceHelper

	$_universalFactory

Protected Attributes inherited from AbstractDb
	$_conn

	$_select

	$_idFieldName

	$_bindParams = []

	$_data = null

	$_map = null

	$_fetchStmt = null

	$_isOrdersRendered = false

	$_logger

	$extensionAttributesJoinProcessor

Protected Attributes inherited from Collection
	$_items = []

	$_itemObjectClass = \Magento\Framework\DataObject::class

	$_orders = []

	$_filters = []

	$_isFiltersRendered = false

	$_curPage = 1

	$_pageSize = false

	$_totalRecords

	$_isCollectionLoaded

	$_flags = []

	$_entityFactory

Detailed Description

Product collection

@api @SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.NumberOfChildren) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since: 100.0.2

Definition at line 36 of file Collection.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Data\Collection\EntityFactory	$entityFactory,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\Data\Collection\Db\FetchStrategyInterface	$fetchStrategy,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Eav\Model\Config	$eavConfig,
		\Magento\Framework\App\ResourceConnection	$resource,
		\Magento\Eav\Model\EntityFactory	$eavEntityFactory,
		\Magento\Catalog\Model\ResourceModel\Helper	$resourceHelper,
		\Magento\Framework\Validator\UniversalFactory	$universalFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Module\Manager	$moduleManager,
		\Magento\Catalog\Model\Indexer\Product\Flat\State	$catalogProductFlatState,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Catalog\Model\Product\OptionFactory	$productOptionFactory,
		\Magento\Catalog\Model\ResourceModel\Url	$catalogUrl,
		\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Framework\Stdlib\DateTime	$dateTime,
		GroupManagementInterface	$groupManagement,
		\Magento\Framework\DB\Adapter\AdapterInterface	$connection = `null`,
		ProductLimitationFactory	$productLimitationFactory = `null`,
		MetadataPool	$metadataPool = `null`,
		TableMaintainer	$tableMaintainer = `null`,
		PriceTableResolver	$priceTableResolver = `null`,
		DimensionFactory	$dimensionFactory = `null`
	)

Collection constructor

Parameters

\Magento\Framework\Data\Collection\EntityFactory	$entityFactory
\Psr\Log\LoggerInterface	$logger
\Magento\Framework\Data\Collection\Db\FetchStrategyInterface	$fetchStrategy
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Eav\Model\Config	$eavConfig
\Magento\Framework\App\ResourceConnection	$resource
\Magento\Eav\Model\EntityFactory	$eavEntityFactory
\Magento\Catalog\Model\ResourceModel\Helper	$resourceHelper
\Magento\Framework\Validator\UniversalFactory	$universalFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Module\Manager	$moduleManager
\Magento\Catalog\Model\Indexer\Product\Flat\State	$catalogProductFlatState
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Catalog\Model\Product\OptionFactory	$productOptionFactory
\Magento\Catalog\Model\ResourceModel\Url	$catalogUrl
\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate
\Magento\Customer\Model\Session	$customerSession
\Magento\Framework\Stdlib\DateTime	$dateTime
GroupManagementInterface	$groupManagement
\Magento\Framework\DB\Adapter\AdapterInterface \| null	$connection
ProductLimitationFactory \| null	$productLimitationFactory
MetadataPool \| null	$metadataPool
TableMaintainer \| null	$tableMaintainer
PriceTableResolver \| null	$priceTableResolver
DimensionFactory \| null	$dimensionFactory	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 322 of file Collection.php.

       {
         $this->moduleManager = $moduleManager;
         $this->_catalogProductFlatState = $catalogProductFlatState;
         $this->_scopeConfig = $scopeConfig;
         $this->_productOptionFactory = $productOptionFactory;
         $this->_catalogUrl = $catalogUrl;
         $this->_localeDate = $localeDate;
         $this->_customerSession = $customerSession;
         $this->_resourceHelper = $resourceHelper;
         $this->dateTime = $dateTime;
         $this->_groupManagement = $groupManagement;
         $productLimitationFactory = $productLimitationFactory ?: ObjectManager::getInstance()->get(
             \Magento\Catalog\Model\ResourceModel\Product\Collection\ProductLimitationFactory::class
         );
         $this->_productLimitationFilters = $productLimitationFactory->create();
         $this->metadataPool = $metadataPool ?: ObjectManager::getInstance()->get(MetadataPool::class);
         parent::__construct(
             $entityFactory,
             $logger,
             $fetchStrategy,
             $eventManager,
             $eavConfig,
             $resource,
             $eavEntityFactory,
             $resourceHelper,
             $universalFactory,
             $storeManager,
             $connection
         );
         $this->tableMaintainer = $tableMaintainer ?: ObjectManager::getInstance()->get(TableMaintainer::class);
         $this->priceTableResolver = $priceTableResolver ?: ObjectManager::getInstance()->get(PriceTableResolver::class);
         $this->dimensionFactory = $dimensionFactory
             ?: ObjectManager::getInstance()->get(DimensionFactory::class);
     }

Member Function Documentation

◆ _addUrlRewrite()

_addUrlRewrite ( )

protected

Add URL rewrites to collection

Returns: void

Definition at line 1403 of file Collection.php.

     {
         $productIds = [];
         foreach ($this->getItems() as $item) {
             $productIds[] = $item->getEntityId();
         }
         if (!$productIds) {
             return;
         }
 
         $select = $this->getConnection()
             ->select()
             ->from(['u' => $this->getTable('url_rewrite')], ['u.entity_id', 'u.request_path'])
             ->where('u.store_id = ?', $this->_storeManager->getStore($this->getStoreId())->getId())
             ->where('u.is_autogenerated = 1')
             ->where('u.entity_type = ?', ProductUrlRewriteGenerator::ENTITY_TYPE)
             ->where('u.entity_id IN(?)', $productIds);
 
         if ($this->_urlRewriteCategory) {
             $select->joinInner(
                 ['cu' => $this->getTable('catalog_url_rewrite_product_category')],
                 'u.url_rewrite_id=cu.url_rewrite_id'
             )->where('cu.category_id IN (?)', $this->_urlRewriteCategory);
         }
 
         // more priority is data with category id
         $urlRewrites = [];
 
         foreach ($this->getConnection()->fetchAll($select) as $row) {
             if (!isset($urlRewrites[$row['entity_id']])) {
                 $urlRewrites[$row['entity_id']] = $row['request_path'];
             }
         }
 
         foreach ($this->getItems() as $item) {
             if (isset($urlRewrites[$item->getEntityId()])) {
                 $item->setData('request_path', $urlRewrites[$item->getEntityId()]);
             } else {
                 $item->setData('request_path', false);
             }
         }
     }

◆ _afterLoad()

_afterLoad ( )

protected

Processing collection items after loading. Adding url rewrites, minimal prices, final prices, tax percents.

Returns: $this

Definition at line 673 of file Collection.php.

     {
         if ($this->_addUrlRewrite) {
             $this->_addUrlRewrite();
         }
 
         $this->_prepareUrlDataObject();
         $this->prepareStoreId();
 
         if (count($this)) {
             $this->_eventManager->dispatch('catalog_product_collection_load_after', ['collection' => $this]);
         }
 
         return $this;
     }

◆ _applyProductLimitations()

_applyProductLimitations ( )

protected

Apply limitation filters to collection Method allows using one time category product index table (or product website table) for different combinations of store_id/category_id/visibility filter states Method supports multiple changes in one collection object for this parameters

Returns: $this

Definition at line 2002 of file Collection.php.

     {
         $this->_prepareProductLimitationFilters();
         $this->_productLimitationJoinWebsite();
         $this->_productLimitationJoinPrice();
         $filters = $this->_productLimitationFilters;
 
         if (!isset($filters['category_id']) && !isset($filters['visibility'])) {
             return $this;
         }
 
         $conditions = [
             'cat_index.product_id=e.entity_id',
             $this->getConnection()->quoteInto('cat_index.store_id=?', $filters['store_id']),
         ];
         if (isset($filters['visibility']) && !isset($filters['store_table'])) {
             $conditions[] = $this->getConnection()->quoteInto('cat_index.visibility IN(?)', $filters['visibility']);
         }
         $conditions[] = $this->getConnection()->quoteInto('cat_index.category_id=?', $filters['category_id']);
         if (isset($filters['category_is_anchor'])) {
             $conditions[] = $this->getConnection()->quoteInto('cat_index.is_parent=?', $filters['category_is_anchor']);
         }
 
         $joinCond = join(' AND ', $conditions);
         $fromPart = $this->getSelect()->getPart(\Magento\Framework\DB\Select::FROM);
         if (isset($fromPart['cat_index'])) {
             $fromPart['cat_index']['joinCondition'] = $joinCond;
             $this->getSelect()->setPart(\Magento\Framework\DB\Select::FROM, $fromPart);
         } else {
             $this->getSelect()->join(
                 ['cat_index' => $this->tableMaintainer->getMainTable($this->getStoreId())],
                 $joinCond,
                 ['cat_index_position' => 'position']
             );
         }
 
         $this->_productLimitationJoinStore();
         $this->_eventManager->dispatch(
             'catalog_product_collection_apply_limitations_after',
             ['collection' => $this]
         );
         return $this;
     }

◆ _applyZeroStoreProductLimitations()

_applyZeroStoreProductLimitations ( )

protected

Apply limitation filters to collection base on API Method allows using one time category product table for combinations of category_id filter states

Returns: $this

Definition at line 2053 of file Collection.php.

     {
         $filters = $this->_productLimitationFilters;
 
         $conditions = [
             'cat_pro.product_id=e.entity_id',
             $this->getConnection()->quoteInto(
                 'cat_pro.category_id=?',
                 $filters['category_id']
             ),
         ];
         $joinCond = join(' AND ', $conditions);
 
         $fromPart = $this->getSelect()->getPart(\Magento\Framework\DB\Select::FROM);
         if (isset($fromPart['cat_pro'])) {
             $fromPart['cat_pro']['joinCondition'] = $joinCond;
             $this->getSelect()->setPart(\Magento\Framework\DB\Select::FROM, $fromPart);
         } else {
             $this->getSelect()->join(
                 ['cat_pro' => $this->getTable('catalog_category_product')],
                 $joinCond,
                 ['cat_index_position' => 'position']
             );
         }
         $this->_joinFields['position'] = ['table' => 'cat_pro', 'field' => 'position'];
 
         return $this;
     }

◆ _buildClearSelect()

_buildClearSelect ( $select = null )

protected

Build clear select

Parameters

\Magento\Framework\DB\Select $select

Returns: \Magento\Framework\DB\Select

Definition at line 1189 of file Collection.php.

     {
         if (null === $select) {
             $select = clone $this->getSelect();
         }
         $select->reset(\Magento\Framework\DB\Select::ORDER);
         $select->reset(\Magento\Framework\DB\Select::LIMIT_COUNT);
         $select->reset(\Magento\Framework\DB\Select::LIMIT_OFFSET);
         $select->reset(\Magento\Framework\DB\Select::COLUMNS);
 
         return $select;
     }

◆ _construct()

_construct ( )

protected

Initialize resources

Returns: void

Definition at line 494 of file Collection.php.

     {
         if ($this->isEnabledFlat()) {
             $this->_init(
                 \Magento\Catalog\Model\Product::class,
                 \Magento\Catalog\Model\ResourceModel\Product\Flat::class
             );
         } else {
             $this->_init(\Magento\Catalog\Model\Product::class, \Magento\Catalog\Model\ResourceModel\Product::class);
         }
         $this->_initTables();
     }

◆ _getClearSelect()

_getClearSelect ( )

protected

Retrieve clear select

Returns: \Magento\Framework\DB\Select

Definition at line 1178 of file Collection.php.

     {
         return $this->_buildClearSelect();
     }

◆ _getSelectCountSql()

_getSelectCountSql	(	?Select	$select = `null`,
			$resetLeftJoins = `true`
	)

protected

Get SQL for get record count

Parameters

Select	$select
bool	$resetLeftJoins

Returns: Select

Definition at line 1134 of file Collection.php.

     {
         $this->_renderFilters();
         $countSelect = $select === null ? $this->_getClearSelect() : $this->_buildClearSelect($select);
         $countSelect->columns('COUNT(DISTINCT e.entity_id)');
         if ($resetLeftJoins) {
             $countSelect->resetJoinLeft();
         }
         return $countSelect;
     }

◆ _init()

_init	(	$model,
		$entityModel
	)

protected

Standard resource collection initialization. Needed for child classes.

Parameters

string	$model
string	$entityModel

Returns: $this

Definition at line 514 of file Collection.php.

     {
         if ($this->isEnabledFlat()) {
             $entityModel = \Magento\Catalog\Model\ResourceModel\Product\Flat::class;
         }
         return parent::_init($model, $entityModel);
     }

◆ _initSelect()

_initSelect ( )

protected

Initialize collection select Redeclared for remove entity_type_id condition in catalog_product_entity we store just products

Returns: $this

Definition at line 597 of file Collection.php.

     {
         if ($this->isEnabledFlat()) {
             $this->getSelect()->from(
                 [self::MAIN_TABLE_ALIAS => $this->getEntity()->getFlatTableName()],
                 null
             )->columns(
                 ['status' => new \Zend_Db_Expr(ProductStatus::STATUS_ENABLED)]
             );
             $this->addAttributeToSelect($this->getResource()->getDefaultAttributes());
             if ($this->_catalogProductFlatState->getFlatIndexerHelper()->isAddChildData()) {
                 $this->getSelect()->where('e.is_child=?', 0);
                 $this->addAttributeToSelect(['child_id', 'is_child']);
             }
         } else {
             $this->getSelect()->from([self::MAIN_TABLE_ALIAS => $this->getEntity()->getEntityTable()]);
         }
         return $this;
     }

◆ _initTables()

_initTables ( )

protected

Define product website and category product tables

Returns: void

Definition at line 527 of file Collection.php.

     {
         $this->_productWebsiteTable = $this->getResource()->getTable('catalog_product_website');
         $this->_productCategoryTable = $this->getResource()->getTable('catalog_category_product');
     }

◆ _loadAttributes()

_loadAttributes	(	$printQuery = `false`,
		$logQuery = `false`
	)

Load attributes into loaded entities

Parameters

bool	$printQuery
bool	$logQuery

Returns: $this

Definition at line 624 of file Collection.php.

     {
         if ($this->isEnabledFlat()) {
             return $this;
         }
         return parent::_loadAttributes($printQuery, $logQuery);
     }

◆ _preparePriceExpressionParameters()

_preparePriceExpressionParameters ( $select )

protected

Prepare additional price expression sql part

Parameters

\Magento\Framework\DB\Select $select

Returns: $this

Definition at line 399 of file Collection.php.

     {
         // prepare response object for event
         $response = new \Magento\Framework\DataObject();
         $response->setAdditionalCalculations([]);
         $tableAliases = array_keys($select->getPart(\Magento\Framework\DB\Select::FROM));
         if (in_array(self::INDEX_TABLE_ALIAS, $tableAliases)) {
             $table = self::INDEX_TABLE_ALIAS;
         } else {
             $table = reset($tableAliases);
         }
 
         // prepare event arguments
         $eventArgs = [
             'select' => $select,
             'table' => $table,
             'store_id' => $this->getStoreId(),
             'response_object' => $response,
         ];
 
         $this->_eventManager->dispatch('catalog_prepare_price_select', $eventArgs);
 
         $additional = join('', $response->getAdditionalCalculations());
         $this->_priceExpression = $table . '.min_price';
         $this->_additionalPriceExpression = $additional;
         $this->_catalogPreparePriceSelect = clone $select;
 
         return $this;
     }

◆ _prepareProductLimitationFilters()

_prepareProductLimitationFilters ( )

protected

Prepare limitation filters

Returns: $this

Definition at line 1754 of file Collection.php.

     {
         if (isset(
             $this->_productLimitationFilters['visibility']
         ) && !isset(
             $this->_productLimitationFilters['store_id']
         )
         ) {
             $this->_productLimitationFilters['store_id'] = $this->getStoreId();
         }
         if (isset(
             $this->_productLimitationFilters['category_id']
         ) && !isset(
             $this->_productLimitationFilters['store_id']
         )
         ) {
             $this->_productLimitationFilters['store_id'] = $this->getStoreId();
         }
         if (isset(
             $this->_productLimitationFilters['store_id']
         ) && isset(
             $this->_productLimitationFilters['visibility']
         ) && !isset(
             $this->_productLimitationFilters['category_id']
         )
         ) {
             $this->_productLimitationFilters['category_id'] = $this->_storeManager->getStore(
                 $this->_productLimitationFilters['store_id']
             )->getRootCategoryId();
         }
 
         return $this;
     }

◆ _prepareStaticFields()

_prepareStaticFields ( )

protected

Prepare static entity fields

Returns: $this

Definition at line 538 of file Collection.php.

     {
         if ($this->isEnabledFlat()) {
             return $this;
         }
         return parent::_prepareStaticFields();
     }

◆ _prepareStatisticsData()

_prepareStatisticsData ( )

protected

Prepare statistics data

Returns: $this

Definition at line 1150 of file Collection.php.

     {
         $select = clone $this->getSelect();
         $priceExpression = $this->getPriceExpression($select) . ' ' . $this->getAdditionalPriceExpression($select);
         $sqlEndPart = ') * ' . $this->getCurrencyRate() . ', 2)';
         $select = $this->_getSelectCountSql($select, false);
         $select->columns(
             [
                 'max' => 'ROUND(MAX(' . $priceExpression . $sqlEndPart,
                 'min' => 'ROUND(MIN(' . $priceExpression . $sqlEndPart,
                 'std' => $this->getConnection()->getStandardDeviationSql('ROUND((' . $priceExpression . $sqlEndPart),
             ]
         );
         $select->where($this->getPriceExpression($select) . ' IS NOT NULL');
         $row = $this->getConnection()->fetchRow($select, $this->_bindParams, \Zend_Db::FETCH_NUM);
         $this->_pricesCount = (int)$row[0];
         $this->_maxPrice = (double)$row[1];
         $this->_minPrice = (double)$row[2];
         $this->_priceStandardDeviation = (double)$row[3];
 
         return $this;
     }

◆ _productLimitationJoinPrice()

_productLimitationJoinPrice ( )

protected

Join Product Price Table

Returns: $this

Definition at line 1883 of file Collection.php.

     {
         return $this->_productLimitationPrice();
     }

◆ _productLimitationJoinStore()

_productLimitationJoinStore ( )

protected

Join additional (alternative) store visibility filter

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 1848 of file Collection.php.

     {
         $filters = $this->_productLimitationFilters;
         if (!isset($filters['store_table'])) {
             return $this;
         }
 
         $hasColumn = false;
         foreach ($this->getSelect()->getPart(\Magento\Framework\DB\Select::COLUMNS) as $columnEntry) {
             list(, , $alias) = $columnEntry;
             if ($alias == 'visibility') {
                 $hasColumn = true;
             }
         }
         if (!$hasColumn) {
             $this->getSelect()->columns('visibility', 'cat_index');
         }
 
         // Avoid column duplication problems
         $this->_resourceHelper->prepareColumnsList($this->getSelect());
 
         $whereCond = $this->getConnection()->quoteInto('cat_index.visibility IN(?)', $filters['visibility']);
         $wherePart = $this->getSelect()->getPart(\Magento\Framework\DB\Select::WHERE);
         if (array_search('(' . $whereCond . ')', $wherePart) === false) {
             $this->getSelect()->where($whereCond);
         }
 
         return $this;
     }

◆ _productLimitationJoinWebsite()

_productLimitationJoinWebsite ( )

protected

Join website product limitation

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 1794 of file Collection.php.

     {
         $joinWebsite = false;
         $filters = $this->_productLimitationFilters;
         $conditions = ['product_website.product_id = e.entity_id'];
 
         if (isset($filters['website_ids'])) {
             $joinWebsite = true;
             if (count($filters['website_ids']) > 1) {
                 $this->getSelect()->distinct(true);
             }
             $conditions[] = $this->getConnection()->quoteInto(
                 'product_website.website_id IN(?)',
                 $filters['website_ids']
             );
         } elseif (isset(
             $filters['store_id']
         ) && (!isset(
             $filters['visibility']
         ) && !isset(
             $filters['category_id']
         )) && !$this->isEnabledFlat()
         ) {
             $joinWebsite = true;
             $websiteId = $this->_storeManager->getStore($filters['store_id'])->getWebsiteId();
             $conditions[] = $this->getConnection()->quoteInto('product_website.website_id = ?', $websiteId);
         }
 
         $fromPart = $this->getSelect()->getPart(\Magento\Framework\DB\Select::FROM);
         if (isset($fromPart['product_website'])) {
             if (!$joinWebsite) {
                 unset($fromPart['product_website']);
             } else {
                 $fromPart['product_website']['joinCondition'] = join(' AND ', $conditions);
             }
             $this->getSelect()->setPart(\Magento\Framework\DB\Select::FROM, $fromPart);
         } elseif ($joinWebsite) {
             $this->getSelect()->join(
                 ['product_website' => $this->getTable('catalog_product_website')],
                 join(' AND ', $conditions),
                 []
             );
         }
 
         return $this;
     }

◆ _productLimitationPrice()

_productLimitationPrice ( $joinLeft = false )

protected

Join Product Price Table with left-join possibility

See also: \Magento\Catalog\Model\ResourceModel\Product\Collection::_productLimitationJoinPrice()

Parameters

bool $joinLeft

Returns: $this

Definition at line 1895 of file Collection.php.

     {
         $filters = $this->_productLimitationFilters;
         if (!$filters->isUsingPriceIndex() ||
             !isset($filters['website_id']) ||
             (string)$filters['website_id'] === '' ||
             !isset($filters['customer_group_id']) ||
             (string)$filters['customer_group_id'] === ''
         ) {
             return $this;
         }
 
         // Preventing overriding price loaded from EAV because we want to use the one from index
         $this->removeAttributeToSelect('price');
 
         $connection = $this->getConnection();
         $select = $this->getSelect();
         $joinCond = join(
             ' AND ',
             [
                 'price_index.entity_id = e.entity_id',
                 $connection->quoteInto('price_index.website_id = ?', $filters['website_id']),
                 $connection->quoteInto('price_index.customer_group_id = ?', $filters['customer_group_id'])
             ]
         );
 
         $fromPart = $select->getPart(\Magento\Framework\DB\Select::FROM);
         if (!isset($fromPart['price_index'])) {
             $least = $connection->getLeastSql(['price_index.min_price', 'price_index.tier_price']);
             $minimalExpr = $connection->getCheckSql(
                 'price_index.tier_price IS NOT NULL',
                 $least,
                 'price_index.min_price'
             );
             $colls = [
                 'price',
                 'tax_class_id',
                 'final_price',
                 'minimal_price' => $minimalExpr,
                 'min_price',
                 'max_price',
                 'tier_price',
             ];
 
             $tableName = [
                 'price_index' => $this->priceTableResolver->resolve(
                     'catalog_product_index_price',
                     [
                         $this->dimensionFactory->create(
                             CustomerGroupDimensionProvider::DIMENSION_NAME,
                             (string)$filters['customer_group_id']
                         ),
                         $this->dimensionFactory->create(
                             WebsiteDimensionProvider::DIMENSION_NAME,
                             (string)$filters['website_id']
                         )
                     ]
                 )
             ];
 
             if ($joinLeft) {
                 $select->joinLeft($tableName, $joinCond, $colls);
             } else {
                 $select->join($tableName, $joinCond, $colls);
             }
             // Set additional field filters
             foreach ($this->_priceDataFieldFilters as $filterData) {
                 $select->where(call_user_func_array('sprintf', $filterData));
             }
         } else {
             $fromPart['price_index']['joinCondition'] = $joinCond;
             $select->setPart(\Magento\Framework\DB\Select::FROM, $fromPart);
         }
         //Clean duplicated fields
         $this->_resourceHelper->prepareColumnsList($select);
 
         return $this;
     }

◆ addAttributeToFilter()

addAttributeToFilter	(	$attribute,
		$condition = `null`,
		$joinType = `'inner'`
	)

Add attribute to filter

Parameters

\Magento\Eav\Model\Entity\Attribute\AbstractAttribute \| string	$attribute
array	$condition
string	$joinType

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 1538 of file Collection.php.

     {
         if ($this->isEnabledFlat()) {
             if ($attribute instanceof \Magento\Eav\Model\Entity\Attribute\AbstractAttribute) {
                 $attribute = $attribute->getAttributeCode();
             }
 
             if (is_array($attribute)) {
                 $sqlArr = [];
                 foreach ($attribute as $condition) {
                     $sqlArr[] = $this->_getAttributeConditionSql($condition['attribute'], $condition, $joinType);
                 }
                 $conditionSql = '(' . join(') OR (', $sqlArr) . ')';
                 $this->getSelect()->where($conditionSql);
                 return $this;
             }
 
             if (!isset($this->_selectAttributes[$attribute])) {
                 $this->addAttributeToSelect($attribute);
             }
 
             if (isset($this->_selectAttributes[$attribute])) {
                 $this->getSelect()->where($this->_getConditionSql('e.' . $attribute, $condition));
             }
 
             return $this;
         }
 
         $this->_allIdsCache = null;
 
         if (is_string($attribute) && $attribute == 'is_saleable') {
             $columns = $this->getSelect()->getPart(\Magento\Framework\DB\Select::COLUMNS);
             foreach ($columns as $columnEntry) {
                 list($correlationName, $column, $alias) = $columnEntry;
                 if ($alias == 'is_saleable') {
                     if ($column instanceof \Zend_Db_Expr) {
                         $field = $column;
                     } else {
                         $connection = $this->getSelect()->getConnection();
                         if (empty($correlationName)) {
                             $field = $connection->quoteColumnAs($column, $alias, true);
                         } else {
                             $field = $connection->quoteColumnAs([$correlationName, $column], $alias, true);
                         }
                     }
                     $this->getSelect()->where("{$field} = ?", $condition);
                     break;
                 }
             }
 
             return $this;
         } else {
             return parent::addAttributeToFilter($attribute, $condition, $joinType);
         }
     }

◆ addAttributeToSelect()

addAttributeToSelect	(	$attribute,
		$joinType = `false`
	)

Add attribute to entities in collection. If $attribute=='*' select all attributes.

Parameters

array \| string \| integer \| \Magento\Framework\App\Config\Element	$attribute
bool \| string	$joinType

Returns: $this

Definition at line 639 of file Collection.php.

     {
         if ($this->isEnabledFlat()) {
             if (!is_array($attribute)) {
                 $attribute = [$attribute];
             }
             foreach ($attribute as $attributeCode) {
                 if ($attributeCode == '*') {
                     foreach ($this->getEntity()->getAllTableColumns() as $column) {
                         $this->getSelect()->columns('e.' . $column);
                         $this->_selectAttributes[$column] = $column;
                         $this->_staticFields[$column] = $column;
                     }
                 } else {
                     $columns = $this->getEntity()->getAttributeForSelect($attributeCode);
                     if ($columns) {
                         foreach ($columns as $alias => $column) {
                             $this->getSelect()->columns([$alias => 'e.' . $column]);
                             $this->_selectAttributes[$column] = $column;
                             $this->_staticFields[$column] = $column;
                         }
                     }
                 }
             }
             return $this;
         }
         return parent::addAttributeToSelect($attribute, $joinType);
     }

◆ addAttributeToSort()

addAttributeToSort	(	$attribute,
		$dir = `self::SORT_ORDER_ASC`
	)

Add attribute to sort order

Parameters

string	$attribute
string	$dir

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 1695 of file Collection.php.

     {
         if ($attribute == 'position') {
             if (isset($this->_joinFields[$attribute])) {
                 $this->getSelect()->order($this->_getAttributeFieldName($attribute) . ' ' . $dir);
                 return $this;
             }
             if ($this->isEnabledFlat()) {
                 $this->getSelect()->order("cat_index_position {$dir}");
             }
             // optimize if using cat index
             $filters = $this->_productLimitationFilters;
             if (isset($filters['category_id']) || isset($filters['visibility'])) {
                 $this->getSelect()->order('cat_index.position ' . $dir);
             } else {
                 $this->getSelect()->order('e.entity_id ' . $dir);
             }
 
             return $this;
         } elseif ($attribute == 'is_saleable') {
             $this->getSelect()->order("is_salable " . $dir);
             return $this;
         }
 
         $storeId = $this->getStoreId();
         if ($attribute == 'price' && $storeId != 0) {
             $this->addPriceData();
             if ($this->_productLimitationFilters->isUsingPriceIndex()) {
                 $this->getSelect()->order("price_index.min_price {$dir}");
                 return $this;
             }
         }
 
         if ($this->isEnabledFlat()) {
             $column = $this->getEntity()->getAttributeSortColumn($attribute);
 
             if ($column) {
                 $this->getSelect()->order("e.{$column} {$dir}");
             } elseif (isset($this->_joinFields[$attribute])) {
                 $this->getSelect()->order($this->_getAttributeFieldName($attribute) . ' ' . $dir);
             }
 
             return $this;
         } else {
             $attrInstance = $this->getEntity()->getAttribute($attribute);
             if ($attrInstance && $attrInstance->usesSource()) {
                 $attrInstance->getSource()->addValueSortToCollection($this, $dir);
                 return $this;
             }
         }
 
         return parent::addAttributeToSort($attribute, $dir);
     }

◆ addCategoriesFilter()

addCategoriesFilter ( array $categoriesFilter )

Filter Product by Categories

Parameters

array $categoriesFilter

Returns: $this

Definition at line 920 of file Collection.php.

     {
         foreach ($categoriesFilter as $conditionType => $values) {
             $categorySelect = $this->getConnection()->select()->from(
                 ['cat' => $this->getTable('catalog_category_product')],
                 'cat.product_id'
             )->where($this->getConnection()->prepareSqlCondition('cat.category_id', ['in' => $values]));
             $selectCondition = [
                 $this->mapConditionType($conditionType) => $categorySelect
             ];
             $this->getSelect()->where($this->getConnection()->prepareSqlCondition('e.entity_id', $selectCondition));
         }
         return $this;
     }

◆ addCategoryFilter()

addCategoryFilter ( \Magento\Catalog\Model\Category $category )

Specify category filter for product collection

Parameters

\Magento\Catalog\Model\Category $category

Returns: $this

Definition at line 896 of file Collection.php.

     {
         $this->_productLimitationFilters['category_id'] = $category->getId();
         if ($category->getIsAnchor()) {
             unset($this->_productLimitationFilters['category_is_anchor']);
         } else {
             $this->_productLimitationFilters['category_is_anchor'] = 1;
         }
 
         if ($this->getStoreId() == Store::DEFAULT_STORE_ID) {
             $this->_applyZeroStoreProductLimitations();
         } else {
             $this->_applyProductLimitations();
         }
 
         return $this;
     }

◆ addCategoryIds()

addCategoryIds ( )

Add category ids to loaded items

Returns: $this

Definition at line 2087 of file Collection.php.

     {
         if ($this->getFlag('category_ids_added')) {
             return $this;
         }
         $ids = array_keys($this->_items);
         if (empty($ids)) {
             return $this;
         }
 
         $select = $this->getConnection()->select();
 
         $select->from($this->_productCategoryTable, ['product_id', 'category_id']);
         $select->where('product_id IN (?)', $ids);
 
         $data = $this->getConnection()->fetchAll($select);
 
         $categoryIds = [];
         foreach ($data as $info) {
             if (isset($categoryIds[$info['product_id']])) {
                 $categoryIds[$info['product_id']][] = $info['category_id'];
             } else {
                 $categoryIds[$info['product_id']] = [$info['category_id']];
             }
         }
 
         foreach ($this->getItems() as $item) {
             $productId = $item->getId();
             if (isset($categoryIds[$productId])) {
                 $item->setCategoryIds($categoryIds[$productId]);
             } else {
                 $item->setCategoryIds([]);
             }
         }
 
         $this->setFlag('category_ids_added', true);
         return $this;
     }

◆ addCountToCategories()

addCountToCategories ( $categoryCollection )

Adding product count to categories collection

Parameters

\Magento\Eav\Model\Entity\Collection\AbstractCollection $categoryCollection

Returns: $this

Definition at line 1271 of file Collection.php.

     {
         $isAnchor = [];
         $isNotAnchor = [];
         foreach ($categoryCollection as $category) {
             if ($category->getIsAnchor()) {
                 $isAnchor[] = $category->getId();
             } else {
                 $isNotAnchor[] = $category->getId();
             }
         }
         $productCounts = [];
         if ($isAnchor || $isNotAnchor) {
             $select = $this->getProductCountSelect();
 
             $this->_eventManager->dispatch(
                 'catalog_product_collection_before_add_count_to_categories',
                 ['collection' => $this]
             );
 
             if ($isAnchor) {
                 $anchorStmt = clone $select;
                 $anchorStmt->limit();
                 //reset limits
                 $anchorStmt->where('count_table.category_id IN (?)', $isAnchor);
                 $productCounts += $this->getConnection()->fetchPairs($anchorStmt);
                 $anchorStmt = null;
             }
             if ($isNotAnchor) {
                 $notAnchorStmt = clone $select;
                 $notAnchorStmt->limit();
                 //reset limits
                 $notAnchorStmt->where('count_table.category_id IN (?)', $isNotAnchor);
                 $notAnchorStmt->where('count_table.is_parent = 1');
                 $productCounts += $this->getConnection()->fetchPairs($notAnchorStmt);
                 $notAnchorStmt = null;
             }
             $select = null;
             $this->unsProductCountSelect();
         }
 
         foreach ($categoryCollection as $category) {
             $_count = 0;
             if (isset($productCounts[$category->getId()])) {
                 $_count = $productCounts[$category->getId()];
             }
             $category->setProductCount($_count);
         }
 
         return $this;
     }

◆ addFilterByRequiredOptions()

addFilterByRequiredOptions ( )

Filter products with required options

Returns: $this

Definition at line 1666 of file Collection.php.

     {
         $this->addAttributeToFilter('required_options', [['neq' => 1], ['null' => true]], 'left');
         return $this;
     }

◆ addFinalPrice()

addFinalPrice ( )

Add price data for calculate final price

Returns: $this

Definition at line 1461 of file Collection.php.

     {
         return $this->addPriceData();
     }

◆ addIdFilter()

addIdFilter	(	$productId,
		$exclude = `false`
	)

Add collection filters by identifiers

Parameters

mixed	$productId
boolean	$exclude

Returns: $this

Definition at line 744 of file Collection.php.

     {
         if (empty($productId)) {
             $this->_setIsLoaded(true);
             return $this;
         }
         if (is_array($productId)) {
             if (!empty($productId)) {
                 if ($exclude) {
                     $condition = ['nin' => $productId];
                 } else {
                     $condition = ['in' => $productId];
                 }
             } else {
                 $condition = '';
             }
         } else {
             if ($exclude) {
                 $condition = ['neq' => $productId];
             } else {
                 $condition = $productId;
             }
         }
         $this->addFieldToFilter('entity_id', $condition);
         return $this;
     }

◆ addMediaGalleryData()

addMediaGalleryData ( )

Add media gallery data to loaded items

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Since: 101.0.1

Exceptions

Definition at line 2286 of file Collection.php.

     {
         if ($this->getFlag('media_gallery_added')) {
             return $this;
         }
 
         if (!$this->getSize()) {
             return $this;
         }
 
         $items = $this->getItems();
         $linkField = $this->getProductEntityMetadata()->getLinkField();
 
         $select = $this->getMediaGalleryResource()
             ->createBatchBaseSelect(
                 $this->getStoreId(),
                 $this->getAttribute('media_gallery')->getAttributeId()
             )->reset(
                 Select::ORDER // we don't care what order is in current scenario
             )->where(
                 'entity.' . $linkField . ' IN (?)',
                 array_map(
                     function ($item) use ($linkField) {
                         return (int) $item->getOrigData($linkField);
                     },
                     $items
                 )
             );
 
         $mediaGalleries = [];
         foreach ($this->getConnection()->fetchAll($select) as $row) {
             $mediaGalleries[$row[$linkField]][] = $row;
         }
 
         foreach ($items as $item) {
             $this->getGalleryReadHandler()
                 ->addMediaDataToProduct(
                     $item,
                     $mediaGalleries[$item->getOrigData($linkField)] ?? []
                 );
         }
 
         $this->setFlag('media_gallery_added', true);
         return $this;
     }

◆ addMinimalPrice()

addMinimalPrice ( )

Add minimal price data to result

Returns: $this

Definition at line 1451 of file Collection.php.

     {
         return $this->addPriceData();
     }

◆ addOptionsToResult()

addOptionsToResult ( )

Adding product custom options to result collection

Returns: $this

Definition at line 1630 of file Collection.php.

     {
         $productsByLinkId = [];
 
         foreach ($this as $product) {
             $productId = $product->getData(
                 $product->getResource()->getLinkField()
             );
 
             $productsByLinkId[$productId] = $product;
         }
 
         if (!empty($productsByLinkId)) {
             $options = $this->_productOptionFactory->create()->getCollection()->addTitleToResult(
                 $this->_storeManager->getStore()->getId()
             )->addPriceToResult(
                 $this->_storeManager->getStore()->getId()
             )->addProductToFilter(
                 array_keys($productsByLinkId)
             )->addValuesToResult();
 
             foreach ($options as $option) {
                 if (isset($productsByLinkId[$option->getProductId()])) {
                     $productsByLinkId[$option->getProductId()]->addOption($option);
                 }
             }
         }
 
         return $this;
     }

◆ addPriceData()

addPriceData	(	$customerGroupId = `null`,
		$websiteId = `null`
	)

Add Price Data to result

Parameters

int	$customerGroupId
int	$websiteId

Returns: $this

Definition at line 1506 of file Collection.php.

     {
         $this->_productLimitationFilters->setUsePriceIndex(true);
 
         if (!isset($this->_productLimitationFilters['customer_group_id']) && $customerGroupId === null) {
             $customerGroupId = $this->_customerSession->getCustomerGroupId();
         }
         if (!isset($this->_productLimitationFilters['website_id']) && $websiteId === null) {
             $websiteId = $this->_storeManager->getStore($this->getStoreId())->getWebsiteId();
         }
 
         if ($customerGroupId !== null) {
             $this->_productLimitationFilters['customer_group_id'] = $customerGroupId;
         }
         if ($websiteId !== null) {
             $this->_productLimitationFilters['website_id'] = $websiteId;
         }
 
         $this->_applyProductLimitations();
 
         return $this;
     }

◆ addPriceDataFieldFilter()

addPriceDataFieldFilter	(	$comparisonFormat,
		$fields
	)

Add field comparison expression

Parameters

string	$comparisonFormat	- expression for sprintf()
array	$fields	- list of fields

Returns: $this

Exceptions

Definition at line 2260 of file Collection.php.

     {
         if (!preg_match('/^%s( (<|>|=|<=|>=|<>) %s)*$/', $comparisonFormat)) {
             throw new \Exception('Invalid comparison format.');
         }
 
         if (!is_array($fields)) {
             $fields = [$fields];
         }
         foreach ($fields as $key => $field) {
             $fields[$key] = $this->_getMappedField($field);
         }
 
         $this->_priceDataFieldFilters[] = array_merge([$comparisonFormat], $fields);
         return $this;
     }

◆ addStoreFilter()

addStoreFilter ( $store = null )

Add store availability filter. Include availability product for store website.

Parameters

null | string | bool | int | Store $store

Returns: $this

Definition at line 846 of file Collection.php.

     {
         if ($store === null) {
             $store = $this->getStoreId();
         }
         $store = $this->_storeManager->getStore($store);
 
         if ($store->getId() != Store::DEFAULT_STORE_ID) {
             $this->setStoreId($store);
             $this->_productLimitationFilters['store_id'] = $store->getId();
             $this->_applyProductLimitations();
         }
 
         return $this;
     }

◆ addTaxPercents()

addTaxPercents ( )

Add require tax percent flag for product collection

Returns: $this

Definition at line 1609 of file Collection.php.

     {
         $this->_addTaxPercents = true;
         return $this;
     }

◆ addTierPriceData()

addTierPriceData ( )

Add tier price data to loaded items.

Returns: $this

Definition at line 2131 of file Collection.php.

     {
         if ($this->getFlag('tier_price_added')) {
             return $this;
         }
 
         $productIds = [];
         foreach ($this->getItems() as $item) {
             $productIds[] = $item->getData($this->getLinkField());
         }
         if (!$productIds) {
             return $this;
         }
         $select = $this->getTierPriceSelect($productIds);
         $this->fillTierPriceData($select);
 
         $this->setFlag('tier_price_added', true);
         return $this;
     }

◆ addTierPriceDataByGroupId()

addTierPriceDataByGroupId ( $customerGroupId )

Load collection items filtered by customer group id and add tier price data.

Parameters

int $customerGroupId

Returns: $this

Since: 102.0.0

Definition at line 2158 of file Collection.php.

     {
         if ($this->getFlag('tier_price_added')) {
             return $this;
         }
 
         $productIds = [];
         foreach ($this->getItems() as $item) {
             $productIds[] = $item->getData($this->getLinkField());
         }
         if (!$productIds) {
             return $this;
         }
         $select = $this->getTierPriceSelect($productIds);
         $select->where(
             '(customer_group_id=? AND all_groups=0) OR all_groups=1',
             $customerGroupId
         );
         $this->fillTierPriceData($select);
 
         $this->setFlag('tier_price_added', true);
         return $this;
     }

◆ addUrlRewrite()

addUrlRewrite ( $categoryId = '' )

Add URL rewrites data to product. If collection loadded - run processing else set flag.

Parameters

int | string $categoryId

Returns: $this

Definition at line 1377 of file Collection.php.

     {
         $this->_addUrlRewrite = true;
         $useCategoryUrl = $this->_scopeConfig->getValue(
             \Magento\Catalog\Helper\Product::XML_PATH_PRODUCT_URL_USE_CATEGORY,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->getStoreId()
         );
         if ($useCategoryUrl) {
             $this->_urlRewriteCategory = $categoryId;
         } else {
             $this->_urlRewriteCategory = 0;
         }
 
         if ($this->isLoaded()) {
             $this->_addUrlRewrite();
         }
 
         return $this;
     }

◆ addWebsiteFilter()

addWebsiteFilter ( $websites = null )

Add website filter to collection

Parameters

null | bool | int | string | array $websites

Returns: $this

Definition at line 868 of file Collection.php.

     {
         if (!is_array($websites)) {
             $websites = [$this->_storeManager->getWebsite($websites)->getId()];
         }
 
         $this->_productLimitationFilters['website_ids'] = $websites;
         $this->_applyProductLimitations();
 
         return $this;
     }

◆ addWebsiteNamesToResult()

addWebsiteNamesToResult ( )

Adding product website names to result collection. Add for each product websites information.

Returns: $this

Definition at line 776 of file Collection.php.

     {
         $this->needToAddWebsiteNamesToResult = true;
         return $this;
     }

◆ applyFrontendPriceLimitations()

applyFrontendPriceLimitations ( )

Apply front-end price limitation filters to the collection

Returns: $this

Definition at line 1979 of file Collection.php.

     {
         $this->_productLimitationFilters->setUsePriceIndex(true);
         if (!isset($this->_productLimitationFilters['customer_group_id'])) {
             $customerGroupId = $this->_customerSession->getCustomerGroupId();
             $this->_productLimitationFilters['customer_group_id'] = $customerGroupId;
         }
         if (!isset($this->_productLimitationFilters['website_id'])) {
             $websiteId = $this->_storeManager->getStore($this->getStoreId())->getWebsiteId();
             $this->_productLimitationFilters['website_id'] = $websiteId;
         }
         $this->_applyProductLimitations();
         return $this;
     }

◆ clear()

clear ( )

Clear collection

Returns: $this

Definition at line 2377 of file Collection.php.

     {
         foreach ($this->_items as $i => $item) {
             if ($item->hasStockItem()) {
                 $item->unsStockItem();
             }
             $this->_items[$i] = null;
         }
 
         foreach ($this->_itemsById as $i => $item) {
             $this->_itemsById[$i] = null;
         }
 
         unset($this->_items, $this->_data, $this->_itemsById);
         $this->_data = [];
         return parent::clear();
     }

◆ doAddWebsiteNamesToResult()

doAddWebsiteNamesToResult ( )

protected

Processs adding product website names to result collection

Returns: $this

Definition at line 803 of file Collection.php.

     {
         $productWebsites = [];
         foreach ($this as $product) {
             $productWebsites[$product->getId()] = [];
         }
 
         if (!empty($productWebsites)) {
             $select = $this->getConnection()->select()->from(
                 ['product_website' => $this->_productWebsiteTable]
             )->join(
                 ['website' => $this->getResource()->getTable('store_website')],
                 'website.website_id = product_website.website_id',
                 ['name']
             )->where(
                 'product_website.product_id IN (?)',
                 array_keys($productWebsites)
             )->where(
                 'website.website_id > ?',
                 0
             );
 
             $data = $this->getConnection()->fetchAll($select);
             foreach ($data as $row) {
                 $productWebsites[$row['product_id']][] = $row['website_id'];
             }
         }
 
         foreach ($this as $product) {
             if (isset($productWebsites[$product->getId()])) {
                 $product->setData('websites', $productWebsites[$product->getId()]);
                 $product->setData('website_ids', $productWebsites[$product->getId()]);
             }
         }
         return $this;
     }

◆ getAdditionalPriceExpression()

getAdditionalPriceExpression ( $select )

Get additional price expression sql part

Parameters

\Magento\Framework\DB\Select $select

Returns: string

Definition at line 448 of file Collection.php.

     {
         if (null === $this->_additionalPriceExpression) {
             $this->_preparePriceExpressionParameters($select);
         }
         return $this->_additionalPriceExpression;
     }

◆ getAllIds()

getAllIds	(	$limit = `null`,
		$offset = `null`
	)

Retrieve all ids for collection

Parameters

int \| string	$limit
int \| string	$offset

Returns: array

Definition at line 1209 of file Collection.php.

     {
         $idsSelect = $this->_getClearSelect();
         $idsSelect->columns('e.' . $this->getEntity()->getIdFieldName());
         $idsSelect->limit($limit, $offset);
         $idsSelect->resetJoinLeft();
 
         return $this->getConnection()->fetchCol($idsSelect, $this->_bindParams);
     }

◆ getAllIdsCache()

getAllIdsCache ( $resetCache = false )

Retrieve all ids

Parameters

boolean $resetCache

Returns: array

Definition at line 1472 of file Collection.php.

     {
         $ids = null;
         if (!$resetCache) {
             $ids = $this->_allIdsCache;
         }
 
         if ($ids === null) {
             $ids = $this->getAllIds();
             $this->setAllIdsCache($ids);
         }
 
         return $ids;
     }

◆ getAttributeValueCount()

getAttributeValueCount ( $attribute )

Retrieve product count by some value of attribute

Parameters

string $attribute

Returns: array ($value => $count)

Definition at line 1041 of file Collection.php.

     {
         $select = clone $this->getSelect();
         $attribute = $this->getEntity()->getAttribute($attribute);
         $attributeCode = $attribute->getAttributeCode();
         $tableAlias = $attributeCode . '_value_count';
 
         $select->reset(\Magento\Framework\DB\Select::GROUP);
         $condition = 'e.entity_id=' . $tableAlias . '.entity_id AND ' . $this->_getConditionSql(
             $tableAlias . '.attribute_id',
             $attribute->getId()
         );
 
         $select->join(
             [$tableAlias => $attribute->getBackend()->getTable()],
             $condition,
             [
                 'count_' . $attributeCode => new \Zend_Db_Expr('COUNT(DISTINCT e.entity_id)'),
                 'value_' . $attributeCode => new \Zend_Db_Expr($tableAlias . '.value')
             ]
         )->group(
             'value_' . $attributeCode
         );
 
         $data = $this->getConnection()->fetchAll($select);
         $res = [];
 
         foreach ($data as $row) {
             $res[$row['value_' . $attributeCode]] = $row['count_' . $attributeCode];
         }
         return $res;
     }

◆ getAttributeValueCountByRange()

getAttributeValueCountByRange	(	$attribute,
		$range
	)

Retrieve ranging product count for arrtibute range

Parameters

string	$attribute
int	$range

Returns: array

Definition at line 1002 of file Collection.php.

     {
         $select = clone $this->getSelect();
         $attribute = $this->getEntity()->getAttribute($attribute);
         $attributeCode = $attribute->getAttributeCode();
         $tableAlias = $attributeCode . '_range_count_value';
 
         $condition = 'e.entity_id = ' . $tableAlias . '.entity_id AND ' . $this->_getConditionSql(
             $tableAlias . '.attribute_id',
             $attribute->getId()
         );
 
         $select->reset(\Magento\Framework\DB\Select::GROUP);
         $select->join(
             [$tableAlias => $attribute->getBackend()->getTable()],
             $condition,
             [
                 'count_' . $attributeCode => new \Zend_Db_Expr('COUNT(DISTINCT e.entity_id)'),
                 'range_' . $attributeCode => new \Zend_Db_Expr('CEIL((' . $tableAlias . '.value+0.01)/' . $range . ')')
             ]
         )->group(
             'range_' . $attributeCode
         );
 
         $data = $this->getConnection()->fetchAll($select);
         $res = [];
 
         foreach ($data as $row) {
             $res[$row['range_' . $attributeCode]] = $row['count_' . $attributeCode];
         }
         return $res;
     }

◆ getCatalogPreparedSelect()

getCatalogPreparedSelect ( )

Get cloned Select after dispatching 'catalog_prepare_price_select' event

Returns: \Magento\Framework\DB\Select

Definition at line 388 of file Collection.php.

     {
         return $this->_catalogPreparePriceSelect;
     }

◆ getCurrencyRate()

getCurrencyRate ( )

Get currency rate

Returns: float

Definition at line 461 of file Collection.php.

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

◆ getEntityPkName()

getEntityPkName ( \Magento\Eav\Model\Entity\AbstractEntity $entity )

protected

Since: 101.0.0

Definition at line 1599 of file Collection.php.

     {
         return $entity->getLinkField();
     }

◆ getFlatState()

getFlatState ( )

Retrieve Catalog Product Flat Helper object

Returns: \Magento\Catalog\Model\Indexer\Product\Flat\State

Definition at line 471 of file Collection.php.

     {
         return $this->_catalogProductFlatState;
     }

◆ getLimitationFilters()

getLimitationFilters ( )

Get filters applied to collection

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

Definition at line 885 of file Collection.php.

     {
         return $this->_productLimitationFilters;
     }

◆ getMaxAttributeValue()

getMaxAttributeValue ( $attribute )

Retrieve max value by attribute

Parameters

string $attribute

Returns: array|null

Definition at line 967 of file Collection.php.

     {
         $select = clone $this->getSelect();
         $attribute = $this->getEntity()->getAttribute($attribute);
         $attributeCode = $attribute->getAttributeCode();
         $tableAlias = $attributeCode . '_max_value';
         $fieldAlias = 'max_' . $attributeCode;
         $condition = 'e.entity_id = ' . $tableAlias . '.entity_id AND ' . $this->_getConditionSql(
             $tableAlias . '.attribute_id',
             $attribute->getId()
         );
 
         $select->join(
             [$tableAlias => $attribute->getBackend()->getTable()],
             $condition,
             [$fieldAlias => new \Zend_Db_Expr('MAX(' . $tableAlias . '.value)')]
         )->group(
             'e.entity_type_id'
         );
 
         $data = $this->getConnection()->fetchRow($select);
         if (isset($data[$fieldAlias])) {
             return $data[$fieldAlias];
         }
 
         return null;
     }

◆ getMaxPrice()

getMaxPrice ( )

Get products max price

Returns: float

Definition at line 2417 of file Collection.php.

     {
         if ($this->_maxPrice === null) {
             $this->_prepareStatisticsData();
         }
 
         return $this->_maxPrice;
     }

◆ getMinPrice()

getMinPrice ( )

Get products min price

Returns: float

Definition at line 2431 of file Collection.php.

     {
         if ($this->_minPrice === null) {
             $this->_prepareStatisticsData();
         }
 
         return $this->_minPrice;
     }

◆ getNewEmptyItem()

getNewEmptyItem ( )

Get collection empty item. Redeclared for specifying id field name without getting resource model inside model.

Returns: \Magento\Framework\DataObject

Definition at line 551 of file Collection.php.

     {
         $object = parent::getNewEmptyItem();
         if ($this->isEnabledFlat()) {
             $object->setIdFieldName($this->getEntity()->getIdFieldName());
         }
         return $object;
     }

◆ getPriceExpression()

getPriceExpression ( $select )

Get price expression sql part

Parameters

\Magento\Framework\DB\Select $select

Returns: string

Definition at line 435 of file Collection.php.

     {
         //@todo: Add caching of price expresion
         $this->_preparePriceExpressionParameters($select);
         return $this->_priceExpression;
     }

◆ getPricesCount()

getPricesCount ( )

Get count of product prices

Returns: int

Definition at line 2459 of file Collection.php.

     {
         if ($this->_pricesCount === null) {
             $this->_prepareStatisticsData();
         }
 
         return $this->_pricesCount;
     }

◆ getPriceStandardDeviation()

getPriceStandardDeviation ( )

Get standard deviation of products price

Returns: float

Definition at line 2445 of file Collection.php.

     {
         if ($this->_priceStandardDeviation === null) {
             $this->_prepareStatisticsData();
         }
 
         return $this->_priceStandardDeviation;
     }

◆ getProductCountSelect()

getProductCountSelect ( )

Retrieve product count select for categories

Returns: \Magento\Framework\DB\Select

Definition at line 1224 of file Collection.php.

     {
         if ($this->_productCountSelect === null) {
             $this->_productCountSelect = clone $this->getSelect();
             $this->_productCountSelect->reset(
                 \Magento\Framework\DB\Select::COLUMNS
             )->reset(
                 \Magento\Framework\DB\Select::GROUP
             )->reset(
                 \Magento\Framework\DB\Select::ORDER
             )->distinct(
                 false
             )->join(
                 ['count_table' => $this->tableMaintainer->getMainTable($this->getStoreId())],
                 'count_table.product_id = e.entity_id',
                 [
                     'count_table.category_id',
                     'product_count' => new \Zend_Db_Expr('COUNT(DISTINCT count_table.product_id)')
                 ]
             )->where(
                 'count_table.store_id = ?',
                 $this->getStoreId()
             )->group(
                 'count_table.category_id'
             );
         }
 
         return $this->_productCountSelect;
     }

◆ getProductEntityMetadata()

getProductEntityMetadata ( )

Get product entity metadata

Returns: \Magento\Framework\EntityManager\EntityMetadataInterface

Since: 102.0.0

Definition at line 2338 of file Collection.php.

     {
         return $this->metadataPool->getMetadata(ProductInterface::class);
     }

◆ getSelectCountSql()

getSelectCountSql ( )

Get SQL for get record count without left JOINs

Returns: \Magento\Framework\DB\Select

Definition at line 1122 of file Collection.php.

     {
         return $this->_getSelectCountSql();
     }

◆ isEnabledFlat()

isEnabledFlat ( )

Retrieve is flat enabled. Return always false if magento run admin.

Returns: bool

Definition at line 481 of file Collection.php.

     {
         if (!isset($this->_flatEnabled[$this->getStoreId()])) {
             $this->_flatEnabled[$this->getStoreId()] = $this->getFlatState()->isAvailable();
         }
         return $this->_flatEnabled[$this->getStoreId()];
     }

◆ joinMinimalPrice()

joinMinimalPrice ( )

Join minimal price attribute to result

Returns: $this

Definition at line 955 of file Collection.php.

     {
         $this->addAttributeToSelect('price')->addAttributeToSelect('minimal_price');
         return $this;
     }

◆ joinUrlRewrite()

joinUrlRewrite ( )

Joins url rewrite rules to collection

Returns: $this

Definition at line 1359 of file Collection.php.

     {
         $this->joinTable(
             'url_rewrite',
             'entity_id = entity_id',
             ['request_path'],
             '{{table}}.entity_type = \'' . ProductUrlRewriteGenerator::ENTITY_TYPE . '\'',
             'left'
         );
         return $this;
     }

◆ load()

load	(	$printQuery = `false`,
		$logQuery = `false`
	)

Definition at line 785 of file Collection.php.

     {
         if ($this->isLoaded()) {
             return $this;
         }
         parent::load($printQuery, $logQuery);
 
         if ($this->needToAddWebsiteNamesToResult) {
             $this->doAddWebsiteNamesToResult();
         }
         return $this;
     }

◆ requireTaxPercent()

requireTaxPercent ( )

Get require tax percent flag value

Returns: bool

Definition at line 1620 of file Collection.php.

     {
         return $this->_addTaxPercents;
     }

◆ setAllIdsCache()

setAllIdsCache ( $value )

Set all ids

Parameters

array $value

Returns: $this

Definition at line 1493 of file Collection.php.

     {
         $this->_allIdsCache = $value;
         return $this;
     }

◆ setEntity()

setEntity ( $entity )

Set entity to use for attributes

Parameters

\Magento\Eav\Model\Entity\AbstractEntity $entity

Returns: $this

Definition at line 566 of file Collection.php.

     {
         if ($this->isEnabledFlat() && $entity instanceof \Magento\Framework\Model\ResourceModel\Db\AbstractDb) {
             $this->_entity = $entity;
             return $this;
         }
         return parent::setEntity($entity);
     }

◆ setOrder()

setOrder	(	$attribute,
		$dir = `Select::SQL_DESC`
	)

Set Order field

Parameters

string	$attribute
string	$dir

Returns: $this

Definition at line 2402 of file Collection.php.

     {
         if ($attribute == 'price') {
             $this->addAttributeToSort($attribute, $dir);
         } else {
             parent::setOrder($attribute, $dir);
         }
         return $this;
     }

◆ setStore()

setStore ( $store )

Set Store scope for collection

Parameters

mixed $store

Returns: $this

Definition at line 581 of file Collection.php.

     {
         parent::setStore($store);
         if ($this->isEnabledFlat()) {
             $this->getEntity()->setStoreId($this->getStoreId());
         }
         return $this;
     }

◆ setVisibility()

setVisibility ( $visibility )

Set product visibility filter for enabled products

Parameters

array $visibility

Returns: $this

Definition at line 1678 of file Collection.php.

     {
         $this->_productLimitationFilters['visibility'] = $visibility;
         $this->_applyProductLimitations();
 
         return $this;
     }

◆ unsProductCountSelect()

unsProductCountSelect ( )

Destruct product count select

Returns: $this

Definition at line 1259 of file Collection.php.

     {
         $this->_productCountSelect = null;
         return $this;
     }

Field Documentation

◆ $_addFinalPrice

$_addFinalPrice = false

protected

Definition at line 93 of file Collection.php.

◆ $_additionalPriceExpression

$_additionalPriceExpression

protected

Definition at line 145 of file Collection.php.

◆ $_addTaxPercents

$_addTaxPercents = false

protected

Definition at line 107 of file Collection.php.

◆ $_addUrlRewrite

$_addUrlRewrite = false

protected

Definition at line 79 of file Collection.php.

◆ $_allIdsCache

$_allIdsCache = null

protected

Definition at line 100 of file Collection.php.

◆ $_catalogPreparePriceSelect

$_catalogPreparePriceSelect = null

protected

Definition at line 180 of file Collection.php.

◆ $_catalogProductFlatState

$_catalogProductFlatState = null

protected

Definition at line 187 of file Collection.php.

◆ $_catalogUrl

$_catalogUrl

protected

Definition at line 220 of file Collection.php.

◆ $_customerSession

$_customerSession

protected

Definition at line 208 of file Collection.php.

◆ $_flatEnabled

$_flatEnabled = []

protected

Definition at line 58 of file Collection.php.

◆ $_groupManagement

$_groupManagement

protected

Definition at line 244 of file Collection.php.

◆ $_idFieldName

$_idFieldName = 'entity_id'

protected

Definition at line 51 of file Collection.php.

◆ $_isWebsiteFilter

$_isWebsiteFilter = false

protected

Definition at line 124 of file Collection.php.

◆ $_localeDate

$_localeDate

protected

Definition at line 213 of file Collection.php.

◆ $_maxPrice

$_maxPrice

protected

Definition at line 152 of file Collection.php.

◆ $_minPrice

$_minPrice

protected

Definition at line 159 of file Collection.php.

◆ $_priceDataFieldFilters

$_priceDataFieldFilters = []

protected

Definition at line 131 of file Collection.php.

◆ $_priceExpression

$_priceExpression

protected

Definition at line 138 of file Collection.php.

◆ $_pricesCount

$_pricesCount = null

protected

Definition at line 173 of file Collection.php.

◆ $_priceStandardDeviation

$_priceStandardDeviation

protected

Definition at line 166 of file Collection.php.

◆ $_productCategoryTable

$_productCategoryTable

protected

Definition at line 72 of file Collection.php.

◆ $_productCountSelect

$_productCountSelect = null

protected

Definition at line 119 of file Collection.php.

◆ $_productLimitationFilters

$_productLimitationFilters

protected

Definition at line 112 of file Collection.php.

◆ $_productOptionFactory

$_productOptionFactory

protected

Definition at line 227 of file Collection.php.

◆ $_productWebsiteTable

$_productWebsiteTable

protected

Definition at line 65 of file Collection.php.

◆ $_resourceHelper

$_resourceHelper

protected

Definition at line 234 of file Collection.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 201 of file Collection.php.

◆ $_urlRewriteCategory

$_urlRewriteCategory = ''

protected

Definition at line 86 of file Collection.php.

◆ $dateTime

$dateTime

protected

Definition at line 239 of file Collection.php.

◆ $moduleManager

$moduleManager = null

protected

Definition at line 194 of file Collection.php.

◆ $needToAddWebsiteNamesToResult

$needToAddWebsiteNamesToResult

protected

Definition at line 251 of file Collection.php.

◆ INDEX_TABLE_ALIAS

const INDEX_TABLE_ALIAS = 'price_index'

Alias for index table

Definition at line 41 of file Collection.php.

◆ MAIN_TABLE_ALIAS

const MAIN_TABLE_ALIAS = 'e'

Alias for main table

Definition at line 46 of file Collection.php.

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

vendor/magento/module-catalog/Model/ResourceModel/Product/Collection.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addUrlRewrite()

◆ _afterLoad()

◆ _applyProductLimitations()

◆ _applyZeroStoreProductLimitations()

◆ _buildClearSelect()

◆ _construct()

◆ _getClearSelect()

◆ _getSelectCountSql()

◆ _init()

◆ _initSelect()

◆ _initTables()

◆ _loadAttributes()

◆ _preparePriceExpressionParameters()

◆ _prepareProductLimitationFilters()

◆ _prepareStaticFields()

◆ _prepareStatisticsData()

◆ _productLimitationJoinPrice()

◆ _productLimitationJoinStore()

◆ _productLimitationJoinWebsite()

◆ _productLimitationPrice()

◆ addAttributeToFilter()

◆ addAttributeToSelect()

◆ addAttributeToSort()

◆ addCategoriesFilter()

◆ addCategoryFilter()

◆ addCategoryIds()

◆ addCountToCategories()

◆ addFilterByRequiredOptions()

◆ addFinalPrice()

◆ addIdFilter()

◆ addMediaGalleryData()

◆ addMinimalPrice()

◆ addOptionsToResult()

◆ addPriceData()

◆ addPriceDataFieldFilter()

◆ addStoreFilter()

◆ addTaxPercents()

◆ addTierPriceData()

◆ addTierPriceDataByGroupId()

◆ addUrlRewrite()

◆ addWebsiteFilter()

◆ addWebsiteNamesToResult()

◆ applyFrontendPriceLimitations()

◆ clear()

◆ doAddWebsiteNamesToResult()

◆ getAdditionalPriceExpression()

◆ getAllIds()

◆ getAllIdsCache()

◆ getAttributeValueCount()

◆ getAttributeValueCountByRange()

◆ getCatalogPreparedSelect()

◆ getCurrencyRate()

◆ getEntityPkName()

◆ getFlatState()

◆ getLimitationFilters()

◆ getMaxAttributeValue()

◆ getMaxPrice()

◆ getMinPrice()

◆ getNewEmptyItem()

◆ getPriceExpression()

◆ getPricesCount()

◆ getPriceStandardDeviation()

◆ getProductCountSelect()

◆ getProductEntityMetadata()

◆ getSelectCountSql()

◆ isEnabledFlat()

◆ joinMinimalPrice()

◆ joinUrlRewrite()

◆ load()

◆ requireTaxPercent()

◆ setAllIdsCache()

◆ setEntity()