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

Public Member Functions

 render ()
 getArticleList ()
 getTopArticleList ()
 getNewestArticles ()
 getFirstArticle ()
 getCatOfferArticle ()
 getCatOfferArticleList ()
 getTitleSuffix ()
 getCanonicalUrl ()
 getBanners ()
 getManufacturerForSlider ()
- Public Member Functions inherited from oxUBase
 init ()
 getViewId ()
 showSorting ()
 setComponents ($aComponents=null)
 getComponents ()
 getComponent ($sName)
 setIsOrderStep ($blIsOrderStep=null)
 getIsOrderStep ()
 setActiveCategory ($oCategory)
 getActiveCategory ()
 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)
 getListOrderBy ()
 getListOrderDirection ()
 setMetaDescription ($sDescription)
 setMetaKeywords ($sKeywords)
 getMetaKeywords ()
 getMetaDescription ()
 getActCurrency ()
 setActCurrency ($oCur)
 getCompareItemCount ()
 noIndex ()
 getMenueList ()
 setMenueList ($aMenu)
 getNavigationParams ()
 setItemSorting ($sSortIdent, $sSortBy, $sSortDir=null)
 getSorting ($sSortIdent)
 getSortingSql ($sIdent)
 getTitlePageSuffix ()
 getTitlePrefix ()
 getPageTitle ()
 getDynUrlParams ()
 getBaseLink ($iLang=null)
 getLink ($iLang=null)
 getSimilarRecommListIds ()
 getSearchParamForHtml ()
 showSearch ()
 getRssLinks ()
 getSortColumns ()
 setSortColumns ($aSortColumns)
 getEditTags ()
 getRecommSearch ()
 getPaymentList ()
 getActiveRecommList ()
 getAccessoires ()
 getCrossSelling ()
 getSimilarProducts ()
 getAlsoBoughtTheseProducts ()
 getArticleId ()
 getTitle ()
 getActiveLangAbbr ()
 addGlobalParams ($oShop=null)
 getAdditionalParams ()
 generatePageNavigationUrl ()
 getPageNavigation ()
 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)
 getAddUrlParams ()
 getTop5ArticleList ($iCount=null)
 getBargainArticleList ()
 isLowOrderPrice ()
 getMinOrderPrice ()
 getNewsRealStatus ()
 getProduct ()
 getManufacturerlist ()
 setManufacturerlist ($aList)
 setRootVendor ($oVendor)
 getRootVendor ()
 setRootManufacturer ($oManufacturer)
 getRootManufacturer ()
 getVendorId ()
 getManufacturerId ()
 getCatMoreUrl ()
 getCatTreePath ()
 getContentByIdent ($sIdent)
 getContentCategory ()
 getMustFillFields ()
 isFieldRequired ($sField)
 getFormId ()
 canAcceptFormData ()
 getPromoFinishedList ()
 getPromoCurrentList ()
 getPromoFutureList ()
 getShowPromotionList ()
 isEnabledPrivateSales ()
 getFieldValidationErrors ()
 getBreadCrumb ()
 setRootCatChanged ($blRootCatChanged)
 isRootCatChanged ()
 getInvoiceAddress ()
 getDeliveryAddress ()
 setDeliveryAddress ($aDeliveryAddress)
 setInvoiceAddress ($aAddress)
 getActiveUsername ()
 getWishlistUserId ()
 getSearchCatId ()
 getSearchVendor ()
 getSearchManufacturer ()
 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

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

Protected Attributes

 $_sListDisplayType = null
 $_sThisTemplate = 'page/shop/start.tpl'
 $_sMetaDescriptionIdent = 'oxstartmetadescription'
 $_sMetaKeywordsIdent = 'oxstartmetakeywords'
 $_blLoadActions = null
 $_aTopArticleList = null
 $_aNewArticleList = null
 $_oFirstArticle = null
 $_oCatOfferArticle = null
 $_oCatOfferArtList = null
 $_sTagCloud = null
 $_blTop5Action = true
 $_blBargainAction = true
- 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
 $_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
 $_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

