API15

Difference between revisions of "JPathway"

From Joomla! Documentation

m (preparing for archive only)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<span class="editsection" style="font-size:76%;">
+
[[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.
<nowiki>[</nowiki>[[Description:JPathway|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
{{Description:JPathway}}
 
  
 
===Defined in===
 
===Defined in===
Line 33: Line 30:
 
|Set item name.
 
|Set item name.
 
|}
 
|}
 +
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.application.pathway' );</source>
 
<source lang="php">jimport( 'joomla.application.pathway' );</source>
  
<span class="editsection" style="font-size:76%;">
+
 
<nowiki>[</nowiki>[[SeeAlso:JPathway|Edit See Also]]<nowiki>]</nowiki>
+
 
</span>
 
{{SeeAlso:JPathway}}
 
  
 
===Examples===
 
===Examples===
<CodeExamplesForm />
+
=== Code Examples ===
 
<dpl>
 
<dpl>
 
  noresultsheader=\n
 
  noresultsheader=\n
 
  category=JPathway
 
  category=JPathway
  category=CodeExample
+
  namespace=CodeExample
 
  category=ClassExample
 
  category=ClassExample
 
  include=*
 
  include=*
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>

Latest revision as of 20:01, 24 March 2017

The "API15" 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 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.

Defined in[edit]

libraries/joomla/application/pathway.php

Methods[edit]

Method name Description
__construct Class constructor
getInstance Returns a reference a JPathway object
getPathway Return the JPathWay items array
setPathway Set the JPathway items array.
getPathwayNames Create and return an array of the pathway names.
addItem Create and add an item to the pathway.
setItemName Set item name.

Importing[edit]

jimport( 'joomla.application.pathway' );



Examples[edit]

Code Examples[edit]