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, \Magento\Customer\Api\GroupManagementInterface $groupManagement, \Magento\Search\Model\QueryFactory $catalogSearchData, \Magento\Framework\Search\Request\Builder $requestBuilder, \Magento\Search\Model\SearchEngine $searchEngine, \Magento\Framework\Search\Adapter\Mysql\TemporaryStorageFactory $temporaryStorageFactory, \Magento\Framework\DB\Adapter\AdapterInterface $connection=null, $searchRequestName='catalog_view_container', SearchResultFactory $searchResultFactory=null, ProductLimitationFactory $productLimitationFactory=null, MetadataPool $metadataPool=null)

	setSearch (\Magento\Search\Api\SearchInterface $object)

	setSearchCriteriaBuilder (\Magento\Framework\Api\Search\SearchCriteriaBuilder $object)

	setFilterBuilder (\Magento\Framework\Api\FilterBuilder $object)

	addFieldToFilter ($field, $condition=null)

	addSearchFilter ($query)

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

	setGeneralDefaultQuery ()

	getFacetedData ($field)

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

	setVisibility ($visibility)

Public Member Functions inherited from Collection
	__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 ()

Protected Member Functions
	_beforeLoad ()

	_renderFilters ()

Protected Member Functions inherited from Collection
	_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
	$queryResponse

	$queryFactory = null

Protected Attributes inherited from Collection
	$_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

Additional Inherited Members
Data Fields inherited from Collection
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'

Detailed Description

Fulltext Collection

This collection should be refactored to not have dependencies on MySQL-specific implementation.

@api

