Class JPathway
Class to maintain a pathway.
The user's navigated path within the application.
Methods summary
public
|
#
__construct( array $options = array() )
Class constructor
Parameters
- $options
array - $options The class options. Since
1.5
|
public static
JPathway
|
#
getInstance( string $client, array $options = array() )
Returns a JPathway object
Returns a JPathway object
Parameters
- $client
string - $client The name of the client- $options
array - $options An associative array of options Returns
Throws
Since
1.5
|
public
array
|
#
getPathway( )
Return the JPathway items array
Return the JPathway items array
Returns
array - Array of pathway items
Since
1.5
|
public
array
|
#
setPathway( array $pathway )
Set the JPathway items array.
Set the JPathway items array.
Parameters
- $pathway
array - $pathway An array of pathway objects. Returns
array - The previous pathway data.
Since
1.5
|
public
array
|
#
getPathwayNames( )
Create and return an array of the pathway names.
Create and return an array of the pathway names.
Returns
array - Array of names of pathway items
Since
1.5
|
public
boolean
|
#
addItem( string $name, string $link = '' )
Create and add an item to the pathway.
Create and add an item to the pathway.
Parameters
- $name
string - $name The name of the item.- $link
string - $link The link to the item. Returns
boolean - True on success
Since
1.5
|
public
boolean
|
#
setItemName( integer $id, string $name )
Set item name.
Parameters
- $id
integer - $id The id of the item on which to set the name.- $name
string - $name The name to set. Returns
boolean - True on success
Since
1.5
|
protected
JPathway
|
#
_makeItem( string $name, string $link )
Create and return a new pathway object.
Create and return a new pathway object.
Deprecated
4.0 Use makeItem() instead
Parameters
- $name
string - $name Name of the item- $link
string - $link Link to the item Returns
Since
1.5
CodeCoverageIgnore
|
protected
JPathway
|
#
makeItem( string $name, string $link )
Create and return a new pathway object.
Create and return a new pathway object.
Parameters
- $name
string - $name Name of the item- $link
string - $link Link to the item Returns
Since
3.1
|
Magic methods summary
Properties summary
protected
array
|
$_pathway
|
#
Array to hold the pathway item objects
Array to hold the pathway item objects
Deprecated
4.0 Will convert to $pathway
Since
1.5
|
protected
integer
|
$_count
|
#
Integer number of items in the pathway
Integer number of items in the pathway
Deprecated
4.0 Will convert to $count
Since
1.5
|
protected static
JPathway[]
|
$instances
|
#
JPathway instances container.
JPathway instances container.
Since
1.7
|
