JParameter/getParam: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Render a parameter type.
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki>
<... |
No edit summary |
||
Line 17: | Line 17: | ||
!Description | !Description | ||
|- | |- | ||
| | | &$node | ||
| | | | ||
| A param tag node. | | A param tag node. |
Revision as of 10:16, 30 March 2010
Description
Render a parameter type.
Template: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);
}
[Edit See Also] Template:SeeAlso:JParameter/getParam
Examples
<CodeExamplesForm />