Since: 100.0.2 @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 30 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,
		\Magento\Customer\Api\GroupManagementInterface	$groupManagement,
		\Magento\Search\Model\QueryFactory	$catalogSearchData,
		\Magento\Framework\Search\Request\Builder	$requestBuilder,
		\Magento\Search\Model\SearchEngine	$searchEngine,
		\Magento\Framework\Search\Adapter\Mysql\TemporaryStorageFactory	$temporaryStorageFactory,
		\Magento\Framework\DB\Adapter\AdapterInterface	$connection = `null`,
			$searchRequestName = `'catalog_view_container'`,
		SearchResultFactory	$searchResultFactory = `null`,
		ProductLimitationFactory	$productLimitationFactory = `null`,
		MetadataPool	$metadataPool = `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
\Magento\Customer\Api\GroupManagementInterface	$groupManagement
\Magento\Search\Model\QueryFactory	$catalogSearchData
\Magento\Framework\Search\Request\Builder	$requestBuilder
\Magento\Search\Model\SearchEngine	$searchEngine
\Magento\Framework\Search\Adapter\Mysql\TemporaryStorageFactory	$temporaryStorageFactory
\Magento\Framework\DB\Adapter\AdapterInterface \| null	$connection
string	$searchRequestName
SearchResultFactory \| null	$searchResultFactory
ProductLimitationFactory \| null	$productLimitationFactory
MetadataPool \| null	$metadataPool	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 138 of file Collection.php.

       {
         $this->queryFactory = $catalogSearchData;
         if ($searchResultFactory === null) {
             $this->searchResultFactory = \Magento\Framework\App\ObjectManager::getInstance()
                 ->get(\Magento\Framework\Api\Search\SearchResultFactory::class);
         }
         parent::__construct(
             $entityFactory,
             $logger,
             $fetchStrategy,
             $eventManager,
             $eavConfig,
             $resource,
             $eavEntityFactory,
             $resourceHelper,
             $universalFactory,
             $storeManager,
             $moduleManager,
             $catalogProductFlatState,
             $scopeConfig,
             $productOptionFactory,
             $catalogUrl,
             $localeDate,
             $customerSession,
             $dateTime,
             $groupManagement,
             $connection,
             $productLimitationFactory,
             $metadataPool
         );
         $this->requestBuilder = $requestBuilder;
         $this->searchEngine = $searchEngine;
         $this->temporaryStorageFactory = $temporaryStorageFactory;
         $this->searchRequestName = $searchRequestName;
     }

Member Function Documentation

◆ _beforeLoad()

_beforeLoad ( )

protected

Since: 100.2.3

Definition at line 391 of file Collection.php.

     {
         /*
          * This order is required to force search results be the same
          * for the same requests and products with the same relevance
          * NOTE: this does not replace existing orders but ADDs one more
          */
         $this->setOrder('entity_id');
         return parent::_beforeLoad();
     }

◆ _renderFilters()

_renderFilters ( )

protected

Render filters.

Returns: $this

Definition at line 407 of file Collection.php.

     {
         $this->_filters = [];
         return parent::_renderFilters();
     }

◆ addCategoryFilter()

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

Specify category filter for product collection

Parameters

\Magento\Catalog\Model\Category $category

Returns: $this

Definition at line 474 of file Collection.php.

     {
         $this->addFieldToFilter('category_ids', $category->getId());
         return parent::addCategoryFilter($category);
     }

◆ addFieldToFilter()

addFieldToFilter	(	$field,
		$condition = `null`
	)

Apply attribute filter to facet collection

Parameters

string	$field
mixed \| null	$condition

Returns: $this

Implements SourceProviderInterface.

Definition at line 292 of file Collection.php.

     {
         if ($this->searchResult !== null) {
             throw new \RuntimeException('Illegal state');
         }
 
         $this->getSearchCriteriaBuilder();
         $this->getFilterBuilder();
         if (!is_array($condition) || !in_array(key($condition), ['from', 'to'], true)) {
             $this->filterBuilder->setField($field);
             $this->filterBuilder->setValue($condition);
             $this->searchCriteriaBuilder->addFilter($this->filterBuilder->create());
         } else {
             if (!empty($condition['from'])) {
                 $this->filterBuilder->setField("{$field}.from");
                 $this->filterBuilder->setValue($condition['from']);
                 $this->searchCriteriaBuilder->addFilter($this->filterBuilder->create());
             }
             if (!empty($condition['to'])) {
                 $this->filterBuilder->setField("{$field}.to");
                 $this->filterBuilder->setValue($condition['to']);
                 $this->searchCriteriaBuilder->addFilter($this->filterBuilder->create());
             }
         }
         return $this;
     }

◆ addSearchFilter()

addSearchFilter ( $query )

Add search query filter

Parameters

string $query

Returns: $this

Definition at line 325 of file Collection.php.

     {
         $this->queryText = trim($this->queryText . ' ' . $query);
         return $this;
     }

◆ getFacetedData()

getFacetedData ( $field )

Return field faceted data from faceted search result

Parameters

string $field

Returns: array

Exceptions

StateException

Definition at line 448 of file Collection.php.

     {
         $this->_renderFilters();
         $result = [];
         $aggregations = $this->searchResult->getAggregations();
         // This behavior is for case with empty object when we got EmptyRequestDataException
         if (null !== $aggregations) {
             $bucket = $aggregations->getBucket($field . RequestGenerator::BUCKET_SUFFIX);
             if ($bucket) {
                 foreach ($bucket->getValues() as $value) {
                     $metrics = $value->getMetrics();
                     $result[$metrics['value']] = $metrics;
                 }
             } else {
                 throw new StateException(__("The bucket doesn't exist."));
             }
         }
         return $result;
     }

◆ setFilterBuilder()

setFilterBuilder ( \Magento\Framework\Api\FilterBuilder $object )

Set filter builder.

Deprecated:: 100.1.0

Parameters

\Magento\Framework\Api\FilterBuilder $object

Returns: void

Since: 100.1.0

Definition at line 280 of file Collection.php.

     {
         $this->filterBuilder = $object;
     }

◆ setGeneralDefaultQuery()

setGeneralDefaultQuery ( )

Stub method for compatibility with other search engines

Returns: $this

Definition at line 436 of file Collection.php.

     {
         return $this;
     }

◆ setOrder()

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

Set Order field

Parameters

string	$attribute
string	$dir

Returns: $this

Definition at line 420 of file Collection.php.

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

◆ setSearch()

setSearch ( \Magento\Search\Api\SearchInterface $object )

Test search.

Deprecated:: 100.1.0

Parameters

\Magento\Search\Api\SearchInterface $object

Returns: void

Since: 100.1.0

Definition at line 225 of file Collection.php.

     {
         $this->search = $object;
     }

◆ setSearchCriteriaBuilder()

setSearchCriteriaBuilder ( \Magento\Framework\Api\Search\SearchCriteriaBuilder $object )

Set search criteria builder.

Deprecated:: 100.1.0

Parameters

\Magento\Framework\Api\Search\SearchCriteriaBuilder $object

Returns: void

Since: 100.1.0

Definition at line 253 of file Collection.php.

     {
         $this->searchCriteriaBuilder = $object;
     }

◆ setVisibility()

setVisibility ( $visibility )

Set product visibility filter for enabled products

Parameters

array $visibility

Returns: $this

Definition at line 486 of file Collection.php.

     {
         $this->addFieldToFilter('visibility', $visibility);
         return parent::setVisibility($visibility);
     }

Field Documentation

◆ $queryFactory

$queryFactory = null

protected

Definition at line 44 of file Collection.php.

◆ $queryResponse

$queryResponse

protected

Definition at line 36 of file Collection.php.

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

vendor/magento/module-catalog-search/Model/ResourceModel/Fulltext/Collection.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _beforeLoad()

◆ _renderFilters()

◆ addCategoryFilter()

◆ addFieldToFilter()

◆ addSearchFilter()

◆ getFacetedData()

◆ setFilterBuilder()

◆ setGeneralDefaultQuery()

◆ setOrder()

◆ setSearch()

◆ setSearchCriteriaBuilder()

◆ setVisibility()

Field Documentation

◆ $queryFactory

◆ $queryResponse