Class JPathway

Description

Class to maintain a pathway.

The user's navigated path within the application.

  • since: 11.1

Located in /libraries/joomla/application/pathway.php (line 21)

JObject
   |
   --JPathway
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 ()
boolean setItemName (integer $id, string $name)
array setPathway (array $pathway)
JPathway _makeItem (string $name, string $link)
Variables
static array $instances = array() (line 39)
  • var: JPathway instances container.
  • since: 11.3
  • access: protected
integer $_count = 0 (line 33)
  • var: Integer number of items in the pathway
  • since: 11.1
  • access: protected
array $_pathway = null (line 27)
  • var: Array to hold the pathway item objects
  • since: 11.1
  • access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors
Methods
static method getInstance (line 64)

Returns a JPathway object

  • return: A JPathway object.
  • since: 11.1
  • 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 48)

Class constructor

  • since: 11.1
  • access: public
JPathway __construct ([array $options = array()])
  • array $options: The class options.

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

Redefined in descendants as:
addItem (line 159)

Create and add an item to the pathway.

  • return: True on success
  • since: 11.1
  • access: public
boolean addItem (string $name, [string $link = ''])
  • string $name: The name of the item.
  • string $link: The link to the item.
getPathway (line 99)

Return the JPathWay items array

  • return: Array of pathway items
  • since: 11.1
  • access: public
array getPathway ()
getPathwayNames (line 134)

Create and return an array of the pathway names.

  • return: Array of names of pathway items
  • since: 11.1
  • access: public
array getPathwayNames ()
setItemName (line 183)

Set item name.

  • return: True on success
  • since: 11.1
  • 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 116)

Set the JPathway items array.

  • return: The previous pathway data.
  • since: 11.1
  • access: public
array setPathway (array $pathway)
  • array $pathway: An array of pathway objects.
_makeItem (line 207)

Create and return a new pathway object.

  • return: Pathway item object
  • since: 11.1
  • access: protected
JPathway _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::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:58:38 -0500 by phpDocumentor 1.4.4