JPathway
Extends \JObjectClass to maintain a pathway.
The user's navigated path within the application.
| package |
Joomla.Platform |
|---|---|
| subpackage |
Application |
| since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
| since |
11.1 |
|---|
Arguments
- $properties
mixedEither and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
| since |
11.1 |
|---|---|
| deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
stringThe classname.
_makeItem
Create and return a new pathway object.
_makeItem(string $name, string $link) : \JPathway
| since |
11.1 |
|---|
Arguments
- $name
stringName of the item- $link
stringLink to the item
Response
\JPathwayPathway item object
addItem
Create and add an item to the pathway.
addItem(string $name, string $link = '') : boolean
| since |
11.1 |
|---|
Arguments
- $name
stringThe name of the item.- $link
stringThe link to the item.
Response
booleanTrue on success
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixed
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|---|
| see | \JObject::getProperties() |
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixedThe value of the property.
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integerOption error index.- $toString
booleanIndicates if JError objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Response
arrayArray of error messages or JErrors.
getInstance
Returns a JPathway object
getInstance(string $client, array $options = array()) : \JPathway
| since |
11.1 |
|---|
Arguments
- $client
stringThe name of the client- $options
arrayAn associative array of options
Response
\JPathwayA JPathway object.
getPathway
Return the JPathWay items array
getPathway() : array
| since |
11.1 |
|---|
Response
arrayArray of pathway items
getPathwayNames
Create and return an array of the pathway names.
getPathwayNames() : array
| since |
11.1 |
|---|
Response
arrayArray of names of pathway items
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
| since |
11.1 |
|---|---|
| see | \JObject::get() |
Arguments
- $public
booleanIf true, returns only the public properties.
Response
array
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $value
mixedThe value of the property to set.
Response
mixedPrevious value of the property.
setError
Add an error message.
setError(string $error) : void
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $error
stringError message.
setItemName
Set item name.
setItemName(integer $id, string $name) : boolean
| since |
11.1 |
|---|
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 JPathway items array.
setPathway(array $pathway) : array
| since |
11.1 |
|---|
Arguments
- $pathway
arrayAn array of pathway objects.
Response
arrayThe previous pathway data.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
| since |
11.1 |
|---|---|
| see | \JObject::set() |
Arguments
- $properties
mixedEither an associative array or another object.
Response
boolean
toString
Converts the object to a string (the class name).
toString() : string
Properties
_pathway
Array to hold the pathway item objects
| since |
11.1 |
|---|
Type(s)
array
_count
Integer number of items in the pathway
| since |
11.1 |
|---|
Type(s)
integer
instances
JPathway instances container.
| since |
11.3 |
|---|
Type(s)
array
_errors
An array of error messages or Exception objects.