TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher Class Reference

Inheritance diagram for TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher:

Protected Member Functions
	executeInternal ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
string array 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)
TypoScriptFrontendController	getTypoScriptFrontendController ()

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

Additional Inherited Members
‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher
	injectObjectManager (ObjectManagerInterface $objectManager)
	__construct (string $finisherIdentifier='')
string	getFinisherIdentifier ()
	setOptions (array $options)
	setOption (string $optionName, $optionValue)
string null	execute (FinisherContext $finisherContext)
bool	isEnabled ()

Detailed Description

A simple finisher that adds a message to the FlashMessageContainer

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

Scope: frontend

Definition at line 51 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 70 of file FlashMessageFinisher.php.

References TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, TYPO3\CMS\Core\Messaging\AbstractMessage\NOTICE, TYPO3\CMS\Form\Domain\Finishers\AbstractFinisher\parseOption(), and TYPO3\CMS\Core\Messaging\AbstractMessage\WARNING.

Member Data Documentation

$defaultOptions

array TYPO3\CMS\Form\Domain\Finishers\FlashMessageFinisher::$defaultOptions

protected

Initial value:

= array( 
        'messageBody' => null,
        'messageTitle' => '',
        'messageArguments' => [],
        'messageCode' => null,
        'severity' => ‪AbstractMessage::OK,
     )

Definition at line 56 of file FlashMessageFinisher.php.