JPathway/1.5

From Joomla! Documentation
< JPathway(Difference between revisions)
Jump to: navigation, search
(Bulk upload by Doxiki2)
 
m (See also: fixing link to API)
 
(One intermediate revision by one user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|1.5}} 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>
{{Description:JPathway}}
 
===Defined in===
 
libraries/joomla/application/pathway.php
 
===Subpackage===
 
[[Subpackage Application/1.5|Application]]
 
===Extends===
 
[[JObject/1.5|JObject]]
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public
 
|[[JPathway::__construct/1.5|__construct]]
 
|[[JPathway::__construct/1.5|__construct]]
 
|Class constructor.  
 
|Class constructor.  
 
|-
 
|-
 +
|public
 
|[[JPathway::_makeItem/1.5|_makeItem]]
 
|[[JPathway::_makeItem/1.5|_makeItem]]
 
|Create and return a new pathway object.  
 
|Create and return a new pathway object.  
 
|-
 
|-
 +
|public
 
|[[JPathway::addItem/1.5|addItem]]
 
|[[JPathway::addItem/1.5|addItem]]
 
|Create and add an item to the pathway.  
 
|Create and add an item to the pathway.  
 
|-
 
|-
 +
|public 
 
|[[JPathway::getInstance/1.5|getInstance]]
 
|[[JPathway::getInstance/1.5|getInstance]]
 
|Returns a reference a  object.  
 
|Returns a reference a  object.  
 
|-
 
|-
 +
|public
 
|[[JPathway::getPathway/1.5|getPathway]]
 
|[[JPathway::getPathway/1.5|getPathway]]
 
|Return the JPathWay items array.  
 
|Return the JPathWay items array.  
 
|-
 
|-
 +
|public
 
|[[JPathway::getPathwayNames/1.5|getPathwayNames]]
 
|[[JPathway::getPathwayNames/1.5|getPathwayNames]]
 
|Create and return an array of the pathway names.  
 
|Create and return an array of the pathway names.  
 
|-
 
|-
 +
|public
 
|[[JPathway::setItemName/1.5|setItemName]]
 
|[[JPathway::setItemName/1.5|setItemName]]
 
|Set item name.  
 
|Set item name.  
 
|-
 
|-
 +
|public
 
|[[JPathway::setPathway/1.5|setPathway]]
 
|[[JPathway::setPathway/1.5|setPathway]]
 
|Set the  items array.  
 
|Set the  items array.  
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/application/pathway.php
 +
* '''Extends''' [[JObject/1.5|JObject]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.application.pathway' );</source>
 
<source lang="php">jimport( 'joomla.application.pathway' );</source>
 
===See also===
 
===See also===
 +
* {{JVer|1.5}} '''JPathway''' on [http://api.joomla.org/1.5/Joomla-Framework/Application/JPathway.html api.joomla.org]
 +
* {{JVer|1.5}} '''JPathway source code''' on [[jframework15:application/pathway.php|JoomlaCode]]
 +
* {{JVer|1.5}} Subpackage [[Subpackage Application/1.5|Application]]
 +
* [[JPathway|Other versions of 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>
{{SeeAlso:JPathway}}
+
===User contributed notes===
* [[JPathway|Other versions of this class]]
+
* [http://api.joomla.org/Joomla-Framework/Application/JPathway.html JPathway on api.joomla.org]
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 59: Line 67:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JPathway]]</noinclude>
 
<noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JPathway]]</noinclude>

Latest revision as of 16:04, 13 February 2013

[edit] Joomla 1.5 JPathway

[edit] 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]

[edit] Methods

Visibility Method name Description
public __construct Class constructor.
public _makeItem Create and return a new pathway object.
public addItem Create and add an item to the pathway.
public getInstance Returns a reference a object.
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.
  • Defined in libraries/joomla/application/pathway.php
  • Extends JObject

[edit] Importing

jimport( 'joomla.application.pathway' );

[edit] See also

SeeAlso:JPathway [Edit See Also]

[edit] User contributed notes

<CodeExamplesForm />


Personal tools
Namespaces

Variants
Actions
Navigation
Joomla! Sites
Toolbox