JPathWay
Description
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.
Located in /joomla/application/pathway.php (line 31)
JObject (Subpackage Base) JPathWay (Subpackage Application)
Method Summary
JPathWay
__construct
()
Methods
Constructor __construct (line 49)
Class constructor
JPathWay
__construct
()
Redefinition of:
- JObject::__construct()
- Class constructor, overridden in descendant classes.
addItem (line 115)
Create and add an item to the pathway.
boolean
addItem
(string $name, [string $link = ''])
- string $name
- string $link
getPathWay (line 61)
Return the JPathWay items array
array
getPathWay
([boolean $showHome = true], [boolean $showComponent = true])
- boolean $showHome: True to show the home element of the JPathWay array
- boolean $showComponent: True to show the component element of the JPathWay array
getPathWayNames (line 85)
Create and return an array of the pathway names.
array
getPathWayNames
([boolean $showHome = true], [boolean $showComponent = true])
- boolean $showHome: True to show the home element of the JPathWay array
- boolean $showComponent: True to show the component element of the JPathWay array
setItemName (line 137)
Set item name.
boolean
setItemName
(integer $id, string $name)
- integer $id
- string $name
Inherited Methods
Inherited From JObject
JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 21:13:55 +0000 by phpDocumentor 1.3.1