TYPO3 v15 dev-main snapshot ()

2026-08-10 22:31:24 +02:00
commit aad9daaefd
1506 changed files with 94005 additions and 0 deletions
@@ -0,0 +1,116 @@
+..  include:: /Includes.rst.txt
+..  _concepts-finishers-flashmessagefinisher:
+
+=====================
+FlashMessage finisher
+=====================
+
+The "FlashMessage finisher" is a basic finisher that adds a message to the
+FlashMessageContainer.
+
+..  contents:: Table of contents
+
+..  note::
+
+    This finisher cannot be used in the backend form editor. It can only be used
+    in a form definition YAML file or programmatically.
+
+..  include:: /Includes/_NoteFinisher.rst
+
+..  _apireference-finisheroptions-flashmessagefinisher-options:
+
+FlashMessage finisher options
+=============================
+
+The following options can be set (in the form definition YAML or
+programmatically):
+
+..  _apireference-finisheroptions-flashmessagefinisher-options-messagebody:
+
+..  confval:: messageBody
+    :name: flashmessagefinisher-messageBody
+    :type: string
+    :required: true
+
+    The flash message. May contain placeholders like `%s` that
+    are replaced with `messageArguments`.
+
+..  _apireference-finisheroptions-flashmessagefinisher-options-messagetitle:
+
+..  confval:: messageTitle
+    :name: flashmessagefinisher-messageTitle
+    :type: string
+    :default: `''`
+
+    If set, is the flash message title.
+
+..  _apireference-finisheroptions-flashmessagefinisher-options-messagearguments:
+
+..  confval:: messageArguments
+    :name: flashmessagefinisher-messageArguments
+    :type: array
+    :default: `[]`
+
+    If `messageBody` contains placeholders (like `%s`), they will be replaced
+    by these.
+
+..  _apireference-finisheroptions-flashmessagefinisher-options-messagecode:
+
+..  confval:: messageCode
+    :name: flashmessagefinisher-messageCode
+    :type: ?int
+    :default: `null`
+
+    A unique code to identify the message. By convention, the
+    unix time stamp at the time when the message is created is used,
+    for example `1758455932`.
+
+..  _apireference-finisheroptions-flashmessagefinisher-options-severity:
+
+..  confval:: severity
+    :name: flashmessagefinisher-severity
+    :type: :php:`\TYPO3\CMS\Core\Type\ContextualFeedbackSeverity`
+    :default: `ContextualFeedbackSeverity::OK`
+
+    The severity influences the display (color and icon) of the flash message.
+
+..  confval:: translation.propertiesExcludedFromTranslation
+    :name: flashmessagefinisher-translation-propertiesExcludedFromTranslation
+    :type: array
+    :default: `[]`
+
+    Defines a list of finisher option properties to be excluded from
+    translation.
+
+    If set, these properties will not be processed by the
+    :php-short:`\TYPO3\CMS\Form\Service\TranslationService` during translation
+    of finisher options. This prevents their values from being replaced by
+    translated equivalents, even if translations exist for those options.
+
+    This option is usually generated automatically as soon as FlexForm overrides
+    are in place and normally does not need to be set manually in the form
+    definition.
+
+    See `Skip translation of overridden form finisher options <https://docs.typo3.org/permalink/typo3/cms-form:concepts-finishers-confirmationfinisher-yaml-propertiesexcludedfromtranslation>`_
+    for an example.
+
+..  _concepts-finishers-flashmessagefinisher-yaml:
+
+FlashMessage finisher in a YAML form definition
+===============================================
+
+..  literalinclude:: _codesnippets/_form.yaml
+    :caption: public/fileadmin/forms/my_form.yaml
+
+..  _apireference-finisheroptions-flashmessagefinisher:
+
+Using FlashMessage finishers in PHP code
+========================================
+
+Developers can use the finisher key `FlashMessage` to create
+flash message finishers in their own classes:
+
+..  literalinclude:: _codesnippets/_finisher.php.inc
+    :language: php
+
+This finisher is implemented in :php:`TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher`.
@@ -0,0 +1,18 @@
+<?php
+
+use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
+use TYPO3\CMS\Form\Domain\Model\FormDefinition;
+
+class SomeClass
+{
+    private function addFlashMessageFinisher(FormDefinition $formDefinition, string $message)
+    {
+        $formDefinition->createFinisher('FlashMessage', [
+            'messageTitle' => 'Merci',
+            'messageCode' => 201905041245,
+            'messageBody' => 'Thx for using %s',
+            'messageArguments' => ['TYPO3'],
+            'severity' => ContextualFeedbackSeverity::OK,
+        ]);
+    }
+}
@@ -0,0 +1,14 @@
+identifier: example-form
+label: 'example'
+type: Form
+
+finishers:
+  -
+    identifier: FlashMessage
+    options:
+      messageTitle: 'Merci'
+      messageCode: 201905041245
+      messageBody: 'Thx for using %s'
+      messageArguments:
+        - 'TYPO3'
+      severity: 0