Pathway

Class to maintain a pathway.

The user's navigated path within the application.

since

1.5

Methods

addItem

Create and add an item to the pathway.

addItem(string $name, string $link = '') : boolean
since

1.5

Arguments

$name

stringThe name of the item.

$link

stringThe link to the item.

Response

booleanTrue on success

getInstance

Returns a Pathway object

getInstance(string $client) : \Joomla\CMS\Pathway\Pathway
static deprecated
since

1.5

throws

\RuntimeException

deprecated

5.0 Get the instance from the application, eg. $application->getPathway()

Arguments

$client

stringThe name of the client

Response

\Joomla\CMS\Pathway\PathwayA Pathway object.

getPathway

Return the Pathway items array

getPathway() : array
since

1.5

Response

arrayArray of pathway items

getPathwayNames

Create and return an array of the pathway names.

getPathwayNames() : array
since

1.5

Response

arrayArray of names of pathway items

makeItem

Create and return a new pathway object.

makeItem(string $name, string $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(integer $id, string $name) : boolean
since

1.5

Arguments

$id

integerThe id of the item on which to set the name.

$name

stringThe name to set.

Response

booleanTrue on success

setPathway

Set the Pathway items array.

setPathway(array $pathway) : array
since

1.5

Arguments

$pathway

arrayAn array of pathway objects.

Response

arrayThe previous pathway data.

Properties

pathway

Array to hold the pathway item objects

since

4.0.0

Type(s)

array

count

Integer number of items in the pathway

since

4.0.0

Type(s)

integer

instances

Pathway instances container.

static
since

1.7

Type(s)

array<mixed,\Joomla\CMS\Pathway\Pathway>