Difference between revisions of "JParameter"
From Joomla! Documentation
(Layout updates) |
m (→User contributed notes: bad link repair) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JParameter== | ||
| + | ===Description=== | ||
| + | {{Description:JParameter}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JParameter|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JParameter|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::__construct/11.1|__construct]] | |[[JParameter::__construct/11.1|__construct]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::addElementPath/11.1|addElementPath]] | |[[JParameter::addElementPath/11.1|addElementPath]] | ||
|Add a directory where should search for element types. | |Add a directory where should search for element types. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::bind/11.1|bind]] | |[[JParameter::bind/11.1|bind]] | ||
|Bind data to the parameter. | |Bind data to the parameter. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::def/11.1|def]] | |[[JParameter::def/11.1|def]] | ||
|Sets a default value if not alreay assigned. | |Sets a default value if not alreay assigned. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::getGroups/11.1|getGroups]] | |[[JParameter::getGroups/11.1|getGroups]] | ||
|Get the number of params in each group. | |Get the number of params in each group. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::getNumParams/11.1|getNumParams]] | |[[JParameter::getNumParams/11.1|getNumParams]] | ||
|Return the number of parameters in a group. | |Return the number of parameters in a group. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::getParam/11.1|getParam]] | |[[JParameter::getParam/11.1|getParam]] | ||
|Render a parameter type. | |Render a parameter type. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::getParams/11.1|getParams]] | |[[JParameter::getParams/11.1|getParams]] | ||
|Render all parameters. | |Render all parameters. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::loadElement/11.1|loadElement]] | |[[JParameter::loadElement/11.1|loadElement]] | ||
|Loads an element type. | |Loads an element type. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::loadSetupFile/11.1|loadSetupFile]] | |[[JParameter::loadSetupFile/11.1|loadSetupFile]] | ||
|Loads an xml setup file and parses it. | |Loads an xml setup file and parses it. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::render/11.1|render]] | |[[JParameter::render/11.1|render]] | ||
|Render the form control. | |Render the form control. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::renderToArray/11.1|renderToArray]] | |[[JParameter::renderToArray/11.1|renderToArray]] | ||
|Render all parameters to an array. | |Render all parameters to an array. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::setXML/11.1|setXML]] | |[[JParameter::setXML/11.1|setXML]] | ||
|Sets the XML object from custom xml files. | |Sets the XML object from custom xml files. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/html/parameter.php | ||
| + | * '''Extends''' [[JRegistry/11.1|JRegistry]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.html.parameter' );</source> | <source lang="php">jimport( 'joomla.html.parameter' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JParameter source code | + | * {{JVer|11.1}} '''JParameter source code''' on [[jplatform:html/parameter.php|BitBucket]] |
| − | * [[JParameter|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Html/11.1|Html]] |
| + | * [[JParameter|Other versions of JParameter]] | ||
{{SeeAlso:JParameter}} | {{SeeAlso:JParameter}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JParameter|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JParameter|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 75: | Line 86: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JParameter]]</noinclude> | + | <noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JParameter]]</noinclude> |
Revision as of 13:59, 29 August 2012
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.
JParameter[edit]
Description[edit]
Template:Description:JParameter [Edit Descripton]
Methods[edit]
| Visibility | Method name | Description |
|---|---|---|
| public | __construct | Constructor. |
| public | addElementPath | Add a directory where should search for element types. |
| public | bind | Bind data to the parameter. |
| public | def | Sets a default value if not alreay assigned. |
| public | getGroups | Get the number of params in each group. |
| public | getNumParams | Return the number of parameters in a group. |
| public | getParam | Render a parameter type. |
| public | getParams | Render all parameters. |
| public | loadElement | Loads an element type. |
| public | loadSetupFile | Loads an xml setup file and parses it. |
| public | render | Render the form control. |
| public | renderToArray | Render all parameters to an array. |
| public | setXML | Sets the XML object from custom xml files. |
- Defined in libraries/joomla/html/parameter.php
- Extends JRegistry
Importing[edit]
jimport( 'joomla.html.parameter' );See also[edit]
- JParameter source code on BitBucket
- Subpackage Html
- Other versions of JParameter
Template:SeeAlso:JParameter [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />