Joomla! Platform 11.4

Download

Demo

Class JPathway

Description
Description | Variables (details) | Methods (details)

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) 

Class JObject   (Subpackage Base)

Class JPathway   (Subpackage Application)
Variable Summary
Description | Variables (details) | Methods (details)
Static variable static array $instances
Variable integer $count
Variable array $pathway
Variable integer $_count
Variable array $_pathway
Method Summary
Description | Variables (details) | Methods (details)
Static method static JPathway getInstance (string $client, [array $options = array()])
Constructor JPathway __construct ([array $options = array()])
Method boolean addItem (string $name, [string $link = ''])
Method array getPathway ()
Method array getPathwayNames ()
Method boolean setItemName (integer $id, string $name)
Method array setPathway (array $pathway)
Method JPathway _makeItem (string $name, string $link)
Variables
Description | Variables (details) | Methods (details)
integer $count = 0 (line 40)
  • var: Integer number of items in the pathway
  • since: 11.1
  • access: protected
array $instances = array() (line 53)
  • var: JPathway instances container.
  • since: 11.3
  • access: protected
array $pathway = null (line 27)
  • var: Array to hold the pathway item objects
  • since: 11.1
  • access: protected
integer $_count = 0 (line 47)
  • var: Integer number of items in the pathway
  • deprecated: use $count declare as private
  • since: 11.1
  • access: protected
array $_pathway = null (line 34)
  • var: Array to hold the pathway item objects
  • deprecated: use $pathway declare as private
  • since: 11.1
  • access: protected

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 62)

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.
addItem (line 173)

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.
getInstance (line 78)

Returns a JPathway object

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

Return the JPathWay items array

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

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

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

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

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