Data Class Reference

Inheritance diagram for Data:

Public Member Functions
	__construct (Context $context, StringUtils $string, Escaper $escaper, StoreManagerInterface $storeManager)
	isMinQueryLength ()
	getEscapedQueryText ()
	getResultUrl ($query=null)
	getSuggestUrl ()
	getSearchTermUrl ()
	getMinQueryLength ($store=null)
	getMaxQueryLength ($store=null)
	addNoteMessage ($message)
	setNoteMessages (array $messages)
	getNoteMessages ()
	checkNotes ($store=null)
	getQueryParamName ()
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Protected Attributes
	$_messages = []
	$string
	$scopeConfig
	$escaper
	$storeManager
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Additional Inherited Members
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Detailed Description

Search helper @api

Since

100.0.2

Definition at line 22 of file Data.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Context	$context,
		StringUtils	$string,
		Escaper	$escaper,
		StoreManagerInterface	$storeManager
	)

Construct

Parameters

Context	$context
StringUtils	$string
Escaper	$escaper
StoreManagerInterface	$storeManager

Definition at line 66 of file Data.php.

      {
        $this->string = $string;
        $this->scopeConfig = $context->getScopeConfig();
        $this->escaper = $escaper;
        $this->storeManager = $storeManager;
        parent::__construct($context);
    }

Member Function Documentation

addNoteMessage()

addNoteMessage

(

$message

)

Add Note message

Parameters

string

$message

Returns

$this

Definition at line 177 of file Data.php.

    {
        $this->_messages[] = $message;
        return $this;
    }

checkNotes()

checkNotes

(

$store = null

)

Check query of a warnings

Parameters

mixed

$store

Returns

$this @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 212 of file Data.php.

    {
        if ($this->isQueryTooLong($this->getQueryText(), $this->getMaxQueryLength())) {
            $this->addNoteMessage(
                __(
                    'Your search query can\'t be longer than %1, so we shortened your query.',
                    $this->getMaxQueryLength()
                )
            );
        }

        return $this;
    }

getEscapedQueryText()

getEscapedQueryText

(

)

Retrieve HTML escaped search query

Returns

string

Definition at line 96 of file Data.php.

    {
        return $this->escaper->escapeHtml(
            $this->getPreparedQueryText($this->getQueryText(), $this->getMaxQueryLength())
        );
    }

getMaxQueryLength()

getMaxQueryLength

(

$store = null

)

Retrieve maximum query length

Parameters

mixed

$store

Returns

int|string

Definition at line 162 of file Data.php.

    {
        return $this->scopeConfig->getValue(
            SearchQuery::XML_PATH_MAX_QUERY_LENGTH,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        );
    }

getMinQueryLength()

getMinQueryLength

(

$store = null

)

Retrieve minimum query length

Parameters

mixed

$store

Returns

int|string

Definition at line 147 of file Data.php.

    {
        return $this->scopeConfig->getValue(
            SearchQuery::XML_PATH_MIN_QUERY_LENGTH,
            \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
            $store
        );
    }

getNoteMessages()

getNoteMessages

(

)

Retrieve Current Note messages

Returns

array

Definition at line 200 of file Data.php.

    {
        return $this->_messages;
    }

getQueryParamName()

getQueryParamName

(

)

Returns

string

Definition at line 229 of file Data.php.

    {
        return QueryFactory::QUERY_VAR_NAME;
    }

getResultUrl()

getResultUrl

(

$query = null

)

Retrieve result page url and set "secure" param to avoid confirm message when we submit form from secure page to unsecure

Parameters

string

$query

Returns

string

Definition at line 110 of file Data.php.

    {
        return $this->_getUrl(
            'catalogsearch/result',
            ['_query' => [QueryFactory::QUERY_VAR_NAME => $query], '_secure' => $this->_request->isSecure()]
        );
    }

getSearchTermUrl()

getSearchTermUrl

(

)

Retrieve search term url

Returns

string

Definition at line 136 of file Data.php.

    {
        return $this->_getUrl('search/term/popular');
    }

getSuggestUrl()

getSuggestUrl

(

)

Retrieve suggest url

Returns

string

Definition at line 123 of file Data.php.

    {
        return $this->_getUrl(
            'search/ajax/suggest',
            ['_secure' => $this->_getRequest()->isSecure()]
        );
    }

isMinQueryLength()

isMinQueryLength

(

)

Is a minimum query length

Returns

bool

Definition at line 84 of file Data.php.

    {
        $minQueryLength = $this->getMinQueryLength();
        $thisQueryLength = $this->string->strlen($this->getQueryText());
        return !$thisQueryLength || $minQueryLength !== '' && $thisQueryLength < $minQueryLength;
    }

setNoteMessages()

setNoteMessages

(

array

$messages

)

Set Note messages

Parameters

array

$messages

Returns

$this

Definition at line 189 of file Data.php.

    {
        $this->_messages = $messages;
        return $this;
    }

Field Documentation

$_messages

$_messages = []

protected

Definition at line 29 of file Data.php.

$escaper

$escaper

protected

Definition at line 50 of file Data.php.

$scopeConfig

$scopeConfig

protected

Definition at line 44 of file Data.php.

$storeManager

$storeManager

protected

Definition at line 56 of file Data.php.

$string

$string

protected

Definition at line 36 of file Data.php.

---

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

• vendor/magento/module-search/Helper/Data.php