Class Mage_CatalogSearch_Helper_Data

Catalog search helper

Mage_CatalogSearch_Helper_Data

Package: Mage\CatalogSearch
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/CatalogSearch/Helper/Data.php

Methods summary
`public string`	# `getQueryParamName( )` Retrieve search query parameter name Retrieve search query parameter name Returns `string`
`public Mage_CatalogSearch_Model_Query`	# `getQuery( )` Retrieve query model object Retrieve query model object Returns `Mage_CatalogSearch_Model_Query`
`public boolean`	# `isMinQueryLength( )` Is a minimum query length Is a minimum query length Returns `boolean`
`public string`	# `getQueryText( )` Retrieve search query text Retrieve search query text Returns `string`
`public string`	# `getEscapedQueryText( )` Retrieve HTML escaped search query Retrieve HTML escaped search query Returns `string`
`public Mage_CatalogSearch_Model_Resource_Query_Collection`	# `getSuggestCollection( )` Retrieve suggest collection for query Retrieve suggest collection for query Returns `Mage_CatalogSearch_Model_Resource_Query_Collection`
`public string`	# `getResultUrl( string $query = null )` Retrieve result page url and set "secure" param to avoid confirm message when we submit form from secure page to unsecure Retrieve result page url and set "secure" param to avoid confirm message when we submit form from secure page to unsecure Parameters `$query` `string` $query Returns `string`
`public string`	# `getSuggestUrl( )` Retrieve suggest url Retrieve suggest url Returns `string`
`public string`	# `getSearchTermUrl( )` Retrieve search term url Retrieve search term url Returns `string`
`public string`	# `getAdvancedSearchUrl( )` Retrieve advanced search URL Retrieve advanced search URL Returns `string`
`public integer\|string`	# `getMinQueryLength( mixed $store = null )` Retrieve minimum query length Retrieve minimum query length Parameters `$store` `mixed` $store Returns `integer\|string`
`public integer\|string`	# `getMaxQueryLength( mixed $store = null )` Retrieve maximum query length Retrieve maximum query length Parameters `$store` `mixed` $store Returns `integer\|string`
`public integer`	# `getMaxQueryWords( mixed $store = null )` Retrieve maximum query words count for like search Retrieve maximum query words count for like search Parameters `$store` `mixed` $store Returns `integer`
`public Mage_CatalogSearch_Helper_Data`	# `addNoteMessage( string $message )` Add Note message Add Note message Parameters `$message` `string` $message Returns `Mage_CatalogSearch_Helper_Data`
`public Mage_CatalogSearch_Helper_Data`	# `setNoteMessages( array $messages )` Set Note messages Set Note messages Parameters `$messages` `array` $messages Returns `Mage_CatalogSearch_Helper_Data`
`public array`	# `getNoteMessages( )` Retrieve Current Note messages Retrieve Current Note messages Returns `array`
`public Mage_CatalogSearch_Helper_Data`	# `checkNotes( mixed $store = null )` Check query of a warnings Check query of a warnings Parameters `$store` `mixed` $store Returns `Mage_CatalogSearch_Helper_Data`
`public string`	# `prepareIndexdata( array $index, string $separator = ' ' )` Join index array to string by separator Support 2 level array gluing Join index array to string by separator Support 2 level array gluing Parameters `$index` `array` $index `$separator` `string` $separator Returns `string`
`public object`	# `getEngine( )` Get current search engine resource model Get current search engine resource model Returns `object`

Methods inherited from Mage_Core_Helper_Abstract
`__(), _cleanCache(), _getModuleName(), _getRequest(), _getUrl(), _loadCache(), _removeCache(), _saveCache(), escapeHtml(), escapeUrl(), getLayout(), isModuleEnabled(), isModuleOutputEnabled(), jsQuoteEscape(), quoteEscape(), removeTags(), setLayout(), stripTags(), translateArray(), urlDecode(), urlEncode()`

Constants summary
`string`	`QUERY_VAR_NAME`	`'q'`	#
`integer`	`MAX_QUERY_LEN`	`200`	#

Properties summary
`protected Mage_CatalogSearch_Model_Query`	`$_query`		# Query object Query object
`protected string`	`$_queryText`		# Query string Query string
`protected array`	`$_messages`	`array()`	# Note messages Note messages
`protected boolean`	`$_isMaxLength`	`false`	# Is a maximum length cut Is a maximum length cut
`protected Mage_CatalogSearch_Model_Resource_Fulltext_Engine`	`$_engine`		# Search engine model Search engine model

Properties inherited from Mage_Core_Helper_Abstract
`$_layout, $_moduleName, $_request`

Packages

Classes

Class Mage_CatalogSearch_Helper_Data

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns