Difference between revisions of "JPathway"
From Joomla! Documentation
m (→User contributed notes: moving preparation) |
m (preparing for archive only) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JPathway== | =={{JVer|11.1}} JPathway== | ||
===Description=== | ===Description=== | ||
| − | + | [[JPathway]] is an abstract class to maintain a pathway. Main example of use so far is the mod_breadcrumbs module that keeps track of the user's navigated path within the Joomla application. | |
| − | + | ||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 14: | Line 12: | ||
|- | |- | ||
|public | |public | ||
| − | |[[JPathway::__construct | + | |[[API17:JPathway::__construct|__construct]] |
|Class constructor. | |Class constructor. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JPathway::addItem | + | |[[API17:JPathway::addItem|addItem]] |
|Create and add an item to the pathway. | |Create and add an item to the pathway. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JPathway::getPathway | + | |[[API17:JPathway::getPathway|getPathway]] |
|Return the JPathWay items array. | |Return the JPathWay items array. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JPathway::getPathwayNames | + | |[[API17:JPathway::getPathwayNames|getPathwayNames]] |
|Create and return an array of the pathway names. | |Create and return an array of the pathway names. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JPathway::setItemName | + | |[[API17:JPathway::setItemName|setItemName]] |
|Set item name. | |Set item name. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JPathway::setPathway | + | |[[API17:JPathway::setPathway|setPathway]] |
|Set the items array. | |Set the items array. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JPathway::getInstance | + | |[[API17:JPathway::getInstance|getInstance]] |
|Returns a object. | |Returns a object. | ||
|- | |- | ||
|} | |} | ||
* '''Defined in''' libraries/joomla/application/pathway.php | * '''Defined in''' libraries/joomla/application/pathway.php | ||
| − | * '''Extends''' [[JObject | + | * '''Extends''' [[API17:JObject|JObject]] |
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.application.pathway' );</source> | <source lang="php">jimport( 'joomla.application.pathway' );</source> | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JPathway source code''' on [[jplatform:application/pathway.php|BitBucket]] | * {{JVer|11.1}} '''JPathway source code''' on [[jplatform:application/pathway.php|BitBucket]] | ||
| − | * {{JVer|11.1}} Subpackage [[Subpackage Application | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Application|Application]] |
| − | * [[JPathway|Other versions of JPathway]] | + | * [[API17:JPathway|Other versions of JPathway]] |
| − | + | ||
| − | + | ||
| − | |||
| − | |||
===User contributed notes=== | ===User contributed notes=== | ||
| − | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JPathway | category=JPathway | ||
| − | + | namespace=CodeExample | |
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
Latest revision as of 22:32, 24 March 2017
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JPathway[edit]
Description[edit]
JPathway is an abstract class to maintain a pathway. Main example of use so far is the mod_breadcrumbs module that keeps track of the user's navigated path within the Joomla application.
Methods[edit]
| Visibility | Method name | Description |
|---|---|---|
| public | __construct | Class constructor. |
| public | addItem | Create and add an item to the pathway. |
| public | getPathway | Return the JPathWay items array. |
| public | getPathwayNames | Create and return an array of the pathway names. |
| public | setItemName | Set item name. |
| public | setPathway | Set the items array. |
| public static | getInstance | Returns a object. |
- Defined in libraries/joomla/application/pathway.php
- Extends JObject
Importing[edit]
jimport( 'joomla.application.pathway' );See also[edit]
- JPathway source code on BitBucket
- Subpackage Application
- Other versions of JPathway
User contributed notes[edit]
Code Examples[edit]