‪TYPO3CMS  ‪main
TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher Class Reference
Inheritance diagram for TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher:
TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher TYPO3\CMS\Form\Domain\Finishers\FinisherInterface

Public Member Functions

 injectFlashMessageService (FlashMessageService $flashMessageService)
 
 injectExtensionService (ExtensionService $extensionService)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
 setFinisherIdentifier (string $finisherIdentifier)
 
 getFinisherIdentifier ()
 
 setOptions (array $options)
 
 setOption (string $optionName, $optionValue)
 
string null execute (FinisherContext $finisherContext)
 
 isEnabled ()
 

Protected Member Functions

 executeInternal ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
string array int null parseOption (string $optionName)
 
array string translateFinisherOption ( $subject, FormRuntime $formRuntime, string $optionName, $optionValue, array $translationOptions)
 
mixed substituteRuntimeReferences ($needle, FormRuntime $formRuntime)
 
int string array resolveRuntimeReference (string $property, FormRuntime $formRuntime)
 
 getTypoScriptFrontendController ()
 

Protected Attributes

array $defaultOptions
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
string $finisherIdentifier = ''
 
string $shortFinisherIdentifier = ''
 
array $options = array( )
 
array $defaultOptions = array( )
 
TYPO3 CMS Form Domain Finishers FinisherContext $finisherContext
 

Private Attributes

ExtensionService $extensionService
 
FlashMessageService $flashMessageService
 

Detailed Description

A simple finisher that adds a message to the FlashMessageContainer

Usage: //... $flashMessageFinisher = GeneralUtility::makeInstance(FlashMessageFinisher::class); $flashMessageFinisher->setOptions( [ 'messageBody' => 'Some message body', 'messageTitle' => 'Some message title', 'messageArguments' => ['foo' => 'bar'], 'severity' => \TYPO3\CMS\Core\Type\ContextualFeedbackSeverity::ERROR ] ); $formDefinition->addFinisher($flashMessageFinisher); // ...

Scope: frontend

Definition at line 54 of file FlashMessageFinisher.php.

Member Function Documentation

◆ executeInternal()

TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher::executeInternal ( )
protected

Executes this finisher

See also
AbstractFinisher::execute()
Exceptions
FinisherException

Reimplemented from TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher.

Definition at line 85 of file FlashMessageFinisher.php.

References TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher\parseOption().

◆ injectExtensionService()

TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher::injectExtensionService ( ExtensionService  $extensionService)

◆ injectFlashMessageService()

TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher::injectFlashMessageService ( FlashMessageService  $flashMessageService)

Member Data Documentation

◆ $defaultOptions

array TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher::$defaultOptions
protected
Initial value:
= array(
'messageBody' => null,
'messageTitle' => '',
'messageArguments' => [],
'messageCode' => null,
'severity' => ContextualFeedbackSeverity::OK,
)

Definition at line 58 of file FlashMessageFinisher.php.

◆ $extensionService

ExtensionService TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher::$extensionService
private

◆ $flashMessageService

FlashMessageService TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher::$flashMessageService
private