TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
BackendTemplateView Class Reference
Inheritance diagram for BackendTemplateView:
ViewInterface

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 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 (   $key,
  $value 
)

Assign a value to the variable container.

Parameters
string$keyThe key of a view variable to set
mixed$valueThe value of the view variable
Returns
the instance of this view to allow chaining

Implements ViewInterface.

Definition at line 101 of file BackendTemplateView.php.

assignMultiple ( array  $values)

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

Parameters
array$valuesKeys and values - only a value with key "value" is considered
Returns
the instance of this view to allow chaining

Implements ViewInterface.

Definition at line 115 of file BackendTemplateView.php.

canRender ( ControllerContext  $controllerContext)

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

Parameters
ControllerContext$controllerContextController context which is available inside the view
Returns
bool

Definition at line 128 of file BackendTemplateView.php.

getModuleTemplate ( )
Returns
ModuleTemplate

Definition at line 59 of file BackendTemplateView.php.

References BackendTemplateView\$moduleTemplate.

initializeView ( )

Init view

Implements ViewInterface.

Definition at line 136 of file BackendTemplateView.php.

injectModuleTemplate ( ModuleTemplate  $moduleTemplate)
Parameters
ModuleTemplate$moduleTemplate

Definition at line 43 of file BackendTemplateView.php.

References BackendTemplateView\$moduleTemplate.

injectTemplateView ( TemplateView  $templateView)
Parameters
TemplateView$templateView

Definition at line 51 of file BackendTemplateView.php.

References BackendTemplateView\$templateView.

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$actionNameIf 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\Extbase\Mvc\Controller\ControllerContext  $controllerContext)

Sets the current controller context

Parameters
\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext$controllerContextController context which is available inside the view
Returns
void

Definition at line 88 of file BackendTemplateView.php.

Member Data Documentation

$moduleTemplate
protected
$templateView
protected

Definition at line 38 of file BackendTemplateView.php.

Referenced by BackendTemplateView\injectTemplateView().