Class JCategories

Description

JCategories Class.

  • since: 11.1

Located in /libraries/joomla/application/categories.php (line 19)


	
			
Direct descendents
Class Description
NewsfeedsCategories Content Component Category Tree
WeblinksCategories Weblinks Component Category Tree
ContactCategories Contact Component Category Tree
ContentCategories Content Component Category Tree
BannersCategories Banners Component Category Tree
Variable Summary
static array $instances
string $_extension
string $_field
string $_key
mixed $_nodes
array $_options
string $_statefield
string $_table
Method Summary
static JCategories getInstance (string $extension, [array $options = array()])
JCategories __construct (array $options)
mixed get ([mixed $id = 'root'], [boolean $forceload = false])
void _load (integer $id)
Variables
static array $instances = array() (line 27)

Array to hold the object instances

  • since: 11.1
  • access: public
array $_checkedCategories (line 43)

Array of checked categories -- used to save values when _nodes are null

  • since: 11.1
  • access: protected
string $_extension = null (line 51)

Name of the extension the categories belong to

  • since: 11.1
  • access: protected
string $_field = null (line 67)

Name of the category field

  • since: 11.1
  • access: protected
string $_key = null (line 75)

Name of the key field

  • since: 11.1
  • access: protected
mixed $_nodes (line 35)

Array of category nodes

  • since: 11.1
  • access: protected
array $_options = null (line 91)

Array of options

  • since: 11.1
  • access: protected
string $_statefield = null (line 83)

Name of the items state field

  • since: 11.1
  • access: protected
string $_table = null (line 59)

Name of the linked content table to get category content count

  • since: 11.1
  • access: protected
Methods
static method getInstance (line 124)

Returns a reference to a JCategories object

  • return: JCategories object
  • since: 11.1
  • access: public
static JCategories getInstance (string $extension, [array $options = array()])
  • string $extension: Name of the categories extension
  • array $options: An array of options
Constructor __construct (line 100)

Class constructor

  • since: 11.1
  • access: public
JCategories __construct (array $options)
  • array $options: Array of options

Redefined in descendants as:
get (line 166)

Loads a specific category and all its children in a JCategoryNode object

  • return: JCategoryNode object or null if $id is not valid
  • since: 11.1
  • access: public
mixed get ([mixed $id = 'root'], [boolean $forceload = false])
  • mixed $id: an optional id integer or equal to 'root'
  • boolean $forceload: True to force the _load method to execute
_load (line 207)

Load method

  • since: 11.1
  • access: protected
void _load (integer $id)
  • integer $id: Id of category to load

Documentation generated on Mon, 25 Jun 2012 13:52:44 -0500 by phpDocumentor 1.4.4