[FlashMessage]¶

Properties¶

implementationClassName¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.implementationClassName

Data type

string

Needed by

Frontend

Mandatory

Yes

Default value

FlashMessage:
  implementationClassName: TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher

Good to know

"Custom finisher implementations"

Description

Classname which implements the finisher.

options.messageBody¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageBody

Data type

string

Needed by

Frontend

Mandatory

Yes

Default value

null

Good to know

Description

The flash message body TEXT.

options.messageTitle¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageTitle

Data type

string

Needed by

Frontend

Mandatory

No

Default value

empty string

Good to know

Description

The flash message title.

options.messageArguments¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageArguments

Data type

array

Needed by

Frontend

Mandatory

No

Default value

empty array

Good to know

Description

The flash message arguments, if needed.

options.messageCode¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.messageCode

Data type

int

Needed by

Frontend

Mandatory

Yes

Default value

null

Good to know

"FlashMessage finisher"

Description

The flash message code, if needed.

options.severity¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.severity

Data type

int

Needed by

Frontend

Mandatory

No

Default value

\TYPO3\CMS\Core\Type\ContextualFeedbackSeverity::OK (0)

Good to know

"FlashMessage finisher"

Description

The flash message severity code. See EXT:core/Classes/Type/ContextualFeedbackSeverity.php (GitHub) cases for the codes.

options.translation.translationFiles¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.options.translation.translationFiles

Data type

string/ array

Needed by

Frontend

Mandatory

No

Default value

undefined

Good to know

Description

If set, this translation file(s) will be used for finisher option translations. If not set, the translation file(s) from the 'Form' element will be used. Read Translate finisher options for more informations.

formeditor.iconIdentifier¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.formEditor.iconIdentifier

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

FlashMessage:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label
    predefinedDefaults:
      options:
        messageBody: ''
        messageTitle: ''
        messageArguments: ''
        messageCode: 0
        severity: 0

Description: An icon identifier which must be registered through the \TYPO3\CMS\Core\Imaging\IconRegistry . This icon will be shown within the - "Inspector [CollectionElementHeaderEditor]" if the finisher is selected.

formeditor.label¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.formEditor.label

Data type

string

Needed by

Backend (form editor)

Mandatory

Yes

Default value

FlashMessage:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label
    predefinedDefaults:
      options:
        messageBody: ''
        messageTitle: ''
        messageArguments: ''
        messageCode: 0
        severity: 0

Good to know

"Translate form editor settings"

Description

This label will be shown within the - "Inspector [CollectionElementHeaderEditor]" if the finisher is selected.

formeditor.predefinedDefaults¶

Option path

prototypes.<prototypeIdentifier>.finishersDefinition.FlashMessage.formEditor.predefinedDefaults

Data type

array

Needed by

Backend (form editor)

Mandatory

No

Default value

FlashMessage:
  formEditor:
    iconIdentifier: form-finisher
    label: formEditor.elements.Form.finisher.FlashMessage.editor.header.label
    predefinedDefaults:
      options:
        messageBody: ''
        messageTitle: ''
        messageArguments: ''
        messageCode: 0
        severity: 0

Description: Defines predefined defaults for finisher options which are prefilled, if the finisher is added to a form.