Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JCategoryNode
+ Graphe d'héritage de JCategoryNode:
+ Graphe de collaboration de JCategoryNode:

Liste de tous les membres

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)
- Fonctions membres publiques inherited from JObject
 __construct ($properties=null)
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Attributs publics

 $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
- Attributs protégés inherited from JObject
 $_errors = array()

Documentation des constructeurs et destructeur

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

Class constructor

Paramètres:
array$categoryThe category data.
JCategoryNode&$constructorThe tree constructor.
Depuis:
11.1

Références $category, et JObject\setProperties().

+ Voici le graphe d'appel pour cette fonction :


Documentation des fonctions membres

JCategoryNode::addChild ( $child)

Add child to this node

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

Paramètres:
JNode&$childThe child to be added.
Renvoie:
void
Depuis:
11.1
JCategoryNode::getAuthor (   $modified_user = false)

Returns the user that created the category

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

Références JFactory\getUser().

+ Voici le graphe d'appel pour cette fonction :

& JCategoryNode::getChildren (   $recursive = false)

Get the children of this node

Paramètres:
boolean$recursiveFalse by default
Renvoie:
array The children
Depuis:
11.1

Références $_children, et setAllLoaded().

Référencé par getNumItems().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JCategoryNode::getMetadata ( )

Returns the category metadata

Renvoie:
JRegistry A JRegistry object containing the metadata
Depuis:
11.1

Références $metadata.

JCategoryNode::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:
11.1

Références $count, $numitems, et getChildren().

+ Voici le graphe d'appel pour cette fonction :

JCategoryNode::getParams ( )

Returns the category parameters

Renvoie:
JRegistry
Depuis:
11.1

Références $params.

& JCategoryNode::getParent ( )

Get the parent of this node

Renvoie:
mixed JNode or null
Depuis:
11.1

Références $_parent.

Référencé par hasParent().

+ Voici le graphe des appelants de cette fonction :

JCategoryNode::getPath ( )

Returns the category path to the root category

Renvoie:
array
Depuis:
11.1

Références $_path.

JCategoryNode::getSibling (   $right = true)

Returns the right or left sibling of a category

Paramètres:
boolean$rightIf set to false, returns the left sibling
Renvoie:
mixed JCategoryNode object with the sibling information or NULL if there is no sibling on that side.
Depuis:
11.1

Références $_leftSibling, $_rightSibling, et setAllLoaded().

+ Voici le graphe d'appel pour cette fonction :

JCategoryNode::hasChildren ( )

Test if this node has children

Renvoie:
boolean True if there is a child
Depuis:
11.1
JCategoryNode::hasParent ( )

Test if this node has a parent

Renvoie:
boolean True if there is a parent
Depuis:
11.1

Références getParent(), et null.

+ Voici le graphe d'appel pour cette fonction :

JCategoryNode::removeChild (   $id)

Remove a specific child

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

Références $key.

JCategoryNode::setAllLoaded ( )

Set to load all children

Renvoie:
void
Depuis:
11.1

Référencé par getChildren(), et getSibling().

+ Voici le graphe des appelants de cette fonction :

JCategoryNode::setParent ( $parent)

Set the parent of this category

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

Paramètres:
mixed&$parentJCategoryNode for the parent to be set or null
Renvoie:
void
Depuis:
11.1

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

JCategoryNode::setSibling (   $sibling,
  $right = true 
)

Function to set the left or right sibling of a category

Paramètres:
object$siblingJCategoryNode object for the sibling
boolean$rightIf set to false, the sibling is the left one
Renvoie:
void
Depuis:
11.1

Documentation des données membres

JCategoryNode::$_allChildrenloaded = false
protected
JCategoryNode::$_children = array()
protected

Référencé par getChildren().

JCategoryNode::$_constructor = null
protected
JCategoryNode::$_leftSibling = null
protected

Référencé par getSibling().

JCategoryNode::$_parent = null
protected

Référencé par getParent().

JCategoryNode::$_path = array()
protected

Référencé par getPath().

JCategoryNode::$_rightSibling = null
protected

Référencé par getSibling().

JCategoryNode::$access = null
JCategoryNode::$alias = null

Référencé par setParent().

JCategoryNode::$asset_id = null
JCategoryNode::$assets = null
JCategoryNode::$checked_out = 0
JCategoryNode::$checked_out_time = 0
JCategoryNode::$childrennumitems = null
JCategoryNode::$created_time = null
JCategoryNode::$created_user_id = null
JCategoryNode::$description = null
JCategoryNode::$extension = null
JCategoryNode::$hits = null
JCategoryNode::$id = null
JCategoryNode::$language = null
JCategoryNode::$level = null
JCategoryNode::$lft = null
JCategoryNode::$metadata = null

Référencé par getMetadata().

JCategoryNode::$metadesc = null
JCategoryNode::$metakey = null
JCategoryNode::$modified_time = null
JCategoryNode::$modified_user_id = null
JCategoryNode::$numitems = null

Référencé par getNumItems().

JCategoryNode::$params = null

Référencé par getParams().

JCategoryNode::$parent_id = null
JCategoryNode::$published = null
JCategoryNode::$rgt = null
JCategoryNode::$slug = null
JCategoryNode::$title = null

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