Actions

API16

JParameter/renderToArray

From Joomla! Documentation

< API16:JParameter
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 all parameters to an array

[Edit Descripton]

Description:JParameter/renderToArray

Syntax

renderToArray($name= 'params', $group= '_default')
Parameter Name Default Value Description
$name 'params' The name of the control, or the default text area if a setup file is not found
$group '_default'

Returns

array Array of all parameters, each as 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 renderToArray($name = 'params', $group = '_default')
{
        if (!isset($this->_xml[$group])) {
                return false;
        }
        $results = array();
        foreach ($this->_xml[$group]->children() as $param)  {
                $result = $this->getParam($param, $name, $group);
                $results[$result[5]] = $result;
        }
        return $results;
}

[Edit See Also] SeeAlso:JParameter/renderToArray

Examples

<CodeExamplesForm />