[FileUpload]

Properties

implementationClassName

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.implementationClassName
Data type
string
Needed by
Frontend/ Backend (form editor)
Overwritable within form definition
No
form editor can write this property into the form definition (for prototype 'standard')
No
Mandatory
Yes
Default value (for prototype 'standard')
FileUpload:
  implementationClassName: TYPO3\CMS\Form\Domain\Model\FormElements\FileUpload
Copied!
Description
Classname which implements the form element.

properties.containerClassAttribute

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.containerClassAttribute
Data type
string
Needed by
Frontend/ Backend (form editor)
Overwritable within form definition
Yes
form editor can write this property into the form definition (for prototype 'standard')
No
Mandatory
No
Default value (for prototype 'standard')
FileUpload:
  properties:
    containerClassAttribute: input
    elementClassAttribute: ''
    elementErrorClassAttribute: error
    saveToFileMount: '1:/user_upload/'
    allowedMimeTypes:
      - application/msword
      - application/vnd.openxmlformats-officedocument.wordprocessingml.document
      - application/vnd.oasis.opendocument.text
      - application/pdf
Copied!
Description
A CSS class which is typically wrapped around the form elements.

properties.elementClassAttribute

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.elementClassAttribute
Data type
string
Needed by
Frontend/ Backend (form editor)
Overwritable within form definition
Yes
form editor can write this property into the form definition (for prototype 'standard')
No
Mandatory
No
Default value (for prototype 'standard')
FileUpload:
  properties:
    containerClassAttribute: input
    elementClassAttribute: ''
    elementErrorClassAttribute: error
    saveToFileMount: '1:/user_upload/'
    allowedMimeTypes:
      - application/msword
      - application/vnd.openxmlformats-officedocument.wordprocessingml.document
      - application/vnd.oasis.opendocument.text
      - application/pdf
Copied!
Description
A CSS class written to the form element.

properties.elementDescription

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.elementDescription
Data type
string
Needed by
Frontend/ Backend (form editor)
Overwritable within form definition
Yes
Form editor can write this property into the form definition (for prototype 'standard')
Yes
Mandatory
No
Default value (for prototype 'standard')
Undefined
Good to know
Description
Set a description of the form element. By default, it is displayed below the form element.

properties.elementErrorClassAttribute

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.elementErrorClassAttribute
Data type
string
Needed by
Frontend/ Backend (form editor)
Overwritable within form definition
Yes
form editor can write this property into the form definition (for prototype 'standard')
No
Mandatory
No
Default value (for prototype 'standard')
FileUpload:
  properties:
    containerClassAttribute: input
    elementClassAttribute: ''
    elementErrorClassAttribute: error
    saveToFileMount: '1:/user_upload/'
    allowedMimeTypes:
      - application/msword
      - application/vnd.openxmlformats-officedocument.wordprocessingml.document
      - application/vnd.oasis.opendocument.text
      - application/pdf
Copied!
Description
A CSS class which is written to the form element if validation errors exists.

properties.saveToFileMount

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.saveToFileMount
Data type
string
Needed by
Frontend/ Backend (form editor)
Overwritable within form definition
Yes
form editor can write this property into the form definition (for prototype 'standard')
Yes
Mandatory
No
Default value (for prototype 'standard')
FileUpload:
  properties:
    containerClassAttribute: input
    elementClassAttribute: ''
    elementErrorClassAttribute: error
    saveToFileMount: '1:/user_upload/'
    allowedMimeTypes:
      - application/msword
      - application/vnd.openxmlformats-officedocument.wordprocessingml.document
      - application/vnd.oasis.opendocument.text
      - application/pdf
Copied!
Description
The location (file mount) for the uploaded files. If this file mount or the property "saveToFileMount" does not exist the folder in which the form definition lies (persistence identifier) will be used. If the form is generated programmatically and therefore no persistence identifier exist the default storage "1:/user_upload/" will be used.

