Class JCategories

JCategories Class.

Package: Joomla\Legacy\Categories
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.6
Located at legacy/categories/categories.php

Methods summary

`public`	# `__construct( array $options )` Class constructor Class constructor Parameters `$options` `array` - $options Array of options Since 1.6
`public static JCategories\|boolean`	# `getInstance( string $extension, array $options = array() )` Returns a reference to a JCategories object Returns a reference to a JCategories object Parameters `$extension` `string` - $extension Name of the categories extension `$options` `array` - $options An array of options Returns `JCategories\|boolean` - JCategories object on success, boolean false if an object does not exist Since 1.6
`public JCategoryNode\|null\|boolean`	# `get( mixed $id = 'root', boolean $forceload = false )` Loads a specific category and all its children in a JCategoryNode object Loads a specific category and all its children in a JCategoryNode object Parameters `$id` `mixed` - $id an optional id integer or equal to 'root' `$forceload` `boolean` - $forceload True to force the _load method to execute Returns `JCategoryNode\|null\|boolean` - JCategoryNode object or null if $id is not valid Since 1.6
`protected`	# `_load( integer $id )` Load method Load method Parameters `$id` `integer` - $id Id of category to load Since 1.6

`public static JCategories[]`	`$instances`	# Array to hold the object instances Array to hold the object instances Since 1.6
`protected JCategoryNode[]`	`$_nodes`	# Array of category nodes Array of category nodes Since 1.6
`protected boolean[]`	`$_checkedCategories`	# Array of checked categories -- used to save values when _nodes are null Array of checked categories -- used to save values when _nodes are null Since 1.6
`protected string`	`$_extension`	# Name of the extension the categories belong to Name of the extension the categories belong to Since 1.6
`protected string`	`$_table`	# Name of the linked content table to get category content count Name of the linked content table to get category content count Since 1.6
`protected string`	`$_field`	# Name of the category field Name of the category field Since 1.6
`protected string`	`$_key`	# Name of the key field Name of the key field Since 1.6
`protected string`	`$_statefield`	# Name of the items state field Name of the items state field Since 1.6
`protected array`	`$_options`	# Array of options Array of options Since 1.6