JParameter deprecated
class JParameter extends JRegistry
deprecated
Parameter handler
Methods
Magic function to render this object as a string using default args of toString method.
Sets a default value if not alreay assigned.
Returns a reference to a global JRegistry object, only creating it if it doesn't already exist.
Load a associative array of values into the default namespace
Load the public variables of the object into the default namespace.
Load the contents of a file into the registry
Load a string into the registry
Get a namespace in a given string format
Load an XML string into the registry into the given namespace [or default if a namespace is not given]
Load an INI string into the registry into the given namespace [or default if a namespace is not given]
Load an JSON string into the registry into the given namespace [or default if a namespace is not given]
Render all parameters to an array.
Render a parameter type.
Add a directory where JParameter should search for element types.
Details
at line 62
void
__construct(mixed $data = '', string $path = '')
deprecated
deprecated
Constructor
in JRegistry at line 73
string
__toString()
Magic function to render this object as a string using default args of toString method.
at line 96
string
def(string $key, string $default = '', string $group = '_default')
deprecated
deprecated
Sets a default value if not alreay assigned.
in JRegistry at line 104
boolean
exists(string $path)
Check if a registry path exists.
in JRegistry at line 139
mixed
get(string $path, mixed $default = null)
Get a registry value.
in JRegistry at line 184
static object
getInstance(string $id)
Returns a reference to a global JRegistry object, only creating it if it doesn't already exist.
This method must be invoked as:
$registry = JRegistry::getInstance($id);
in JRegistry at line 208
boolean
loadArray(array $array)
Load a associative array of values into the default namespace
in JRegistry at line 224
boolean
loadObject(object $object)
Load the public variables of the object into the default namespace.
in JRegistry at line 242
boolean
loadFile(string $file, string $format = 'JSON', mixed $options = array())
Load the contents of a file into the registry
in JRegistry at line 262
boolean
loadString(string $data, string $format = 'JSON', mixed $options = array())
Load a string into the registry
in JRegistry at line 282
boolean
merge(object $source)
Merge a JRegistry object into this one
in JRegistry at line 307
mixed
set(string $path, mixed $value)
Set a registry value.
in JRegistry at line 339
array
toArray()
Transforms a namespace to an array
in JRegistry at line 351
object
toObject()
Transforms a namespace to an object
in JRegistry at line 366
string
toString(string $format = 'JSON', mixed $options = array())
Get a namespace in a given string format
in JRegistry at line 445
boolean
loadXML(string $data, string $namespace = null)
deprecated
deprecated
Load an XML string into the registry into the given namespace [or default if a namespace is not given]
in JRegistry at line 463
boolean
loadINI(string $data, string $namespace = null, mixed $options = array())
deprecated
deprecated
Load an INI string into the registry into the given namespace [or default if a namespace is not given]
in JRegistry at line 479
boolean
loadJSON(string $data)
deprecated
deprecated
Load an JSON string into the registry into the given namespace [or default if a namespace is not given]
in JRegistry at line 495
boolean
makeNameSpace(string $namespace)
deprecated
deprecated
Create a namespace
in JRegistry at line 510
array
getNameSpaces()
deprecated
deprecated
Get the list of namespaces
in JRegistry at line 528
mixed
getValue(string $path, mixed $default = null)
deprecated
deprecated
Get a registry value
in JRegistry at line 550
mixed
setValue(string $path, mixed $value)
deprecated
deprecated
Set a registry value
at line 324
boolean
loadSetupFile(string $path)
deprecated
deprecated
Loads an XML setup file and parses it.
at line 113
void
setXML(JSimpleXMLElement $xml)
deprecated
deprecated
Sets the XML object from custom XML files.
at line 139
boolean
bind(mixed $data, string $group = '_default')
deprecated
deprecated
Bind data to the parameter.
at line 161
string
render(string $name = 'params', string $group = '_default')
deprecated
deprecated
Render the form control.
at line 203
array
renderToArray(string $name = 'params', string $group = '_default')
deprecated
deprecated
Render all parameters to an array.
at line 226
mixed
getNumParams(string $group = '_default')
deprecated
deprecated
Return the number of parameters in a group.
at line 243
array
getGroups()
deprecated
deprecated
Get the number of params in each group.
at line 267
array
getParams(string $name = 'params', string $group = '_default')
deprecated
deprecated
Render all parameters.
at line 292
array
getParam(object $node, string $control_name = 'params', string $group = '_default')
deprecated
deprecated
Render a parameter type.
at line 357
object
loadElement(string $type, boolean $new = false)
deprecated
deprecated
Loads an element type.
at line 411
void
addElementPath(mixed $path)
deprecated
deprecated
Add a directory where JParameter should search for element types.
You may either pass a string or an array of directories.
JParameter will be searching for a element type in the same order you added them. If the parameter type cannot be found in the custom folders, it will look in JParameter/types.