API16

JParameter/renderToArray: Difference between revisions

From Joomla! Documentation

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




{{subst:Description:JParameter/renderToArray}}
 


===Syntax===
===Syntax===
Line 49: Line 49:




{{subst:SeeAlso:JParameter/renderToArray}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=renderToArray
  category=renderToArray
  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 all parameters to an array



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;
}



Examples

Code Examples