‪TYPO3CMS  10.4
TYPO3\CMS\Fluid\ViewHelpers\Be\Labels\CshViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\Be\Labels\CshViewHelper:
TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper

Public Member Functions

 initializeArguments ()
 
string render ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper
ModuleTemplate getModuleTemplate ()
 
PageRenderer getPageRenderer ()
 

Static Public Member Functions

static string renderStatic (array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
 

Static Protected Member Functions

static LanguageService getLanguageService ()
 

Protected Attributes

bool $escapeOutput = false
 

Detailed Description

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

.. note:: The CSH label 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.labels.csh />

CSH label as known from the TYPO3 backend.

Full configuration::

<f:be.labels.csh table="xMOD_csh_corebe" field="someCshKey" label="lang/Resources/Private/Language/locallang/header.languages" />

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

Definition at line 49 of file CshViewHelper.php.

Member Function Documentation

◆ getLanguageService()

static LanguageService TYPO3\CMS\Fluid\ViewHelpers\Be\Labels\CshViewHelper::getLanguageService ( )
staticprotected

Returns the Language Service

Returns
‪LanguageService

Definition at line 61 of file CshViewHelper.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Fluid\ViewHelpers\Be\Labels\CshViewHelper\renderStatic().

◆ initializeArguments()

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

Initialize arguments.

Exceptions

Definition at line 71 of file CshViewHelper.php.

◆ render()

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

Render context sensitive help (CSH) for the given table

Returns
‪string the rendered CSH icon

Definition at line 84 of file CshViewHelper.php.

◆ renderStatic()

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

Definition at line 99 of file CshViewHelper.php.

References TYPO3\CMS\Fluid\ViewHelpers\Be\Labels\CshViewHelper\getLanguageService(), TYPO3\CMS\Core\Localization\LanguageService\sL(), and TYPO3\CMS\Backend\Utility\BackendUtility\wrapInHelp().

Member Data Documentation

◆ $escapeOutput

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

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

Definition at line 55 of file CshViewHelper.php.