JCategories/get: Difference between revisions
From Joomla! Documentation
m removing red link to edit, no existant pages |
m clean up |
||
| Line 2: | Line 2: | ||
Loads a specific category and all its children in a JCategoryNode object | Loads a specific category and all its children in a JCategoryNode object | ||
<! removed transcluded page call, red link never existed > | <! removed transcluded page call, red link never existed > | ||
| Line 55: | Line 53: | ||
</source> | </source> | ||
<! removed transcluded page call, red link never existed > | <! removed transcluded page call, red link never existed > | ||
Revision as of 13:44, 24 March 2017
Description
Loads a specific category and all its children in a JCategoryNode object
<! removed transcluded page call, red link never existed >
Syntax
get($id='root', $options=array())
| Parameter Name | Default Value | Description |
|---|---|---|
| $id | 'root' | optional id integer or equal to 'root' |
| $options | array() | optional array of boolean options (all set to true by default). 'load' to force loading 'children' to get its direct children, 'parent' to get its direct parent, 'siblings' to get its siblings 'ascendants' to get its ascendants 'descentants' to get its descendants 'level-min' to get nodes from this level 'level-max' to get nodes until this level |
Returns
JCategoryNode|null
Defined in
libraries/joomla/application/categories.php
Importing
jimport( 'joomla.application.categories' );
Source Body
public function get($id='root',$options=array())
{
if ($id != 'root')
{
$id = (int) $id;
if ($id == 0)
{
return null;
}
}
if (!isset($this->_nodes[$id]) || !isset($options['load']) || $options['load'])
{
$this->_load($id,$options);
}
return $this->node($id);
}
<! removed transcluded page call, red link never existed >
Examples
<CodeExamplesForm />
need more info
===Description===
Loads a specific category and all its children in a JCategoryNode object
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax
get($id)
| Parameter Name | Default Value | Description |
|---|---|---|
| $id |
Returns
Defined in
libraries/joomla/application/categories.php
Importing
jimport( 'joomla.application.categories' );
Source Body
public function get($id)
{
$id = (int) $id;
if ($id == 0)
{
return false;
}
if (!isset($this->_nodes[$id]))
{
$this->_load($id);
}
if ($this->_nodes[$id] instanceof JCategoryNode)
{
return $this->_nodes[$id];
} else {
throw new JException('Unable to load category: '.$id, 0000, E_ERROR, $info, true);
}
}
[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples
Code Examples
need more info
hi, I am trying to use this go get all the subcategories of a certain category jimport('joomla.application.categories'); $categories = new JCategories('com_content'); print_r($categories); $subCategories = $categories->get(78); print_r($subCategories);
but this gives: JCategories Object ( [_nodes:protected] => [_checkedCategories:protected] => [_extension:protected] => c [_table:protected] => c [_field:protected] => c [_key:protected] => c [_statefield:protected] => c [_options:protected] => com_jumi ) subs:
So my guess is I can't acces the nessacary data because it is protected... any help?
hi, I am trying to use this go get all the subcategories of a certain category jimport('joomla.application.categories'); $categories = new JCategories('com_content'); print_r($categories); $subCategories = $categories->get(78); print_r($subCategories);
but this gives: JCategories Object ( [_nodes:protected] => [_checkedCategories:protected] => [_extension:protected] => c [_table:protected] => c [_field:protected] => c [_key:protected] => c [_statefield:protected] => c [_options:protected] => com_jumi ) subs:
So my guess is I can't acces the nessacary data because it is protected... any help?