CshViewHelper extends AbstractBackendViewHelper

ViewHelper which returns CSH (context sensitive help) button with icon.

.. note:: The CSH button will only work, if the current BE user has the "Context Sensitive Help mode" set to something else than "Display no help information" in the Users settings.

.. note:: This ViewHelper is experimental!

Examples

Default::

<f:be.buttons.csh />

CSH button as known from the TYPO3 backend.

Full configuration::

<f:be.buttons.csh table="xMOD_csh_corebe" field="someCshKey" />

CSH button as known from the TYPO3 backend with some custom settings.

Full configuration with content::

<f:be.buttons.csh table="xMOD_csh_corebe" field="someCshKey"> some text to link </f:be.buttons.csh>

A link with text "some text to link" to link the help.

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
Render context sensitive help (CSH) for the given table
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
ModuleTemplate

getPageRenderer()

Gets instance of PageRenderer if exists or create a new one.

public getPageRenderer() : PageRenderer

Saves instance in viewHelperVariableContainer

Return values
PageRenderer

initializeArguments()

Initialize arguments.

public initializeArguments() : mixed
Tags
throws
Exception

render()

Render context sensitive help (CSH) for the given table

public render() : string
Return values
string

the rendered CSH icon

renderStatic()

public static renderStatic(array<string|int, mixed> $arguments, Closure $renderChildrenClosure, RenderingContextInterface $renderingContext) : string
Parameters
$arguments : array<string|int, mixed>
$renderChildrenClosure : Closure
$renderingContext : RenderingContextInterface
Return values
string

        
On this page

Search results