TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\CshViewHelper Class Reference
Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\CshViewHelper:
TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper Tx_Fluid_ViewHelpers_Be_Buttons_CshViewHelper

Public Member Functions

 render ($table=NULL, $field='', $iconOnly=FALSE, $styleAttributes='')
 
- 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 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 view helper is experimental!

= Examples =

<f:be.buttons.csh /> <output> CSH button as known from the TYPO3 backend. </output>

<f:be.buttons.csh table="xMOD_csh_corebe" field="someCshKey" iconOnly="1" styleAttributes="border: 1px solid red" /> <output> CSH button as known from the TYPO3 backend with some custom settings. </output>

Definition at line 46 of file CshViewHelper.php.

Member Function Documentation

◆ render()

TYPO3\CMS\Fluid\ViewHelpers\Be\Buttons\CshViewHelper::render (   $table = NULL,
  $field = '',
  $iconOnly = FALSE,
  $styleAttributes = '' 
)

Render context sensitive help (CSH) for the given table

Parameters
string$tableTable name ('MOD'+module name). If not set, the current module name will be used
string$fieldField name (CSH locallang main key)
boolean$iconOnlyIf set, the full text will never be shown (only icon)
string$styleAttributesAdditional style-attribute content for wrapping table (full text mode only)
Returns
string the rendered CSH icon

Definition at line 57 of file CshViewHelper.php.

References $GLOBALS, $moduleName, and TYPO3\CMS\Backend\Utility\BackendUtility\cshItem().