OXID eShop CE  4.9.7
 All Classes Files Functions Variables Pages
oxCategoryList Class Reference
+ Inheritance diagram for oxCategoryList:
+ Collaboration diagram for oxCategoryList:

Public Member Functions

 __construct ($sObjectsInListName= 'oxcategory')
 setLoadFull ($blForceFull)
 getLoadFull ()
 setLoadLevel ($iForceLevel)
 getLoadLevel ()
 load ()
 buildTree ($sActCat)
 loadList ()
 setShopID ($sShopID)
 getPath ()
 getClickCat ()
 getClickRoot ()
 updateCategoryTree ($blVerbose=true, $sShopID=null)
 getUpdateInfo ()
 __get ($sName)
- Public Member Functions inherited from oxList
 offsetExists ($offset)
 offsetGet ($offset)
 offsetSet ($offset, $oBase)
 offsetUnset ($offset)
 arrayKeys ()
 rewind ()
 current ()
 key ()
 prev ()
 next ()
 valid ()
 count ()
 clear ()
 assign ($aArray)
 reverse ()
 getArray ()
 init ($sObjectName, $sCoreTable=null)
 getBaseObject ()
 setBaseObject ($oObject)
 selectString ($sSql)
 add ($oObject)
 assignArray ($aData)
 setSqlLimit ($iStart, $iRecords)
 containsFieldValue ($oVal, $sFieldName)
 getList ()
- 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

 _getSqlSelectFieldsForTree ($sTable, $aColumns=null)
 _getSelectString ($blReverse=false, $aColumns=null, $sOrder=null)
 _getDepthSqlSnippet ($oCat)
 _getDepthSqlUnion ($oCat, $aColumns=null)
 _loadFromDb ()
 _ppLoadFullCategory ($sId)
 _ppRemoveInactiveCategories ()
 _ppAddPathInfo ()
 _ppAddContentCategories ()
 _ppBuildTree ()
 _ppAddDepthInformation ()
 _addDepthInfo ($aTree, $oCat, $sDepth="")
 _updateNodes ($oxRootId, $isRoot, $thisRoot)
- Protected Member Functions inherited from oxList
 _assignElement ($oListObject, $aDbFields)
 _getFieldLongName ($sFieldName)

Protected Attributes

 $_sObjectsInListName = 'oxcategory'
 $_blHideEmpty = false
 $_blForceFull = false
 $_iForceLevel = 2
 $_sActCat = null
 $_aPath = array()
 $_aUpdateInfo = array()
- Protected Attributes inherited from oxList
 $_aArray = array()
 $_blRemovedActive = false
 $_sObjectsInListName = 'oxBase'
 $_sCoreTable = null
 $_sShopID = null
 $_aSqlLimit = array()

Additional Inherited Members

- Static Protected Attributes inherited from oxSuperCfg
static $_oConfig = null
static $_oSession = null
static $_oRights = null
static $_oActUser = null
static $_blIsAdmin = null

Detailed Description

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

Definition at line 10 of file oxcategorylist.php.

Constructor & Destructor Documentation

oxCategoryList::__construct (   $sObjectsInListName = 'oxcategory')

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

Parameters
string$sObjectsInListNameoptional parameter, the objects contained in the list, always oxCategory
Returns
null

Reimplemented from oxList.

Definition at line 69 of file oxcategorylist.php.

Member Function Documentation

oxCategoryList::__get (   $sName)

Extra getter to guarantee compatibility with templates

Parameters
string$sNamevariable name
Returns
string

Reimplemented from oxList.

Definition at line 632 of file oxcategorylist.php.

oxCategoryList::_addDepthInfo (   $aTree,
  $oCat,
  $sDepth = "" 
)
protected

Recursive function to add depth information

Parameters
array$aTreenew category tree
object$oCatcategory object
string$sDepthstring to show category depth
Returns
array $aTree

Definition at line 527 of file oxcategorylist.php.

oxCategoryList::_getDepthSqlSnippet (   $oCat)
protected

constructs the sql snippet responsible for depth optimizations, loads only selected category's siblings

Parameters
oxCategory$oCatselected category
Returns
string

Definition at line 199 of file oxcategorylist.php.

oxCategoryList::_getDepthSqlUnion (   $oCat,
  $aColumns = null 
)
protected

returns sql snippet for union of select category's and its upper level siblings of the same root (siblings of the category, and parents and grandparents etc)

Parameters
oxCategory$oCatcurrent category object
array$aColumnsrequired column names (optional)
Returns
string

Definition at line 235 of file oxcategorylist.php.

oxCategoryList::_getSelectString (   $blReverse = false,
  $aColumns = null,
  $sOrder = null 
)
protected

