OXID eShop CE  4.8.11
 All Classes Files Functions Variables Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Search Class Reference
+ Inheritance diagram for Search:
+ Collaboration diagram for Search:

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 ()
- Public Member Functions inherited from oxUBase
 getViewId ()
 showSorting ()
 setComponents ($aComponents=null)
 getComponents ()
 getComponent ($sName)
 setIsOrderStep ($blIsOrderStep=null)
 getIsOrderStep ()
 setActiveCategory ($oCategory)
 getListType ()
 getListDisplayType ()
 getCustomListDisplayType ()
 setListType ($sType)
 loadCurrency ()
 dontShowEmptyCategories ()
 showCategoryArticlesCount ()
 isLanguageLoaded ()
 getTopNavigationCatCnt ()
 addRssFeed ($sTitle, $sUrl, $key=null)
 getSortOrderByParameterName ()
 getSortOrderParameterName ()
 getSortIdent ()
 getDefaultSorting ()
 getUserSelectedSorting ()
 getSavedSorting ($sSortIdent)
 setListOrderBy ($sColumn)
 setListOrderDirection ($sDirection)
 prepareSortColumns ()
 getListOrderBy ()
 getListOrderDirection ()
 setMetaDescription ($sDescription)
 setMetaKeywords ($sKeywords)
 getMetaKeywords ()
 getMetaDescription ()
 getActCurrency ()
 setActCurrency ($oCur)
 getCompareItemCount ()
 noIndex ()
 isSortingActive ()
 getMenueList ()
 setMenueList ($aMenue)
 getNavigationParams ()
 getSortingSql ($sIdent)
 getTitleSuffix ()
 getTitlePageSuffix ()
 getTitlePrefix ()
 getDynUrlParams ()
 getLink ($iLang=null)
 getCanonicalUrl ()
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 setSortColumns ($aSortColumns)
 getEditTags ()
 getRecommSearch ()
 getPaymentList ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtTheseProducts ()
 getArticleId ()
 getTitle ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 getAdditionalParams ()
 generatePageNavigationUrl ()
 getPageNavigationLimitedTop ($iPositionCount=7)
 getPageNavigationLimitedBottom ($iPositionCount=11)
 generatePageNavigation ($iPositionCount=0)
 getViewProduct ()
 setViewProduct ($oProduct)
 getViewProductList ()
 getActPage ()
 getActTag ()
 getActVendor ()
 getActManufacturer ()
 setActVendor ($oVendor)
 setActManufacturer ($oManufacturer)
 getActSearch ()
 getCategoryTree ()
 setCategoryTree ($oCatTree)
 getManufacturerTree ()
 setManufacturerTree ($oManufacturerTree)
 getTop5ArticleList ($iCount=null)
 getBargainArticleList ()
 isLowOrderPrice ()
 getMinOrderPrice ()
 getNewsRealStatus ()
 getProduct ()
 getManufacturerlist ()
 setManufacturerlist ($aList)
 setRootVendor ($oVendor)
 getRootVendor ()
 setRootManufacturer ($oManufacturer)
 getRootManufacturer ()
 getVendorId ()
 getManufacturerId ()
 getSearchCatTree ()
 setSearchCatTree ($aTree)
 getCatMoreUrl ()
 getCatTreePath ()
 getContentByIdent ($sIdent)
 getContentCategory ()
 getMustFillFields ()
 isFieldRequired ($sField)
 getFormId ()
 canAcceptFormData ()
 getPromoFinishedList ()
 getPromoCurrentList ()
 getPromoFutureList ()
 getShowPromotionList ()
 isEnabledPrivateSales ()
 getFieldValidationErrors ()
 setRootCatChanged ($blRootCatChanged)
 isRootCatChanged ()
 getInvoiceAddress ()
 getDeliveryAddress ()
 setDeliveryAddress ($aDeliveryAddress)
 setInvoiceAddress ($aAddress)
 getActiveUsername ()
 getWishlistUserId ()
 getLastProducts ()
 getNewBasketItemMsgType ()
 isActive ($sName)
 isFbWidgetVisible ()
 isEnabledDownloadableFiles ()
 showRememberMe ()
 isVatIncluded ()
 isPriceCalculated ()
 showTags ()
 getWishlistName ()
 getWidgetLink ()
