CshViewHelper Class Reference

Inheritance diagram for CshViewHelper:

Public Member Functions
	render ($table=null, $field= '', $iconOnly=false, $styleAttributes= '')
Public Member Functions inherited from CompilableInterface
	compile ($argumentsVariableName, $renderChildrenClosureVariableName, &$initializationPhpCode,\TYPO3\CMS\Fluid\Core\Parser\SyntaxTree\AbstractNode $syntaxTreeNode,\TYPO3\CMS\Fluid\Core\Compiler\TemplateCompiler $templateCompiler)

Static Public Member Functions
static	renderStatic (array $arguments,\Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
Static Public Member Functions inherited from CompilableInterface
static	renderStatic (array $arguments,\Closure $renderChildrenClosure,\TYPO3\CMS\Fluid\Core\Rendering\RenderingContextInterface $renderingContext)

Additional Inherited Members
Protected Member Functions inherited from AbstractViewHelper
	registerArgument ($name, $type, $description, $required=false, $defaultValue=null)
	overrideArgument ($name, $type, $description, $required=false, $defaultValue=null)
	callRenderMethod ()
	getLogger ()
	buildRenderChildrenClosure ()
	hasArgument ($argumentName)
Protected Attributes inherited from 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" /> <output> CSH button as known from the TYPO3 backend with some custom settings. </output>

Definition at line 52 of file CshViewHelper.php.

Member Function Documentation

render	(		$table = null,
			$field = '',
			$iconOnly = false,
			$styleAttributes = ''
	)

Render context sensitive help (CSH) for the given table

Parameters

string	$table	Table name ('MOD'+module name). If not set, the current module name will be used
string	$field	Field name (CSH locallang main key)
bool	$iconOnly	Deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8
string	$styleAttributes	Deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Returns

string the rendered CSH icon

Definition at line 63 of file CshViewHelper.php.

References AbstractViewHelper\buildRenderChildrenClosure().

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

static

Parameters

array	$arguments
callable	$renderChildrenClosure
RenderingContextInterface	$renderingContext

Returns

string

Definition at line 91 of file CshViewHelper.php.

References BackendUtility\cshItem(), and RenderingContextInterface\getControllerContext().