Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Attributs publics | Attributs protégés
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)

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()

Description détaillée

Définition à la ligne 374 du fichier categories.php.

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

Définition à la ligne 662 du fichier categories.php.

Références JObject\setProperties().

{
if ($category)
{
$this->setProperties($category);
if ($constructor)
{
$this->_constructor = $constructor;
}
return true;
}
return false;
}

+ 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:
JCategoryNode$childThe child to be added.
Renvoie:
void
Depuis:
11.1

Définition à la ligne 735 du fichier categories.php.

{
if ($child instanceof JCategoryNode)
{
$child->setParent($this);
}
}
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

Définition à la ligne 943 du fichier categories.php.

Références JFactory\getUser().

{
if ($modified_user)
{
return JFactory::getUser($this->modified_user_id);
}
return JFactory::getUser($this->created_user_id);
}

+ 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

Définition à la ligne 767 du fichier categories.php.

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

Référencé par getNumItems().

{
if (!$this->_allChildrenloaded)
{
$temp = $this->_constructor->get($this->id, true);
if ($temp)
{
$this->_children = $temp->getChildren();
$this->_leftSibling = $temp->getSibling(false);
$this->_rightSibling = $temp->getSibling(true);
$this->setAllLoaded();
}
}
if ($recursive)
{
$items = array();
foreach ($this->_children as $child)
{
$items[] = $child;
$items = array_merge($items, $child->getChildren(true));
}
return $items;
}
return $this->_children;
}

+ 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

Définition à la ligne 910 du fichier categories.php.

Références $metadata.

