OXID eShop CE  4.10.2
 All Classes Namespaces Files Functions Variables Pages
oxcmp_categories Class Reference
+ Inheritance diagram for oxcmp_categories:
+ Collaboration diagram for oxcmp_categories:

Public Member Functions

 init ()
 getProduct ()
 render ()
 setCategoryTree ($oCategoryTree)
 setManufacturerTree ($oManufacturerTree)
- Public Member Functions inherited from oxView
 setViewParameters ($aParams=null)
 getViewParameter ($sKey)
 setIsCallForCache ($blIsCallForCache=null)
 getIsCallForCache ()
 getViewId ()
 addGlobalParams ($oShop=null)
 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)
 getAdditionalParams ()
 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

 _getActCat ()
 _loadCategoryTree ($sActCat)
 _loadManufacturerTree ($sActManufacturer)
 _addAdditionalParams ($oProduct, $sActCat, $sActManufacturer, $sActTag, $sActVendor)
 _getDefaultParams ($oProduct)
- Protected Member Functions inherited from oxView
 _executeNewAction ($sNewAction)

Protected Attributes

 $_oMoreCat = null
 $_blIsComponent = true
 $_oCategoryTree = null
 $_oManufacturerTree = 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 oxView
static $_blExecuted = false

Detailed Description

Transparent category manager class (executed automatically).

oxcmp

Definition at line 8 of file oxcmp_categories.php.

Member Function Documentation

oxcmp_categories::_addAdditionalParams (   $oProduct,
  $sActCat,
  $sActManufacturer,
  $sActTag,
  $sActVendor 
)
protected

Adds additional parameters: active category, list type and category id

Parameters
oxArticle$oProductloaded product
string$sActCatactive category id
string$sActManufactureractive manufacturer id
string$sActTagactive tag
string$sActVendoractive vendor
Deprecated:
v5.3 (2016-05-04); Tags will be moved to own module. So the parameter sActTag will be removed.
Returns
string $sActCat

Definition at line 220 of file oxcmp_categories.php.

oxcmp_categories::_getActCat ( )
protected

get active category id

Returns
string

Definition at line 100 of file oxcmp_categories.php.

oxcmp_categories::_getDefaultParams (   $oProduct)
protected

Returns array containing default list type and category (or manufacturer ir vendor) id

Parameters
oxArticle$oProductcurrent product object
Returns
array

Definition at line 270 of file oxcmp_categories.php.

oxcmp_categories::_loadCategoryTree (   $sActCat)
protected

Category tree loader

Parameters
string$sActCatactive category id

Definition at line 142 of file oxcmp_categories.php.

oxcmp_categories::_loadManufacturerTree (   $sActManufacturer)
protected

Manufacturer tree loader

Parameters
string$sActManufactureractive Manufacturer id

Definition at line 162 of file oxcmp_categories.php.

oxcmp_categories::getProduct ( )

get active article

Returns
oxarticle

Definition at line 77 of file oxcmp_categories.php.

oxcmp_categories::init ( )

Executes parent::init(), searches for active category in URL, session, post variables ("cnid", "cdefnid"), active article ("anid", usually article details), then loads article and category if any of them available. Generates category/navigation list.

Returns
null

Reimplemented from oxView.

Definition at line 48 of file oxcmp_categories.php.

oxcmp_categories::render ( )

Executes parent::render(), loads expanded/clicked category object, adds parameters template engine and returns list of category tree.

Returns
oxCategoryList

Reimplemented from oxView.

Definition at line 189 of file oxcmp_categories.php.

oxcmp_categories::setCategoryTree (   $oCategoryTree)

Setter of category tree

Parameters
oxCategoryList$oCategoryTreecategory list

Definition at line 294 of file oxcmp_categories.php.

oxcmp_categories::setManufacturerTree (   $oManufacturerTree)

Setter of manufacturer tree

Parameters
oxManufacturerList$oManufacturerTreemanufacturer list

Definition at line 304 of file oxcmp_categories.php.

Member Data Documentation

oxcmp_categories::$_blIsComponent = true
protected

Definition at line 23 of file oxcmp_categories.php.

oxcmp_categories::$_oCategoryTree = null
protected

Definition at line 30 of file oxcmp_categories.php.

oxcmp_categories::$_oManufacturerTree = null
protected

Definition at line 37 of file oxcmp_categories.php.

oxcmp_categories::$_oMoreCat = null
protected

Definition at line 16 of file oxcmp_categories.php.


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