API15

JParameter/getParam

From Joomla! Documentation

< API15:JParameter
Revision as of 19:01, 24 March 2017 by JoomlaWikiBot (talk | contribs) (preparing for archive only)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Render a parameter type

[<! removed edit link to red link >]

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

Syntax[edit]

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[edit]

array Any array of the label, the form element and the tooltip

Defined in[edit]

libraries/joomla/html/parameter.php

Importing[edit]

jimport( 'joomla.html.parameter' );

Source Body[edit]

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[edit]

Code Examples[edit]