Actions

Difference between revisions of "File form field type"

From Joomla! Documentation

(Remove Incomplete and review tags)
(Add Labelclass and showon. Include some more catagories)
 
Line 6: Line 6:
 
* '''name''' (mandatory) is the unique name of the field.
 
* '''name''' (mandatory) is the unique name of the field.
 
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
 
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''default''' (optional) (not translatable) is the default value, but doesn't mean much for a file.
 
 
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
 
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
 +
* '''default''' (optional) (not translatable) is the default value, but doesn't mean much for a file.
 
* '''size''' (optional) is the width of the file box in characters.  
 
* '''size''' (optional) is the width of the file box in characters.  
 
* [http://www.w3schools.com/tags/att_input_accept.asp '''accept'''] (optional) Tells the browser what MIME types your form will allow to be uploaded.
 
* [http://www.w3schools.com/tags/att_input_accept.asp '''accept'''] (optional) Tells the browser what MIME types your form will allow to be uploaded.
 
* '''class''' (optional) is a CSS class name for the HTML form field.
 
* '''class''' (optional) is a CSS class name for the HTML form field.
 +
* '''labelclass''' (optional) adds a CSS class for form field's label; for Joomla 2.5.4+
 
* '''disabled''' (optional)  HTML equivalent attribute
 
* '''disabled''' (optional)  HTML equivalent attribute
* '''onchange''' (optional)  HTML equivalent attribute
+
* '''onchange''' (optional)  HTML equivalent attribute (javascript use)
 
* '''required''' (optional)  For Joomla form validating it to be filled in
 
* '''required''' (optional)  For Joomla form validating it to be filled in
 
* '''validate''' (optional)  Whether to Joomla validate the field according to rules
 
* '''validate''' (optional)  Whether to Joomla validate the field according to rules
* '''onchange''' (optional)  HTML equivalent attribute (javascript use)
+
* '''showon''' (optional)  Allows you to hide the field based on the value(s) of another field; for Joomla 3.2.4+
  
 
'''Note:'''
 
'''Note:'''
You should always add the attribute enctype="multipart/form-data" to your form tag when using the file input type. Otherwise, the uploaded files will not be attached correctly.
+
When using the file input type you should always add the attribute enctype="multipart/form-data" to your form tag. Otherwise, the uploaded files will not be attached correctly.
  
 
'''Note 2:'''
 
'''Note 2:'''
Line 24: Line 25:
 
Example XML field definition:
 
Example XML field definition:
  
<source lang="xml"><field name="myfilevalue" type="file" label="Enter some text" description="Choose an image from your computer with maximum 100KB" size="10" accept="image/*" /></source>
+
<source lang="xml">
 +
<field name="myfilevalue" type="file" label="Enter some text" description="Choose an image from your computer with maximum 100KB" size="10" accept="image/*" />
 +
</source>
  
  
 
=== See also ===
 
=== See also ===
* [[Media_form_field_type]]
+
 
 
* [[Standard form field types|List of standard form field types]]
 
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>
+
<noinclude>
 +
[[Category:Standard form field types]]
 +
[[Category:Form fields]]
 +
[[Category:Development]]
 +
</noinclude>

Latest revision as of 13:23, 1 July 2015

Intro: todo

  • type (mandatory) must be file.
  • name (mandatory) is the unique name of the field.
  • label (mandatory) (translatable) is the descriptive title of the field.
  • description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
  • default (optional) (not translatable) is the default value, but doesn't mean much for a file.
  • size (optional) is the width of the file box in characters.
  • accept (optional) Tells the browser what MIME types your form will allow to be uploaded.
  • class (optional) is a CSS class name for the HTML form field.
  • labelclass (optional) adds a CSS class for form field's label; for Joomla 2.5.4+
  • disabled (optional) HTML equivalent attribute
  • onchange (optional) HTML equivalent attribute (javascript use)
  • required (optional) For Joomla form validating it to be filled in
  • validate (optional) Whether to Joomla validate the field according to rules
  • showon (optional) Allows you to hide the field based on the value(s) of another field; for Joomla 3.2.4+

Note: When using the file input type you should always add the attribute enctype="multipart/form-data" to your form tag. Otherwise, the uploaded files will not be attached correctly.

Note 2: You can put a soft limit file size by adding a hidden field with name="MAX_FILE_SIZE" and value the maximum allowed bytes which is handled by php, but you must also handle it in your code with or without it. Example XML field definition:

<field name="myfilevalue" type="file" label="Enter some text" description="Choose an image from your computer with maximum 100KB" size="10" accept="image/*" />


See also