oxCategoryList Class Reference

Inheritance diagram for oxCategoryList:

[legend]

Collaboration diagram for oxCategoryList:

[legend]

List of all members.

---

Detailed Description

Category list manager. Collects available categories, performs some SQL queries to create category list structure.

Public Member Functions
	__construct ($sObjectsInListName= 'oxcategory')
	buildTree ($sActCat, $blLoadFullTree, $blPerfLoadTreeForSearch, $blTopNaviLayout)
	buildList ($blLoad)
	setShopID ($sShopID)
	getPath ()
	getHtmlPath ()
	getClickCat ()
	getClickRoot ()
	updateCategoryTree ($blVerbose=true, $sShopID=null)
	__get ($sName)
Protected Member Functions
	_getSelectString ($blReverse=false)
	_getDepthSqlSnippet ()
	_getRRSqlSnippet ()
	_ppRemoveInactiveCategories ()
	_ppAddPathInfo ()
	_ppAddContentCategories ()
	_ppBuildTree ()
	_ppAddDepthInformation ()
	_updateNodes ($oxRootId, $isroot, $thisRoot)
Protected Attributes
	$_sObjectsInListName = 'oxcategory'
	$_blHideEmpty = false
	$_blForseFull = false
	$_iForseLevel = 1
	$_sActCat = null
	$_aPath = array()

---

Constructor & Destructor Documentation

oxCategoryList.__construct

(

$

sObjectsInListName = 'oxcategory'

)

Class constructor, initiates parent constructor (parent.oxList()).

Parameters:

string

$sObjectsInListName optional parameter, the objects contained in the list, always oxcategory

Returns:

null

Reimplemented from oxList.

---

Member Function Documentation

oxCategoryList._getSelectString

(

$

blReverse = false

)

[protected]

constructs the sql string to get the category list

Parameters:

bool

$blReverse (list loading order, true for tree, false for simple list)

Returns:

string

oxCategoryList._getDepthSqlSnippet

(

)

[protected]

constructs the sql snippet responsible for dept optimizations, based on performance options: ( HideEmpty, ForseFull, ForseLevel, ActCat, isAdmin )

Returns:

string

oxCategoryList._getRRSqlSnippet

(

)

[protected]

constructs the sql snippet responsible for RR engine:

Returns:

string

oxCategoryList.buildTree	(	$	sActCat,
		$	blLoadFullTree,
		$	blPerfLoadTreeForSearch,
		$	blTopNaviLayout
	)

Fetches reversed raw categories and does all necesarry postprocessing for removing invisible or forbidden categories, duilding oc navigation path, adding content categories and building tree structure.

Parameters:

	string	$sActCat Active category (default null)
	bool	$blLoadFullTree ($myConfig->getConfigParam( 'blLoadFullTree' ) )
	bool	$blPerfLoadTreeForSearch ($myConfig->getConfigParam( 'bl_perfLoadTreeForSearch' ) )
	bool	$blTopNaviLayout ($myConfig->getConfigParam( 'blTopNaviLayout' ) )

Returns:

null

oxCategoryList.buildList

(

$

blLoad

)

Fetches raw categories and does postprocessing for adding depth information

Parameters:

bool

$blLoad usually used with config option bl_perfLoadCatTree

Returns:

null

oxCategoryList.setShopID

(

$

sShopID

)

setter for shopID

Parameters:

int

$sShopID ShopID

Returns:

null

oxCategoryList.getPath

(

)

Getter for active category path

Returns:

array

oxCategoryList.getHtmlPath

(

)

Returns HTML formated active category path

Returns:

string

oxCategoryList.getClickCat

(

)

Getter for active category

Returns:

oxcategory

oxCategoryList.getClickRoot

(

)

Getter for active root category

Returns:

oxcategory

oxCategoryList._ppRemoveInactiveCategories

(

)

[protected]

Category list postprocessing routine, responsible for removal of inactive of forbidden categories, and subcategories.

Returns:

null

oxCategoryList._ppAddPathInfo

(

)

[protected]

Category list postprocessing routine, responsible for generation of active category path

Returns:

null

oxCategoryList._ppAddContentCategories

(

)

[protected]

Category list postprocessing routine, responsible adding of content categories

Returns:

null

oxCategoryList._ppBuildTree

(

)

[protected]

Category list postprocessing routine, responsible building an sorting of hierarchical category tree

Returns:

null

oxCategoryList._ppAddDepthInformation

(

)

[protected]

Category list postprocessing routine, responsible adding depth information. Requires not reversed category list!

Returns:

null

oxCategoryList.updateCategoryTree	(	$	blVerbose = true,
		$	sShopID = null
	)

Rebuilds nested sets information by updating oxleft and oxright category attributes, from oxparentid

Parameters:

	bool	$blVerbose Set to true for outputing the update status for user,
	string	$sShopID the shop id

Returns:

null

oxCategoryList._updateNodes	(	$	oxRootId,
		$	isroot,
		$	thisRoot
	)			[protected]

Recursivly updates root nodes, this method is used (only) in updateCategoryTree()

Parameters:

	string	$oxRootId rootid of tree
	bool	$isroot is the current node root?
	string	$thisRoot the id of the root

Returns:

null

oxCategoryList.__get

(

$

sName

)

Extra getter to guarantee compatibility with templates

Parameters:

string

$sName variable name

Returns:

unknown

Reimplemented from oxList.

---

Member Data Documentation

oxCategoryList.$_sObjectsInListName = 'oxcategory' [protected]

Reimplemented from oxList.

oxCategoryList.$_blHideEmpty = false [protected]

oxCategoryList.$_blForseFull = false [protected]

oxCategoryList.$_iForseLevel = 1 [protected]

oxCategoryList.$_sActCat = null [protected]

oxCategoryList.$_aPath = array() [protected]

---

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

• core/oxcategorylist.php