TYPO3  7.6
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
FlashMessagesViewHelper Class Reference
Inheritance diagram for FlashMessagesViewHelper:
AbstractTagBasedViewHelper AbstractViewHelper

Public Member Functions

 initializeArguments ()
 
 render ($renderMode=null, $as=null)
 
- Public Member Functions inherited from AbstractTagBasedViewHelper
 __construct ()
 
 initialize ()
 
- Public Member Functions inherited from 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

 renderFromTemplate (array $flashMessages, $as)
 
 renderDiv (array $flashMessages)
 
- Protected Member Functions inherited from AbstractTagBasedViewHelper
 registerTagAttribute ($name, $type, $description, $required=false, $default=null)
 
 registerUniversalTagAttributes ()
 
- Protected Member Functions inherited from 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 AbstractTagBasedViewHelper
 $tag = null
 
 $tagName = 'div'
 
- Protected Attributes inherited from AbstractViewHelper
 $arguments
 
 $templateVariableContainer
 
 $controllerContext
 
 $renderingContext
 
 $renderChildrenClosure = null
 
 $viewHelperVariableContainer
 
 $objectManager
 
 $escapingInterceptorEnabled = true
 

Additional Inherited Members

- Static Public Member Functions inherited from 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>

</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 ( )
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,\xrefitemdeprecated 215.
string$asThe name of the current flashMessage variable for rendering inside
Returns
string rendered Flash Messages, if there are any.

Definition at line 119 of file FlashMessagesViewHelper.php.

References GeneralUtility\deprecationLog(), FlashMessagesViewHelper\renderDiv(), and FlashMessagesViewHelper\renderFromTemplate().

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 AbstractViewHelper\hasArgument().

Referenced by FlashMessagesViewHelper\render().

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 AbstractViewHelper\$templateVariableContainer, and AbstractViewHelper\renderChildren().

Referenced by FlashMessagesViewHelper\render().

Member Data Documentation

$tagName = 'ul'
protected

Definition at line 94 of file FlashMessagesViewHelper.php.

const RENDER_MODE_DIV = 'div'

Definition at line 89 of file FlashMessagesViewHelper.php.

const RENDER_MODE_UL = 'ul'

Definition at line 88 of file FlashMessagesViewHelper.php.