Public Member Functions | Protected Member Functions | Protected Attributes

Search Class Reference

Inheritance diagram for Search:
Collaboration diagram for Search:

List of all members.

Public Member Functions

 init ()
 render ()
 getAddUrlParams ()
 setItemSorting ($sCnid, $sSortBy, $sSortOrder=null)
 getSorting ($sCnid)
 isEmptySearch ()
 getArticleList ()
 getSimilarRecommListIds ()
 getSearchParamForHtml ()
 getSearchParam ()
 getSearchCatId ()
 getSearchVendor ()
 getSearchManufacturer ()
 getPageNavigation ()
 getActiveCategory ()
 getBreadCrumb ()
 canSelectDisplayType ()
 getArticleCount ()

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.

Definition at line 7 of file search.php.


Member Function Documentation

Search._canRedirect (  )  [protected]

Checks if current request parameters does not block SEO redirection process

Returns:
bool

Reimplemented from oxUBase.

Definition at line 464 of file search.php.

Search._isSearchClass (  )  [protected]

Template variable getter. Returns similar recommendation lists

Returns:
object

Definition at line 276 of file search.php.

Search._processListArticles (  )  [protected]

Iterates through list articles and performs list view specific tasks:

  • sets type of link whicn needs to be generated (Manufacturer link)
Returns:
null

Definition at line 197 of file search.php.

Search.canSelectDisplayType (  ) 

Returns cofig prameters blShowListDisplayType value

Returns:
boolean

Definition at line 454 of file search.php.

Search.getActiveCategory (  ) 

Template variable getter. Returns active search

Returns:
object

Reimplemented from oxUBase.

Definition at line 427 of file search.php.

Search.getAddUrlParams (  ) 

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

Returns:
string

Reimplemented from oxUBase.

Definition at line 218 of file search.php.

Search.getArticleCount (  ) 

Article count getter

Returns:
int

Definition at line 474 of file search.php.

Search.getArticleList (  ) 

Template variable getter. Returns searched article list

Returns:
array

Definition at line 301 of file search.php.

Search.getBreadCrumb (  ) 

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

Returns:
array

Reimplemented from oxUBase.

Definition at line 437 of file search.php.

Search.getPageNavigation (  ) 

Template variable getter. Returns page navigation

Returns:
object

Reimplemented from oxUBase.

Definition at line 412 of file search.php.

Search.getSearchCatId (  ) 

Template variable getter. Returns searched category id

Returns:
string

Reimplemented from oxUBase.

Definition at line 362 of file search.php.

Search.getSearchManufacturer (  ) 

Template variable getter. Returns searched Manufacturer id

Returns:
string

Reimplemented from oxUBase.

Definition at line 395 of file search.php.

Search.getSearchParam (  ) 

Template variable getter. Returns search parameter

Returns:
string

Definition at line 346 of file search.php.

Search.getSearchParamForHtml (  ) 

Template variable getter. Returns search parameter for Html

Returns:
string

Reimplemented from oxUBase.

Definition at line 330 of file search.php.

Search.getSearchVendor (  ) 

Template variable getter. Returns searched vendor id

Returns:
string

Reimplemented from oxUBase.

Definition at line 378 of file search.php.

Search.getSimilarRecommListIds (  ) 

Return array of id to form recommend list.

Returns:
array

Reimplemented from oxUBase.

Definition at line 311 of file search.php.

Search.getSorting ( sCnid  ) 

Returns search sorting config

Parameters:
string $sCnid sortable item id
Deprecated:
since v4.7.3/5.0.3 (2013-01-07); dublicated code
Returns:
string

Reimplemented from oxUBase.

Definition at line 266 of file search.php.

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.

Returns:
null

Reimplemented from oxUBase.

Definition at line 116 of file search.php.

Search.isEmptySearch (  ) 

Template variable getter. Returns if searched was empty

Returns:
bool

Definition at line 291 of file search.php.

Search.render (  ) 

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

Returns:
string current template file name

Reimplemented from oxUBase.

Definition at line 171 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
Deprecated:
since v4.7.3/5.0.3 (2013-01-07); dublicated code
Returns:
null

Reimplemented from oxUBase.

Definition at line 252 of file search.php.


Member Data Documentation

Search.$_aSimilarRecommListIds = null [protected]

Definition at line 105 of file search.php.

Search.$_blEmptySearch = null [protected]

Definition at line 43 of file search.php.

Search.$_blSearchClass = null [protected]

Definition at line 85 of file search.php.

Search.$_blShowSorting = true [protected]

Reimplemented from oxUBase.

Definition at line 37 of file search.php.

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.$_iViewIndexState = VIEW_INDEXSTATE_NOINDEXNOFOLLOW [protected]

Current view search engine indexing state: VIEW_INDEXSTATE_INDEX - index without limitations VIEW_INDEXSTATE_NOINDEXNOFOLLOW - no index / no follow VIEW_INDEXSTATE_NOINDEXFOLLOW - no index / follow

Reimplemented from oxUBase.

Definition at line 98 of file search.php.

Search.$_oPageNavigation = null [protected]

Definition at line 91 of file search.php.

Search.$_oRecommList = null [protected]

Definition at line 49 of file search.php.

Search.$_sListType = 'search' [protected]

Reimplemented from oxUBase.

Definition at line 31 of file search.php.

Search.$_sSearchCatId = null [protected]

Definition at line 67 of file search.php.

Search.$_sSearchManufacturer = null [protected]

Definition at line 79 of file search.php.

Search.$_sSearchParam = null [protected]

Definition at line 61 of file search.php.

Search.$_sSearchParamForHtml = null [protected]

Definition at line 55 of file search.php.

Search.$_sSearchVendor = null [protected]

Definition at line 73 of file search.php.

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

Reimplemented from oxView.

Definition at line 25 of file search.php.


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