[class tree: bigace-classes] [index: bigace-classes] [all elements]

Class: Category

Source Location: /CORE/system/classes/category/Category.php

Class Category

Class Overview

A Category within BIGACE.

Categories are used to be linked to Items to build any kind of meta-structure.

Located in /CORE/system/classes/category/Category.php [line 38]

Author(s):

Kevin Papst

Information Tags:

Version:	$Id: Category.php,v 1.7 2007/01/08 22:51:42 kpapst Exp $
Copyright:	Copyright (C) 2002-2006 Kevin Papst
License:	GNU Public License

Methods

[ Top ]

Descendants

Child Class	Description
DBCategory	This represents a Category that is initialized with an value array.

[ Top ]

Method Summary

Category	Category()	This intializes the Object with the given Category ID
int	countChilds()	Counts the amount of children for this Category.
CategoryTreeWalker	getChildEnumeration()	Alias for getChilds().
CategoryTreeWalker	getChilds()	Get the childs of this Category.
void	getDescription()
int	getID()	Gets the ID of the current Category
String	getName()	Returns the Name of the Category.
Category	getParent()	Returns the Parent Category or null if this is the TOP LEVEL Category.
void	getParentID()
boolean	hasChilds()	Returns if this Category has Children.

[ Top ]

Methods

Constructor Category [line 50]

Category Category(
int
$id 
)

This intializes the Object with the given Category ID

Parameters:

int

$id:

the Category ID

[ Top ]

countChilds [line 132]

int countChilds(
)

Counts the amount of children for this Category.

API Tags:

Return:

the amount of children

[ Top ]

getChildEnumeration [line 124]

CategoryTreeWalker getChildEnumeration(
)

Alias for getChilds().

API Tags:

Return:	the children of this Category
Deprecated:	use getChilds() instead

[ Top ]

getChilds [line 115]

CategoryTreeWalker getChilds(
)

Get the childs of this Category.

API Tags:

Return:

the children of this Category

[ Top ]

getDescription [line 85]

void getDescription(
)

[ Top ]

getID [line 72]

int getID(
)

Gets the ID of the current Category

API Tags:

Return:

the ID

[ Top ]

getName [line 80]

String getName(
)

Returns the Name of the Category.

API Tags:

Return:

the Category Name

[ Top ]

getParent [line 97]

Category getParent(
)

Returns the Parent Category or null if this is the TOP LEVEL Category.

API Tags:

Return:

the Parent Category or null

[ Top ]

getParentID [line 89]

void getParentID(
)

[ Top ]

hasChilds [line 146]

boolean hasChilds(
)

Returns if this Category has Children.

API Tags:

Return:

whether this Category has Children or not

[ Top ]