Docs For Class Mage_CatalogSearch_Helper

Description

Catalog search helper

author: Magento Core Team <[email protected]>

Located in /CatalogSearch/Helper/Data.php (line 32)

Mage_Core_Helper_Abstract
   |
   --Mage_CatalogSearch_Helper_Data

Class Constant Summary

MAX_QUERY_LEN = 200

QUERY_VAR_NAME = 'q'

Variable Summary

Mage_CatalogSearch_Model_Mysql4_Fulltext_Engine $_engine

bool $_isMaxLength

array $_messages

Mage_CatalogSearch_Model_Query $_query

string $_queryText

Method Summary

Mage_CatalogSearch_Helper_Data addNoteMessage (string $message)

Mage_CatalogSearch_Helper_Data checkNotes ([mixed $store = null])

string getAdvancedSearchUrl ()

object getEngine ()

string getEscapedQueryText ()

int getMaxQueryLength ([mixed $store = null])

int getMaxQueryWords ([mixed $store = null])

int getMinQueryLength ([mixed $store = null])

array getNoteMessages ()

Mage_CatalogSearch_Model_Query getQuery ()

string getQueryParamName ()

string getQueryText ()

string getResultUrl ([string $query = null])

string getSearchTermUrl ()

Mage_CatalogSearch_Model_Mysql4_Query_Collection getSuggestCollection ()

string getSuggestUrl ()

bool isMinQueryLength ()

string prepareIndexdata (array $index, [string $separator = ' '])

Mage_CatalogSearch_Helper_Data setNoteMessages ( $messages)

Variables

Mage_CatalogSearch_Model_Mysql4_Fulltext_Engine $_engine (line 70)

Search engine model

access: protected

bool $_isMaxLength = false (line 63)

Is a maximum length cut

access: protected

array $_messages = array() (line 56)

Note messages

access: protected

Mage_CatalogSearch_Model_Query $_query (line 42)

Query object

access: protected

string $_queryText (line 49)

Query string

access: protected

Inherited Variables

Inherited from Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::$_layout
Mage_Core_Helper_Abstract::$_moduleName
Mage_Core_Helper_Abstract::$_request

Methods

addNoteMessage (line 249)

Add Note message

access: public

Mage_CatalogSearch_Helper_Data addNoteMessage (string $message)

string $message

checkNotes (line 283)

Check query of a warnings

access: public

Mage_CatalogSearch_Helper_Data checkNotes ([mixed $store = null])

mixed $store

getAdvancedSearchUrl (line 205)

Retrieve advanced search URL

access: public

string getAdvancedSearchUrl ()

getEngine (line 340)

Get current search engine resource model

access: public

object getEngine ()

getEscapedQueryText (line 148)

Retrieve HTML escaped search query

access: public

string getEscapedQueryText ()

getMaxQueryLength (line 227)

Retrieve maximum query length

access: public

int getMaxQueryLength ([mixed $store = null])

mixed $store

getMaxQueryWords (line 238)

Retrieve maximum query words count for like search

access: public

int getMaxQueryWords ([mixed $store = null])

mixed $store

getMinQueryLength (line 216)

Retrieve minimum query length

access: public

int getMinQueryLength ([mixed $store = null])

mixed $store

getNoteMessages (line 272)

Retrieve Current Note messages

access: public

array getNoteMessages ()

getQuery (line 87)

Retrieve query model object

access: public

Mage_CatalogSearch_Model_Query getQuery ()

getQueryParamName (line 77)

Retrieve search query parameter name

access: public

string getQueryParamName ()

getQueryText (line 117)

Retrieve search query text

access: public

string getQueryText ()

getResultUrl (line 170)

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

access: public

string getResultUrl ([string $query = null])

string $query

getSearchTermUrl (line 195)

Retrieve search term url

access: public

string getSearchTermUrl ()

getSuggestCollection (line 158)

Retrieve suggest collection for query

access: public

Mage_CatalogSearch_Model_Mysql4_Query_Collection getSuggestCollection ()

getSuggestUrl (line 183)

Retrieve suggest url

access: public

string getSuggestUrl ()

isMinQueryLength (line 104)

Is a minimum query length

access: public

bool isMinQueryLength ()

prepareIndexdata (line 321)

Join index array to string by separator Support 2 level array gluing

access: public

string prepareIndexdata (array $index, [string $separator = ' '])

array $index
string $separator

setNoteMessages (line 261)

Set Note messages

access: public

Mage_CatalogSearch_Helper_Data setNoteMessages ( $messages)

array $messages

Inherited Methods

Inherited From Mage_Core_Helper_Abstract

Mage_Core_Helper_Abstract::escapeHtml()
Mage_Core_Helper_Abstract::escapeUrl()
Mage_Core_Helper_Abstract::getLayout()
Mage_Core_Helper_Abstract::htmlEscape()
Mage_Core_Helper_Abstract::isModuleEnabled()
Mage_Core_Helper_Abstract::isModuleOutputEnabled()
Mage_Core_Helper_Abstract::jsQuoteEscape()
Mage_Core_Helper_Abstract::setLayout()
Mage_Core_Helper_Abstract::stripTags()
Mage_Core_Helper_Abstract::translateArray()
Mage_Core_Helper_Abstract::urlDecode()
Mage_Core_Helper_Abstract::urlEncode()
Mage_Core_Helper_Abstract::urlEscape()
Mage_Core_Helper_Abstract::_cleanCache()
Mage_Core_Helper_Abstract::_getModuleName()
Mage_Core_Helper_Abstract::_getRequest()
Mage_Core_Helper_Abstract::_getUrl()
Mage_Core_Helper_Abstract::_loadCache()
Mage_Core_Helper_Abstract::_removeCache()
Mage_Core_Helper_Abstract::_saveCache()
Mage_Core_Helper_Abstract::__()

Class Constants

MAX_QUERY_LEN = 200 (line 35)

QUERY_VAR_NAME = 'q' (line 34)

Class Mage_CatalogSearch_Helper_Data

Inherited Variables

Inherited Methods