class JNode extends JObject


Located at : UKNOWVA_ROOT/libraries/joomla/base/node.php

Tree Node Class.

Methods

__construct()

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
void
addChild(JNode $child)

Add child to this node

void
setParent(mixed $parent)

Set the parent of a this node

array
getChildren()

Get the children of this node

mixed
getParent()

Get the parent of this node

boolean
hasChildren()

Test if this node has children

boolean
hasParent()

Test if this node has a parent

Details

at line 43
JObject __construct()

Constructor

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()

at line 59
void addChild(JNode $child)

Add child to this node

If the child already has a parent, the link is unset

Parameters

JNode $child The child to be added

Return Value

void

at line 78
void setParent(mixed $parent)

Set the parent of a this node

If the node already has a parent, the link is unset

Parameters

mixed $parent The JNode for parent to be set or null

Return Value

void

at line 102
array getChildren()

Get the children of this node

Return Value

array The children

at line 114
mixed getParent()

Get the parent of this node

Return Value

mixed JNode object with the parent or null for no parent

at line 126
boolean hasChildren()

Test if this node has children

Return Value

boolean True if there are chilren

at line 138
boolean hasParent()

Test if this node has a parent

Return Value

boolean True if there is a parent