properties.allowedMimeTypes

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.properties.allowedMimeTypes
Data type
array
Needed by
Frontend/ Backend (form editor)
Overwritable within form definition
Yes
form editor can write this property into the form definition (for prototype 'standard')
Yes
Mandatory
Yes
Default value (for prototype 'standard')
FileUpload:
  properties:
    containerClassAttribute: input
    elementClassAttribute: ''
    elementErrorClassAttribute: error
    saveToFileMount: '1:/user_upload/'
    allowedMimeTypes:
      - application/msword
      - application/vnd.openxmlformats-officedocument.wordprocessingml.document
      - application/vnd.oasis.opendocument.text
      - application/pdf
Copied!
Description
The allowed mime types for the file uploads.

formEditor

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor
Data type
array
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    editors:
      100:
        identifier: header
        templateName: Inspector-FormElementHeaderEditor
      200:
        identifier: label
        templateName: Inspector-TextEditor
        label: formEditor.elements.FormElement.editor.label.label
        propertyPath: label
      230:
         identifier: elementDescription
         templateName: Inspector-TextEditor
         label: formEditor.elements.FormElement.editor.elementDescription.label
         propertyPath: properties.elementDescription
      300:
        identifier: allowedMimeTypes
        templateName: Inspector-MultiSelectEditor
        label: formEditor.elements.FileUpload.editor.allowedMimeTypes.label
        propertyPath: properties.allowedMimeTypes
        selectOptions:
          10:
            value: application/msword
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.doc
          20:
            value: application/vnd.openxmlformats-officedocument.wordprocessingml.document
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.docx
          30:
            value: application/msexcel
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.xls
          40:
            value: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.xlsx
          50:
            value: application/pdf
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.pdf
          60:
            value: application/vnd.oasis.opendocument.text
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.odt
          70:
            value: application/vnd.oasis.opendocument.spreadsheet-template
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.ods
      400:
        identifier: saveToFileMount
        templateName: Inspector-SingleSelectEditor
        label: formEditor.elements.FileUploadMixin.editor.saveToFileMount.label
        propertyPath: properties.saveToFileMount
        selectOptions:
          10:
            value: '1:/user_upload/'
            label: '1:/user_upload/'
      700:
        identifier: gridColumnViewPortConfiguration
        templateName: Inspector-GridColumnViewPortConfigurationEditor
        label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label
        configurationOptions:
          viewPorts:
            10:
              viewPortIdentifier: xs
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label
            20:
              viewPortIdentifier: sm
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label
            30:
              viewPortIdentifier: md
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label
            40:
              viewPortIdentifier: lg
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label
         numbersOfColumnsToUse:
           label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label
           propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse'
           fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText
      800:
        identifier: requiredValidator
        templateName: Inspector-RequiredValidatorEditor
        label: formEditor.elements.FormElement.editor.requiredValidator.label
        validatorIdentifier: NotEmpty
        propertyPath: properties.fluidAdditionalAttributes.required
        propertyValue: required
      900:
        identifier: 'validators'
        templateName: 'Inspector-ValidatorsEditor'
        label: 'formEditor.elements.FileUploadMixin.editor.validators.label'
        selectOptions:
          10:
            value: ''
            label: 'formEditor.elements.FileUploadMixin.editor.validators.EmptyValue.label'
          20:
            value: 'FileSize'
            label: 'formEditor.elements.FileUploadMixin.editor.validators.FileSize.label'
      9999:
        identifier: removeButton
        templateName: Inspector-RemoveElementEditor
    propertyCollections:
      validators:
        10:
          identifier: FileSize
          editors:
            100:
              identifier: header
              templateName: Inspector-CollectionElementHeaderEditor
              label: formEditor.elements.FileUploadMixin.validators.FileSize.editor.header.label
            200:
              identifier: minimum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
              propertyPath: options.minimum
              propertyValidators:
                10: FileSize
            300:
              identifier: maximum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
              propertyPath: options.maximum
              propertyValidators:
                10: FileSize
            9999:
              identifier: removeButton
              templateName: Inspector-RemoveElementEditor
    predefinedDefaults:
      properties:
        saveToFileMount: '1:/user_upload/'
        allowedMimeTypes:
          - application/pdf
    label: formEditor.elements.FileUpload.label
    group: custom
    groupSorting: 100
    iconIdentifier: form-file-upload