constructs the sql string to get the category list

Parameters
bool$blReverselist loading order, true for tree, false for simple list (optional, default false)
array$aColumnsrequired column names (optional)
string$sOrderorder by string (optional)
Returns
string

Definition at line 163 of file oxcategorylist.php.

oxCategoryList::_getSqlSelectFieldsForTree (   $sTable,
  $aColumns = null 
)
protected

return fields to select while loading category tree

Parameters
string$sTabletable name
array$aColumnsrequired column names (optional)
Returns
string return

Definition at line 128 of file oxcategorylist.php.

oxCategoryList::_loadFromDb ( )
protected

Get data from db

Returns
array

Definition at line 258 of file oxcategorylist.php.

oxCategoryList::_ppAddContentCategories ( )
protected

Category list postprocessing routine, responsible adding of content categories

Definition at line 460 of file oxcategorylist.php.

oxCategoryList::_ppAddDepthInformation ( )
protected

Category list postprocessing routine, responsible for making flat category tree and adding depth information. Requires reversed category list!

Definition at line 498 of file oxcategorylist.php.

oxCategoryList::_ppAddPathInfo ( )
protected

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

Returns
null

Definition at line 438 of file oxcategorylist.php.

oxCategoryList::_ppBuildTree ( )
protected

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

Definition at line 477 of file oxcategorylist.php.

oxCategoryList::_ppLoadFullCategory (   $sId)
protected

set full category object in tree

Parameters
string$sIdcategory id

Definition at line 319 of file oxcategorylist.php.

oxCategoryList::_ppRemoveInactiveCategories ( )
protected

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

Definition at line 398 of file oxcategorylist.php.

oxCategoryList::_updateNodes (   $oxRootId,
  $isRoot,
  $thisRoot 
)
protected

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

Parameters
string$oxRootIdrootid of tree
bool$isRootis the current node root?
string$thisRootthe id of the root

Definition at line 590 of file oxcategorylist.php.

oxCategoryList::buildTree (   $sActCat)

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

Parameters
string$sActCatActive category (default null)

Definition at line 285 of file oxcategorylist.php.

oxCategoryList::getClickCat ( )

Getter for active category

Returns
oxCategory

Definition at line 376 of file oxcategorylist.php.

oxCategoryList::getClickRoot ( )

Getter for active root category

Returns
array of oxCategory

Definition at line 388 of file oxcategorylist.php.

oxCategoryList::getLoadFull ( )

Return true if load full tree

Returns
boolean

Definition at line 90 of file oxcategorylist.php.

oxCategoryList::getLoadLevel ( )

Returns tree load level

Returns
integer

Definition at line 115 of file oxcategorylist.php.

oxCategoryList::getPath ( )

Getter for active category path

Returns
array

Definition at line 366 of file oxcategorylist.php.

oxCategoryList::getUpdateInfo ( )

Returns update log data array

Returns
array

Definition at line 578 of file oxcategorylist.php.

oxCategoryList::load ( )

Load category list data

Definition at line 269 of file oxcategorylist.php.

oxCategoryList::loadList ( )

Fetches raw categories and does postprocessing for adding depth information

Definition at line 335 of file oxcategorylist.php.

oxCategoryList::setLoadFull (   $blForceFull)

Set how to load tree true - for full tree

Parameters
boolean$blForceFull- true to load full

Definition at line 80 of file oxcategorylist.php.

oxCategoryList::setLoadLevel (   $iForceLevel)

Set tree level 1- load root or 2 - root and second level

Parameters
int$iForceLevel- level number

Definition at line 100 of file oxcategorylist.php.

oxCategoryList::setShopID (   $sShopID)

setter for shopID

Parameters
int$sShopIDShopID

Definition at line 356 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$blVerboseSet to true for output the update status for user,
string$sShopIDthe shop id

Definition at line 548 of file oxcategorylist.php.

Member Data Documentation

oxCategoryList::$_aPath = array()
protected

Definition at line 53 of file oxcategorylist.php.

oxCategoryList::$_aUpdateInfo = array()
protected

Definition at line 60 of file oxcategorylist.php.

oxCategoryList::$_blForceFull = false
protected

Definition at line 32 of file oxcategorylist.php.

oxCategoryList::$_blHideEmpty = false
protected

Definition at line 25 of file oxcategorylist.php.

oxCategoryList::$_iForceLevel = 2
protected

Definition at line 39 of file oxcategorylist.php.

oxCategoryList::$_sActCat = null
protected

Definition at line 46 of file oxcategorylist.php.

oxCategoryList::$_sObjectsInListName = 'oxcategory'
protected

Definition at line 18 of file oxcategorylist.php.


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