Inheritance diagram for Query:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, Registry $registry, QueryCollectionFactory $queryCollectionFactory, CollectionFactory $searchCollectionFactory, StoreManagerInterface $storeManager, ScopeConfigInterface $scopeConfig, AbstractResource $resource=null, DbCollection $resourceCollection=null, array $data=[])

	getSearchCollection ()

	getSuggestCollection ()

	loadByQuery ($text)

	loadByQueryText ($text)

	setStoreId ($storeId)

	getStoreId ()

	prepare ()

	saveIncrementalPopularity ()

	saveNumResults ($numResults)

	getMinQueryLength ()

	getMaxQueryLength ()

	getQueryText ()

	isQueryTextExceeded ()

	isQueryTextShort ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Data Fields
const	CACHE_TAG = 'SEARCH_QUERY'

const	XML_PATH_MIN_QUERY_LENGTH = 'catalog/search/min_query_length'

const	XML_PATH_MAX_QUERY_LENGTH = 'catalog/search/max_query_length'

Protected Member Functions
	_construct ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_eventPrefix = 'search_query'

	$_eventObject = 'search_query'

	$_scopeConfig

	$_storeManager

	$_searchCollectionFactory

	$_queryCollectionFactory

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Search query model

@method \Magento\Search\Model\Query setQueryText(string $value) @method int getNumResults() @method \Magento\Search\Model\Query setNumResults(int $value) @method int getPopularity() @method \Magento\Search\Model\Query setPopularity(int $value) @method string getRedirect() @method \Magento\Search\Model\Query setRedirect(string $value) @method int getDisplayInTerms() @method \Magento\Search\Model\Query setDisplayInTerms(int $value) @method \Magento\Search\Model\Query setQueryNameExceeded(bool $value) @method int getIsActive() @method \Magento\Search\Model\Query setIsActive(int $value) @method int getIsProcessed() @method \Magento\Search\Model\Query setIsProcessed(int $value) @method string getUpdatedAt() @method \Magento\Search\Model\Query setUpdatedAt(string $value) @method \Magento\Search\Model\Query setIsQueryTextExceeded(bool $value) @method \Magento\Search\Model\Query setIsQueryTextShort(bool $value) @SuppressWarnings(PHPMD.CouplingBetweenObjects) @api

Since: 100.0.2

Definition at line 44 of file Query.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		Registry	$registry,
		QueryCollectionFactory	$queryCollectionFactory,
		CollectionFactory	$searchCollectionFactory,
		StoreManagerInterface	$storeManager,
		ScopeConfigInterface	$scopeConfig,
		AbstractResource	$resource = `null`,
		DbCollection	$resourceCollection = `null`,
		array	$data = `[]`
	)

Construct

Parameters

\Magento\Framework\Model\Context	$context
Registry	$registry
QueryCollectionFactory	$queryCollectionFactory
CollectionFactory	$searchCollectionFactory
StoreManagerInterface	$storeManager
ScopeConfigInterface	$scopeConfig
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
DbCollection	$resourceCollection
array	$data

Definition at line 107 of file Query.php.

       {
         $this->_queryCollectionFactory = $queryCollectionFactory;
         $this->_searchCollectionFactory = $searchCollectionFactory;
         $this->_storeManager = $storeManager;
         $this->_scopeConfig = $scopeConfig;
         parent::__construct($context, $registry, $resource, $resourceCollection, $data);
     }

Member Function Documentation

◆ _construct()

_construct ( )

protected

Init resource model

Returns: void

Definition at line 130 of file Query.php.

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

◆ getMaxQueryLength()

getMaxQueryLength ( )

Retrieve maximum query length

Returns: int

Exceptions

Definition at line 288 of file Query.php.

     {
         return $this->_scopeConfig->getValue(
             self::XML_PATH_MAX_QUERY_LENGTH,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->getStoreId()
         );
     }

◆ getMinQueryLength()

getMinQueryLength ( )

Retrieve minimum query length

Returns: int

Exceptions

Definition at line 273 of file Query.php.

     {
         return $this->_scopeConfig->getValue(
             self::XML_PATH_MIN_QUERY_LENGTH,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->getStoreId()
         );
     }

◆ getQueryText()

getQueryText ( )

Returns: string

Implements QueryInterface.

Definition at line 300 of file Query.php.

     {
         return $this->getDataByKey('query_text');
     }

◆ getSearchCollection()

getSearchCollection ( )

Retrieve search collection

Returns: Collection

Definition at line 140 of file Query.php.

     {
         return $this->_searchCollectionFactory->create();
     }

◆ getStoreId()

getStoreId ( )

Retrieve store Id

Returns: int

Exceptions

