API15

JParameter/getParam: Difference between revisions

From Joomla! Documentation

m removing red link to edit, no existant pages
m preparing for archive only
 
Line 73: Line 73:


===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=*

Latest revision as of 01:01, 25 March 2017

Description

Render a parameter type

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

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

function getParam(&$node, $control_name = 'params', $group = '_default')
{
        //get the type of the parameter
        $type = $node->attributes('type');

        //remove any occurance of a mos_ prefix
        $type = str_replace('mos_', '', $type);

        $element =& $this->loadElement($type);

        // error happened
        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);
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

Code Examples