API17:JPathway
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JPathway== | ||
| + | ===Description=== | ||
| + | {{Description:JPathway}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JPathway|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JPathway|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JPathway::__construct/11.1|__construct]] | |[[JPathway::__construct/11.1|__construct]] | ||
|Class constructor. | |Class constructor. | ||
|- | |- | ||
| − | | | + | |public |
| − | + | ||
| − | + | ||
|[[JPathway::addItem/11.1|addItem]] | |[[JPathway::addItem/11.1|addItem]] | ||
|Create and add an item to the pathway. | |Create and add an item to the pathway. | ||
|- | |- | ||
| + | |public | ||
|[[JPathway::getPathway/11.1|getPathway]] | |[[JPathway::getPathway/11.1|getPathway]] | ||
|Return the JPathWay items array. | |Return the JPathWay items array. | ||
|- | |- | ||
| + | |public | ||
|[[JPathway::getPathwayNames/11.1|getPathwayNames]] | |[[JPathway::getPathwayNames/11.1|getPathwayNames]] | ||
|Create and return an array of the pathway names. | |Create and return an array of the pathway names. | ||
|- | |- | ||
| + | |public | ||
|[[JPathway::setItemName/11.1|setItemName]] | |[[JPathway::setItemName/11.1|setItemName]] | ||
|Set item name. | |Set item name. | ||
|- | |- | ||
| + | |public | ||
|[[JPathway::setPathway/11.1|setPathway]] | |[[JPathway::setPathway/11.1|setPathway]] | ||
|Set the items array. | |Set the items array. | ||
|- | |- | ||
| + | |public static | ||
|[[JPathway::getInstance/11.1|getInstance]] | |[[JPathway::getInstance/11.1|getInstance]] | ||
|Returns a object. | |Returns a object. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/application/pathway.php | ||
| + | * '''Extends''' [[JObject/11.1|JObject]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.application.pathway' );</source> | <source lang="php">jimport( 'joomla.application.pathway' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JPathway source code | + | * {{JVer|11.1}} '''JPathway source code''' on [[jplatform:application/pathway.php|BitBucket]] |
| − | * [[JPathway|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Application/11.1|Application]] |
| + | * [[JPathway|Other versions of JPathway]] | ||
{{SeeAlso:JPathway}} | {{SeeAlso:JPathway}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JPathway|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JPathway|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 60: | Line 62: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JPathway]]</noinclude> | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JPathway]]</noinclude> | ||
Revision as of 18:07, 27 April 2011
JPathway
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. [Edit Descripton]
Methods
| 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
jimport( 'joomla.application.pathway' );
See also
- JPathway source code on BitBucket
- Subpackage Application
- Other versions of JPathway
SeeAlso:JPathway [Edit See Also]
User contributed notes
<CodeExamplesForm />
