TYPO3 CMS  TYPO3_7-6
TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper:
TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper

Public Member Functions

 initializeArguments ()
 
 render ($renderMode=null, $as=null)
 
- Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
 __construct ()
 
 initialize ()
 
- Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 setArguments (array $arguments)
 
 setRenderingContext (\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 isEscapingInterceptorEnabled ()
 
 setViewHelperNode (\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\ViewHelperNode $node)
 
 setRenderChildrenClosure (\Closure $renderChildrenClosure)
 
 initializeArgumentsAndRender ()
 
 initialize ()
 
 renderChildren ()
 
 prepareArguments ()
 
 validateArguments ()
 
 initializeArguments ()
 
 compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)
 
 resetState ()
 

Public Attributes

const RENDER_MODE_UL = 'ul'
 
const RENDER_MODE_DIV = 'div'
 

Protected Member Functions

 renderFromTemplate (array $flashMessages, $as)
 
 renderDiv (array $flashMessages)
 
- Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
 registerTagAttribute ($name, $type, $description, $required=false, $default=null)
 
 registerUniversalTagAttributes ()
 
- Protected Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 registerArgument ($name, $type, $description, $required=false, $defaultValue=null)
 
 overrideArgument ($name, $type, $description, $required=false, $defaultValue=null)
 
 callRenderMethod ()
 
 getLogger ()
 
 buildRenderChildrenClosure ()
 
 hasArgument ($argumentName)
 

Protected Attributes

 $tagName = 'ul'
 
- Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper
 $tag = null
 
 $tagName = 'div'
 
- Protected Attributes inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
 $arguments
 
 $templateVariableContainer
 
 $controllerContext
 
 $renderingContext
 
 $renderChildrenClosure = null
 
 $viewHelperVariableContainer
 
 $objectManager
 
 $escapingInterceptorEnabled = true
 

Additional Inherited Members

- Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
static renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)
 

Detailed Description

View helper which renders the flash messages (if there are any) as an unsorted list.

In case you need custom Flash Message HTML output, please write your own ViewHelper for the moment.

= Examples =

<f:flashMessages /> <output> An ul-list of flash messages. </output>

<f:flashMessages class="specialClass" /> <output>

.. </output>

<f:flashMessages /> <output>

  • Some Message Header

    Some message body

  • Some notice message without header

</output> <f:flashMessages as="flashMessages">

f:for each="{flashMessages}" as="flashMessage">

{flashMessage.code} {flashMessage.message} </f:for>

</f:flashMessages> <output>

1013
Some Warning Message.

</output>

<f:flashMessages queueIdentifier="myQueue" />

Definition at line 86 of file FlashMessagesViewHelper.php.

Member Function Documentation

◆ initializeArguments()

TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::initializeArguments ( )

◆ render()

TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::render (   $renderMode = null,
  $as = null 
)

Renders FlashMessages and flushes the FlashMessage queue Note: This disables the current page cache in order to prevent FlashMessage output from being cached.

See also
::no_cache
Parameters
string$renderMode

Definition at line 119 of file FlashMessagesViewHelper.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument(), TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper\renderDiv(), and TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper\renderFromTemplate().

◆ renderDiv()

TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::renderDiv ( array  $flashMessages)
protected

Renders the flash messages as nested divs

Deprecated:
in 7.3 will be removed in 8.0
Parameters
array$flashMessages[]
Returns
string

Definition at line 195 of file FlashMessagesViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper\render().

◆ renderFromTemplate()

TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::renderFromTemplate ( array  $flashMessages,
  $as 
)
protected

Renders the flash messages as nested divs Defer the rendering of Flash Messages to the template. In this case, the flash messages are stored in the template inside the variable specified in "as".

Parameters
array$flashMessages[]
string$as
Returns
string

Definition at line 178 of file FlashMessagesViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\$templateVariableContainer, and TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\renderChildren().

Referenced by TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper\render().

Member Data Documentation

◆ $tagName

TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::$tagName = 'ul'
protected

Definition at line 94 of file FlashMessagesViewHelper.php.

◆ RENDER_MODE_DIV

const TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::RENDER_MODE_DIV = 'div'

Definition at line 89 of file FlashMessagesViewHelper.php.

◆ RENDER_MODE_UL

const TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::RENDER_MODE_UL = 'ul'

Definition at line 88 of file FlashMessagesViewHelper.php.