.. include:: /Includes.rst.txt .. _fluidtypo3-flux-field-file: ========== field.file ========== Group (select supertype) FlexForm field ViewHelper, subtype "file" Select and render an image ========================== Then use `` to render the image in the frontend: `alt` and `title` tags are not loaded from the file's meta data record. Use `` if you want this feature. Arguments ========= .. _field.file_name: name ---- :aspect:`DataType` string :aspect:`Required` true :aspect:`Description` Name of the attribute, FlexForm XML-valid tag name string .. _field.file_label: label ----- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Label for the attribute, can be LLL: value. Optional - if not specified, Flux tries to detect an LLL label named "flux.fluxFormId.fields.foobar" based on field name, in scope of extension rendering the Flux form. If field is in an object, use "flux.fluxFormId.objects.objectname.foobar" where "foobar" is the name of the field. .. _field.file_default: default ------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Default value for this attribute .. _field.file_native: native ------ :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, this field will treated as a native TCA field (requiring a matching SQL column). If the "name" of this field is an already existing field, that original field will be replaced by this field. If the field is a new field (which doesn't already exist in TCA). You can control where this field visually appears in the editing form by specifying the "position" argument, which supports the same syntax as \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addToAllTCAtypes (after:X before:X and replace:X). Note that when declaring a field as "native" it will no longer be rendered as part of the FlexForm where Flux fields are normally rendered. .. _field.file_position: position -------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Only applies if native=1. Specify where in the editing form this field should be, using the syntax of \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addToAllTCAtypes (after:X before:X and replace:X). Additionally, allows you to specify a TCA sheet if you want this field to be positioned in a dedicated sheet. Examples: position="after:header", position="replace:header", position="after:header My Sheet" .. _field.file_required: required -------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, this attribute must be filled when editing the FCE .. _field.file_exclude: exclude ------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, this field becomes an "exclude field" (see TYPO3 documentation about this) .. _field.file_transform: transform --------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Set this to transform your value to this type - integer, array (for csv values), float, DateTime, Vendor\MyExt\Domain\Model\Object or ObjectStorage with type hint. .. _field.file_enabled: enabled ------- :aspect:`DataType` boolean :aspect:`Default` true :aspect:`Required` false :aspect:`Description` If FALSE, disables the field in the FlexForm .. _field.file_requestupdate: requestUpdate ------------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, the form is force-saved and reloaded when field value changes .. _field.file_displaycond: displayCond ----------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Optional "Display Condition" (TCA style) for this particular field. See: https://docs.typo3.org/typo3cms/TCAReference/Reference/Columns/Index.html#displaycond .. _field.file_inherit: inherit ------- :aspect:`DataType` boolean :aspect:`Default` true :aspect:`Required` false :aspect:`Description` If TRUE, the value for this particular field is inherited - if inheritance is enabled by the ConfigurationProvider .. _field.file_inheritempty: inheritEmpty ------------ :aspect:`DataType` boolean :aspect:`Default` true :aspect:`Required` false :aspect:`Description` If TRUE, allows empty values (specifically excluding the number zero!) to be inherited - if inheritance is enabled by the ConfigurationProvider .. _field.file_clear: clear ----- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, a "clear value" checkbox is displayed next to the field which when checked, completely destroys the current field value all the way down to the stored XML value .. _field.file_variables: variables --------- :aspect:`DataType` mixed :aspect:`Default` array () :aspect:`Required` false :aspect:`Description` Freestyle variables which become assigned to the resulting Component - can then be read from that Component outside this Fluid template and in other templates using the Form object from this template .. _field.file_extensionname: extensionName ------------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` If provided, enables overriding the extension context for this and all child nodes. The extension name is otherwise automatically detected from rendering context. .. _field.file_config: config ------ :aspect:`DataType` mixed :aspect:`Default` array () :aspect:`Required` false :aspect:`Description` Raw TCA options - passed directly to "config" section of created field and overrides anything generated by the component itself. Can be used to provide options that Flux itself does not support, and can be used to pass root-level arguments for a "userFunc" .. _field.file_validate: validate -------- :aspect:`DataType` string :aspect:`Default` 'trim' :aspect:`Required` false :aspect:`Description` FlexForm-type validation configuration for this input .. _field.file_size: size ---- :aspect:`DataType` integer :aspect:`Default` 1 :aspect:`Required` false :aspect:`Description` Size of the selector box .. _field.file_multiple: multiple -------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, allows selecting the same value multiple times .. _field.file_minitems: minItems -------- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Minimum required number of items to be selected .. _field.file_maxitems: maxItems -------- :aspect:`DataType` integer :aspect:`Default` 1 :aspect:`Required` false :aspect:`Description` Maxium allowed number of items to be selected .. _field.file_itemliststyle: itemListStyle ------------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Overrides the default list style when maxItems > 1 .. _field.file_selectedliststyle: selectedListStyle ----------------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Overrides the default selected list style when maxItems > 1 and renderType is SelectSingle .. _field.file_items: items ----- :aspect:`DataType` mixed :aspect:`Required` false :aspect:`Description` Items for the selector; array / CSV / Traversable / Query supported .. _field.file_emptyoption: emptyOption ----------- :aspect:`DataType` mixed :aspect:`Required` false :aspect:`Description` If not-FALSE, adds one empty option/value pair to the generated selector box and tries to use this property's value (cast to string) as label. .. _field.file_translatecsvitems: translateCsvItems ----------------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, attempts to resolve a LLL label for each value provided as CSV in "items" attribute using convention for lookup "$field.option.123" if given "123" as CSV item value. Field name is determined by normal Flux field name conventions .. _field.file_itemsprocfunc: itemsProcFunc ------------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Function for serving items. See TCA "select" field "itemsProcFunc" attribute .. _field.file_maxsize: maxSize ------- :aspect:`DataType` integer :aspect:`Required` false :aspect:`Description` Maximum file size allowed in KB .. _field.file_allowed: allowed ------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Defines a list of file types allowed in this field .. _field.file_disallowed: disallowed ---------- :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Defines a list of file types NOT allowed in this field .. _field.file_uploadfolder: uploadFolder ------------ :aspect:`DataType` string :aspect:`Required` false :aspect:`Description` Upload folder to use for copied/directly uploaded files .. _field.file_showthumbnails: showThumbnails -------------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` If TRUE, displays thumbnails for selected values .. _field.file_usefalrelation: useFalRelation -------------- :aspect:`DataType` boolean :aspect:`Required` false :aspect:`Description` Use a fal relation instead of a simple file path .. _field.file_internaltype: internalType ------------ :aspect:`DataType` string :aspect:`Default` 'file_reference' :aspect:`Required` false :aspect:`Description` Internal type (TCA internal_type) to use for the field. Defaults to `file_reference` but can be set to `file` to support file uploading