oxCategory Class Reference
Detailed Description
Category manager. Collects category information (articles, etc.), performs insertion/deletion of categories nodes. By recursion methods are set structure of category.Definition at line 8 of file oxcategory.php.
Constructor & Destructor Documentation
| oxCategory.__construct | ( | ) |
Class constructor, initiates parent constructor (parent.oxI18n()).
Reimplemented from oxI18n.
Definition at line 102 of file oxcategory.php.
Member Function Documentation
| oxCategory.__get | ( | $ | sName | ) |
Extra getter to guarantee compatibility with templates
- Parameters:
-
string $sName name of variable to get
- Returns:
- unknown
Reimplemented from oxBase.
Definition at line 115 of file oxcategory.php.
| oxCategory.assign | ( | $ | dbRecord | ) |
Loads and assigns object data from DB.
- Parameters:
-
mixed $dbRecord database record array
- Returns:
- null
Reimplemented from oxI18n.
Definition at line 160 of file oxcategory.php.
| oxCategory.delete | ( | $ | sOXID = null |
) |
Delete empty categories, returns true on success.
- Parameters:
-
string $sOXID Object ID
- Returns:
- bool
Reimplemented from oxBase.
Definition at line 193 of file oxcategory.php.
| oxCategory.getSubCats | ( | ) |
| oxCategory.getSubCat | ( | $ | sKey | ) |
returns a specific sub categpory
- Parameters:
-
string $sKey the key of the category
- Returns:
- object
Definition at line 261 of file oxcategory.php.
| oxCategory.setSubCats | ( | $ | aCats | ) |
Sets an array of sub cetegories, handles sorting and parent hasVisibleSubCats
- Parameters:
-
array $aCats array of categories
- Returns:
- null
Definition at line 273 of file oxcategory.php.
| oxCategory.setSubCat | ( | $ | oCat, | |
| $ | sKey = null, |
|||
| $ | blSkipSorting = false | |||
| ) |
sets a single category, handles sorting and parent hasVisibleSubCats
- Parameters:
-
oxcategory $oCat the category string $sKey (optional, default=null) the key for that category, without a key, the category isjust added to the array boolean $blSkipSorting (optional, default=false) should we skip sorting now?
- Returns:
- null
Definition at line 295 of file oxcategory.php.
| oxCategory.sortSubCats | ( | ) |
| oxCategory.cmpCat | ( | $ | a, | |
| $ | b | |||
| ) |
categry sorting callback function, $_aIds array will be set with function oxcategory.setSortingIds() and generated in oxcategorylist.sortCats()
- Parameters:
-
oxcategory $a first category oxcategory $b second category
- Returns:
- integer
Definition at line 336 of file oxcategory.php.
| oxCategory.setSortingIds | ( | $ | aSorIds | ) |
categry sorted array
- Parameters:
-
array $aSorIds sorted category array
- Returns:
- null
Definition at line 360 of file oxcategory.php.
| oxCategory.getContentCats | ( | ) |
| oxCategory.setContentCats | ( | $ | aContent | ) |
Sets an array of content cetegories
- Parameters:
-
array $aContent array of content
- Returns:
- null
Definition at line 382 of file oxcategory.php.
| oxCategory.setContentCat | ( | $ | oContent, | |
| $ | sKey = null | |||
| ) |
sets a single category
- Parameters:
-
oxcategory $oContent the category string $sKey optional, the key for that category, without a key, the category isjust added to the array
- Returns:
- null
Definition at line 395 of file oxcategory.php.
| oxCategory.getNrOfArticles | ( | ) |
returns number or articles in category
- Returns:
- integer
Definition at line 409 of file oxcategory.php.
| oxCategory.setNrOfArticles | ( | $ | iNum | ) |
sets the number or articles in category
- Parameters:
-
int $iNum category product count setter
- Returns:
- null
Definition at line 425 of file oxcategory.php.
| oxCategory.getIsVisible | ( | ) |
returns the visibility of a category, handles hidden and empty categories
- Returns:
- bool
Definition at line 435 of file oxcategory.php.
| oxCategory.setIsVisible | ( | $ | blVisible | ) |
sets the visibilty of a category
- Parameters:
-
bool $blVisible category visibility status setter
- Returns:
- null
Definition at line 458 of file oxcategory.php.
| oxCategory.getPictureUrl | ( | ) |
| oxCategory.getLink | ( | $ | iLang = null |
) |
returns the url of the category
- Parameters:
-
int $iLang language
- Returns:
- string
Definition at line 484 of file oxcategory.php.
| oxCategory.setLink | ( | $ | sLink | ) |
sets the url of the category
- Parameters:
-
string $sLink category url
- Returns:
- null
Definition at line 517 of file oxcategory.php.
| oxCategory.getSqlActiveSnippet | ( | $ | blForceCoreTable = false |
) |
Returns SQL select string with checks if items are available
- Parameters:
-
bool $blForceCoreTable forces core table usage (optional)
- Returns:
- string
Reimplemented from oxI18n.
Definition at line 529 of file oxcategory.php.
| oxCategory.getStdLink | ( | $ | iLang = null |
) |
Returns standard URL to category
- Parameters:
-
int $iLang language
- Returns:
- string
Definition at line 547 of file oxcategory.php.
| oxCategory.getExpanded | ( | ) |
returns the expanded state of the category
- Returns:
- bool
Definition at line 571 of file oxcategory.php.
| oxCategory.setExpanded | ( | $ | blExpanded | ) |
setsthe expanded state of the category
- Parameters:
-
bool $blExpanded expanded status setter
- Returns:
- null
Definition at line 588 of file oxcategory.php.
| oxCategory.getHasSubCats | ( | ) |
returns if a category has sub categories
- Returns:
- bool
Definition at line 598 of file oxcategory.php.
| oxCategory.getHasVisibleSubCats | ( | ) |
returns if a category has visible sub categories
- Returns:
- bool
Definition at line 612 of file oxcategory.php.
| oxCategory.setHasVisibleSubCats | ( | $ | blHasVisibleSubcats | ) |
sets the state of has visible sub categories for the category
- Parameters:
-
bool $blHasVisibleSubcats marker if category has visible subcategories
- Returns:
- null
Definition at line 628 of file oxcategory.php.
| oxCategory.getAttributes | ( | ) |
Loads and returns attribute list associated with this category
- Returns:
- array
Definition at line 638 of file oxcategory.php.
| oxCategory.getCatInLang | ( | $ | oActCategory = null |
) |
Loads and returns category in base language
- Parameters:
-
object $oActCategory active category
- Returns:
- object
Definition at line 708 of file oxcategory.php.
| oxCategory.setParentCategory | ( | $ | oCategory | ) |
Parent category setter
- Parameters:
-
oxcategory $oCategory parent category object
- Returns:
- null
Definition at line 729 of file oxcategory.php.
| oxCategory.getParentCategory | ( | ) |
Returns parent category object for current category (is it is available)
- Returns:
- oxcategory
Definition at line 739 of file oxcategory.php.
| static oxCategory.getRootId | ( | $ | sCategoryId | ) | [static] |
Returns root category id of a child category
- Parameters:
-
string $sCategoryId category id
- Returns:
- integer
Definition at line 766 of file oxcategory.php.
| oxCategory.assignViewableRecord | ( | $ | sSelect | ) |
Before assigning the record from SQL it checks for viewable rights
- Parameters:
-
string $sSelect SQL select
- Returns:
- bool
Definition at line 783 of file oxcategory.php.
| oxCategory._insert | ( | ) | [protected] |
Inserts new category (and updates existing node oxleft amd oxright accordingly). Returns true on success.
- Returns:
- bool
Reimplemented from oxBase.
Definition at line 798 of file oxcategory.php.
| oxCategory._update | ( | ) | [protected] |
Updates category tree, returns true on success.
- Returns:
- bool
Reimplemented from oxI18n.
Definition at line 855 of file oxcategory.php.
| oxCategory._setFieldData | ( | $ | sFieldName, | |
| $ | sValue, | |||
| $ | iDataType = oxField::T_TEXT | |||
| ) | [protected] |
Sets data field value
- Parameters:
-
string $sFieldName index OR name (eg. 'oxarticles__oxtitle') of a data field to set string $sValue value of data field int $iDataType field type
- Returns:
- null
Reimplemented from oxBase.
Definition at line 961 of file oxcategory.php.
| oxCategory.getIconUrl | ( | ) |
| oxCategory.isTopCategory | ( | ) |
Returns true is category parent id is 'oxrootid'
- Returns:
- bool
Definition at line 988 of file oxcategory.php.
| oxCategory.isPriceCategory | ( | ) |
Returns true if current category is price type ( ( oxpricefrom || oxpriceto ) > 0 )
- Returns:
- bool
Definition at line 1001 of file oxcategory.php.
Member Data Documentation
oxCategory.$_aSubCats = array() [protected] |
Definition at line 14 of file oxcategory.php.
oxCategory.$_aContentCats = array() [protected] |
Definition at line 20 of file oxcategory.php.
oxCategory.$_sClassName = 'oxcategory' [protected] |
oxCategory.$_iNrOfArticles [protected] |
Definition at line 34 of file oxcategory.php.
oxCategory.$_blIsVisible [protected] |
Definition at line 41 of file oxcategory.php.
oxCategory.$_blExpanded [protected] |
Definition at line 48 of file oxcategory.php.
oxCategory.$_blHasSubCats [protected] |
Definition at line 55 of file oxcategory.php.
oxCategory.$_blHasVisibleSubCats [protected] |
Definition at line 62 of file oxcategory.php.
oxCategory.$_blIsSeoObject = true [protected] |
oxCategory.$_blUseLazyLoading = false [protected] |
oxCategory.$_sDynImageDir = null [protected] |
Definition at line 83 of file oxcategory.php.
oxCategory.$_blTopCategory = null [protected] |
Definition at line 90 of file oxcategory.php.
oxCategory.$_aIds = array() [protected] |
Definition at line 97 of file oxcategory.php.
The documentation for this class was generated from the following file:
- core/oxcategory.php
