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

Public Member Functions
	initializeArguments ()

string	render ()

‪Public Member Functions inherited from ‪TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper
DocumentTemplate	getDocInstance ()

PageRenderer	getPageRenderer ()

Static Public Member Functions
static string	renderStatic (array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)

Protected Attributes
bool	$escapeOutput = false

Detailed Description

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.

Definition at line 55 of file CshViewHelper.php.

Member Function Documentation

◆ initializeArguments()

TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\CshViewHelper::initializeArguments ( )

Initialize arguments.

Exceptions

Definition at line 68 of file CshViewHelper.php.

◆ render()

string TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\CshViewHelper::render ( )

Render context sensitive help (CSH) for the given table

Returns: ‪string the rendered CSH icon

Definition at line 81 of file CshViewHelper.php.

◆ renderStatic()

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

static

Parameters

array	$arguments
\Closure	$renderChildrenClosure
RenderingContextInterface	$renderingContext

Returns: ‪string

Definition at line 96 of file CshViewHelper.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\cshItem(), and TYPO3\CMS\Backend\Utility\BackendUtility\wrapInHelp().

Member Data Documentation

◆ $escapeOutput

bool TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\CshViewHelper::$escapeOutput = false

protected

As this ViewHelper renders HTML, the output must not be escaped.

Definition at line 61 of file CshViewHelper.php.

Public Member Functions

Static Public Member Functions

Protected Attributes