class JPathwaySite extends JPathway


Located at : UKNOWVA_ROOT/includes/pathway.php

Class to manage the site application pathway.

Methods

__construct($options = array())

Class constructor.

string
__toString()

Magic method to convert the object to a string gracefully.

from JObject
mixed
def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

from JObject
mixed
get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

from JObject
array
getProperties(boolean $public = true)

Returns an associative array of object properties.

from JObject
string
getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

from JObject
array
getErrors()

Return all errors, if any.

from JObject
mixed
set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

from JObject
boolean
setProperties(mixed $properties)

Set the object properties based on a named array/hash.

from JObject
void
setError(string $error)

Add an error message.

from JObject
string
toString() deprecated

No description

from JObject
static JPathway
getInstance(string $client, array $options = array())

Returns a JPathway object

from JPathway
array
getPathway()

Return the JPathWay items array

from JPathway
array
setPathway(array $pathway)

Set the JPathway items array.

from JPathway
array
getPathwayNames()

Create and return an array of the pathway names.

from JPathway
boolean
addItem(string $name, string $link = '')

Create and add an item to the pathway.

from JPathway
boolean
setItemName(integer $id, string $name)

Set item name.

from JPathway

Details

at line 28
JObject __construct($options = array())

Class constructor.

Parameters

$options

Return Value

JObject

in JObject at line 56
string __toString()

Magic method to convert the object to a string gracefully.

Return Value

string The classname.

in JObject at line 70
mixed def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed

in JObject at line 88
mixed get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed The value of the property.

See also

getProperties()

in JObject at line 107
array getProperties(boolean $public = true)

Returns an associative array of object properties.

Parameters

boolean $public If true, returns only the public properties.

Return Value

array

See also

get()

in JObject at line 133
string getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

Parameters

integer $i Option error index.
boolean $toString Indicates if JError objects should return their error message.

Return Value

string Error message

in JObject at line 165
array getErrors()

Return all errors, if any.

Return Value

array Array of error messages or JErrors.

in JObject at line 180
mixed set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

Parameters

string $property The name of the property.
mixed $value The value of the property to set.

Return Value

mixed Previous value of the property.

in JObject at line 198
boolean setProperties(mixed $properties)

Set the object properties based on a named array/hash.

Parameters

mixed $properties Either an associative array or another object.

Return Value

boolean

See also

set()

in JObject at line 222
void setError(string $error)

Add an error message.

Parameters

string $error Error message.

Return Value

void

in JObject at line 235
string toString() deprecated

deprecated 12.1 Use magic method __toString()

Return Value

string

See also

__toString()

in JPathway at line 54
static JPathway getInstance(string $client, array $options = array())

Returns a JPathway object

Parameters

string $client The name of the client
array $options An associative array of options

Return Value

JPathway A JPathway object.

in JPathway at line 95
array getPathway()

Return the JPathWay items array

Return Value

array Array of pathway items

in JPathway at line 112
array setPathway(array $pathway)

Set the JPathway items array.

Parameters

array $pathway An array of pathway objects.

Return Value

array The previous pathway data.

in JPathway at line 130
array getPathwayNames()

Create and return an array of the pathway names.

Return Value

array Array of names of pathway items

in JPathway at line 154
boolean addItem(string $name, string $link = '')

Create and add an item to the pathway.

Parameters

string $name
string $link

Return Value

boolean True on success

in JPathway at line 177
boolean setItemName(integer $id, string $name)

Set item name.

Parameters

integer $id
string $name

Return Value

boolean True on success