Actions

API15

JParameter/getParam

From Joomla! Documentation

< API15:JParameter
Revision as of 13:40, 12 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

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

<CodeExamplesForm />