Docs For Class 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.

since: 1.1
author: Louis Landry <[email protected]>

Located in /application/pathway.php (line 27)

JObject
   |
   --JPathWay

Variable Summary

mixed $_count

mixed $_pathway

Method Summary

JPathWay __construct ()

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

array getNamePathWay ([boolean $showHome = true], [boolean $showComponent = true])

array getPathWay ([boolean $showHome = true], [boolean $showComponent = true])

boolean setItemName (integer $id, string $name)

object Pathway _makeItem (string $name, string $link)

Variables

mixed $_count = 0 (line 39)

Integer number of items in the pathway

access: private

mixed $_pathway = null (line 33)

Array to hold the pathway item objects

access: private

Methods

Constructor __construct (line 44)

Class constructor

JPathWay __construct ()

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

addItem (line 116)

Create and add an item to the pathway.

return: True on success
since: 1.1
access: public

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

string $name
string $link

getNamePathWay (line 82)

Create and return an array of the pathway names. Useful for things like SEF URLs

return: Array of names of pathway items
since: 1.1
access: public

array getNamePathWay ([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

getPathWay (line 56)

Return the JPathWay items array

return: Array of pathway items
since: 1.1
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

setItemName (line 138)

Set item name.

return: True on success
since: 1.1
access: public

boolean setItemName (integer $id, string $name)

integer $id
string $name

_makeItem (line 160)

Create and return a new pathway object.

return: item object
since: 1.1
access: private

object Pathway _makeItem (string $name, string $link)

string $name: Name of the item
string $link: Link to the item

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::JObject()
JObject::get()
JObject::set()
JObject::toString()
JObject::__destruct()