| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
Joomla! Content Management System
| Copyright: | (C) 2017 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 500 lines (11 kb) |
| Included or required: | 0 times |
| Referenced: | 2 times |
| Includes or requires: | 0 files |
CategoryNode:: (10 methods):
__construct()
setParent()
getChildren()
getSibling()
getParams()
getMetadata()
getPath()
getAuthor()
setAllLoaded()
getNumItems()
Class: CategoryNode - X-Ref
Helper class to load Categorytree| __construct($category = null, $constructor = null) X-Ref |
| Class constructor param: array $category The category data. param: Categories $constructor The tree constructor. |
| setParent(NodeInterface $parent) X-Ref |
| Set the parent of this category If the category already has a parent, the link is unset param: CategoryNode|null $parent CategoryNode for the parent to be set or null return: void |
| getChildren($recursive = false) X-Ref |
| Get the children of this node param: boolean $recursive False by default return: CategoryNode[] The children |
| getSibling($right = true) X-Ref |
| Returns the right or left sibling of a category param: boolean $right If set to false, returns the left sibling return: CategoryNode|null CategoryNode object with the sibling information or null if there is no sibling on that side. |
| getParams() X-Ref |
| Returns the category parameters return: Registry |
| getMetadata() X-Ref |
| Returns the category metadata return: Registry A Registry object containing the metadata |
| getPath() X-Ref |
| Returns the category path to the root category return: array |
| getAuthor($modifiedUser = false) X-Ref |
| Returns the user that created the category param: boolean $modifiedUser Returns the modified_user when set to true return: \Joomla\CMS\User\User A User object containing a userid |
| setAllLoaded() X-Ref |
| Set to load all children return: void |
| getNumItems($recursive = false) X-Ref |
| Returns the number of items. param: boolean $recursive If false number of children, if true number of descendants return: integer Number of children or descendants |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |