Search Class Reference

Inheritance diagram for Search:
[legend]
Collaboration diagram for Search:
[legend]

List of all members.


Detailed Description

Articles searching class. Performs searching through articles in database.

Definition at line 7 of file search.php.


Public Member Functions

 init ()
 render ()
 getAddUrlParams ()
 setItemSorting ($sCnid, $sSortBy, $sSortOrder=null)
 getSorting ($sCnid)
 isEmptySearch ()
 getArticleList ()
 getSimilarRecommLists ()
 getSearchParamForHtml ()
 getSearchParam ()
 getSearchCatId ()
 getSearchVendor ()
 getPageNavigation ()
 getActiveCategory ()

Protected Member Functions

 _isSearchClass ()

Protected Attributes

 $_iAllArtCnt = 0
 $_iCntPages = null
 $_sThisTemplate = 'search.tpl'
 $_sListType = 'search'
 $_blShowSorting = true
 $_blEmptySearch = null
 $_oRecommList = null
 $_sSearchParamForHtml = null
 $_sSearchParam = null
 $_sSearchCatId = null
 $_sSearchVendor = null
 $_blSearchClass = null
 $_oPageNavigation = null
 $_iViewIndexState = 1

Member Function Documentation

Search.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.

Session variables: searchparam

Template variables: emptysearch

Returns:
null

Reimplemented from oxUBase.

Definition at line 109 of file search.php.

Search.render (  ) 

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

Template variables: articlelist, searchparam, searchparamforhtml searchcnid, searchvendor, searchlink, pageNavigation, searchlink, articlebargainlist, additionalparams

Returns:
string current template file name

Reimplemented from oxUBase.

Definition at line 167 of file search.php.

Search.getAddUrlParams (  ) 

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

Returns:
string

Reimplemented from oxUBase.

Definition at line 204 of file search.php.

Search.setItemSorting ( sCnid,
sSortBy,
sSortOrder = null 
)

Sets search sorting config

Parameters:
string $sCnid sortable item id
string $sSortBy sort field
string $sSortOrder sort order
Returns:
null

Reimplemented from oxView.

Definition at line 232 of file search.php.

Search.getSorting ( sCnid  ) 

Returns search sorting config

Parameters:
string $sCnid sortable item id
Returns:
string

Reimplemented from oxView.

Definition at line 244 of file search.php.

Search._isSearchClass (  )  [protected]

Template variable getter. Returns similar recommendation lists

Returns:
object

Definition at line 254 of file search.php.

Search.isEmptySearch (  ) 

Template variable getter. Returns if searched was empty

Returns:
bool

Definition at line 269 of file search.php.

Search.getArticleList (  ) 

Template variable getter. Returns searched article list

Returns:
array

Definition at line 279 of file search.php.

Search.getSimilarRecommLists (  ) 

Template variable getter. Returns similar recommendation lists

Returns:
object

Reimplemented from oxView.

Definition at line 289 of file search.php.

Search.getSearchParamForHtml (  ) 

Template variable getter. Returns search parameter for Html

Returns:
string

Definition at line 308 of file search.php.

Search.getSearchParam (  ) 

Template variable getter. Returns search parameter

Returns:
string

Definition at line 324 of file search.php.

Search.getSearchCatId (  ) 

Template variable getter. Returns searched category id

Returns:
string

Definition at line 340 of file search.php.

Search.getSearchVendor (  ) 

Template variable getter. Returns searched vendor id

Returns:
string

Definition at line 356 of file search.php.

Search.getPageNavigation (  ) 

Template variable getter. Returns page navigation

Returns:
object

Definition at line 373 of file search.php.

Search.getActiveCategory (  ) 

Template variable getter. Returns active search

Returns:
object

Reimplemented from oxView.

Definition at line 387 of file search.php.


Member Data Documentation

Search.$_iAllArtCnt = 0 [protected]

Definition at line 13 of file search.php.

Search.$_iCntPages = null [protected]

Definition at line 19 of file search.php.

Search.$_sThisTemplate = 'search.tpl' [protected]

Reimplemented from oxView.

Definition at line 25 of file search.php.

Search.$_sListType = 'search' [protected]

Reimplemented from oxView.

Definition at line 31 of file search.php.

Search.$_blShowSorting = true [protected]

Reimplemented from oxView.

Definition at line 37 of file search.php.

Search.$_blEmptySearch = null [protected]

Definition at line 43 of file search.php.

Search.$_oRecommList = null [protected]

Definition at line 49 of file search.php.

Search.$_sSearchParamForHtml = null [protected]

Definition at line 55 of file search.php.

Search.$_sSearchParam = null [protected]

Definition at line 61 of file search.php.

Search.$_sSearchCatId = null [protected]

Definition at line 67 of file search.php.

Search.$_sSearchVendor = null [protected]

Definition at line 73 of file search.php.

Search.$_blSearchClass = null [protected]

Definition at line 79 of file search.php.

Search.$_oPageNavigation = null [protected]

Definition at line 85 of file search.php.

Search.$_iViewIndexState = 1 [protected]

Current view search engine indexing state: 0 - index without limitations 1 - no index / no follow 2 - no index / follow

Reimplemented from oxView.

Definition at line 93 of file search.php.


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

Generated on Thu Dec 4 12:05:40 2008 for OXID eShop CE by  doxygen 1.5.5