JParameter/getParam: Difference between revisions
From Joomla! Documentation
No edit summary |
m preparing for archive only |
||
(One intermediate revision by the same user not shown) | |||
Line 2: | Line 2: | ||
Render a parameter type. | Render a parameter type. | ||
===Syntax=== | ===Syntax=== | ||
Line 63: | Line 61: | ||
</source> | </source> | ||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=getParam | category=getParam | ||
category=JParameter | category=JParameter | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> |
Latest revision as of 01:58, 25 March 2017
Description
Render a parameter type.
Syntax
getParam(&$node, $control_name= 'params', $group= '_default')
Parameter Name | Default Value | Description |
---|---|---|
&$node | A param tag node. | |
$control_name | 'params' | The control name. |
$group | '_default' |
Returns
array Any array of the label, the form element and the tooltip.
Defined in
libraries/joomla/html/parameter.php
Importing
jimport( 'joomla.html.parameter' );
Source Body
public function getParam(&$node, $control_name = 'params', $group = '_default')
{
// Get the type of the parameter.
$type = $node->attributes('type');
$element = &$this->loadElement($type);
// Check for an error.
if ($element === false) {
$result = array();
$result[0] = $node->attributes('name');
$result[1] = JText::_('Element not defined for type').' = '.$type;
$result[5] = $result[0];
return $result;
}
// Get value.
$value = $this->get($node->attributes('name'), $node->attributes('default'), $group);
return $element->render($node, $value, $control_name);
}
Examples
Code Examples