TYPO3 CMS  TYPO3_6-2
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 Tx_Fluid_ViewHelpers_FlashMessagesViewHelper

Public Member Functions

 injectConfigurationManager (\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
 
 initializeArguments ()
 
 render ($renderMode=self::RENDER_MODE_UL)
 
- 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)
 
 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

 renderUl (array $flashMessages)
 
 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 ()
 
 buildRenderChildrenClosure ()
 
 hasArgument ($argumentName)
 

Protected Attributes

 $contentObject
 
 $configurationManager
 
- 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 renderMode="div" /> <output>

Some Message Header
Some message body
Some notice message without header

</output>

Definition at line 64 of file FlashMessagesViewHelper.php.

Member Function Documentation

◆ initializeArguments()

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

◆ injectConfigurationManager()

TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::injectConfigurationManager ( \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface  $configurationManager)
Parameters
\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface$configurationManager
Returns
void

Definition at line 83 of file FlashMessagesViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper\$configurationManager.

◆ render()

TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::render (   $renderMode = self::RENDER_MODE_UL)

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$renderModeone of the RENDER_MODE_* constants
Returns
string rendered Flash Messages, if there are any.

Definition at line 108 of file FlashMessagesViewHelper.php.

References $GLOBALS, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\OBJECTTYPE_USER, TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper\renderDiv(), and TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper\renderUl().

◆ renderDiv()

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

Renders the flash messages as nested divs

Parameters
array$flashMessagesarray<>
Returns
string

Definition at line 151 of file FlashMessagesViewHelper.php.

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

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

◆ renderUl()

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

Renders the flash messages as unordered list

Parameters
array$flashMessagesarray<>
Returns
string

Definition at line 132 of file FlashMessagesViewHelper.php.

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

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

Member Data Documentation

◆ $configurationManager

TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::$configurationManager
protected

◆ $contentObject

TYPO3\CMS\Fluid\ViewHelpers\FlashMessagesViewHelper::$contentObject
protected

Definition at line 72 of file FlashMessagesViewHelper.php.

◆ RENDER_MODE_DIV

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

Definition at line 67 of file FlashMessagesViewHelper.php.

◆ RENDER_MODE_UL

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

Definition at line 66 of file FlashMessagesViewHelper.php.