Form.upload ViewHelper <f:form.upload>

A ViewHelper which generates an <input type="file"> HTML element. Make sure to set enctype="multipart/form-data" on the form!

Examples

Example:

<f:form.upload name="file" />
Copied!

Output:

<input type="file" name="file" />
Copied!

Source code

Go to the source code of this ViewHelper: UploadViewHelper.php (GitHub).

Arguments

The following arguments are available for <f:form.upload>:

Name Type Default
mixed
mixed
mixed
string
mixed
string
string
string
string
string 'f3-form-error'
string
string
string
string
string
string
string
integer
string
additionalAttributes
Type
mixed
Required

true

Additional tag attributes. They will be added directly to the resulting HTML tag.

data
Type
mixed
Required

true

Additional data-* attributes. They will each be added with a "data-" prefix.

aria
Type
mixed
Required

true

Additional aria-* attributes. They will each be added with a "aria-" prefix.

name
Type
string
Required

true

Name of input tag

value
Type
mixed
Required

true

Value of input tag

property
Type
string
Required

true

Name of Object Property. If used in conjunction with <f:form object="...">, the "name" property will be ignored, while "value" can be used to specify a default field value instead of the object property value.

disabled
Type
string
Required

true

Specifies that the input element should be disabled when the page loads

multiple
Type
string
Required

true

Specifies that the file input element should allow multiple selection of files

accept
Type
string
Required

true

Specifies the allowed file extensions to upload via comma-separated list, example ".png,.gif"

errorClass
Type
string
Required

true

Default
'f3-form-error'

CSS class to set if there are errors for this ViewHelper

class
Type
string
Required

true

CSS class(es) for this element

dir
Type
string
Required

true

Text direction for this HTML element. Allowed strings: "ltr" (left to right), "rtl" (right to left)

id
Type
string
Required

true

Unique (in this file) identifier for this HTML element.

lang
Type
string
Required

true

Language for this element. Use short names specified in RFC 1766

style
Type
string
Required

true

Individual CSS styles for this element

title
Type
string
Required

true

Tooltip text of element

accesskey
Type
string
Required

true

Keyboard shortcut to access this element

tabindex
Type
integer
Required

true

Specifies the tab order of this element

onclick
Type
string
Required

true

JavaScript evaluated for the onclick event