API16

JParameter/getParam: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JParameter/getParam}}
 


===Syntax===
===Syntax===
Line 62: Line 62:




{{subst:SeeAlso:JParameter/getParam}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=getParam
  category=getParam
  category=JParameter
  category=JParameter
  category=CodeExample
  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