API17

Difference between revisions of "JParameter::getParams"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JParameter::getParams|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JParameter::getParams|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JParameter::getParams ($name= 'params', $group= '_default')
+
public function getParams (
 +
        $name= 'params'
 +
        $group= '_default'
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 29: Line 29:
 
|string
 
|string
 
|'_default'
 
|'_default'
|An optional group to render. The default group is used if not supplied.  
+
|An optional group to render. The default group is used if not supplied.
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' array An array of all parameters, each as array of the label, the form element and the tooltip.
array An array of all parameters, each as array of the label, the form element and the tooltip.
+
* '''Defined''' on line 252 of libraries/joomla/html/parameter.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/html/parameter.php (line 246)
 
* see source code in [[jplatform:html/parameter.php#cl-246|BitBucket]]
 
===Referenced by===
 
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JParameter::getParams source code''' on [[jplatform:html/parameter.php#cl-244|BitBucket]]
 +
* {{JVer|11.1}} Class [[JParameter/11.1|JParameter]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Html/11.1|Html]]
 +
* [[JParameter::getParams|Other versions of JParameter::getParams]]
 +
{{SeeAlso:JParameter::getParams}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JParameter::getParams|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JParameter::getParams|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JParameter/11.1|JParameter]]
+
===User contributed notes===
* [[JParameter::getParams|Other versions of this method]]
 
{{SeeAlso:JParameter::getParams}}
 
===Examples===
 
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 53: Line 52:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JParameter]][[Category:JParameter::getParams]]</noinclude>
 
<noinclude>[[Category:JParameter]][[Category:JParameter::getParams]]</noinclude>

Revision as of 21:28, 27 April 2011

The "API17" 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.

Joomla 11.1 JParameter::getParams[edit]

Description[edit]

Render all parameters.

Template:Description:JParameter::getParams [Edit Descripton]

public function getParams (
        $name= 'params'
        $group= '_default'
)
Parameter Type Default Description
$name string 'params' An optional name of the HTML form control. The default is 'params' if not supplied.
$group string '_default' An optional group to render. The default group is used if not supplied.
  • Returns array An array of all parameters, each as array of the label, the form element and the tooltip.
  • Defined on line 252 of libraries/joomla/html/parameter.php
  • Since Joomla 11.1

See also[edit]

Template:SeeAlso:JParameter::getParams [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />