Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe CategoryNode
+ Graphe d'héritage de CategoryNode:

Fonctions membres publiques

 __construct ($category=null, $constructor=null)
 
 setParent ($parent)
 
 addChild ($child)
 
 removeChild ($id)
 
getChildren ($recursive=false)
 
 getParent ()
 
 hasChildren ()
 
 hasParent ()
 
 setSibling ($sibling, $right=true)
 
 getSibling ($right=true)
 
 getParams ()
 
 getMetadata ()
 
 getPath ()
 
 getAuthor ($modified_user=false)
 
 setAllLoaded ()
 
 getNumItems ($recursive=false)
 

Champs de données

 $id = null
 
 $asset_id = null
 
 $parent_id = null
 
 $lft = null
 
 $rgt = null
 
 $level = null
 
 $extension = null
 
 $title = null
 
 $alias = null
 
 $description = null
 
 $published = null
 
 $checked_out = 0
 
 $checked_out_time = 0
 
 $access = null
 
 $params = null
 
 $metadesc = null
 
 $metakey = null
 
 $metadata = null
 
 $created_user_id = null
 
 $created_time = null
 
 $modified_user_id = null
 
 $modified_time = null
 
 $hits = null
 
 $language = null
 
 $numitems = null
 
 $childrennumitems = null
 
 $slug = null
 
 $assets = null
 

Attributs protégés

 $_parent = null
 
 $_children = array()
 
 $_path = array()
 
 $_leftSibling = null
 
 $_rightSibling = null
 
 $_allChildrenloaded = false
 
 $_constructor = null
 

Description détaillée

Helper class to load Categorytree

Depuis
1.6

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $category = null,
  $constructor = null 
)

Class constructor

Paramètres
array$categoryThe category data.
CategoryNode$constructorThe tree constructor.
Depuis
1.6

Références $category.

Documentation des fonctions membres

◆ addChild()

addChild (   $child)

Add child to this node

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

Paramètres
CategoryNode$childThe child to be added.
Renvoie
void
Depuis
1.6

◆ getAuthor()

getAuthor (   $modified_user = false)

Returns the user that created the category

Paramètres
boolean$modified_userReturns the modified_user when set to true
Renvoie
A object containing a userid
Depuis
1.6

◆ getChildren()

& getChildren (   $recursive = false)

Get the children of this node

Paramètres
boolean$recursiveFalse by default
Renvoie
CategoryNode[] The children
Depuis
1.6

Références $items.

◆ getMetadata()

getMetadata ( )

Returns the category metadata

Renvoie
Registry A Registry object containing the metadata
Depuis
1.6

◆ getNumItems()

getNumItems (   $recursive = false)

Returns the number of items.

Paramètres
boolean$recursiveIf false number of children, if true number of descendants
Renvoie
integer Number of children or descendants
Depuis
1.6

Références $count.

◆ getParams()

getParams ( )

Returns the category parameters

Renvoie
Registry
Depuis
1.6

Références $params.

◆ getParent()

getParent ( )

Get the parent of this node

Renvoie
CategoryNode
Depuis
1.6

◆ getPath()

getPath ( )

Returns the category path to the root category

Renvoie
array
Depuis
1.6

◆ getSibling()

getSibling (   $right = true)

Returns the right or left sibling of a category

Paramètres
boolean$rightIf set to false, returns the left sibling
Renvoie
CategoryNode|null CategoryNode object with the sibling information or null if there is no sibling on that side.
Depuis
1.6

◆ hasChildren()

hasChildren ( )

Test if this node has children

Renvoie
boolean True if there is a child
Depuis
1.6

◆ hasParent()

hasParent ( )

Test if this node has a parent

Renvoie
boolean True if there is a parent
Depuis
1.6

Références null.

◆ removeChild()

removeChild (   $id)

Remove a specific child

Paramètres
integer$idID of a category
Renvoie
void
Depuis
1.6

Références $key.

◆ setAllLoaded()

setAllLoaded ( )

Set to load all children

Renvoie
void
Depuis
1.6

◆ setParent()

setParent (   $parent)

Set the parent of this category

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

Paramètres
CategoryNode | null$parentCategoryNode for the parent to be set or null
Renvoie
void
Depuis
1.6

Références $id, et $key.

◆ setSibling()

setSibling (   $sibling,
  $right = true 
)

Function to set the left or right sibling of a category

Paramètres
CategoryNode$siblingCategoryNode object for the sibling
boolean$rightIf set to false, the sibling is the left one
Renvoie
void
Depuis
1.6

Documentation des champs

◆ $_allChildrenloaded

$_allChildrenloaded = false
protected

◆ $_children

$_children = array()
protected

◆ $_constructor

$_constructor = null
protected

◆ $_leftSibling

$_leftSibling = null
protected

◆ $_parent

$_parent = null
protected

◆ $_path

$_path = array()
protected

◆ $_rightSibling

$_rightSibling = null
protected

◆ $access

$access = null

◆ $alias

$alias = null

◆ $asset_id

$asset_id = null

◆ $assets

$assets = null

◆ $checked_out

$checked_out = 0

◆ $checked_out_time

$checked_out_time = 0

◆ $childrennumitems

$childrennumitems = null

◆ $created_time

$created_time = null

◆ $created_user_id

$created_user_id = null

◆ $description

◆ $extension

◆ $hits

$hits = null

◆ $id

$id = null

◆ $language

$language = null

◆ $level

$level = null

◆ $lft

$lft = null

◆ $metadata

$metadata = null

◆ $metadesc

$metadesc = null

◆ $metakey

$metakey = null

◆ $modified_time

$modified_time = null

◆ $modified_user_id

$modified_user_id = null

◆ $numitems

$numitems = null

◆ $params

$params = null

◆ $parent_id

$parent_id = null

◆ $published

$published = null

◆ $rgt

$rgt = null

◆ $slug

$slug = null

◆ $title

$title = null

La documentation de cette classe a été générée à partir du fichier suivant :