Difference between revisions of "Password form field type"

From Joomla! Documentation

(Created page for form field type)
 
(Marked for translation)
Line 1: Line 1:
 +
<noinclude><languages /></noinclude>
 +
<translate>The '''password''' form field type provides a text box for entry of a password. The password characters will be obscured as they are entered. If the field has a saved value this is entered (in obscured form) into the text box. If not, the default value (if any) is entered.</translate>
 
[[Image:Params.password.jpg|right]]
 
[[Image:Params.password.jpg|right]]
 +
<translate>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.</translate>
  
{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]]. For that version, you may want to use the corresponding [[Password parameter type]].}}
+
<translate>* '''type''' (mandatory) must be ''password''.</translate>
 +
<translate>* '''name''' (mandatory) is the unique name of the field.</translate>
 +
<translate>* '''label''' (mandatory) (translatable) is the descriptive title of the field.</translate>
 +
<translate>* '''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.</translate>
 +
<translate>* '''default''' (optional) is the default password.</translate>
 +
<translate>* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.</translate>
 +
<translate>* '''class''' (optional)  is a CSS class name for the HTML form field. If omitted this will default to 'text_area'.</translate>
  
The '''password''' form field type provides a text box for entry of a password. The password characters will be obscured as they are entered. If the field has a saved value this is entered (in obscured form) into the text box. If not, the default value (if any) is entered.
+
<translate>Example XML field definition:</translate>
 +
<source lang="xml"><field name="mypassword" type="password" default="secret" label="Enter a password" description="" size="5" /></source>
  
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.
+
<translate>
 +
=== See also ===
 +
</translate>
 +
<translate>
 +
* [[S:MyLanguage/Text form field type|Text form field type]]
 +
* [[S:MyLanguage/Standard form field types|List of standard form field types]]
 +
</translate>
  
* '''type''' (mandatory) must be ''password''.
 
* '''name''' (mandatory) is the unique name of the field.
 
* '''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 field definition:
 
<source lang="xml"><field name="mypassword" type="password" default="secret" label="Enter a password" description="" size="5" /></source>
 
 
<noinclude>
 
<noinclude>
=== See also ===
+
<translate>
* [[Text form field type]]
+
[[Category:Standard form field types]]
* [[Standard form field types|List of standard form field types]]
+
</translate>
[[Category:Standard form field types]]</noinclude>
+
</noinclude>

Revision as of 19:56, 22 August 2015

Other languages:
English • ‎Nederlands • ‎español • ‎français

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

Params.password.jpg

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 field.
  • 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 field definition:

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

See also[edit]