CategoryNode

Extends \JObject

Helper class to load Categorytree

since

1.6

Methods

__construct

Class constructor

__construct(array $category = null, \Joomla\CMS\Categories\CategoryNode $constructor = null) 
since

1.6

Arguments

$category

arrayThe category data.

$constructor

\Joomla\CMS\Categories\CategoryNodeThe tree constructor.

addChild

Add child to this node

addChild(\Joomla\CMS\Categories\CategoryNode $child) : void

If the child already has a parent, the link is unset

since

1.6

Arguments

$child

\Joomla\CMS\Categories\CategoryNodeThe child to be added.

getAuthor

Returns the user that created the category

getAuthor(boolean $modified_user = false) : \JUser
since

1.6

Arguments

$modified_user

booleanReturns the modified_user when set to true

Response

\JUserA \JUser object containing a userid

getChildren

Get the children of this node

getChildren(boolean $recursive = false) : array<mixed,\Joomla\CMS\Categories\CategoryNode>
since

1.6

Arguments

$recursive

booleanFalse by default

Response

array<mixed,\Joomla\CMS\Categories\CategoryNode>The children

getNumItems

Returns the number of items.

getNumItems(boolean $recursive = false) : integer
since

1.6

Arguments

$recursive

booleanIf false number of children, if true number of descendants

Response

integerNumber of children or descendants

getParams

Returns the category parameters

getParams() : \Joomla\Registry\Registry
since

1.6

Response

\Joomla\Registry\Registry

getParent

Get the parent of this node

getParent() : \Joomla\CMS\Categories\CategoryNode

getPath

Returns the category path to the root category

getPath() : array
since

1.6

Response

array

getSibling

Returns the right or left sibling of a category

getSibling(boolean $right = true) : \Joomla\CMS\Categories\CategoryNode|null
since

1.6

Arguments

$right

booleanIf set to false, returns the left sibling

Response

\Joomla\CMS\Categories\CategoryNode|nullCategoryNode object with the sibling information or null if there is no sibling on that side.

hasChildren

Test if this node has children

hasChildren() : boolean
since

1.6

Response

booleanTrue if there is a child

hasParent

Test if this node has a parent

hasParent() : boolean
since

1.6

Response

booleanTrue if there is a parent

removeChild

Remove a specific child

removeChild(integer $id) : void
since

1.6

Arguments

$id

integerID of a category

setAllLoaded

Set to load all children

setAllLoaded() : void
since

1.6

setParent

Set the parent of this category

setParent(\Joomla\CMS\Categories\CategoryNode|null $parent) : void

If the category already has a parent, the link is unset

since

1.6

Arguments

$parent

\Joomla\CMS\Categories\CategoryNode|nullCategoryNode for the parent to be set or null

setSibling

Function to set the left or right sibling of a category

setSibling(\Joomla\CMS\Categories\CategoryNode $sibling, boolean $right = true) : void
since

1.6

Arguments

$sibling

\Joomla\CMS\Categories\CategoryNodeCategoryNode object for the sibling

$right

booleanIf set to false, the sibling is the left one

Properties

id

Primary key

Type(s)

integer

asset_id

The id of the category in the asset table

Type(s)

integer

parent_id

The id of the parent of category in the asset table, 0 for category root

Type(s)

integer

lft

The lft value for this category in the category tree

Type(s)

integer

rgt

The rgt value for this category in the category tree

Type(s)

integer

level

The depth of this category's position in the category tree

Type(s)

integer

extension

The extension this category is associated with

Type(s)

integer

title

The menu title for the category (a short name)

Type(s)

string

alias

The the alias for the category

Type(s)

string

description

Description of the category.

Type(s)

string

published

The publication status of the category

Type(s)

boolean

checked_out

Whether the category is or is not checked out

Type(s)

boolean

checked_out_time

The time at which the category was checked out

Type(s)

string

access

Access level for the category

Type(s)

integer

params

JSON string of parameters

Type(s)

string

metadesc

Metadata description

Type(s)

string

metakey

Key words for metadata

Type(s)

string

created_user_id

The ID of the user who created the category

Type(s)

integer

created_time

The time at which the category was created

Type(s)

string

modified_user_id

The ID of the user who last modified the category

Type(s)

integer

modified_time

The time at which the category was modified

Type(s)

string

hits

Nmber of times the category has been viewed

Type(s)

integer

language

The language for the category in xx-XX format

Type(s)

string

numitems

Number of items in this category or descendants of this category

Type(s)

integer

childrennumitems

Number of children items

Type(s)

integer

slug

Slug fo the category (used in URL)

Type(s)

string

assets

Array of assets

Type(s)

array

_parent

Parent Category object

_children

Array of Children

_path

Path from root to this category

Type(s)

array

_leftSibling

Category left of this one

_rightSibling

Category right of this one

_allChildrenloaded

Flag if all children have been loaded

Type(s)

boolean

_constructor

Constructor of this tree