Pathway

Class to maintain a pathway.

The user's navigated path within the application.

since

1.5

Methods

__construct

Class constructor

__construct(array $options = array()) 
since

1.5

Arguments

$options

arrayThe class options.

_makeItem

Create and return a new pathway object.

_makeItem(string $name, string $link) : \Joomla\CMS\Pathway\Pathway
deprecated
since

1.5

deprecated

4.0 Use makeItem() instead

Arguments

$name

stringName of the item

$link

stringLink to the item

Response

\Joomla\CMS\Pathway\PathwayPathway item object

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, array $options = array()) : \Joomla\CMS\Pathway\Pathway
static
since

1.5

throws

\RuntimeException

Arguments

$client

stringThe name of the client

$options

arrayAn associative array of options

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) : \Joomla\CMS\Pathway\Pathway
since

3.1

Arguments

$name

stringName of the item

$link

stringLink to the item

Response

\Joomla\CMS\Pathway\PathwayPathway 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

deprecated
since

1.5

deprecated

4.0 Will convert to $pathway

Type(s)

array

_count

Integer number of items in the pathway

deprecated
since

1.5

deprecated

4.0 Will convert to $count

Type(s)

integer

instances

JPathway instances container.

static
since

1.7

Type(s)

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