TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\IconViewHelper Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\IconViewHelper:

Public Member Functions
	initializeArguments ()
	render ($uri='', $icon='actions-document-close', $title='')
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 ()

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)
Protected Member Functions inherited from TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper
	createDocInstance ()
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 inherited from TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
	$arguments
	$templateVariableContainer
	$controllerContext
	$renderingContext
	$renderChildrenClosure = NULL
	$viewHelperVariableContainer
	$objectManager
	$escapingInterceptorEnabled = TRUE

Detailed Description

View helper which returns a button icon

= Examples =

<f:be.buttons.icon uri="{f:uri.action()}" /> <output> An icon button as known from the TYPO3 backend, skinned and linked with the default action of the current controller. Note: By default the "close" icon is used as image </output>

<f:be.buttons.icon uri="{f:uri.action(action:'new')}" icon="actions-document-new" title="Create new Foo" />

<f:be.buttons.icon icon="actions-document-new" title="Create new Foo" /> <output> Here the "actions-document-new" icon is returned, but without link. </output>

Definition at line 47 of file IconViewHelper.php.

Member Function Documentation

initializeArguments()

TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\IconViewHelper::initializeArguments

(

)

Initialize arguments

Returns

void

Definition at line 55 of file IconViewHelper.php.

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

render()

TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\IconViewHelper::render	(		$uri = '',
			$icon = 'actions-document-close',
			$title = ''
	)

Renders a linked icon as known from the TYPO3 backend.

If the URI is left empty, the icon is rendered without link.

Parameters

string	$uri	The target URI for the link. If you want to execute JavaScript here, prefix the URI with "javascript:". Leave empty to render just an icon.
string	$icon	Icon to be used.
string	$title	Title attribute of the icon construct

Returns

string The rendered icon with or without link

Definition at line 69 of file IconViewHelper.php.

References TYPO3\CMS\Backend\Utility\IconUtility\getSpriteIcon(), and TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\hasArgument().