OxidEsales\EshopCommunity\Application\Model\Search Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Model\Search:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Model\Search:

Public Member Functions
	__construct ()
	setLanguage ($iLanguage=null)
	getSearchArticles ($sSearchParamForQuery=false, $sInitialSearchCat=false, $sInitialSearchVendor=false, $sInitialSearchManufacturer=false, $sSortBy=false)
	getSearchArticleCount ($sSearchParamForQuery=false, $sInitialSearchCat=false, $sInitialSearchVendor=false, $sInitialSearchManufacturer=false)

Protected Member Functions
	_getSearchSelect ($sSearchParamForQuery=false, $sInitialSearchCat=false, $sInitialSearchVendor=false, $sInitialSearchManufacturer=false, $sSortBy=false)
	_getWhere ($sSearchString)
	getDescriptionJoin ($table)
	getSearchField ($table, $field)

Protected Attributes
	$_iLanguage = 0

Detailed Description

Implements search

Constructor & Destructor Documentation

__construct()

OxidEsales\EshopCommunity\Application\Model\Search::__construct

(

)

Class constructor. Executes search lenguage setter

Member Function Documentation

_getSearchSelect()

OxidEsales\EshopCommunity\Application\Model\Search::_getSearchSelect (   $sSearchParamForQuery = false,   $sInitialSearchCat = false,   $sInitialSearchVendor = false,   $sInitialSearchManufacturer = false,   $sSortBy = false  )

protected

Returns the appropriate SQL select for a search according to search parameters

Parameters

string	$sSearchParamForQuery	query parameter
string	$sInitialSearchCat	initial category to search in
string	$sInitialSearchVendor	initial vendor to search for
string	$sInitialSearchManufacturer	initial Manufacturer to search for
string	$sSortBy	sort by

Returns

string

_getWhere()

OxidEsales\EshopCommunity\Application\Model\Search::_getWhere (   $sSearchString )

protected

Forms and returns SQL query string for search in DB.

Parameters

string

$sSearchString

searching string

Returns

string

getDescriptionJoin()

OxidEsales\EshopCommunity\Application\Model\Search::getDescriptionJoin (   $table )

protected

Get description join. Needed in case of searching for data in table oxartextends or its views.

Parameters

string

$table

Returns

string

getSearchArticleCount()

OxidEsales\EshopCommunity\Application\Model\Search::getSearchArticleCount	(		$sSearchParamForQuery = false,
			$sInitialSearchCat = false,
			$sInitialSearchVendor = false,
			$sInitialSearchManufacturer = false
	)

Returns the amount of articles according to search parameters.

Parameters

string	$sSearchParamForQuery	query parameter
string	$sInitialSearchCat	initial category to seearch in
string	$sInitialSearchVendor	initial vendor to seearch for
string	$sInitialSearchManufacturer	initial Manufacturer to seearch for

Returns

int

getSearchArticles()

OxidEsales\EshopCommunity\Application\Model\Search::getSearchArticles	(		$sSearchParamForQuery = false,
			$sInitialSearchCat = false,
			$sInitialSearchVendor = false,
			$sInitialSearchManufacturer = false,
			$sSortBy = false
	)

Returns a list of articles according to search parameters. Returns matched

Parameters

string	$sSearchParamForQuery	query parameter
string	$sInitialSearchCat	initial category to seearch in
string	$sInitialSearchVendor	initial vendor to seearch for
string	$sInitialSearchManufacturer	initial Manufacturer to seearch for
string	$sSortBy	sort by

Returns

ArticleList

getSearchField()

OxidEsales\EshopCommunity\Application\Model\Search::getSearchField (   $table,   $field  )

protected

Get search field name. Needed in case of searching for data in table oxartextends or its views.

Parameters

string	$table
string	$field	Chose table depending on field.

Returns

string

setLanguage()

OxidEsales\EshopCommunity\Application\Model\Search::setLanguage

(

$iLanguage = null

)

Search language setter. If no param is passed, will be taken default shop language

Parameters

string

$iLanguage

string (default null)

Member Data Documentation

$_iLanguage

OxidEsales\EshopCommunity\Application\Model\Search::$_iLanguage = 0

protected

---

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

• /oxideshop-ce/source/Application/Model/Search.php