Actions

API17

Difference between revisions of "JParameter"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (moving preparation)
 
(5 intermediate revisions by 2 users 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>
{{Description:JParameter}}
 
===Defined in===
 
libraries/joomla/html/parameter.php
 
===Subpackage===
 
[[Subpackage Html/11.1|Html]]
 
===Extends===
 
[[JRegistry/11.1|JRegistry]]
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
|[[JParameter::__construct/11.1|__construct]]
+
|public
 +
|[[API17:JParameter::__construct|__construct]]
 
|Constructor.  
 
|Constructor.  
 
|-
 
|-
|[[JParameter::addElementPath/11.1|addElementPath]]
+
|public
 +
|[[API17:JParameter::addElementPath|addElementPath]]
 
|Add a directory where  should search for element types.  
 
|Add a directory where  should search for element types.  
 
|-
 
|-
|[[JParameter::bind/11.1|bind]]
+
|public
 +
|[[API17:JParameter::bind|bind]]
 
|Bind data to the parameter.  
 
|Bind data to the parameter.  
 
|-
 
|-
|[[JParameter::def/11.1|def]]
+
|public
 +
|[[API17:JParameter::def|def]]
 
|Sets a default value if not alreay assigned.  
 
|Sets a default value if not alreay assigned.  
 
|-
 
|-
|[[JParameter::getGroups/11.1|getGroups]]
+
|public
 +
|[[API17:JParameter::getGroups|getGroups]]
 
|Get the number of params in each group.  
 
|Get the number of params in each group.  
 
|-
 
|-
|[[JParameter::getNumParams/11.1|getNumParams]]
+
|public
 +
|[[API17:JParameter::getNumParams|getNumParams]]
 
|Return the number of parameters in a group.  
 
|Return the number of parameters in a group.  
 
|-
 
|-
|[[JParameter::getParam/11.1|getParam]]
+
|public
 +
|[[API17:JParameter::getParam|getParam]]
 
|Render a parameter type.  
 
|Render a parameter type.  
 
|-
 
|-
|[[JParameter::getParams/11.1|getParams]]
+
|public
 +
|[[API17:JParameter::getParams|getParams]]
 
|Render all parameters.  
 
|Render all parameters.  
 
|-
 
|-
|[[JParameter::loadElement/11.1|loadElement]]
+
|public
 +
|[[API17:JParameter::loadElement|loadElement]]
 
|Loads an element type.  
 
|Loads an element type.  
 
|-
 
|-
|[[JParameter::loadSetupFile/11.1|loadSetupFile]]
+
|public
 +
|[[API17:JParameter::loadSetupFile|loadSetupFile]]
 
|Loads an xml setup file and parses it.  
 
|Loads an xml setup file and parses it.  
 
|-
 
|-
|[[JParameter::render/11.1|render]]
+
|public
 +
|[[API17:JParameter::render|render]]
 
|Render the form control.  
 
|Render the form control.  
 
|-
 
|-
|[[JParameter::renderToArray/11.1|renderToArray]]
+
|public
 +
|[[API17:JParameter::renderToArray|renderToArray]]
 
|Render all parameters to an array.  
 
|Render all parameters to an array.  
 
|-
 
|-
|[[JParameter::setXML/11.1|setXML]]
+
|public
 +
|[[API17:JParameter::setXML|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''' [[API17:JRegistry|JRegistry]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.html.parameter' );</source>
 
<source lang="php">jimport( 'joomla.html.parameter' );</source>
 
===See also===
 
===See also===
* [[JParameter|Other versions of this class]]
+
* {{JVer|11.1}} '''JParameter source code''' on [[jplatform:html/parameter.php|BitBucket]]
 +
* {{JVer|11.1}} Subpackage [[API17:Subpackage Html|Html]]
 +
* [[API17: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>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 73: 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 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 20:18, 11 May 2013

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.

Joomla 11.1 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 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

jimport( 'joomla.html.parameter' );

See also

  • Joomla 11.1 JParameter source code on BitBucket
  • Joomla 11.1 Subpackage Html
  • Other versions of JParameter

SeeAlso:JParameter [Edit See Also]

User contributed notes

<CodeExamplesForm />