Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe Pathway
+ Graphe d'héritage de Pathway:

Fonctions membres publiques

 __construct ($options=array())
 
 getPathway ()
 
 setPathway ($pathway)
 
 getPathwayNames ()
 
 addItem ($name, $link='')
 
 setItemName ($id, $name)
 

Fonctions membres publiques statiques

static getInstance ($client, $options=array())
 

Fonctions membres protégées

 _makeItem ($name, $link)
 
 makeItem ($name, $link)
 

Attributs protégés

 $_pathway = array()
 
 $_count = 0
 

Attributs protégés statiques

static $instances = array()
 

Description détaillée

Class to maintain a pathway.

The user's navigated path within the application.

Depuis
1.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options = array())

Class constructor

Paramètres
array$optionsThe class options.
Depuis
1.5

Documentation des fonctions membres

◆ _makeItem()

_makeItem (   $name,
  $link 
)
protected

Create and return a new pathway object.

Paramètres
string$nameName of the item
string$linkLink to the item
Renvoie
Pathway Pathway item object
Depuis
1.5
Obsolète:
4.0 Use makeItem() instead

Références $link, et $name.

◆ addItem()

addItem (   $name,
  $link = '' 
)

Create and add an item to the pathway.

Paramètres
string$nameThe name of the item.
string$linkThe link to the item.
Renvoie
boolean True on success
Depuis
1.5

Références $link, et $name.

◆ getInstance()

static getInstance (   $client,
  $options = array() 
)
static

Returns a Pathway object

Paramètres
string$clientThe name of the client
array$optionsAn associative array of options
Renvoie
Pathway A Pathway object.
Depuis
1.5
Exceptions

Références $client, $info, $options, $path, ApplicationHelper\getClientInfo(), et JLoader\register().

◆ getPathway()

getPathway ( )

Return the Pathway items array

Renvoie
array Array of pathway items
Depuis
1.5

◆ getPathwayNames()

getPathwayNames ( )

Create and return an array of the pathway names.

Renvoie
array Array of names of pathway items
Depuis
1.5

Références $item, et $names.

◆ makeItem()

makeItem (   $name,
  $link 
)
protected

Create and return a new pathway object.

Paramètres
string$nameName of the item
string$linkLink to the item
Renvoie
Pathway Pathway item object
Depuis
3.1

Références $item, $link, $name, et ENT_COMPAT.

◆ setItemName()

setItemName (   $id,
  $name 
)

Set item name.

Paramètres
integer$idThe id of the item on which to set the name.
string$nameThe name to set.
Renvoie
boolean True on success
Depuis
1.5

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

◆ setPathway()

setPathway (   $pathway)

Set the Pathway items array.

Paramètres
array$pathwayAn array of pathway objects.
Renvoie
array The previous pathway data.
Depuis
1.5

Documentation des champs

◆ $_count

$_count = 0
protected

◆ $_pathway

$_pathway = array()
protected

◆ $instances

$instances = array()
staticprotected

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