Actions

J1.5

Difference between revisions of "Standard parameter types"

From Joomla! Documentation

m (moved Standard parameter types 1.6 to Standard parameter types: Parameters are deprecated since Joomla! 1.6)
(Improved accuracy and added an explanation)
Line 1: Line 1:
There are 21 different standard parameter types supported in the Joomla Framework for all extension types (templates, components, modules and plugins). This section gives a brief description of each parameter type, in alphabetical order. Full details of each parameter type are given on the following pages.
+
{{Notice|Parameters are deprecated since Joomla! 1.6 {{JVer|1.6}}. Configuration options can now be defined using [[Form field|form fields]].}}
 +
Parameters are a mechanism in Joomla! 1.5 {{JVer|1.5}} that enables administrators to configure [[Extension|extensions]]. Parameters are handled by [[JParameter/1.5|the JParameter class]], and each parameter type is a subclass of [[JElement/1.5|JElement]]. There are 21 different standard parameter types supported in the Joomla Framework for all extension types ([[Template|templates]], [[Component|components]], [[Module|modules]] and [[Plugin|plugins]]). This section gives a brief description of each parameter type, in alphabetical order. Full details of each parameter type are given on the following pages.
  
 
* '''[[Calendar parameter type|calendar]]''' provides a text box for entry of a date.  An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
 
* '''[[Calendar parameter type|calendar]]''' provides a text box for entry of a date.  An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.

Revision as of 10:38, 20 May 2011

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.
Info non-talk.png
General Information

Parameters are deprecated since Joomla! 1.6 Joomla 1.6. Configuration options can now be defined using form fields.

Parameters are a mechanism in Joomla! 1.5 Joomla 1.5 that enables administrators to configure extensions. Parameters are handled by the JParameter class, and each parameter type is a subclass of JElement. There are 21 different standard parameter types supported in the Joomla Framework for all extension types (templates, components, modules and plugins). This section gives a brief description of each parameter type, in alphabetical order. Full details of each parameter type are given on the following pages.

  • calendar provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
  • category provides a drop down list of categories from a given section.
  • editors provides a drop down list of the available WYSIWYG editors.
  • filelist provides a drop down list of files from a specified directory.
  • folderlist provides a drop down list of folders from a specified directory.
  • helpsites provides a drop down list of the help sites for your Joomla installation.
  • hidden provides a hidden field for saving a parameter whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the params.ini file).
  • imagelist provides a drop down list of image files in a specified directory.
  • languages provides a drop down list of the installed languages for the Front-end or Back-end.
  • list provides a drop down list of custom-defined entries.
  • menu provides a drop down list of the available menus from your Joomla site.
  • menuitem provides a drop down list of the available menu items from your Joomla site.
  • password provides a text box for entry of a password. The password characters will be obscured as they are entered.
  • radio provides radio buttons to select different options.
  • spacer provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored.
  • sql provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box.
  • text provides a text box for data entry.
  • textarea provides a text area for entry of multi-line text.
  • timezones provides a drop down list of time zones.
  • usergroup provides a drop down list of user groups.