Starting shop page. Shop starter, manages starting visible articles, etc.

Definition at line 7 of file start.php.

Member Function Documentation

Start::_getLoadActionsParam ( )
protected

Template variable getter. Returns if actions are ON

Returns
string

Definition at line 188 of file start.php.

Start::_prepareMetaDescription (   $sMeta,
  $iLength = 1024,
  $blDescTag = false 
)
protected

Returns current view meta data If $sMeta parameter comes empty, sets to it article title and description. It happens if current view has no meta data defined in oxcontent table

Parameters
string$sMetacategory path
int$iLengthmax length of result, -1 for no truncation
bool$blDescTagif true - performs additional dublicate cleaning
Returns
string

Reimplemented from oxUBase.

Definition at line 147 of file start.php.

Start::_prepareMetaKeyword (   $sKeywords,
  $blRemoveDuplicatedWords = true 
)
protected

Returns current view keywords seperated by comma If $sKeywords parameter comes empty, sets to it article title and description. It happens if current view has no meta data defined in oxcontent table

Parameters
string$sKeywordsdata to use as keywords
bool$blRemoveDuplicatedWordsremove dublicated words
Returns
string

Reimplemented from oxUBase.

Definition at line 170 of file start.php.

Start::getArticleList ( )

Template variable getter. Returns start page articles (OXSTART)

Returns
array

Definition at line 205 of file start.php.

Start::getBanners ( )

Returns active banner list

Returns
objects

Definition at line 356 of file start.php.

Start::getCanonicalUrl ( )

Returns view canonical url

Returns
string

Reimplemented from oxUBase.

Definition at line 343 of file start.php.

Start::getCatOfferArticle ( )

Template variable getter. Returns category offer article (OXCATOFFER)

Returns
object

Definition at line 294 of file start.php.

Start::getCatOfferArticleList ( )

Template variable getter. Returns category offer article list (OXCATOFFER)

Returns
array

Definition at line 311 of file start.php.

Start::getFirstArticle ( )

Template variable getter. Returns first article

Returns
object

Definition at line 272 of file start.php.

Start::getManufacturerForSlider ( )

Returns manufacturer list for manufacturer slider

Returns
objects

Definition at line 374 of file start.php.

Start::getNewestArticles ( )

Template variable getter. Returns newest article list

Returns
array

Definition at line 250 of file start.php.

Start::getTitleSuffix ( )

Returns SEO suffix for page title

Returns
string

Reimplemented from oxUBase.

Definition at line 333 of file start.php.

Start::getTopArticleList ( )

Template variable getter. Returns Top article list (OXTOPSTART)

Returns
array

Definition at line 227 of file start.php.

Start::render ( )

Executes parent::render(), loads action articles (oxarticlelist::loadActionArticles()). Returns name of template file to render.

Returns
string cuurent template file name

Reimplemented from oxUBase.

Definition at line 111 of file start.php.

Member Data Documentation

Start::$_aNewArticleList = null
protected

Definition at line 57 of file start.php.

Start::$_aTopArticleList = null
protected

Definition at line 50 of file start.php.

Start::$_blBargainAction = true
protected

Definition at line 101 of file start.php.

Start::$_blLoadActions = null
protected

Definition at line 43 of file start.php.

Start::$_blTop5Action = true
protected

Definition at line 94 of file start.php.

Start::$_oCatOfferArticle = null
protected

Definition at line 71 of file start.php.

Start::$_oCatOfferArtList = null
protected

Definition at line 78 of file start.php.

Start::$_oFirstArticle = null
protected

Definition at line 64 of file start.php.

Start::$_sListDisplayType = null
protected

Definition at line 15 of file start.php.

Start::$_sMetaDescriptionIdent = 'oxstartmetadescription'
protected

Definition at line 29 of file start.php.

Start::$_sMetaKeywordsIdent = 'oxstartmetakeywords'
protected

Definition at line 36 of file start.php.

Start::$_sTagCloud = null
protected

Definition at line 87 of file start.php.

Start::$_sThisTemplate = 'page/shop/start.tpl'
protected

Definition at line 22 of file start.php.

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