JCategories
JCategories Class.
package |
Joomla.Platform |
---|---|
subpackage |
Application |
since |
11.1 |
Methods
__construct
Class constructor
__construct(array $options)
since |
11.1 |
---|
Arguments
- $options
array
Array of options
_load
Load method
_load(integer $id) : void
since |
11.1 |
---|
Arguments
- $id
integer
Id of category to load
get
Loads a specific category and all its children in a JCategoryNode object
get(mixed $id = 'root', boolean $forceload = false) : mixed
since |
11.1 |
---|
Arguments
- $id
mixed
an optional id integer or equal to 'root'- $forceload
boolean
True to force the _load method to execute
Response
mixed
JCategoryNode object or null if $id is not valid
getInstance
Returns a reference to a JCategories object
getInstance(string $extension, array $options = array()) : \JCategories
since |
11.1 |
---|
Arguments
- $extension
string
Name of the categories extension- $options
array
An array of options
Response
\JCategories
JCategories object
Properties
instances
Array to hold the object instances
since |
11.1 |
---|
Type(s)
array
_nodes
Array of category nodes
since |
11.1 |
---|
Type(s)
mixed
_checkedCategories
Array of checked categories -- used to save values when _nodes are null
since |
11.1 |
---|
Type(s)
array
_extension
Name of the extension the categories belong to
since |
11.1 |
---|
Type(s)
string
_table
Name of the linked content table to get category content count
since |
11.1 |
---|
Type(s)
string
_field
Name of the category field
since |
11.1 |
---|
Type(s)
string
_key
Name of the key field
since |
11.1 |
---|
Type(s)
string
_statefield
Name of the items state field
since |
11.1 |
---|
Type(s)
string
_options
Array of options
since |
11.1 |
---|
Type(s)
array