- Public Member Functions inherited from oxView
 setViewParameters ($aParams=null)
 getViewParameter ($sKey)
 setIsCallForCache ($blIsCallForCache=null)
 getIsCallForCache ()
 addTplParam ($sPara, $sValue)
 getBelboonParam ()
 getViewConfig ()
 getTemplateName ()
 setTemplateName ($sTemplate)
 setClassName ($sClassName)
 getClassName ()
 setFncName ($sFncName)
 getFncName ()
 setViewData ($aViewData=null)
 getViewData ()
 getViewDataElement ($sParamId=null)
 setClassLocation ($sClassLocation=null)
 getClassLocation ()
 setThisAction ($sThisAction=null)
 getThisAction ()
 setParent ($oParent=null)
 getParent ()
 setIsComponent ($blIsComponent=null)
 getIsComponent ()
 executeFunction ($sFunction)
 getTrustedShopId ()
 getTSExcellenceId ()
 getCharSet ()
 getShopVersion ()
 getShopEdition ()
 getRevision ()
 getPackageInfo ()
 getShopFullEdition ()
 isDemoVersion ()
 isBetaVersion ()
 isRCVersion ()
 showBetaNote ()
 isDemoShop ()
 showNewsletter ()
 setShowNewsletter ($blShow)
 getShopLogo ()
 setShopLogo ($sLogo)
 getActCategory ()
 setActCategory ($oCategory)
 getCategoryId ()
 setCategoryId ($sCategoryId)
 getErrorDestination ()
 getActionClassName ()
 isConnectedWithFb ()
 getFbUserId ()
 showFbConnectToAccountMsg ()
 isMall ()
 showRdfa ()
 getSidForWidget ()
- Public Member Functions inherited from oxSuperCfg
 __call ($sMethod, $aArgs)
 __construct ()
 getConfig ()
 setConfig ($oConfig)
 getSession ()
 setSession ($oSession)
 getUser ()
 setUser ($oUser)
 isAdmin ()
 setAdminMode ($blAdmin)

Protected Member Functions

 _processListArticles ()
 _isSearchClass ()
 _canRedirect ()
- Protected Member Functions inherited from oxUBase
 _getComponentNames ()
 _processRequest ()
 _getMetaFromSeo ($sDataType)
 _getMetaFromContent ($sMetaIdent)
 _forceNoIndex ()
 _setNrOfArtPerPage ()
 _getSeoObjectId ()
 _prepareMetaDescription ($sMeta, $iLength=1024, $blRemoveDuplicatedWords=false)
 _prepareMetaKeyword ($sKeywords, $blRemoveDuplicatedWords=true)
 _removeDuplicatedWords ($aInput, $aSkipTags=array())
 _getSubject ($iLang)
 _getRequestParams ($blAddPageNr=true)
 _getSeoRequestParams ()
 _addPageNrParam ($sUrl, $iPage, $iLang=null)
- Protected Member Functions inherited from oxView
 _executeNewAction ($sNewAction)

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
- Protected Attributes inherited from oxUBase
 $_blFbWidgetsOn = null
 $_sRemoveMetaChars = '.\+*?[^]$(){}=!<>|:&'
 $_oaComponents = array()
 $_blIsOrderStep = false
 $_sListType = null
 $_aListDisplayTypes = array( 'grid', 'line', 'infogrid' )
 $_sListDisplayType = null
 $_sCustomListDisplayType = null
 $_oActCategory = null
 $_oActManufacturer = null
 $_oActVendor = null
 $_oActiveRecommList = null
 $_oActSearch = null
 $_blShowSorting = false
 $_blLoadCurrency = null
 $_blLoadManufacturerTree = null
 $_blDontShowEmptyCats = null
 $_blLoadLanguage = null
 $_iTopCatNavItmCnt = null
 $_aRssLinks = null
 $_sListOrderBy = null
 $_sListOrderDir = null
 $_sMetaDescription = null
 $_sMetaKeywords = null
 $_sMetaDescriptionIdent = null
 $_sMetaKeywordsIdent = null
 $_sAdditionalParams = null
 $_oActCurrency = null
 $_blEnabledPrivateSales = null
 $_blCommonAdded = false
 $_iViewIndexState = VIEW_INDEXSTATE_INDEX
 $_blForceNoIndex = false
 $_iCompItemsCnt = null
 $_sContentId = null
 $_oContent = null
 $_sViewResetID = null
 $_blActiveSorting = null
 $_aMenueList = null
 $_aComponentNames
 $_aUserComponentNames = array()
 $_oProduct = null
 $_iActPage = null
 $_aArticleList = null
 $_oManufacturerTree = null
 $_oCategoryTree = null
 $_aTop5ArticleList = null
 $_aBargainArticleList = null
 $_blLowOrderPrice = null
 $_sMinOrderPrice = null
 $_iNewsRealStatus = null
 $_aBlockRedirectParams = array( 'fnc', 'stoken', 'force_sid', 'force_admin_sid' )
 $_oRootVendor = null
 $_sVendorId = null
 $_aManufacturerlist = null
 $_oRootManufacturer = null
 $_sManufacturerId = null
 $_aSearchCatTree = null
 $_blNewsSubscribed = null
 $_oDelAddress = null
 $_sCatTreePath = null
 $_aContents = array()
 $_blTop5Action = false
 $_blBargainAction = false
 $_aMustFillFields = null
 $_blShowTagCloud = true
 $_blRootCatChanged = false
 $_aInvoiceAddress = null
 $_aDeliveryAddress = null
 $_sActiveUsername = null
 $_blLoadComponents = true
 $_aSortColumns = null
