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.

Definition at line 9 of file oxcategorylist.php.


Public Member Functions
	__construct ($sObjectsInListName= 'oxcategory')
	buildTree ($sActCat, $blLoadFullTree, $blPerfLoadTreeForSearch, $blTopNaviLayout)
	buildList ($blLoad)
	setShopID ($sShopID)
	getPath ()
	getHtmlPath ()
	getClickCat ()
	getClickRoot ()
	sortCats ()
	updateCategoryTree ($blVerbose=true, $sShopID=null)
	__get ($sName)
Protected Member Functions
	_getSelectString ($blReverse=false)
	_getDepthSqlSnippet ()
	_ppLoadFullCategory ($sId)
	_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.

Definition at line 60 of file oxcategorylist.php.

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

Definition at line 73 of file oxcategorylist.php.

oxCategoryList._getDepthSqlSnippet ( ) [protected]

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

Returns:: string

Definition at line 98 of file oxcategorylist.php.

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

Definition at line 151 of file oxcategorylist.php.

oxCategoryList._ppLoadFullCategory ( $ sId ) [protected]

set full category object in tree

Parameters:

string

$sId category id

Definition at line 188 of file oxcategorylist.php.

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

Definition at line 204 of file oxcategorylist.php.

oxCategoryList.setShopID ( $ sShopID )

setter for shopID

Parameters:

int

$sShopID ShopID

Returns:: null

Definition at line 229 of file oxcategorylist.php.

oxCategoryList.getPath ( )

Getter for active category path

Returns:: array

Definition at line 239 of file oxcategorylist.php.

oxCategoryList.getHtmlPath ( )

Returns HTML formated active category path

Returns:: string

Definition at line 249 of file oxcategorylist.php.

oxCategoryList.getClickCat ( )

Getter for active category

Returns:: oxcategory

Definition at line 265 of file oxcategorylist.php.

oxCategoryList.getClickRoot ( )

Getter for active root category

Returns:: oxcategory

Definition at line 277 of file oxcategorylist.php.

oxCategoryList._ppRemoveInactiveCategories ( ) [protected]

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

Returns:: null

Definition at line 289 of file oxcategorylist.php.

oxCategoryList._ppAddPathInfo ( ) [protected]

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

Returns:: null

Definition at line 318 of file oxcategorylist.php.

oxCategoryList._ppAddContentCategories ( ) [protected]

Category list postprocessing routine, responsible adding of content categories

Returns:: null

Definition at line 343 of file oxcategorylist.php.

oxCategoryList._ppBuildTree ( ) [protected]

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

Returns:: null

Definition at line 362 of file oxcategorylist.php.

oxCategoryList.sortCats ( )

Sorts category tree after oxsort and oxtitle fields and returns ids.

Returns:: array $aIds

Definition at line 391 of file oxcategorylist.php.

oxCategoryList._ppAddDepthInformation ( ) [protected]

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

Returns:: null

Definition at line 416 of file oxcategorylist.php.

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

Definition at line 455 of file oxcategorylist.php.

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

Definition at line 488 of file oxcategorylist.php.

oxCategoryList.__get ( $ sName )

Extra getter to guarantee compatibility with templates

Parameters:

string

$sName variable name

Returns:: unknown

Reimplemented from oxList.

Definition at line 528 of file oxcategorylist.php.

Member Data Documentation

oxCategoryList.$_sObjectsInListName = 'oxcategory' [protected]

Reimplemented from oxList.

Definition at line 16 of file oxcategorylist.php.

oxCategoryList.$_blHideEmpty = false [protected]

Definition at line 23 of file oxcategorylist.php.

oxCategoryList.$_blForseFull = false [protected]

Definition at line 30 of file oxcategorylist.php.

oxCategoryList.$_iForseLevel = 1 [protected]

Definition at line 37 of file oxcategorylist.php.

oxCategoryList.$_sActCat = null [protected]

Definition at line 44 of file oxcategorylist.php.

oxCategoryList.$_aPath = array() [protected]

Definition at line 51 of file oxcategorylist.php.

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

core/oxcategorylist.php

oxCategoryList Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation