Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class JPathWay

Description
Description | Methods (details)

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) 

Class JObject   (Subpackage Base)

Class JPathWay   (Subpackage Application)
Method Summary
Description | Methods (details)
Constructor JPathWay __construct ()
Method boolean addItem (string $name, [string $link = ''])
Method array getPathWay ([boolean $showHome = true], [boolean $showComponent = true])
Method array getPathWayNames ([boolean $showHome = true], [boolean $showComponent = true])
Method boolean setItemName (integer $id, string $name)
Methods
Description | Methods (details)
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.

  • return: True on success
  • since: 1.5
  • access: public
boolean addItem (string $name, [string $link = ''])
  • string $name
  • string $link
getPathWay (line 61)

Return the JPathWay items array

  • return: Array of pathway items
  • since: 1.5
  • access: public
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.

  • return: Array of names of pathway items
  • since: 1.5
  • access: public
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.

  • 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::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 21:13:55 +0000 by phpDocumentor 1.3.1