oxCategory Class Reference

Inheritance diagram for oxCategory:

[legend]

Collaboration diagram for oxCategory:

[legend]

List of all members.

---

Detailed Description

Category manager. Collects category information (articles, etc.), performs insertion/deletion of categories nodes. By recursion methods are set structure of category.

Public Member Functions
	__construct ()
	__get ($sName)
	assign ($dbRecord)
	delete ($sOXID=null)
	getSubCats ()
	getSubCat ($sKey)
	setSubCats ($aCats)
	setSubCat ($oCat, $sKey=null)
	sortSubCats ()
	getContentCats ()
	setContentCats ($aContent)
	setContentCat ($oContent, $sKey=null)
	cmpCat ($a, $b)
	getNrOfArticles ()
	setNrOfArticles ($iNum)
	getIsVisible ()
	setIsVisible ($blVisible)
	getPictureUrl ()
	getLink ($iLang=null)
	setLink ($sLink)
	getSqlActiveSnippet ($blForceCoreTable=false)
	getStdLink ($iLang=null)
	getExpanded ()
	setExpanded ($blExpanded)
	getHasSubCats ()
	getHasVisibleSubCats ()
	setHasVisibleSubCats ($blHasVisibleSubcats)
	getAttributes ()
	getCatInLang ($oActCategory=null)
	setParentCategory ($oCategory)
	getParentCategory ()
	assignViewableRecord ($sSelect)
Static Public Member Functions
static	getRootId ($sCategoryId)
Protected Member Functions
	_insert ()
	_update ()
	_setFieldData ($sFieldName, $sValue, $iDataType=oxField::T_TEXT)
Protected Attributes
	$_aSubCats = array()
	$_aContentCats = array()
	$_sClassName = 'oxcategory'
	$_iNrOfArticles
	$_blIsVisible
	$_blExpanded
	$_blHasSubCats
	$_blHasVisibleSubCats
	$_blIsSeoObject = true
	$_blUseLazyLoading = false
	$_sDynImageDir = null

---

Constructor & Destructor Documentation

oxCategory.__construct

(

)

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

Reimplemented from oxI18n.

---

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.

oxCategory.assign

(

$

dbRecord

)

Loads and assigns object data from DB.

Parameters:

mixed

$dbRecord database record array

Returns:

null

Reimplemented from oxI18n.

oxCategory.delete

(

$

sOXID = null

)

Delete empty categories, returns true on success.

Parameters:

string

$sOXID Object ID

Returns:

bool

Reimplemented from oxBase.

oxCategory.getSubCats

(

)

returns the sub category array

Returns:

array

oxCategory.getSubCat

(

$

sKey

)

returns a specific sub categpory

Parameters:

string

$sKey the key of the category

Returns:

object

oxCategory.setSubCats

(

$

aCats

)

Sets an array of sub cetegories, handles sorting and parent hasVisibleSubCats

Parameters:

array

$aCats array of categories

Returns:

null

oxCategory.setSubCat	(	$	oCat,
		$	sKey = null
	)

sets a single category, handles sorting and parent hasVisibleSubCats

Parameters:

	oxcategory	$oCat the category
	string	$sKey optional, the key for that category, without a key, the category isjust added to the array

Returns:

null

oxCategory.sortSubCats

(

)

Sorts sub categories

Returns:

null

oxCategory.getContentCats

(

)

returns the content category array

Returns:

array

oxCategory.setContentCats

(

$

aContent

)

Sets an array of content cetegories

Parameters:

array

$aContent array of content

Returns:

null

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

oxCategory.cmpCat	(	$	a,
		$	b
	)

categry sorting callback function

Parameters:

	oxcategory	$a first category
	oxcategory	$b second category

Returns:

integer

oxCategory.getNrOfArticles

(

)

returns number or articles in category

Returns:

integer

oxCategory.setNrOfArticles

(

$

iNum

)

sets the number or articles in category

Parameters:

int

$iNum category product count setter

Returns:

null

oxCategory.getIsVisible

(

)

returns the visibility of a category, handles hidden and empty categories

Returns:

bool

oxCategory.setIsVisible

(

$

blVisible

)

sets the visibilty of a category

Parameters:

bool

$blVisible category visibility status setter

Returns:

null

oxCategory.getPictureUrl

(

)

Returns dyn image dir

Returns:

string

oxCategory.getLink

(

$

iLang = null

)

returns the url of the category

Returns:

string

oxCategory.setLink

(

$

sLink

)

returns the url of the category

Parameters:

string

$sLink

Returns:

null

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.

oxCategory.getStdLink

(

$

iLang = null

)

Returns standard URL to category

Returns:

string

oxCategory.getExpanded

(

)

returns the expanded state of the category

Returns:

bool

oxCategory.setExpanded

(

$

blExpanded

)

setsthe expanded state of the category

Parameters:

bool

$blExpanded expanded status setter

Returns:

null

oxCategory.getHasSubCats

(

)

returns if a category has sub categories

Returns:

bool

oxCategory.getHasVisibleSubCats

(

)

returns if a category has visible sub categories

Returns:

bool

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

oxCategory.getAttributes

(

)

Loads and returns attribute list associated with this category

Returns:

array

oxCategory.getCatInLang

(

$

oActCategory = null

)

Loads and returns category in base language

Parameters:

object

$oActCategory active category

Returns:

object

oxCategory.setParentCategory

(

$

oCategory

)

Parent category setter

Parameters:

oxcategory

$oCategory parent category object

Returns:

null

oxCategory.getParentCategory

(

)

Returns parent category object for current category (is it is available)

Returns:

oxcategory

static oxCategory.getRootId

(

$

sCategoryId

)

[static]

Returns root category id of a child category

Parameters:

string

$sCategoryId category id

Returns:

integer

oxCategory.assignViewableRecord

(

$

sSelect

)

Before assigning the record from SQL it checks for viewable rights

Parameters:

string

$sSelect SQL select

Returns:

bool

oxCategory._insert

(

)

[protected]

Inserts new category (and updates existing node oxleft amd oxright accordingly). Returns true on success.

Returns:

bool

Reimplemented from oxBase.

oxCategory._update

(

)

[protected]

Updates category tree, returns true on success.

Returns:

bool

Reimplemented from oxI18n.

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.

---

Member Data Documentation

oxCategory.$_aSubCats = array() [protected]

oxCategory.$_aContentCats = array() [protected]

oxCategory.$_sClassName = 'oxcategory' [protected]

Reimplemented from oxI18n.

oxCategory.$_iNrOfArticles [protected]

oxCategory.$_blIsVisible [protected]

oxCategory.$_blExpanded [protected]

oxCategory.$_blHasSubCats [protected]

oxCategory.$_blHasVisibleSubCats [protected]

oxCategory.$_blIsSeoObject = true [protected]

Reimplemented from oxBase.

oxCategory.$_blUseLazyLoading = false [protected]

Reimplemented from oxBase.

oxCategory.$_sDynImageDir = null [protected]

---

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

• core/oxcategory.php