Actions

J1.5

Difference between revisions of "Password parameter type"

From Joomla! Documentation

m (Fixed category mess)
(This is a parameter, not a form field.)
Line 1: Line 1:
 
[[Image:Params.password.jpg|right]]
 
[[Image:Params.password.jpg|right]]
 +
 +
{{Ambox|type=notice|text=[[Parameter|Parameters]] have been superseded by [[Form field|form fields]] in Joomla! 1.6. You may want to use the corresponding [[Password form field type]].}}
 +
 
The '''password''' parameter type provides a text box for entry of a password.  The password characters will be obscured as they are entered.  If the parameter has a saved value this is entered (in obscured form) into the text box.  If not, the default value (if any) is entered.
 
The '''password''' parameter type provides a text box for entry of a password.  The password characters will be obscured as they are entered.  If the parameter has a saved value this is entered (in obscured form) into the text box.  If not, the default value (if any) is entered.
  
Line 17: Line 20:
 
=== See also ===
 
=== See also ===
 
* [[Text parameter type]]
 
* [[Text parameter type]]
* [[Standard form field types|Table of all standard form field types]]
+
* [[Standard parameter types|List of standard parameter types]]
[[Category:Standard form field types]]</noinclude>
+
[[Category:Standard parameter types]]</noinclude>

Revision as of 07:50, 21 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.
Params.password.jpg

The password parameter type provides a text box for entry of a password. The password characters will be obscured as they are entered. If the parameter has a saved value this is entered (in obscured form) into the text box. If not, the default value (if any) is entered.

Note that the password string is stored in params.ini in cleartext; the stored value is not obscured by any hash function. Since most web servers will, by default, serve a params.ini file if the URL is entered in a web browser, this cannot be considered a secure method of holding a password.

  • type (mandatory) must be password.
  • name (mandatory) is the unique name of the parameter.
  • label (mandatory) (translatable) is the descriptive title of the field.
  • size (optional) is the width of the text box in characters. If omitted the width is determined by the browser. The value of size does not limit the number of characters that may be entered.
  • default (optional) is the default password.
  • description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
  • class (optional) is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.

Example XML parameter definition:

<param name="mypassword" type="password" default="secret" label="Enter a password" description="" size="5" />

See also