ShortcutViewHelper extends AbstractBackendViewHelper
ViewHelper which returns shortcut button with icon.
since v11, will be removed in v12. Deprecation logged by ModuleTemplate->makeShortcutIcon()
.. note:: This ViewHelper is experimental!
Examples
Default::
<f:be.buttons.shortcut />
Shortcut button as known from the TYPO3 backend. By default the current page id, module name and all module arguments will be stored.
Explicitly set parameters to be stored in the shortcut::
<f:be.buttons.shortcut getVars="{0: 'route', 1: 'myOwnPrefix'}" setVars="{0: 'function'}" />
Shortcut button as known from the TYPO3 backend. This time only the specified GET parameters and SET[]-settings will be stored.
.. note:
Normally you won't need to set getVars & setVars parameters in Extbase modules.
Table of Contents
Properties
- $escapeOutput : bool
- As this ViewHelper renders HTML, the output must not be escaped.
Methods
- getModuleTemplate() : ModuleTemplate
- Gets instance of template if exists or create a new one.
- getPageRenderer() : PageRenderer
- Gets instance of PageRenderer if exists or create a new one.
- initializeArguments() : mixed
- Initialize arguments.
- render() : string
- Renders a shortcut button as known from the TYPO3 backend
- renderStatic() : string
Properties
$escapeOutput
As this ViewHelper renders HTML, the output must not be escaped.
protected
bool
$escapeOutput
= false
Methods
getModuleTemplate()
Gets instance of template if exists or create a new one.
public
getModuleTemplate() : ModuleTemplate
Saves instance in viewHelperVariableContainer
Return values
ModuleTemplategetPageRenderer()
Gets instance of PageRenderer if exists or create a new one.
public
getPageRenderer() : PageRenderer
Saves instance in viewHelperVariableContainer
Return values
PageRendererinitializeArguments()
Initialize arguments.
public
initializeArguments() : mixed
Tags
render()
Renders a shortcut button as known from the TYPO3 backend
public
render() : string
Tags
Return values
string —the rendered shortcut button
renderStatic()
public
static renderStatic(array<string|int, mixed> $arguments, Closure $renderChildrenClosure, RenderingContextInterface $renderingContext) : string
Parameters
- $arguments : array<string|int, mixed>
- $renderChildrenClosure : Closure
- $renderingContext : RenderingContextInterface