Joomla! 1.5 API

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Abstract 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.

  • abstract:
  • since: 1.5

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

Class JObject   (Subpackage Base)

Abstract class JPathway   (Subpackage Application)
Method Summary
Constructor JPathway __construct ([ $options = array()])
Method boolean addItem (string $name, [string $link = ''])
Method JPathway &getInstance (string $client, [array $options = array()])
Method array getPathway ()
Method array getPathwayNames ()
Method boolean setItemName (integer $id, string $name)
Method array setPathway (array $pathway)
Variables

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Constructor __construct (line 46)

Class constructor

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

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

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 64)

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 105)

Return the JPathWay items array

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

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 184)

Set item name.

  • return: True on success
  • since: 1.5
  • access: public
boolean setItemName (integer $id, string $name)
  • integer $id
  • string $name
setPathway (line 121)

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.

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()
Support Joomla!