File form field type

From Joomla! Documentation

Revision as of 05:30, 22 November 2012 by Waveywhite (Talk | contribs)

Quill icon.png
Content is Incomplete

This article or section is incomplete, which means it may be lacking information. You are welcome to assist in its completion by editing it as well. If this article or section has not been edited in several days, please consider helping complete the content.
This article was last edited by Waveywhite (talk| contribs) 3 years ago. (Purge)

This Article Needs Your Help

This article is tagged because it NEEDS REVIEW. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.

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.
  • 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.
  • 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.
  • disabled (optional) HTML equivalent attribute
  • onchange (optional) HTML equivalent attribute
  • required (optional) For Joomla form validating it to be filled in
  • validate (optional) Whether to Joomla validate the field according to rules
  • onchange (optional) HTML equivalent attribute (javascript use)

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.

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