Docs For Class JPathway

Description

Class to maintain a pathway.

The user's navigated path within the application.

since: 1.5

Located in /libraries/cms/pathway/pathway.php (line 21)

Direct descendents

Class	Description
JPathwaySite	Class to manage the site application pathway.

Variable Summary

static array $instances

integer $_count

array $_pathway

Method Summary

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

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

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

array getPathway ()

array getPathwayNames ()

JPathway makeItem (string $name, string $link)

boolean setItemName (integer $id, string $name)

array setPathway (array $pathway)

JPathway _makeItem (string $name, string $link)

Variables

static array $instances = array() (line 41)

var: JPathway instances container.
since: 1.7
access: protected

integer $_count = 0 (line 35)

var: Integer number of items in the pathway
deprecated: 4.0 Will convert to $count
since: 1.5
access: protected

array $_pathway = array() (line 28)

var: Array to hold the pathway item objects
deprecated: 4.0 Will convert to $pathway
since: 1.5
access: protected

Methods

static getInstance (line 65)

Returns a JPathway object

return: A JPathway object.
throws: RuntimeException
since: 1.5
access: public

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

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

Constructor __construct (line 50)

Class constructor

since: 1.5
access: public

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

array $options: The class options.

Redefined in descendants as:

JPathwaySite::__construct() : Class constructor.

addItem (line 168)

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: The name of the item.
string $link: The link to the item.

getPathway (line 110)

Return the JPathway items array

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

array getPathway ()

getPathwayNames (line 144)

Create and return an array of the pathway names.

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

array getPathwayNames ()

makeItem (line 230)

Create and return a new pathway object.

return: Pathway item object
since: 3.1
access: protected

JPathway makeItem (string $name, string $link)

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

setItemName (line 191)

Set item name.

return: True on success
since: 1.5
access: public

boolean setItemName (integer $id, string $name)

integer $id: The id of the item on which to set the name.
string $name: The name to set.

setPathway (line 127)

Set the JPathway items array.

return: The previous pathway data.
since: 1.5
access: public

array setPathway (array $pathway)

array $pathway: An array of pathway objects.

_makeItem (line 215)

Create and return a new pathway object.

return: Pathway item object
deprecated: 4.0 Use makeItem() instead
since: 1.5
access: protected

JPathway _makeItem (string $name, string $link)

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