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

Public Member Functions

 getActiveCategory ()
 render ()
 setProduct ($oArticle)
 getProduct ()
 getLink ($iLang=null)
 isVatIncluded ()
 getWishId ()
 getRemoveFunction ()
 getToBasketFunction ()
 getDisableToCart ()
 getIndex ()
 getRecommId ()
 getIteration ()
 getRSSLinks ()
 getShowMainLink ()
 getAltProduct ()
- Public Member Functions inherited from oxWidget
 init ()
- 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)
 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)
 getTitleSuffix ()
 getTitlePageSuffix ()
 getTitlePrefix ()
 getPageTitle ()
 getDynUrlParams ()
 getBaseLink ($iLang=null)
 getCanonicalUrl ()
 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 ()
 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 ()
 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

 _addDynParamsToLink ($sAddDynParams, $oArticle)
 _getArticleById ($sArticleId)
- Protected Member Functions inherited from oxWidget
 _processRequest ()
- Protected Member Functions inherited from oxUBase
 _getComponentNames ()
 _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)
 _canRedirect ()
- Protected Member Functions inherited from oxView
 _executeNewAction ($sNewAction)

Protected Attributes

 $_aComponentNames = array('oxcmp_user' => 1, 'oxcmp_basket' => 1, 'oxcmp_cur' => 1)
 $_sTemplate = 'widget/product/boxproduct.tpl'
 $_oArticle = null
- Protected Attributes inherited from oxWidget
 $_aComponentNames = array()
 $_blLoadComponents = false
- 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

Article box widget

Definition at line 6 of file oxwarticlebox.php.

Member Function Documentation

oxwArticleBox::_addDynParamsToLink (   $sAddDynParams,
  $oArticle 
)
protected

Appends dyn params to url.

Parameters
string$sAddDynParamsDyn params
oxArticle$oArticleArticle
Returns
bool

Definition at line 245 of file oxwarticlebox.php.

oxwArticleBox::_getArticleById (   $sArticleId)
protected

Returns prepared article by id.

Parameters
string$sArticleIdArticle id
Returns
oxArticle

Definition at line 268 of file oxwarticlebox.php.

oxwArticleBox::getActiveCategory ( )

Returns active category

Returns
null|oxCategory

Reimplemented from oxUBase.

Definition at line 39 of file oxwarticlebox.php.

oxwArticleBox::getAltProduct ( )

Returns if alternate product exists

Returns
bool

Definition at line 232 of file oxwarticlebox.php.

oxwArticleBox::getDisableToCart ( )

Returns if toCart must be disabled

Returns
bool

Definition at line 165 of file oxwarticlebox.php.

oxwArticleBox::getIndex ( )

Returns list item id with identifier

Returns
string

Definition at line 175 of file oxwarticlebox.php.

oxwArticleBox::getIteration ( )

Returns iteration number

Returns
string

Definition at line 197 of file oxwarticlebox.php.

oxwArticleBox::getLink (   $iLang = null)

get link of current top view

Parameters
int$iLangrequested language
Returns
string

Reimplemented from oxUBase.

Definition at line 115 of file oxwarticlebox.php.

oxwArticleBox::getProduct ( )

Get product article

Returns
oxArticle

Reimplemented from oxUBase.

Definition at line 88 of file oxwarticlebox.php.

oxwArticleBox::getRecommId ( )

Returns recommendation id

Deprecated:
since v5.3 (2016-06-17); Listmania will be moved to an own module.
Returns
string

Definition at line 187 of file oxwarticlebox.php.

oxwArticleBox::getRemoveFunction ( )

Returns remove function

Returns
string

Definition at line 145 of file oxwarticlebox.php.

oxwArticleBox::getRSSLinks ( )

Returns RSS links

Returns
array|null

Definition at line 207 of file oxwarticlebox.php.

oxwArticleBox::getShowMainLink ( )

Returns the answer if main link must be showed

Returns
bool

Definition at line 222 of file oxwarticlebox.php.

oxwArticleBox::getToBasketFunction ( )

Returns toBasket function

Returns
string

Definition at line 155 of file oxwarticlebox.php.

oxwArticleBox::getWishId ( )

Returns wishlist id

Returns
string

Definition at line 135 of file oxwarticlebox.php.

oxwArticleBox::isVatIncluded ( )

Returns if VAT is included in price

Returns
bool

Reimplemented from oxUBase.

Definition at line 125 of file oxwarticlebox.php.

oxwArticleBox::render ( )

Renders template based on widget type or just use directly passed path of template

Returns
string

Reimplemented from oxUBase.

Definition at line 54 of file oxwarticlebox.php.

oxwArticleBox::setProduct (   $oArticle)

Sets box product

Parameters
oxArticle$oArticleBox product

Definition at line 78 of file oxwarticlebox.php.

Member Data Documentation

oxwArticleBox::$_aComponentNames = array('oxcmp_user' => 1, 'oxcmp_basket' => 1, 'oxcmp_cur' => 1)
protected

Definition at line 16 of file oxwarticlebox.php.

oxwArticleBox::$_oArticle = null
protected

Definition at line 31 of file oxwarticlebox.php.

oxwArticleBox::$_sTemplate = 'widget/product/boxproduct.tpl'
protected

Definition at line 23 of file oxwarticlebox.php.

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