TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper:

Public Member Functions
	render ($title=null, $message=null, $state=self::STATE_NOTICE, $iconName=null, $disableIcon=false)
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 Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\Facets\CompilableInterface
	compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode, \TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode, \TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)

Static Public Member Functions
static	renderStatic (array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
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)
Static Public Member Functions inherited from TYPO3\CMS\Fluid\Core\ViewHelper\Facets\CompilableInterface
static	renderStatic (array $arguments, \Closure $renderChildrenClosure, \TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)

Public Attributes
const	STATE_NOTICE = -2
const	STATE_INFO = -1
const	STATE_OK = 0
const	STATE_WARNING = 1
const	STATE_ERROR = 2

Additional Inherited Members
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 inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	$arguments
	$templateVariableContainer
	$controllerContext
	$renderingContext
	$renderChildrenClosure = null
	$viewHelperVariableContainer
	$objectManager
	$escapingInterceptorEnabled = true

Detailed Description

View helper for rendering a styled content infobox markup.

= States =

The Infobox provides different context sensitive states that can be used to provide an additional visual feedback to the to the user to underline the meaning of the information.

Possible values are in range from -2 to 2. Please choose a meaningful value from the following list.

-2: Notices (Default) -1: Information 0: Positive feedback 1: Warnings 2: Error

= Examples =

<f:be.infobox title="Message title">your box content</f:be.infobox>

<f:be.infobox title="Message title" message="your box content" state="-2" iconName="check" disableIcon="TRUE" />

Definition at line 52 of file InfoboxViewHelper.php.

Member Function Documentation

render()

TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::render	(		$title = null,
			$message = null,
			$state = self::STATE_NOTICE,
			$iconName = null,
			$disableIcon = false
	)

Parameters

string	$title	The title of the info box
string	$message	The message of the info box, if NULL tag content is used
int	$state	The state of the box, InfoboxViewHelper::STATE_*
string	$iconName	The icon name from font awesome, NULL sets default icon
bool	$disableIcon	If set to TRUE, the icon is not rendered.

Returns

string

Definition at line 69 of file InfoboxViewHelper.php.

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

renderStatic()

static TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::renderStatic ( array  $arguments, \Closure  $renderChildrenClosure, RenderingContextInterface  $renderingContext  )

static

Parameters

array	$arguments
\Closure	$renderChildrenClosure
RenderingContextInterface	$renderingContext

Returns

string

Definition at line 91 of file InfoboxViewHelper.php.

References TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\$renderChildrenClosure, and TYPO3\CMS\Core\Utility\MathUtility\isIntegerInRange().

Member Data Documentation

STATE_ERROR

const TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_ERROR = 2

Definition at line 58 of file InfoboxViewHelper.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\checkSchedulerUser().

STATE_INFO

const TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_INFO = -1

Definition at line 55 of file InfoboxViewHelper.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\checkSchedulerUser(), TYPO3\CMS\Backend\Controller\PageLayoutController\getHeaderFlashMessagesForCurrentPid(), TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateModuleController\linkWrapTemplateTitle(), TYPO3\CMS\Func\Controller\PageFunctionsController\main(), and TYPO3\CMS\Backend\Controller\PageLayoutController\main().

STATE_NOTICE

const TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_NOTICE = -2

Definition at line 54 of file InfoboxViewHelper.php.

STATE_OK

const TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_OK = 0

Definition at line 56 of file InfoboxViewHelper.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\checkSchedulerUser().

STATE_WARNING

const TYPO3\CMS\Fluid\ViewHelpers\Be\InfoboxViewHelper::STATE_WARNING = 1

Definition at line 57 of file InfoboxViewHelper.php.

Referenced by TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\checkSchedulerUser(), and TYPO3\CMS\Tstemplate\Controller\TypoScriptTemplateObjectBrowserModuleFunctionController\main().