- Protected Attributes inherited from oxView
 $_aViewData = array()
 $_sClassLocation = null
 $_sThisAction = null
 $_oParent = null
 $_blIsComponent = false
 $_sThisTemplate = null
 $_sViewId = null
 $_sClass = null
 $_sFnc = null
 $_sTrustedShopId = null
 $_sTSExcellenceId = null
 $_sCharSet = null
 $_sVersion = null
 $_blDemoVersion = null
 $_blDemoShop = null
 $_iNewsStatus = null
 $_sShopLogo = null
 $_sCategoryId = null
 $_oClickCat = null
 $_blIsCallForCache = false
 $_oViewConf = null

Additional Inherited Members

- Static Protected Attributes inherited from oxUBase
static $_aCollectedComponentNames = 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 465 of file search.php.

Search::_isSearchClass ( )
protected

Template variable getter. Returns similar recommendation lists

Returns
object

Definition at line 277 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 455 of file search.php.

Search::getActiveCategory ( )

Template variable getter. Returns active search

Returns
object

Reimplemented from oxUBase.

Definition at line 428 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 475 of file search.php.

Search::getArticleList ( )

Template variable getter. Returns searched article list

Returns
array

Definition at line 302 of file search.php.

Search::getBreadCrumb ( )

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

Returns
array

Reimplemented from oxUBase.

Definition at line 438 of file search.php.

Search::getPageNavigation ( )

Template variable getter. Returns page navigation

Returns
object

Reimplemented from oxUBase.

Definition at line 413 of file search.php.

Search::getSearchCatId ( )

Template variable getter. Returns searched category id

Returns
string

Reimplemented from oxUBase.

Definition at line 363 of file search.php.

Search::getSearchManufacturer ( )

Template variable getter. Returns searched Manufacturer id

Returns
string

Reimplemented from oxUBase.

Definition at line 396 of file search.php.

Search::getSearchParam ( )

Template variable getter. Returns search parameter

Returns
string

Definition at line 347 of file search.php.

Search::getSearchParamForHtml ( )

Template variable getter. Returns search parameter for Html

Returns
string

Reimplemented from oxUBase.

Definition at line 331 of file search.php.

Search::getSearchVendor ( )

Template variable getter. Returns searched vendor id

Returns
string

Reimplemented from oxUBase.

Definition at line 379 of file search.php.

Search::getSimilarRecommListIds ( )

Return array of id to form recommend list.

Returns
array

Reimplemented from oxUBase.

Definition at line 312 of file search.php.

Search::getSorting (   $sCnid)

Returns search sorting config

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

Reimplemented from oxUBase.

Definition at line 267 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 292 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$sCnidsortable item id
string$sSortBysort field
string$sSortOrdersort order
Deprecated:
since v4.7.3/5.0.3 (2013-01-07); dublicated code
Returns
null

Reimplemented from oxUBase.

Definition at line 253 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

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

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

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

Definition at line 25 of file search.php.

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