SitePathway
Extends PathwayClass to manage the site application pathway.
| since |
1.5 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Class constructor.
__construct(\Joomla\CMS\Application\SiteApplication app = null) :
addItem
Create and add an item to the pathway.
addItem( name, link = '') :
| since |
1.5 |
|---|
Arguments
- name
stringThe name of the item.- link
stringThe link to the item.
Response
boolTrue on success
getInstance
Returns a Pathway object
getInstance( client) : \Joomla\CMS\Pathway\Pathway
| since |
1.5 |
|---|---|
| throws |
|
| deprecated |
4.3 will be removed in 6.0 Get the instance from the application Example: $app->getPathway() |
Arguments
- client
stringThe name of the client
Response
PathwayA Pathway object.
getPathway
Return the Pathway items array
getPathway() : mixed||string|int
| since |
1.5 |
|---|
Response
array<string|int, mixed>Array of pathway items
getPathwayNames
Create and return an array of the pathway names.
getPathwayNames() : mixed||string|int
| since |
1.5 |
|---|
Response
array<string|int, mixed>Array of names of pathway items
makeItem
Create and return a new pathway object.
makeItem( name, link) : \stdClass
| since |
3.1 |
|---|
Arguments
- name
stringName of the item- link
stringLink to the item
Response
stdClassPathway item object
setItemName
Set item name.
setItemName( id, name) :
| since |
1.5 |
|---|
Arguments
- id
intThe id of the item on which to set the name.- name
stringThe name to set.
Response
boolTrue on success
setPathway
Set the Pathway items array.
setPathway(mixed||string|int pathway) : mixed||string|int
| since |
1.5 |
|---|
Arguments
- pathway
array<string|int, mixed>An array of pathway objects.
Response
array<string|int, mixed>The previous pathway data.
Properties
pathway
Array to hold the pathway item objects
| since |
4.0.0 |
|---|
Type(s)
array<string|int, mixed>
count
Integer number of items in the pathway
| since |
4.0.0 |
|---|
Type(s)
int
instances
Pathway instances container.