Pathway
Class to maintain a pathway.
The user's navigated path within the application.
since |
1.5 |
---|---|
package |
Joomla CMS |
Methods
addItem
Create and add an item to the pathway.
addItem(string name, string link = '') : bool
since |
1.5 |
---|
Arguments
- name
string
The name of the item.- link
string
The link to the item.
Response
bool
True on success
getInstance
Returns a Pathway object
getInstance(string client) : \Joomla\CMS\Pathway\Pathway
since |
1.5 |
---|---|
throws |
|
deprecated |
5.0 Get the instance from the application, eg. $application->getPathway() |
Arguments
- client
string
The name of the client
Response
\Joomla\CMS\Pathway\Pathway
A Pathway object.
getPathway
Return the Pathway items array
getPathway() : array
since |
1.5 |
---|
Response
array
Array of pathway items
getPathwayNames
Create and return an array of the pathway names.
getPathwayNames() : array
since |
1.5 |
---|
Response
array
Array of names of pathway items
makeItem
Create and return a new pathway object.
makeItem(string name, string link) : \stdClass
since |
3.1 |
---|
Arguments
- name
string
Name of the item- link
string
Link to the item
Response
\stdClass
Pathway item object
setItemName
Set item name.
setItemName(int id, string name) : bool
since |
1.5 |
---|
Arguments
- id
int
The id of the item on which to set the name.- name
string
The name to set.
Response
bool
True on success
setPathway
Set the Pathway items array.
setPathway(array pathway) : array
since |
1.5 |
---|
Arguments
- pathway
array
An array of pathway objects.
Response
array
The previous pathway data.