Collection Class Reference

Inheritance diagram for Collection:

Public Member Functions
	__construct (\Magento\Framework\Data\Collection\EntityFactoryInterface $entityFactory, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\DB\Helper $resourceHelper, \Magento\Framework\DB\Adapter\AdapterInterface $connection=null, \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource=null)
	setStoreId ($store)
	getStoreId ()
	setQueryFilter ($query)
	setPopularQueryFilter ($storeIds=null)
	setRecentQueryFilter ()
	addStoreFilter ($storeIds)
Public Member Functions inherited from AbstractCollection
	__construct (\Magento\Framework\Data\Collection\EntityFactoryInterface $entityFactory, \Psr\Log\LoggerInterface $logger, \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy, \Magento\Framework\Event\ManagerInterface $eventManager, \Magento\Framework\DB\Adapter\AdapterInterface $connection=null, \Magento\Framework\Model\ResourceModel\Db\AbstractDb $resource=null)
	getMainTable ()
	setMainTable ($table)
	getSelect ()
	addFieldToSelect ($field, $alias=null)
	addExpressionFieldToSelect ($alias, $expression, $fields)
	removeFieldFromSelect ($field, $isAlias=false)
	removeAllFieldsFromSelect ()
	setModel ($model)
	getModelName ()
	setResourceModel ($model)
	getResourceModelName ()
	getResource ()
	getTable ($table)
	getAllIds ()
	join ($table, $cond, $cols=' *')
	setResetItemsDataChanged ($flag)
	resetItemsDataChanged ()
	save ()
	__sleep ()
	__wakeup ()
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
	getIdFieldName ()
	addFieldToFilter ($attribute, $condition=null)

Protected Member Functions
	_construct ()
Protected Member Functions inherited from AbstractCollection
	_construct ()
	_initSelect ()
	_initSelectFields ()
	_getInitialFieldsToSelect ()
	_initInitialFieldsToSelect ()
	_init ($model, $resourceModel)
	_beforeLoad ()
	_afterLoad ()
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
	$_storeId
	$_storeManager
	$_resourceHelper
Protected Attributes inherited from AbstractCollection
	$_model
	$_resourceModel
	$_resource
	$_fieldsToSelect = null
	$_initialFieldsToSelect = null
	$_fieldsToSelectChanged = false
	$_joinedTables = []
	$_mainTable = null
	$_resetItemsDataChanged = false
	$_eventPrefix = ''
	$_eventObject = ''
	$_eventManager = null
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	SORT_ORDER_ASC = 'ASC'
const	SORT_ORDER_DESC = 'DESC'

Detailed Description

Search query collection

@api

Since

100.0.2

Definition at line 16 of file Collection.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Data\Collection\EntityFactoryInterface	$entityFactory,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\Data\Collection\Db\FetchStrategyInterface	$fetchStrategy,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\DB\Helper	$resourceHelper,
		\Magento\Framework\DB\Adapter\AdapterInterface	$connection = null,
		\Magento\Framework\Model\ResourceModel\Db\AbstractDb	$resource = null
	)

Parameters

\Magento\Framework\Data\Collection\EntityFactory	$entityFactory
\Psr\Log\LoggerInterface	$logger
\Magento\Framework\Data\Collection\Db\FetchStrategyInterface	$fetchStrategy
\Magento\Framework\Event\ManagerInterface	$eventManager
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\DB\Helper	$resourceHelper
\Magento\Framework\DB\Adapter\AdapterInterface	$connection
\Magento\Framework\Model\ResourceModel\Db\AbstractDb	$resource

Definition at line 49 of file Collection.php.

      {
        $this->_storeManager = $storeManager;
        $this->_resourceHelper = $resourceHelper;
        parent::__construct($entityFactory, $logger, $fetchStrategy, $eventManager, $connection, $resource);
    }

Member Function Documentation

_construct()

_construct ( )

protected

Init model for collection

Returns

void

Definition at line 69 of file Collection.php.

    {
        $this->_init(\Magento\Search\Model\Query::class, \Magento\Search\Model\ResourceModel\Query::class);
    }

addStoreFilter()

addStoreFilter

(

$storeIds

)

Filter collection by specified store ids

Parameters

array | int

$storeIds

Returns

$this

Definition at line 173 of file Collection.php.

    {
        if (!is_array($storeIds)) {
            $storeIds = [$storeIds];
        }
        $this->getSelect()->where('main_table.store_id IN (?)', $storeIds);
        return $this;
    }

getStoreId()

getStoreId

(

)

Retrieve Store ID Filter

Returns

int|null

Definition at line 94 of file Collection.php.

    {
        return $this->_storeId;
    }

setPopularQueryFilter()

setPopularQueryFilter

(

$storeIds = null

)

Set Popular Search Query Filter

Parameters

int | array

$storeIds

Returns

$this

Definition at line 131 of file Collection.php.

    {

        $this->getSelect()->reset(
            \Magento\Framework\DB\Select::FROM
        )->reset(
            \Magento\Framework\DB\Select::COLUMNS
        )->distinct(
            true
        )->from(
            ['main_table' => $this->getTable('search_query')]
        );
        if ($storeIds) {
            $this->addStoreFilter($storeIds);
            $this->getSelect()->where('num_results > 0');
        } elseif (null === $storeIds) {
            $this->addStoreFilter($this->_storeManager->getStore()->getId());
            $this->getSelect()->where('num_results > 0');
        }

        $this->getSelect()->order(['popularity desc']);

        return $this;
    }

setQueryFilter()

setQueryFilter

(

$query

)

Set search query text to filter

Parameters

string

$query

Returns

$this

Definition at line 105 of file Collection.php.

    {
        $this->getSelect()->reset(
            \Magento\Framework\DB\Select::FROM
        )->distinct(
            true
        )->from(
            ['main_table' => $this->getTable('search_query')]
        )->where(
            'num_results > 0 AND display_in_terms = 1 AND query_text LIKE ?',
            $this->_resourceHelper->addLikeEscape($query, ['position' => 'start'])
        )->order(
            'popularity ' . \Magento\Framework\DB\Select::SQL_DESC
        );
        if ($this->getStoreId()) {
            $this->getSelect()->where('store_id = ?', (int)$this->getStoreId());
        }
        return $this;
    }

setRecentQueryFilter()

setRecentQueryFilter

(

)

Set Recent Queries Order

Returns

$this

Definition at line 161 of file Collection.php.

    {
        $this->setOrder('updated_at', 'desc');
        return $this;
    }

setStoreId()

setStoreId

(

$store

)

Set Store ID for filter

Parameters

Store | int

$store

Returns

$this

Definition at line 80 of file Collection.php.

    {
        if ($store instanceof Store) {
            $store = $store->getId();
        }
        $this->_storeId = $store;
        return $this;
    }

Field Documentation

$_resourceHelper

$_resourceHelper

protected

Definition at line 37 of file Collection.php.

$_storeId

$_storeId

protected

Definition at line 23 of file Collection.php.

$_storeManager

$_storeManager

protected

Definition at line 30 of file Collection.php.

---

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

• vendor/magento/module-search/Model/ResourceModel/Query/Collection.php