{
if (!($this->metadata instanceof JRegistry))
{
$temp = new JRegistry;
$temp->loadString($this->metadata);
$this->metadata = $temp;
}
return $this->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

Définition à la ligne 978 du fichier categories.php.

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

{
if ($recursive)
{
$count = $this->numitems;
foreach ($this->getChildren() as $child)
{
$count = $count + $child->getNumItems(true);
}
return $count;
}
return $this->numitems;
}

+ Voici le graphe d'appel pour cette fonction :

JCategoryNode::getParams ( )

Returns the category parameters

Renvoie:
JRegistry
Depuis:
11.1

Définition à la ligne 891 du fichier categories.php.

Références $params.

{
if (!($this->params instanceof JRegistry))
{
$temp = new JRegistry;
$temp->loadString($this->params);
$this->params = $temp;
}
return $this->params;
}
JCategoryNode::getParent ( )

Get the parent of this node

Renvoie:
mixed JCategoryNode or null
Depuis:
11.1

Définition à la ligne 802 du fichier categories.php.

Références $_parent.

Référencé par hasParent().

{
return $this->_parent;
}

+ Voici le graphe des appelants de cette fonction :

JCategoryNode::getPath ( )

Returns the category path to the root category

Renvoie:
array
Depuis:
11.1

Définition à la ligne 929 du fichier categories.php.

Références $_path.

{
return $this->_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

Définition à la ligne 863 du fichier categories.php.

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

{
if (!$this->_allChildrenloaded)
{
$temp = $this->_constructor->get($this->id, true);
$this->_children = $temp->getChildren();
$this->_leftSibling = $temp->getSibling(false);
$this->_rightSibling = $temp->getSibling(true);
$this->setAllLoaded();
}
if ($right)
{
return $this->_rightSibling;
}
else
{
return $this->_leftSibling;
}
}

+ 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

Définition à la ligne 814 du fichier categories.php.

{
return count($this->_children);
}
JCategoryNode::hasParent ( )

Test if this node has a parent

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

Définition à la ligne 826 du fichier categories.php.

Références getParent().

{
return $this->getParent() != 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

Définition à la ligne 752 du fichier categories.php.

{
$key = array_search($this, $this->_parent->_children);
unset($this->_parent->_children[$key]);
}
JCategoryNode::setAllLoaded ( )

Set to load all children

Renvoie:
void
Depuis:
11.1

Définition à la ligne 960 du fichier categories.php.

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

{
$this->_allChildrenloaded = true;
foreach ($this->_children as $child)
{
$child->setAllLoaded();
}
}

+ 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

Définition à la ligne 689 du fichier categories.php.

Références $alias.

{
if ($parent instanceof JCategoryNode || is_null($parent))
{
if (!is_null($this->_parent))
{
$key = array_search($this, $this->_parent->_children);
unset($this->_parent->_children[$key]);
}
if (!is_null($parent))
{
$parent->_children[] = & $this;
}
$this->_parent = $parent;
if ($this->id != 'root')
{
if ($this->parent_id != 1)
{
$this->_path = $parent->getPath();
}
$this->_path[] = $this->id . ':' . $this->alias;
}
if (count($parent->_children) > 1)
{
end($parent->_children);
$this->_leftSibling = prev($parent->_children);
$this->_leftSibling->_rightsibling = & $this;
}
}
}
JCategoryNode::setSibling (   $sibling,
  $right = true 
)

Function to set the left or right sibling of a category

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

Définition à la ligne 841 du fichier categories.php.

{
if ($right)
{
$this->_rightSibling = $sibling;
}
else
{
$this->_leftSibling = $sibling;
}
}

Documentation des données membres

JCategoryNode::$_allChildrenloaded = false
protected

Définition à la ligne 644 du fichier categories.php.

JCategoryNode::$_children = array()
protected

Définition à la ligne 612 du fichier categories.php.

Référencé par getChildren().

JCategoryNode::$_constructor = null
protected

Définition à la ligne 652 du fichier categories.php.

JCategoryNode::$_leftSibling = null
protected

Définition à la ligne 628 du fichier categories.php.

Référencé par getSibling().

JCategoryNode::$_parent = null
protected

Définition à la ligne 606 du fichier categories.php.

Référencé par getParent().

JCategoryNode::$_path = array()
protected

Définition à la ligne 620 du fichier categories.php.

Référencé par getPath().

JCategoryNode::$_rightSibling = null
protected

Définition à la ligne 636 du fichier categories.php.

Référencé par getSibling().

JCategoryNode::$access = null

Définition à la ligne 486 du fichier categories.php.

JCategoryNode::$alias = null

Définition à la ligne 446 du fichier categories.php.

Référencé par setParent().

JCategoryNode::$asset_id = null

Définition à la ligne 390 du fichier categories.php.

JCategoryNode::$assets = null

Définition à la ligne 598 du fichier categories.php.

JCategoryNode::$checked_out = 0

Définition à la ligne 470 du fichier categories.php.

JCategoryNode::$checked_out_time = 0

Définition à la ligne 478 du fichier categories.php.

JCategoryNode::$childrennumitems = null

Définition à la ligne 582 du fichier categories.php.

JCategoryNode::$created_time = null

Définition à la ligne 534 du fichier categories.php.

JCategoryNode::$created_user_id = null

Définition à la ligne 526 du fichier categories.php.

JCategoryNode::$description = null

Définition à la ligne 454 du fichier categories.php.

JCategoryNode::$extension = null

Définition à la ligne 430 du fichier categories.php.

JCategoryNode::$hits = null

Définition à la ligne 558 du fichier categories.php.

JCategoryNode::$id = null

Définition à la ligne 382 du fichier categories.php.

JCategoryNode::$language = null

Définition à la ligne 566 du fichier categories.php.

JCategoryNode::$level = null

Définition à la ligne 422 du fichier categories.php.

JCategoryNode::$lft = null

Définition à la ligne 406 du fichier categories.php.

JCategoryNode::$metadata = null

Définition à la ligne 518 du fichier categories.php.

Référencé par getMetadata().

JCategoryNode::$metadesc = null

Définition à la ligne 502 du fichier categories.php.

JCategoryNode::$metakey = null

Définition à la ligne 510 du fichier categories.php.

JCategoryNode::$modified_time = null

Définition à la ligne 550 du fichier categories.php.

JCategoryNode::$modified_user_id = null

Définition à la ligne 542 du fichier categories.php.

JCategoryNode::$numitems = null

Définition à la ligne 574 du fichier categories.php.

Référencé par getNumItems().

JCategoryNode::$params = null

Définition à la ligne 494 du fichier categories.php.

Référencé par getParams().

JCategoryNode::$parent_id = null

Définition à la ligne 398 du fichier categories.php.

JCategoryNode::$published = null

Définition à la ligne 462 du fichier categories.php.

JCategoryNode::$rgt = null

Définition à la ligne 414 du fichier categories.php.

JCategoryNode::$slug = null

Définition à la ligne 590 du fichier categories.php.

JCategoryNode::$title = null

Définition à la ligne 438 du fichier categories.php.

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