Difference between revisions of "JCategoryNode"
From Joomla! Documentation
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JCategoryNode== | ||
| + | ===Description=== | ||
| + | {{Description:JCategoryNode}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JCategoryNode|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JCategoryNode|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::__construct/11.1|__construct]] | |[[JCategoryNode::__construct/11.1|__construct]] | ||
|Class constructor. | |Class constructor. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::addChild/11.1|addChild]] | |[[JCategoryNode::addChild/11.1|addChild]] | ||
|Add child to this node. | |Add child to this node. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::getAuthor/11.1|getAuthor]] | |[[JCategoryNode::getAuthor/11.1|getAuthor]] | ||
|Returns the user that authored the category. | |Returns the user that authored the category. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::getChildren/11.1|getChildren]] | |[[JCategoryNode::getChildren/11.1|getChildren]] | ||
|Get the children of this node. | |Get the children of this node. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::getMetadata/11.1|getMetadata]] | |[[JCategoryNode::getMetadata/11.1|getMetadata]] | ||
|Returns the category metadata. | |Returns the category metadata. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::getNumItems/11.1|getNumItems]] | |[[JCategoryNode::getNumItems/11.1|getNumItems]] | ||
| | | | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::getParams/11.1|getParams]] | |[[JCategoryNode::getParams/11.1|getParams]] | ||
|Returns the category parameters. | |Returns the category parameters. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::getParent/11.1|getParent]] | |[[JCategoryNode::getParent/11.1|getParent]] | ||
|Get the parent of this node. | |Get the parent of this node. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::getPath/11.1|getPath]] | |[[JCategoryNode::getPath/11.1|getPath]] | ||
|Returns the category path to the root category. | |Returns the category path to the root category. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::getSibling/11.1|getSibling]] | |[[JCategoryNode::getSibling/11.1|getSibling]] | ||
|Returns the right or left sibling of a category. | |Returns the right or left sibling of a category. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::hasChildren/11.1|hasChildren]] | |[[JCategoryNode::hasChildren/11.1|hasChildren]] | ||
|Test if this node has children. | |Test if this node has children. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::hasParent/11.1|hasParent]] | |[[JCategoryNode::hasParent/11.1|hasParent]] | ||
|Test if this node has a parent. | |Test if this node has a parent. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::removeChild/11.1|removeChild]] | |[[JCategoryNode::removeChild/11.1|removeChild]] | ||
|Remove a specific child. | |Remove a specific child. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::setAllLoaded/11.1|setAllLoaded]] | |[[JCategoryNode::setAllLoaded/11.1|setAllLoaded]] | ||
| | | | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::setParent/11.1|setParent]] | |[[JCategoryNode::setParent/11.1|setParent]] | ||
|Set the parent of this category. | |Set the parent of this category. | ||
|- | |- | ||
| + | |public | ||
|[[JCategoryNode::setSibling/11.1|setSibling]] | |[[JCategoryNode::setSibling/11.1|setSibling]] | ||
|Function to set the left or right sibling of a category. | |Function to set the left or right sibling of a category. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/application/categories.php | ||
| + | * '''Extends''' [[JObject/11.1|JObject]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.application.categories' );</source> | <source lang="php">jimport( 'joomla.application.categories' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JCategoryNode source code | + | * {{JVer|11.1}} '''JCategoryNode source code''' on [[jplatform:application/categories.php|BitBucket]] |
| − | * [[JCategoryNode|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Application/11.1|Application]] |
| + | * [[JCategoryNode|Other versions of JCategoryNode]] | ||
{{SeeAlso:JCategoryNode}} | {{SeeAlso:JCategoryNode}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JCategoryNode|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JCategoryNode|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 84: | Line 98: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JCategoryNode]]</noinclude> | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JCategoryNode]]</noinclude> | ||
Revision as of 17:57, 27 April 2011
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JCategoryNode[edit]
Description[edit]
Template:Description:JCategoryNode [Edit Descripton]
Methods[edit]
| Visibility | Method name | Description |
|---|---|---|
| public | __construct | Class constructor. |
| public | addChild | Add child to this node. |
| public | getAuthor | Returns the user that authored the category. |
| public | getChildren | Get the children of this node. |
| public | getMetadata | Returns the category metadata. |
| public | getNumItems | |
| public | getParams | Returns the category parameters. |
| public | getParent | Get the parent of this node. |
| public | getPath | Returns the category path to the root category. |
| public | getSibling | Returns the right or left sibling of a category. |
| public | hasChildren | Test if this node has children. |
| public | hasParent | Test if this node has a parent. |
| public | removeChild | Remove a specific child. |
| public | setAllLoaded | |
| public | setParent | Set the parent of this category. |
| public | setSibling | Function to set the left or right sibling of a category. |
- Defined in libraries/joomla/application/categories.php
- Extends JObject
Importing[edit]
jimport( 'joomla.application.categories' );See also[edit]
- JCategoryNode source code on BitBucket
- Subpackage Application
- Other versions of JCategoryNode
Template:SeeAlso:JCategoryNode [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />