TYPO3\CMS\Backend\View\BackendTemplateView Class Reference

Inheritance diagram for TYPO3\CMS\Backend\View\BackendTemplateView:

Public Member Functions
	injectModuleTemplate (ModuleTemplate $moduleTemplate)
	injectTemplateView (TemplateView $templateView)
	getModuleTemplate ()
	render ($actionName=null)
	setControllerContext (\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
	assign ($key, $value)
	assignMultiple (array $values)
	canRender (ControllerContext $controllerContext)
	initializeView ()
Public Member Functions inherited from TYPO3\CMS\Extbase\Mvc\View\ViewInterface
	setControllerContext (\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
	canRender (\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
	render ()

Protected Attributes
	$moduleTemplate
	$templateView

Detailed Description

Decorates the main template view. Should be used as view if you want to use Fluid templates in a backend module in order to have a consistent backend.

Definition at line 28 of file BackendTemplateView.php.

Member Function Documentation

assign()

TYPO3\CMS\Backend\View\BackendTemplateView::assign	(		$key,
			$value
	)

Assign a value to the variable container.

Parameters

string	$key	The key of a view variable to set
mixed	$value	The value of the view variable

Returns

the instance of this view to allow chaining

Implements TYPO3\CMS\Extbase\Mvc\View\ViewInterface.

Definition at line 101 of file BackendTemplateView.php.

assignMultiple()

TYPO3\CMS\Backend\View\BackendTemplateView::assignMultiple

(

array

$values

)

Assigns multiple values to the JSON output. However, only the key "value" is accepted.

Parameters

array

$values

Keys and values - only a value with key "value" is considered

Returns

the instance of this view to allow chaining

Implements TYPO3\CMS\Extbase\Mvc\View\ViewInterface.

Definition at line 115 of file BackendTemplateView.php.

canRender()

TYPO3\CMS\Backend\View\BackendTemplateView::canRender

(

ControllerContext

$controllerContext

)

Checks whether a template can be resolved for the current request context.

Parameters

ControllerContext

$controllerContext

Controller context which is available inside the view

Returns

bool

Definition at line 128 of file BackendTemplateView.php.

getModuleTemplate()

TYPO3\CMS\Backend\View\BackendTemplateView::getModuleTemplate

(

)

Returns

ModuleTemplate

Definition at line 59 of file BackendTemplateView.php.

References TYPO3\CMS\Backend\View\BackendTemplateView\$moduleTemplate.

initializeView()

TYPO3\CMS\Backend\View\BackendTemplateView::initializeView

(

)

Init view

Implements TYPO3\CMS\Extbase\Mvc\View\ViewInterface.

Definition at line 136 of file BackendTemplateView.php.

injectModuleTemplate()

TYPO3\CMS\Backend\View\BackendTemplateView::injectModuleTemplate

(

ModuleTemplate

$moduleTemplate

)

Parameters

ModuleTemplate

$moduleTemplate

Definition at line 43 of file BackendTemplateView.php.

References TYPO3\CMS\Backend\View\BackendTemplateView\$moduleTemplate.

injectTemplateView()

TYPO3\CMS\Backend\View\BackendTemplateView::injectTemplateView

(

TemplateView

$templateView

)

Parameters

TemplateView

$templateView

Definition at line 51 of file BackendTemplateView.php.

References TYPO3\CMS\Backend\View\BackendTemplateView\$templateView.

render()

TYPO3\CMS\Backend\View\BackendTemplateView::render

(

$actionName = null

)

Loads the template source and render the template. If "layoutName" is set in a PostParseFacet callback, it will render the file with the given layout.

Additionally amends the rendered template with a module template "frame"

Parameters

string

$actionName

If set, the view of the specified action will be rendered instead. Default is the action specified in the Request object

Returns

string Rendered Template

Definition at line 74 of file BackendTemplateView.php.

setControllerContext()

TYPO3\CMS\Backend\View\BackendTemplateView::setControllerContext

(

\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext

$controllerContext

)

Sets the current controller context

Parameters

\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext

$controllerContext

Controller context which is available inside the view

Returns

void

Definition at line 88 of file BackendTemplateView.php.

Member Data Documentation

$moduleTemplate

TYPO3\CMS\Backend\View\BackendTemplateView::$moduleTemplate

protected

Definition at line 33 of file BackendTemplateView.php.

Referenced by TYPO3\CMS\Backend\View\BackendTemplateView\getModuleTemplate(), and TYPO3\CMS\Backend\View\BackendTemplateView\injectModuleTemplate().

$templateView

TYPO3\CMS\Backend\View\BackendTemplateView::$templateView

protected

Definition at line 38 of file BackendTemplateView.php.

Referenced by TYPO3\CMS\Backend\View\BackendTemplateView\injectTemplateView().