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.

• since: 1.5
• author: Louis Landry <louis.landry@joomla.org>
• abstract:

Located in /joomla/application/pathway.php (line 30)

 JObject   (Subpackage Base)

 JPathway   (Subpackage Application)

Inherited Variables

Inherited from JObject

JObject::$_errors

Constructor __construct (line 47)

Class constructor

JPathway __construct ([ $options = array()])

• $options

---

Redefinition of:

JObject::__construct()

Class constructor, overridden in descendant classes.

addItem (line 144)

Create and add an item to the pathway.

• return: True on success
• since: 1.5
• access: public

boolean addItem (string $name, [string $link = ''])

• string $name
• string $link

getInstance (line 65)

Returns a reference a JPathway object

This method must be invoked as:

  $menu = &JPathway::getInstance();

• return: A pathway object.
• since: 1.5
• access: public

JPathway &getInstance (string $client, [array $options = array()])

• string $client: The name of the client
• array $options: An associative array of options

getPathway (line 106)

Return the JPathWay items array

• return: Array of pathway items
• since: 1.5
• access: public

array getPathway ()

getPathwayNames (line 121)

Create and return an array of the pathway names.

• return: Array of names of pathway items
• since: 1.5
• access: public

array getPathwayNames ()

setItemName (line 166)

Set item name.

• return: True on success
• since: 1.5
• access: public

boolean setItemName (integer $id, string $name)

• integer $id
• string $name

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()