TYPO3\CMS\Fluid\ViewHelpers\Be\ContainerViewHelper Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\ViewHelpers\Be\ContainerViewHelper:

Public Member Functions
	render ($pageTitle='', $enableJumpToUrl=TRUE, $enableClickMenu=TRUE, $loadPrototype=TRUE, $loadScriptaculous=FALSE, $scriptaculousModule='', $loadExtJs=FALSE, $loadExtJsTheme=TRUE, $extJsAdapter='', $enableExtJsDebug=FALSE, $addCssFile=NULL, $addJsFile=NULL, $loadJQuery=FALSE, $includeCssFiles=NULL, $includeJsFiles=NULL, $addJsInlineLabels=NULL, $includeCsh=TRUE)
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 allows you to create extbase based modules in the style of TYPO3 default modules.

= Examples =

<f:be.container>your module content</f:be.container> <output> "your module content" wrapped with proper head & body tags. Default backend CSS styles and JavaScript will be included </output>

<f:be.container pageTitle="foo" enableJumpToUrl="false" enableClickMenu="false" loadPrototype="false" loadScriptaculous="false" scriptaculousModule="someModule,someOtherModule" loadExtJs="true" loadExtJsTheme="false" extJsAdapter="jQuery" enableExtJsDebug="true" loadJQuery="true" includeCssFiles="0: '{f:uri.resource(path:\'Styles/Styles.css\')}'" includeJsFiles="0: '{f:uri.resource(path:\'JavaScript/Library1.js\')}', 1: '{f:uri.resource(path:\'JavaScript/Library2.js\')}'" addJsInlineLabels="{0: 'label1', 1: 'label2'}" includeCsh="true">your module content</f:be.container> <output> "your module content" wrapped with proper head & body tags. Custom CSS file EXT:your_extension/Resources/Public/Styles/styles.css and JavaScript files EXT:your_extension/Resources/Public/JavaScript/Library1.js and EXT:your_extension/Resources/Public/JavaScript/Library2.js will be loaded, plus ExtJS and jQuery and some inline labels for usage in JS code. </output>

Definition at line 49 of file ContainerViewHelper.php.

Member Function Documentation

render()

TYPO3\CMS\Fluid\ViewHelpers\Be\ContainerViewHelper::render	(		$pageTitle = '',
			$enableJumpToUrl = TRUE,
			$enableClickMenu = TRUE,
			$loadPrototype = TRUE,
			$loadScriptaculous = FALSE,
			$scriptaculousModule = '',
			$loadExtJs = FALSE,
			$loadExtJsTheme = TRUE,
			$extJsAdapter = '',
			$enableExtJsDebug = FALSE,
			$addCssFile = NULL,
			$addJsFile = NULL,
			$loadJQuery = FALSE,
			$includeCssFiles = NULL,
			$includeJsFiles = NULL,
			$addJsInlineLabels = NULL,
			$includeCsh = TRUE
	)

Render start page with and pageTitle

Parameters

string	$pageTitle	title tag of the module. Not required by default, as BE modules are shown in a frame
boolean	$enableJumpToUrl	If TRUE, includes "jumpTpUrl" javascript function required by ActionMenu. Defaults to TRUE, deprecated, as not needed anymore
boolean	$enableClickMenu	If TRUE, loads clickmenu.js required by BE context menus. Defaults to TRUE
boolean	$loadPrototype	specifies whether to load prototype library. Defaults to TRUE
boolean	$loadScriptaculous	specifies whether to load scriptaculous libraries. Defaults to FALSE
string	$scriptaculousModule	additionales modules for scriptaculous
boolean	$loadExtJs	specifies whether to load ExtJS library. Defaults to FALSE
boolean	$loadExtJsTheme	whether to load ExtJS "grey" theme. Defaults to FALSE
string	$extJsAdapter	load alternative adapter (ext-base is default adapter)
boolean	$enableExtJsDebug	if TRUE, debug version of ExtJS is loaded. Use this for development only
string	$addCssFile	Custom CSS file to be loaded (deprecated, use $includeCssFiles)
string	$addJsFile	Custom JavaScript file to be loaded (deprecated, use $includeJsFiles)
boolean	$loadJQuery	whether to load jQuery library. Defaults to FALSE
array	$includeCssFiles	List of custom CSS file to be loaded
array	$includeJsFiles	List of custom JavaScript file to be loaded
array	$addJsInlineLabels	Custom labels to add to JavaScript inline labels
boolean	$includeCsh	flag for including CSH

Returns

string

See also

Definition at line 75 of file ContainerViewHelper.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper\renderChildren(), and TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().