Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class Pathway - list of methods

Class to maintain a pathway.
The user's navigated path within the application.

Direct known subclasses

SitePathway
Package: Joomla\CMS\Pathway
Copyright: (C) 2005 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Pathway/Pathway.php
Project: Joomla

Method Summary

public static \Joomla\CMS\Pathway\Pathway
(mixed $client)

Returns a Pathway object
Parameters
  • string $client The name of the client
Returns
  • \Joomla\CMS\Pathway\Pathway A Pathway object.
Since
  • 1.5
Deprecated
  • 5.0
-
  • \RuntimeException
Show source code of this method: getInstance Source Code

public array
()

Return the Pathway items array
Returns
  • array Array of pathway items
Since
  • 1.5
Show source code of this method: getPathway Source Code

public array
(mixed $pathway)

Set the Pathway items array.
Parameters
  • array $pathway An array of pathway objects.
Returns
  • array The previous pathway data.
Since
  • 1.5
Show source code of this method: setPathway Source Code

public array
()

Create and return an array of the pathway names.
Returns
  • array Array of names of pathway items
Since
  • 1.5
Show source code of this method: getPathwayNames Source Code

public bool
(mixed $name, mixed $link = '')

Create and add an item to the pathway.
Parameters
  • string $name The name of the item.
  • string $link The link to the item.
Returns
  • bool True on success
Since
  • 1.5
Show source code of this method: addItem Source Code

public bool
(mixed $id, mixed $name)

Set item name.
Parameters
  • int $id The id of the item on which to set the name.
  • string $name The name to set.
Returns
  • bool True on success
Since
  • 1.5
Show source code of this method: setItemName Source Code

protected \stdClass
(mixed $name, mixed $link)

Create and return a new pathway object.
Parameters
  • string $name Name of the item
  • string $link Link to the item
Returns
  • \stdClass Pathway item object
Since
  • 3.1
Show source code of this method: makeItem Source Code

Properties Summary

protected array
$pathway
Array to hold the pathway item objects
Since
  • 4.0.0
protected int
$count
Integer number of items in the pathway
Since
  • 4.0.0
protected static \Joomla\CMS\Pathway\Pathway[]
$instances
Pathway instances container.
Since
  • 1.7

Tags Summary

Since
1.5