Copied!

formEditor.editors.100

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.100
Data type
array/ [FormElementHeaderEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    editors:
      100:
        identifier: header
        templateName: Inspector-FormElementHeaderEditor
Copied!

formEditor.editors.200

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.200
Data type
array/ [TextEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    editors:
      200:
        identifier: label
        templateName: Inspector-TextEditor
        label: formEditor.elements.FormElement.editor.label.label
        propertyPath: label
Copied!

formEditor.editors.230

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.230
Data type
array/ [TextEditor]
Needed by
Frontend/ Backend (form editor)
Mandatory
No
Default value (for prototype 'standard')
Date:
  formEditor:
    editors:
      230:
        identifier: elementDescription
        templateName: Inspector-TextEditor
        label: formEditor.elements.FormElement.editor.elementDescription.label
        propertyPath: properties.elementDescription
Copied!

formEditor.editors.300

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.300
Data type
array/ [MultiSelectEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    editors:
      300:
        identifier: allowedMimeTypes
        templateName: Inspector-MultiSelectEditor
        label: formEditor.elements.FileUpload.editor.allowedMimeTypes.label
        propertyPath: properties.allowedMimeTypes
        selectOptions:
          10:
            value: application/msword
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.doc
          20:
            value: application/vnd.openxmlformats-officedocument.wordprocessingml.document
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.docx
          30:
            value: application/msexcel
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.xls
          40:
            value: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.xlsx
          50:
            value: application/pdf
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.pdf
          60:
            value: application/vnd.oasis.opendocument.text
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.odt
          70:
            value: application/vnd.oasis.opendocument.spreadsheet-template
            label: formEditor.elements.FileUpload.editor.allowedMimeTypes.ods
Copied!

formEditor.editors.400

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.400
Data type
array/ [SingleSelectEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    editors:
      400:
        identifier: saveToFileMount
        templateName: Inspector-SingleSelectEditor
        label: formEditor.elements.FileUploadMixin.editor.saveToFileMount.label
        propertyPath: properties.saveToFileMount
        selectOptions:
          10:
            value: '1:/user_upload/'
            label: '1:/user_upload/'
Copied!

formEditor.editors.700

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.700
Data type
array/ [GridColumnViewPortConfigurationEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    editors:
      700:
        identifier: gridColumnViewPortConfiguration
        templateName: Inspector-GridColumnViewPortConfigurationEditor
        label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.label
        configurationOptions:
          viewPorts:
            10:
              viewPortIdentifier: xs
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.xs.label
            20:
              viewPortIdentifier: sm
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.sm.label
            30:
              viewPortIdentifier: md
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.md.label
            40:
              viewPortIdentifier: lg
              label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.lg.label
          numbersOfColumnsToUse:
            label: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.label
            propertyPath: 'properties.gridColumnClassAutoConfiguration.viewPorts.{@viewPortIdentifier}.numbersOfColumnsToUse'
            fieldExplanationText: formEditor.elements.FormElement.editor.gridColumnViewPortConfiguration.numbersOfColumnsToUse.fieldExplanationText
Copied!

formEditor.editors.800

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.800
Data type
array/ [RequiredValidatorEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    editors:
      800:
        identifier: requiredValidator
        templateName: Inspector-RequiredValidatorEditor
        label: formEditor.elements.FormElement.editor.requiredValidator.label
        validatorIdentifier: NotEmpty
        propertyPath: properties.fluidAdditionalAttributes.required
        propertyValue: required
Copied!

formEditor.editors.900

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.900
Data type
array/ [ValidatorsEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    editors:
      900:
        identifier: validators
        templateName: Inspector-ValidatorsEditor
        label: formEditor.elements.FileUploadMixin.editor.validators.label
        selectOptions:
          10:
            value: ''
            label: formEditor.elements.FileUploadMixin.editor.validators.EmptyValue.label
          20:
            value: FileSize
            label: formEditor.elements.FileUploadMixin.editor.validators.FileSize.label
Copied!

formEditor.editors.9999

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.editors.9999
Data type
array/ [RemoveElementEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    editors:
      9999:
        identifier: removeButton
        templateName: Inspector-RemoveElementEditor
Copied!

formEditor.predefinedDefaults

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.predefinedDefaults
Data type
array
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    predefinedDefaults:
      properties:
        saveToFileMount: '1:/user_upload/'
        allowedMimeTypes:
          - application/pdf
Copied!
Description
Defines predefined defaults for form element properties which are prefilled, if the form element is added to a form.

formEditor.propertyCollections.validators.10

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.propertyCollections.validators.10
Data type
array
Needed by
Backend (form editor)
Mandatory
No
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: FileSize
          editors:
            100:
              identifier: header
              templateName: Inspector-CollectionElementHeaderEditor
              label: formEditor.elements.FileUploadMixin.validators.FileSize.editor.header.label
            200:
              identifier: minimum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
              propertyPath: options.minimum
              propertyValidators:
                10: FileSize
            300:
              identifier: maximum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
              propertyPath: options.maximum
              propertyValidators:
                10: FileSize
            9999:
              identifier: removeButton
              templateName: Inspector-RemoveElementEditor
Copied!

formEditor.propertyCollections.validators.10.identifier

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.propertyCollections.validators.10.identifier
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: FileSize
Copied!
Good to know
Description
Identifies the validator which should be attached to the form element. Must be equal to an existing <validatorIdentifier>.

formEditor.propertyCollections.validators.10.editors.100

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.propertyCollections.validators.10.editors.100
Data type
array/ [CollectionElementHeaderEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: FileSize
          editors:
            100:
              identifier: header
              templateName: Inspector-CollectionElementHeaderEditor
              label: formEditor.elements.FileUploadMixin.validators.FileSize.editor.header.label
Copied!

formEditor.propertyCollections.validators.10.editors.100

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.propertyCollections.validators.10.editors.100
Data type
array/ [CollectionElementHeaderEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: FileSize
          editors:
            200:
              identifier: minimum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.minimum.label
              propertyPath: options.minimum
              propertyValidators:
                10: FileSize
Copied!

formEditor.propertyCollections.validators.10.editors.100

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.propertyCollections.validators.10.editors.100
Data type
array/ [CollectionElementHeaderEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: FileSize
          editors:
            300:
              identifier: maximum
              templateName: Inspector-TextEditor
              label: formEditor.elements.MinimumMaximumEditorsMixin.editor.maximum.label
              propertyPath: options.maximum
              propertyValidators:
                10: FileSize
Copied!

formEditor.propertyCollections.validators.10.editors.9999

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.propertyCollections.validators.10.editors.9999
Data type
array/ [RemoveElementEditor]
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    propertyCollections:
      validators:
        10:
          identifier: FileSize
          editors:
            9999:
              identifier: removeButton
              templateName: Inspector-RemoveElementEditor
Copied!

formEditor.label

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.label
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    label: formEditor.elements.FileUpload.label
Copied!
Good to know
Description
This label will be shown within the "new element" Modal.

formEditor.group

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.group
Data type
string
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    group: custom
Copied!
Default value
Depends (see concrete element configuration)
Description
Define within which group within the form editor "new Element" modal the form element should be shown. The group value must be equal to an array key within formElementGroups.

formEditor.groupSorting

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.groupSorting
Data type
int
Needed by
Backend (form editor)
Mandatory
Recommended
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    groupSorting: 100
Copied!
Description
The position within the formEditor.group for this form element.

formEditor.iconIdentifier

Option path
prototypes.<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.iconIdentifier
Data type
string
Needed by
Backend (form editor)
Mandatory
Yes
Default value (for prototype 'standard')
FileUpload:
  formEditor:
    iconIdentifier: form-file-upload
Copied!
Description

An icon identifier which must be registered through the \TYPO3\CMS\Core\Imaging\IconRegistry . This icon will be shown within