JParameter/getParam: Difference between revisions
From Joomla! Documentation
No edit summary |
m clean up |
||
Line 2: | Line 2: | ||
Render a parameter type. | Render a parameter type. | ||
{{Description:JParameter/getParam}} | |||
{{subst:Description:JParameter/getParam}} | |||
===Syntax=== | ===Syntax=== | ||
Line 63: | Line 61: | ||
</source> | </source> | ||
{{subst:SeeAlso:JParameter/getParam}} | |||
{{SeeAlso:JParameter/getParam}} | |||
===Examples=== | ===Examples=== |
Revision as of 14:18, 24 March 2017
Description
Render a parameter type.
{{subst:Description:JParameter/getParam}}
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);
}
{{subst:SeeAlso:JParameter/getParam}}
Examples
<CodeExamplesForm />