PHPXRef 0.7.1 : Joomla 1.5.26 DE : Detail view of pathway.php

(no description)

Copyright:	Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License:	GNU/GPL, see LICENSE.php
Version:	$Id: pathway.php 14997 2010-02-22 23:27:02Z ian $
File Size:	218 lines (5 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

JPathway:: (8 methods):
  __construct()
  getInstance()
  getPathway()
  setPathway()
  getPathwayNames()
  addItem()
  setItemName()
  _makeItem()

Class: JPathway - X-Ref

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.

__construct($options = array() X-Ref

Class constructor

getInstance($client, $options = array() X-Ref

Returns a reference a JPathway object

This method must be invoked as:
<pre>  $menu = &JPathway::getInstance();</pre>

param: string  $client  The name of the client
param: array     $options An associative array of options
return: JPathway     A pathway object.

getPathway() X-Ref

Return the JPathWay items array

return: array Array of pathway items

setPathway($pathway) X-Ref

Set the JPathway items array.

param: array $pathway An array of pathway objects.
return: array The previous pathway data.

getPathwayNames() X-Ref

Create and return an array of the pathway names.

return: array Array of names of pathway items

addItem($name, $link='') X-Ref

Create and add an item to the pathway.

param: string $name
param: string $link
return: boolean True on success

setItemName($id, $name) X-Ref

Set item name.

param: integer $id
param: string $name
return: boolean True on success

_makeItem($name, $link) X-Ref

Create and return a new pathway object.

param: string $name Name of the item
param: string $link Link to the item
return: object Pathway item object

PHP Cross Reference of Joomla 1.5.26 DE

/libraries/joomla/application/ -> pathway.php (summary)

Defines 1 class