JParameter/1.5
From Joomla! Documentation
< JParameter(Difference between revisions)
(Bulk upload by Doxiki2) |
(Layout updates) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|1.5}} 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/1.5|__construct]] | |[[JParameter::__construct/1.5|__construct]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::addElementPath/1.5|addElementPath]] | |[[JParameter::addElementPath/1.5|addElementPath]] | ||
|Add a directory where should search for element types. | |Add a directory where should search for element types. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::bind/1.5|bind]] | |[[JParameter::bind/1.5|bind]] | ||
|Bind data to the parameter. | |Bind data to the parameter. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::def/1.5|def]] | |[[JParameter::def/1.5|def]] | ||
|Sets a default value if not alreay assigned. | |Sets a default value if not alreay assigned. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::get/1.5|get]] | |[[JParameter::get/1.5|get]] | ||
|Get a value. | |Get a value. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::getGroups/1.5|getGroups]] | |[[JParameter::getGroups/1.5|getGroups]] | ||
|Get the number of params in each group. | |Get the number of params in each group. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::getNumParams/1.5|getNumParams]] | |[[JParameter::getNumParams/1.5|getNumParams]] | ||
|Return number of params to render. | |Return number of params to render. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::getParam/1.5|getParam]] | |[[JParameter::getParam/1.5|getParam]] | ||
|Render a parameter type. | |Render a parameter type. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::getParams/1.5|getParams]] | |[[JParameter::getParams/1.5|getParams]] | ||
|Render all parameters. | |Render all parameters. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::loadElement/1.5|loadElement]] | |[[JParameter::loadElement/1.5|loadElement]] | ||
|Loads a element type. | |Loads a element type. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::loadSetupFile/1.5|loadSetupFile]] | |[[JParameter::loadSetupFile/1.5|loadSetupFile]] | ||
|Loads an xml setup file and parses it. | |Loads an xml setup file and parses it. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::render/1.5|render]] | |[[JParameter::render/1.5|render]] | ||
|Render. | |Render. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::renderToArray/1.5|renderToArray]] | |[[JParameter::renderToArray/1.5|renderToArray]] | ||
|Render all parameters to an array. | |Render all parameters to an array. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::set/1.5|set]] | |[[JParameter::set/1.5|set]] | ||
|Set a value. | |Set a value. | ||
|- | |- | ||
| + | |public | ||
|[[JParameter::setXML/1.5|setXML]] | |[[JParameter::setXML/1.5|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/1.5|JRegistry]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.html.parameter' );</source> | <source lang="php">jimport( 'joomla.html.parameter' );</source> | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|1.5}} '''JParameter''' on [http://api.joomla.org/Joomla-Framework/Html/JParameter.html api.joomla.org] | ||
| + | * {{JVer|1.5}} '''JParameter source code''' on [[jframework15:html/parameter.php|JoomlaCode]] | ||
| + | * {{JVer|1.5}} Subpackage [[Subpackage Html/1.5|Html]] | ||
| + | * [[JParameter|Other versions of 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 80: | Line 95: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JParameter]]</noinclude> | <noinclude>[[Category:Framework]][[Category:Framework 1.5]][[Category:JParameter]]</noinclude> | ||
Revision as of 18:11, 25 April 2011
JParameter
Description
Description:JParameter [Edit Descripton]
Methods
| 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 | get | Get a value. |
| public | getGroups | Get the number of params in each group. |
| public | getNumParams | Return number of params to render. |
| public | getParam | Render a parameter type. |
| public | getParams | Render all parameters. |
| public | loadElement | Loads a element type. |
| public | loadSetupFile | Loads an xml setup file and parses it. |
| public | render | Render. |
| public | renderToArray | Render all parameters to an array. |
| public | set | Set a value. |
| public | setXML | Sets the XML object from custom xml files. |
- Defined in libraries/joomla/html/parameter.php
- Extends JRegistry
Importing
jimport( 'joomla.html.parameter' );
See also
- JParameter on api.joomla.org
- JParameter source code on JoomlaCode
- Subpackage Html
- Other versions of JParameter
SeeAlso:JParameter [Edit See Also]
User contributed notes
<CodeExamplesForm />
