Class JCategoryNode

Helper class to load Categorytree

JObject

JCategoryNode

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 $category = null, JCategoryNode $constructor = null )` Class constructor Class constructor Parameters `$category` `array` - $category The category data. `$constructor` `JCategoryNode` - $constructor The tree constructor. Since 1.6 Overrides `JObject::__construct`
`public`	# `setParent( JCategoryNode\|null $parent )` Set the parent of this category Set the parent of this category If the category already has a parent, the link is unset Parameters `$parent` `JCategoryNode\|null` - $parent JCategoryNode for the parent to be set or null Since 1.6
`public`	# `addChild( JCategoryNode $child )` Add child to this node Add child to this node If the child already has a parent, the link is unset Parameters `$child` `JCategoryNode` - $child The child to be added. Since 1.6
`public`	# `removeChild( integer $id )` Remove a specific child Remove a specific child Parameters `$id` `integer` - $id ID of a category Since 1.6
`public JCategoryNode[] &`	# `getChildren( boolean $recursive = false )` Get the children of this node Get the children of this node Parameters `$recursive` `boolean` - $recursive False by default Returns `JCategoryNode[]` - The children Since 1.6
`public JCategoryNode`	# `getParent( )` Get the parent of this node Get the parent of this node Returns `JCategoryNode` Since 1.6
`public boolean`	# `hasChildren( )` Test if this node has children Test if this node has children Returns `boolean` - True if there is a child Since 1.6
`public boolean`	# `hasParent( )` Test if this node has a parent Test if this node has a parent Returns `boolean` - True if there is a parent Since 1.6
`public`	# `setSibling( JCategoryNode $sibling, boolean $right = true )` Function to set the left or right sibling of a category Function to set the left or right sibling of a category Parameters `$sibling` `JCategoryNode` - $sibling JCategoryNode object for the sibling `$right` `boolean` - $right If set to false, the sibling is the left one Since 1.6
`public JCategoryNode\|null`	# `getSibling( boolean $right = true )` Returns the right or left sibling of a category Returns the right or left sibling of a category Parameters `$right` `boolean` - $right If set to false, returns the left sibling Returns `JCategoryNode\|null` - JCategoryNode object with the sibling information or null if there is no sibling on that side. Since 1.6
`public Joomla\Registry\Registry`	# `getParams( )` Returns the category parameters Returns the category parameters Returns `Joomla\Registry\Registry` Since 1.6
`public Joomla\Registry\Registry`	# `getMetadata( )` Returns the category metadata Returns the category metadata Returns `Joomla\Registry\Registry` - A Registry object containing the metadata Since 1.6
`public array`	# `getPath( )` Returns the category path to the root category Returns the category path to the root category Returns `array` Since 1.6
`public JUser`	# `getAuthor( boolean $modified_user = false )` Returns the user that created the category Returns the user that created the category Parameters `$modified_user` `boolean` - $modified_user Returns the modified_user when set to true Returns `JUser` - A JUser object containing a userid Since 1.6
`public`	# `setAllLoaded( )` Set to load all children Set to load all children Since 1.6
`public integer`	# `getNumItems( boolean $recursive = false )` Returns the number of items. Returns the number of items. Parameters `$recursive` `boolean` - $recursive If false number of children, if true number of descendants Returns `integer` - Number of children or descendants Since 1.6

Methods inherited from JObject

__toString(), def(), get(), getError(), getErrors(), getProperties(), set(), setError(), setProperties()

Magic methods summary

Properties summary

`public integer`	`$id`	# Primary key Primary key Since 1.6
`public integer`	`$asset_id`	# The id of the category in the asset table The id of the category in the asset table Since 1.6
`public integer`	`$parent_id`	# The id of the parent of category in the asset table, 0 for category root The id of the parent of category in the asset table, 0 for category root Since 1.6
`public integer`	`$lft`	# The lft value for this category in the category tree The lft value for this category in the category tree Since 1.6
`public integer`	`$rgt`	# The rgt value for this category in the category tree The rgt value for this category in the category tree Since 1.6
`public integer`	`$level`	# The depth of this category's position in the category tree The depth of this category's position in the category tree Since 1.6
`public integer`	`$extension`	# The extension this category is associated with The extension this category is associated with Since 1.6
`public string`	`$title`	# The menu title for the category (a short name) The menu title for the category (a short name) Since 1.6
`public string`	`$alias`	# The the alias for the category The the alias for the category Since 1.6
`public string`	`$description`	# Description of the category. Description of the category. Since 1.6
`public boolean`	`$published`	# The publication status of the category The publication status of the category Since 1.6
`public boolean`	`$checked_out`	# Whether the category is or is not checked out Whether the category is or is not checked out Since 1.6
`public string`	`$checked_out_time`	# The time at which the category was checked out The time at which the category was checked out Since 1.6
`public integer`	`$access`	# Access level for the category Access level for the category Since 1.6
`public string`	`$params`	# JSON string of parameters JSON string of parameters Since 1.6
`public string`	`$metadesc`	# Metadata description Metadata description Since 1.6
`public string`	`$metakey`	# Key words for meta data Key words for meta data Since 1.6
`public string`	`$metadata`	# JSON string of other meta data JSON string of other meta data Since 1.6
`public integer`	`$created_user_id`	# The ID of the user who created the category The ID of the user who created the category Since 1.6
`public string`	`$created_time`	# The time at which the category was created The time at which the category was created Since 1.6
`public integer`	`$modified_user_id`	# The ID of the user who last modified the category The ID of the user who last modified the category Since 1.6
`public string`	`$modified_time`	# The time at which the category was modified The time at which the category was modified Since 1.6
`public integer`	`$hits`	# Nmber of times the category has been viewed Nmber of times the category has been viewed Since 1.6
`public string`	`$language`	# The language for the category in xx-XX format The language for the category in xx-XX format Since 1.6
`public integer`	`$numitems`	# Number of items in this category or descendants of this category Number of items in this category or descendants of this category Since 1.6
`public integer`	`$childrennumitems`	# Number of children items Number of children items Since 1.6
`public string`	`$slug`	# Slug fo the category (used in URL) Slug fo the category (used in URL) Since 1.6
`public array`	`$assets`	# Array of assets Array of assets Since 1.6
`protected JCategoryNode`	`$_parent`	# Parent Category object Parent Category object Since 1.6
`protected JCategoryNode[]`	`$_children`	# Array of Children Array of Children Since 1.6
`protected array`	`$_path`	# Path from root to this category Path from root to this category Since 1.6
`protected JCategoryNode`	`$_leftSibling`	# Category left of this one Category left of this one Since 1.6
`protected JCategoryNode`	`$_rightSibling`	# Category right of this one Category right of this one Since 1.6
`protected boolean`	`$_allChildrenloaded`	# Flag if all children have been loaded Flag if all children have been loaded Since 1.6
`protected JCategoryNode`	`$_constructor`	# Constructor of this tree Constructor of this tree Since 1.6

Properties inherited from JObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JCategoryNode

Methods summary

Parameters

Since

Overrides

Parameters

Since

Parameters

Since

Parameters

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Returns

Since

Parameters

Returns

Since

Since

Parameters

Returns

Since

Methods inherited from JObject

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since