OxidEsales\EshopCommunity\Application\Controller\SearchController Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Controller\SearchController:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Controller\SearchController:

Public Member Functions
	init ()
	render ()
	getAddUrlParams ()
	isEmptySearch ()
	getArticleList ()
	getSimilarRecommListIds ()
	getSearchParamForHtml ()
	getSearchParam ()
	getSearchCatId ()
	getSearchVendor ()
	getSearchManufacturer ()
	getPageNavigation ()
	getActiveCategory ()
	getBreadCrumb ()
	canSelectDisplayType ()
	getArticleCount ()
	getTitle ()

Protected Member Functions
	_processListArticles ()
	_isSearchClass ()
	_canRedirect ()

Protected Attributes
	$_iAllArtCnt = 0
	$_iCntPages = null
	$_sThisTemplate = 'page/search/search.tpl'
	$_sListType = 'search'
	$_blShowSorting = true
	$_blEmptySearch = null
	$_oRecommList = null
	$_sSearchParamForHtml = null
	$_sSearchParam = null
	$_sSearchCatId = null
	$_sSearchVendor = null
	$_sSearchManufacturer = null
	$_blSearchClass = null
	$_oPageNavigation = null
	$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW
	$_aSimilarRecommListIds = null

Detailed Description

Articles searching class. Performs searching through articles in database.

Member Function Documentation

_canRedirect()

OxidEsales\EshopCommunity\Application\Controller\SearchController::_canRedirect ( )

protected

Checks if current request parameters does not block SEO redirection process

Returns

bool

_isSearchClass()

OxidEsales\EshopCommunity\Application\Controller\SearchController::_isSearchClass ( )

protected

Template variable getter. Returns similar recommendation lists

Returns

object

_processListArticles()

OxidEsales\EshopCommunity\Application\Controller\SearchController::_processListArticles ( )

protected

Iterates through list articles and performs list view specific tasks:

• sets type of link which needs to be generated (Manufacturer link)

canSelectDisplayType()

OxidEsales\EshopCommunity\Application\Controller\SearchController::canSelectDisplayType

(

)

Returns config parameters blShowListDisplayType value

Returns

boolean

getActiveCategory()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getActiveCategory

(

)

Template variable getter. Returns active search

Returns

object

getAddUrlParams()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getAddUrlParams

(

)

Returns additional URL parameters which must be added to list products urls

Returns

string

getArticleCount()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getArticleCount

(

)

Article count getter

Returns

int

getArticleList()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getArticleList

(

)

Template variable getter. Returns searched article list

Returns

array

getBreadCrumb()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getBreadCrumb

(

)

Returns Bread Crumb - you are here page1/page2/page3...

Returns

array

getPageNavigation()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getPageNavigation

(

)

Template variable getter. Returns page navigation

Returns

object

getSearchCatId()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getSearchCatId

(

)

Template variable getter. Returns searched category id

Returns

string

getSearchManufacturer()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getSearchManufacturer

(

)

Template variable getter. Returns searched Manufacturer id

Returns

string

getSearchParam()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getSearchParam

(

)

Template variable getter. Returns search parameter

Returns

string

getSearchParamForHtml()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getSearchParamForHtml

(

)

Template variable getter. Returns search parameter for Html

Returns

string

getSearchVendor()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getSearchVendor

(

)

Template variable getter. Returns searched vendor id

Returns

string

getSimilarRecommListIds()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getSimilarRecommListIds

(

)

Return array of id to form recommend list.

Deprecated:

since v5.3 (2016-06-17); Listmania will be moved to an own module.

Returns

array

getTitle()

OxidEsales\EshopCommunity\Application\Controller\SearchController::getTitle

(

)

Return page title

Returns

string

init()

OxidEsales\EshopCommunity\Application\Controller\SearchController::init

(

)

Fetches search parameter from GET/POST/session, prepares search SQL (search::GetWhere()), and executes it forming the list of found articles. Article list is stored at search::_aArticleList array.

Returns

null

isEmptySearch()

OxidEsales\EshopCommunity\Application\Controller\SearchController::isEmptySearch

(

)

Template variable getter. Returns if searched was empty

Returns

bool

render()

OxidEsales\EshopCommunity\Application\Controller\SearchController::render

(

)

Forms search navigation URLs, executes parent::render() and returns name of template to render search::_sThisTemplate.

Returns

string current template file name

Member Data Documentation

$_aSimilarRecommListIds

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_aSimilarRecommListIds = null

protected

$_blEmptySearch

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_blEmptySearch = null

protected

$_blSearchClass

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_blSearchClass = null

protected

$_blShowSorting

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_blShowSorting = true

protected

$_iAllArtCnt

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_iAllArtCnt = 0

protected

$_iCntPages

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_iCntPages = null

protected

$_iViewIndexState

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW

protected

$_oPageNavigation

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_oPageNavigation = null

protected

$_oRecommList

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_oRecommList = null

protected

$_sListType

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_sListType = 'search'

protected

$_sSearchCatId

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_sSearchCatId = null

protected

$_sSearchManufacturer

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_sSearchManufacturer = null

protected

$_sSearchParam

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_sSearchParam = null

protected

$_sSearchParamForHtml

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_sSearchParamForHtml = null

protected

$_sSearchVendor

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_sSearchVendor = null

protected

$_sThisTemplate

OxidEsales\EshopCommunity\Application\Controller\SearchController::$_sThisTemplate = 'page/search/search.tpl'

protected

---

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

• /oxideshop-ce/source/Application/Controller/SearchController.php