OxidEsales\EshopCommunity\Application\Component\CategoriesComponent Class Reference

Inheritance diagram for OxidEsales\EshopCommunity\Application\Component\CategoriesComponent:

Collaboration diagram for OxidEsales\EshopCommunity\Application\Component\CategoriesComponent:

Public Member Functions
	init ()
	getProduct ()
	render ()
	setCategoryTree ($oCategoryTree)
	setManufacturerTree ($oManufacturerTree)

Protected Member Functions
	_getActCat ()
	_loadCategoryTree ($sActCat)
	_loadManufacturerTree ($sActManufacturer)
	_addAdditionalParams ($oProduct, $sActCat, $sActManufacturer, $sActVendor)
	_getDefaultParams ($oProduct)
	getManufacturerList ()

Protected Attributes
	$_oMoreCat = null
	$_blIsComponent = true
	$_oCategoryTree = null
	$_oManufacturerTree = null

Detailed Description

Transparent category manager class (executed automatically).

@subpackage oxcmp

Member Function Documentation

_addAdditionalParams()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::_addAdditionalParams (   $oProduct,   $sActCat,   $sActManufacturer,   $sActVendor  )

protected

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

Parameters

\OxidEsales\Eshop\Application\Model\Article	$oProduct	loaded product
string	$sActCat	active category id
string	$sActManufacturer	active manufacturer id
string	$sActVendor	active vendor

Returns

string $sActCat

Deprecated:

underscore prefix violates PSR12, will be renamed to "addAdditionalParams" in next major

_getActCat()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::_getActCat ( )

protected

get active category id

Returns

string

Deprecated:

underscore prefix violates PSR12, will be renamed to "getActCat" in next major

_getDefaultParams()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::_getDefaultParams (   $oProduct )

protected

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

Parameters

\OxidEsales\Eshop\Application\Model\Article

$oProduct

current product object

Returns

array

Deprecated:

underscore prefix violates PSR12, will be renamed to "getDefaultParams" in next major

_loadCategoryTree()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::_loadCategoryTree (   $sActCat )

protected

Category tree loader

Parameters

string

$sActCat

active category id

Deprecated:

underscore prefix violates PSR12, will be renamed to "loadCategoryTree" in next major

_loadManufacturerTree()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::_loadManufacturerTree (   $sActManufacturer )

protected

Manufacturer tree loader

Parameters

string

$sActManufacturer

active Manufacturer id

Deprecated:

underscore prefix violates PSR12, will be renamed to "loadManufacturerTree" in next major

getManufacturerList()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::getManufacturerList ( )

protected

Returns

\OxidEsales\Eshop\Application\Model\ManufacturerList

getProduct()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::getProduct

(

)

get active article

Returns

\OxidEsales\Eshop\Application\Model\Article

init()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::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

render()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::render

(

)

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

Returns

\OxidEsales\Eshop\Application\Model\CategoryList

setCategoryTree()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::setCategoryTree

(

$oCategoryTree

)

Setter of category tree

Parameters

\OxidEsales\Eshop\Application\Model\CategoryList

$oCategoryTree

category list

setManufacturerTree()

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::setManufacturerTree

(

$oManufacturerTree

)

Setter of manufacturer tree

Parameters

\OxidEsales\Eshop\Application\Model\ManufacturerList

$oManufacturerTree

manufacturer list

Member Data Documentation

$_blIsComponent

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::$_blIsComponent = true

protected

$_oCategoryTree

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::$_oCategoryTree = null

protected

$_oManufacturerTree

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::$_oManufacturerTree = null

protected

$_oMoreCat

OxidEsales\EshopCommunity\Application\Component\CategoriesComponent::$_oMoreCat = null

protected

---

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

• /oxideshop-ce/source/Application/Component/CategoriesComponent.php