[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Pathway/ -> Pathway.php (summary)

Joomla! Content Management System

Copyright: (C) 2005 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 193 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Pathway:: (7 methods):
  getInstance()
  getPathway()
  setPathway()
  getPathwayNames()
  addItem()
  setItemName()
  makeItem()


Class: Pathway  - X-Ref

Class to maintain a pathway.

The user's navigated path within the application.

getInstance($client)   X-Ref
Returns a Pathway object

param: string  $client  The name of the client
return: Pathway  A Pathway object.

getPathway()   X-Ref
Return the Pathway items array

return: array  Array of pathway items

setPathway($pathway)   X-Ref
Set the Pathway 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  The name of the item.
param: string  $link  The link to the item.
return: boolean  True on success

setItemName($id, $name)   X-Ref
Set item name.

param: integer  $id    The id of the item on which to set the name.
param: string   $name  The name to set.
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: \stdClass  Pathway item object



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer