‪TYPO3CMS  10.4
Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\View\BackendTemplateView Class Reference
Inheritance diagram for TYPO3\CMS\Backend\View\BackendTemplateView:
TYPO3\CMS\Extbase\Mvc\View\ViewInterface

Public Member Functions

 injectModuleTemplate (ModuleTemplate $moduleTemplate)
 
 injectTemplateView (TemplateView $templateView)
 
ModuleTemplate getModuleTemplate ()
 
string render ($actionName=null)
 
 setControllerContext (ControllerContext $controllerContext)
 
TYPO3 CMS Fluid View AbstractTemplateView assign ($key, $value)
 
TYPO3 CMS Fluid View AbstractTemplateView assignMultiple (array $values)
 
bool canRender (ControllerContext $controllerContext)
 
 initializeView ()
 
 setTemplateRootPaths (array $templateRootPaths)
 
 setPartialRootPaths (array $partialRootPaths)
 
 setLayoutRootPaths (array $layoutRootPaths)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\View\ViewInterface
string render ()
 

Protected Attributes

ModuleTemplate $moduleTemplate
 
TemplateView $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 27 of file BackendTemplateView.php.

Member Function Documentation

◆ assign()

TYPO3 CMS Fluid View AbstractTemplateView 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
‪\TYPO3\CMS\Fluid\View\AbstractTemplateView the instance of this view to allow chaining

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

Definition at line 94 of file BackendTemplateView.php.

Referenced by TYPO3\CMS\IndexedSearch\Controller\AdministrationController\initializeView(), and TYPO3\CMS\Filelist\Controller\FileListController\initializeView().

◆ assignMultiple()

TYPO3 CMS Fluid View AbstractTemplateView 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
‪\TYPO3\CMS\Fluid\View\AbstractTemplateView the instance of this view to allow chaining

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

Definition at line 107 of file BackendTemplateView.php.

Referenced by TYPO3\CMS\Extensionmanager\Controller\AbstractModuleController\resolveView().

◆ canRender()

bool 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

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

Definition at line 119 of file BackendTemplateView.php.

◆ getModuleTemplate()

ModuleTemplate TYPO3\CMS\Backend\View\BackendTemplateView::getModuleTemplate ( )
Returns
‪ModuleTemplate

Definition at line 56 of file BackendTemplateView.php.

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

Referenced by TYPO3\CMS\IndexedSearch\Controller\AdministrationController\initializeView(), and TYPO3\CMS\Beuser\Controller\PermissionController\initializeView().

◆ initializeView()

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

Init view

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

Definition at line 127 of file BackendTemplateView.php.

◆ injectModuleTemplate()

TYPO3\CMS\Backend\View\BackendTemplateView::injectModuleTemplate ( ModuleTemplate  $moduleTemplate)
Parameters
ModuleTemplate$moduleTemplate

Definition at line 40 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 48 of file BackendTemplateView.php.

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

◆ render()

string 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 70 of file BackendTemplateView.php.

◆ setControllerContext()

TYPO3\CMS\Backend\View\BackendTemplateView::setControllerContext ( ControllerContext  $controllerContext)

Sets the current controller context

Parameters
\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext$controllerContext‪Controller context which is available inside the view

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

Definition at line 82 of file BackendTemplateView.php.

◆ setLayoutRootPaths()

TYPO3\CMS\Backend\View\BackendTemplateView::setLayoutRootPaths ( array  $layoutRootPaths)

Set the root path(s) to the layouts.

Parameters
array$layoutRootPaths‪Root path to the layouts.

Definition at line 157 of file BackendTemplateView.php.

◆ setPartialRootPaths()

TYPO3\CMS\Backend\View\BackendTemplateView::setPartialRootPaths ( array  $partialRootPaths)

Set the root path(s) to the partials.

Parameters
array$partialRootPaths‪Root paths to the partials.

Definition at line 147 of file BackendTemplateView.php.

◆ setTemplateRootPaths()

TYPO3\CMS\Backend\View\BackendTemplateView::setTemplateRootPaths ( array  $templateRootPaths)

Set the root path(s) to the templates.

Parameters
array$templateRootPaths‪Root path(s) to the templates.

Definition at line 137 of file BackendTemplateView.php.

Member Data Documentation

◆ $moduleTemplate

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

Definition at line 31 of file BackendTemplateView.php.

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

◆ $templateView

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

Definition at line 35 of file BackendTemplateView.php.

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