Definition at line 211 of file Query.php.

     {
         if (!($storeId = $this->getData('store_id'))) {
             $storeId = $this->_storeManager->getStore()->getId();
         }
         return $storeId;
     }

◆ getSuggestCollection()

getSuggestCollection ( )

Retrieve collection of suggest queries

Returns: QueryCollection

Exceptions

Definition at line 151 of file Query.php.

     {
         $collection = $this->getData('suggest_collection');
         if ($collection === null) {
             $collection = $this->_queryCollectionFactory->create()->setStoreId(
                 $this->getStoreId()
             )->setQueryFilter(
                 $this->getQueryText()
             );
             $this->setData('suggest_collection', $collection);
         }
         return $collection;
     }

◆ isQueryTextExceeded()

isQueryTextExceeded ( )

Check if query maximum length exceeded.

Returns: bool @codeCoverageIgnore

Definition at line 311 of file Query.php.

     {
         return $this->getData('is_query_text_exceeded');
     }

◆ isQueryTextShort()

isQueryTextShort ( )

Check if minimum query length reached.

Returns: bool @codeCoverageIgnore

Since: 100.1.0

Definition at line 323 of file Query.php.

     {
         return $this->getData('is_query_text_short');
     }

◆ loadByQuery()

loadByQuery ( $text )

Load Query object by query string

Parameters

string $text

Returns: $this

Exceptions

Definition at line 173 of file Query.php.

     {
         $this->loadByQueryText($text);
         return $this;
     }

◆ loadByQueryText()

loadByQueryText ( $text )

Load Query object only by query text

Parameters

string $text

Returns: $this

Exceptions

Definition at line 186 of file Query.php.

     {
         $this->_getResource()->loadByQueryText($this, $text);
         $this->_afterLoad();
         $this->setOrigData();
         return $this;
     }

◆ prepare()

prepare ( )

Prepare save query for result

Returns: $this

Exceptions

Definition at line 225 of file Query.php.

     {
         if (!$this->getId()) {
             $this->setIsActive(0);
             $this->setIsProcessed(0);
             $this->save();
             $this->setIsActive(1);
         }
 
         return $this;
     }

◆ saveIncrementalPopularity()

saveIncrementalPopularity ( )

Save query with incremental popularity

Returns: $this

Exceptions

Definition at line 244 of file Query.php.

     {
         $this->getResource()->saveIncrementalPopularity($this);
 
         return $this;
     }

◆ saveNumResults()

saveNumResults ( $numResults )

Save query with number of results

Parameters

int $numResults

Returns: $this

Exceptions

Definition at line 259 of file Query.php.

     {
         $this->setNumResults($numResults);
         $this->getResource()->saveNumResults($this);
 
         return $this;
     }

◆ setStoreId()

setStoreId ( $storeId )

Set Store Id

Parameters

int $storeId

Returns: void

Definition at line 200 of file Query.php.

     {
         $this->setData('store_id', $storeId);
     }

Field Documentation

◆ $_eventObject

$_eventObject = 'search_query'

protected

Definition at line 58 of file Query.php.

◆ $_eventPrefix

$_eventPrefix = 'search_query'

protected

Definition at line 51 of file Query.php.

◆ $_queryCollectionFactory

$_queryCollectionFactory

protected

Definition at line 92 of file Query.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 71 of file Query.php.

◆ $_searchCollectionFactory

$_searchCollectionFactory

protected

Definition at line 85 of file Query.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 78 of file Query.php.

◆ CACHE_TAG

const CACHE_TAG = 'SEARCH_QUERY'

Definition at line 60 of file Query.php.

◆ XML_PATH_MAX_QUERY_LENGTH

const XML_PATH_MAX_QUERY_LENGTH = 'catalog/search/max_query_length'

Definition at line 64 of file Query.php.

◆ XML_PATH_MIN_QUERY_LENGTH

const XML_PATH_MIN_QUERY_LENGTH = 'catalog/search/min_query_length'

Definition at line 62 of file Query.php.

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

vendor/magento/module-search/Model/Query.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _construct()

◆ getMaxQueryLength()

◆ getMinQueryLength()

◆ getQueryText()

◆ getSearchCollection()

◆ getStoreId()

◆ getSuggestCollection()

◆ isQueryTextExceeded()

◆ isQueryTextShort()

◆ loadByQuery()

◆ loadByQueryText()

◆ prepare()

◆ saveIncrementalPopularity()

◆ saveNumResults()

◆ setStoreId()

Field Documentation

◆ $_eventObject

◆ $_eventPrefix

◆ $_queryCollectionFactory

◆ $_scopeConfig

◆ $_searchCollectionFactory

◆ $_storeManager

◆ CACHE_TAG

◆ XML_PATH_MAX_QUERY_LENGTH

◆ XML_PATH_MIN_QUERY_LENGTH