TYPO3\CMS\Fluid\View\AbstractTemplateView Class Reference

Inheritance diagram for TYPO3\CMS\Fluid\View\AbstractTemplateView:

Public Member Functions
	initializeView ()
	__construct (RenderingContextInterface $context=null)
bool	canRender (\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
	setControllerContext (\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
	setTemplate ($templateName)
	setTemplatePathAndFilename ($templatePathAndFilename)
	setTemplateRootPaths (array $templateRootPaths)
string[]	getTemplateRootPaths ()
	setPartialRootPaths (array $partialRootPaths)
string[]	getPartialRootPaths ()
string[]	getLayoutRootPaths ()
	setLayoutRootPaths (array $layoutRootPaths)
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\View\ViewInterface
	setControllerContext (\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
TYPO3 CMS Extbase Mvc View ViewInterface	assign ($key, $value)
TYPO3 CMS Extbase Mvc View ViewInterface	assignMultiple (array $values)
bool	canRender (\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext $controllerContext)
string	render ()

Protected Attributes
TYPO3 CMS Extbase Mvc Controller ControllerContext	$controllerContext

Detailed Description

Abstract Fluid Template View.

Contains the fundamental methods which any Fluid based template view needs.

Definition at line 29 of file AbstractTemplateView.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Fluid\View\AbstractTemplateView::__construct

(

RenderingContextInterface

$context = null

)

Parameters

RenderingContextInterface

$context

Definition at line 46 of file AbstractTemplateView.php.

Member Function Documentation

canRender()

bool TYPO3\CMS\Fluid\View\AbstractTemplateView::canRender

(

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

$controllerContext

)

Tells if the view implementation can render the view for the given context.

By default we assume that the view implementation can handle all kinds of contexts. Override this method if that is not the case.

Parameters

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

$controllerContext

‪Controller context which is available inside the view

Returns

‪bool TRUE if the view has something useful to display, otherwise FALSE

Definition at line 63 of file AbstractTemplateView.php.

getLayoutRootPaths()

string [] TYPO3\CMS\Fluid\View\AbstractTemplateView::getLayoutRootPaths

(

)

Resolves the layout root to be used inside other paths.

Returns

‪string[] Fluid layout root paths

Exceptions

InvalidTemplateResourceException

Definition at line 153 of file AbstractTemplateView.php.

getPartialRootPaths()

string [] TYPO3\CMS\Fluid\View\AbstractTemplateView::getPartialRootPaths

(

)

Returns the absolute path to the folder that contains Fluid partial files

Returns

‪string[] Fluid partial root paths

Exceptions

InvalidTemplateResourceException

Definition at line 142 of file AbstractTemplateView.php.

getTemplateRootPaths()

string [] TYPO3\CMS\Fluid\View\AbstractTemplateView::getTemplateRootPaths

(

)

Resolves the template root to be used inside other paths.

Returns

‪string[] Path(s) to template root directory

Definition at line 121 of file AbstractTemplateView.php.

initializeView()

TYPO3\CMS\Fluid\View\AbstractTemplateView::initializeView

(

)

Initializes this view.

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

Definition at line 38 of file AbstractTemplateView.php.

setControllerContext()

TYPO3\CMS\Fluid\View\AbstractTemplateView::setControllerContext

(

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

$controllerContext

)

Sets the current controller context

Parameters

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

$controllerContext

Definition at line 74 of file AbstractTemplateView.php.

References TYPO3\CMS\Fluid\View\AbstractTemplateView\$controllerContext, and TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext\getRequest().

Referenced by TYPO3\CMS\Fluid\View\TemplateView\canRender().

setLayoutRootPaths()

TYPO3\CMS\Fluid\View\AbstractTemplateView::setLayoutRootPaths

(

array

$layoutRootPaths

)

Set the root path(s) to the layouts. If set, overrides the one determined from $this->layoutRootPathPattern

Parameters

string[]

$layoutRootPaths

‪Root path to the layouts. If set, overrides the one determined from $this->layoutRootPathPattern

Definition at line 164 of file AbstractTemplateView.php.

Referenced by TYPO3\CMS\Backend\Controller\Wizard\ImageManipulationController\__construct(), TYPO3\CMS\Info\Controller\InfoModuleController\getFluidTemplateObject(), TYPO3\CMS\Info\Controller\InfoPageTyposcriptConfigController\getFluidTemplateObject(), TYPO3\CMS\Backend\Controller\LoginController\getFluidTemplateObject(), TYPO3\CMS\Seo\XmlSitemap\XmlSitemapRenderer\getStandaloneView(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\initializeView().

setPartialRootPaths()

TYPO3\CMS\Fluid\View\AbstractTemplateView::setPartialRootPaths

(

array

$partialRootPaths

)

Set the root path(s) to the partials. If set, overrides the one determined from $this->partialRootPathPattern

Parameters

string[]

$partialRootPaths

‪Root paths to the partials. If set, overrides the one determined from $this->partialRootPathPattern

Definition at line 131 of file AbstractTemplateView.php.

Referenced by TYPO3\CMS\Backend\Controller\Wizard\ImageManipulationController\__construct(), TYPO3\CMS\Backend\Template\ModuleTemplate\getDynamicTabMenu(), TYPO3\CMS\Info\Controller\InfoModuleController\getFluidTemplateObject(), TYPO3\CMS\Info\Controller\InfoPageTyposcriptConfigController\getFluidTemplateObject(), TYPO3\CMS\Backend\Controller\LoginController\getFluidTemplateObject(), TYPO3\CMS\Seo\XmlSitemap\XmlSitemapRenderer\getStandaloneView(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\initializeView().

setTemplate()

TYPO3\CMS\Fluid\View\AbstractTemplateView::setTemplate

(

$templateName

)

Parameters

string

$templateName

Definition at line 89 of file AbstractTemplateView.php.

setTemplatePathAndFilename()

TYPO3\CMS\Fluid\View\AbstractTemplateView::setTemplatePathAndFilename

(

$templatePathAndFilename

)

Sets the path and name of of the template file. Effectively overrides the dynamic resolving of a template file.

Parameters

string

$templatePathAndFilename

‪Template file path

Definition at line 100 of file AbstractTemplateView.php.

Referenced by TYPO3\CMS\Backend\Controller\Wizard\ImageManipulationController\__construct(), TYPO3\CMS\Backend\Template\ModuleTemplate\getDynamicTabMenu(), TYPO3\CMS\Info\Controller\InfoModuleController\getFluidTemplateObject(), TYPO3\CMS\Info\Controller\InfoPageTyposcriptConfigController\getFluidTemplateObject(), TYPO3\CMS\Backend\Controller\ContentElement\NewContentElementController\getFluidTemplateObject(), TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\initializeView(), TYPO3\CMS\Backend\LoginProvider\UsernamePasswordLoginProvider\render(), and TYPO3\CMS\Recordlist\LinkHandler\RecordLinkHandler\render().

setTemplateRootPaths()

TYPO3\CMS\Fluid\View\AbstractTemplateView::setTemplateRootPaths

(

array

$templateRootPaths

)

Set the root path(s) to the templates. If set, overrides the one determined from $this->templateRootPathPattern

Parameters

string[]

$templateRootPaths

‪Root path(s) to the templates. If set, overrides the one determined from $this->templateRootPathPattern

Definition at line 111 of file AbstractTemplateView.php.

Referenced by TYPO3\CMS\Info\Controller\InfoModuleController\getFluidTemplateObject(), TYPO3\CMS\Info\Controller\InfoPageTyposcriptConfigController\getFluidTemplateObject(), TYPO3\CMS\Backend\Controller\LoginController\getFluidTemplateObject(), TYPO3\CMS\Seo\XmlSitemap\XmlSitemapRenderer\getStandaloneView(), and TYPO3\CMS\Backend\Controller\ContentElement\ElementHistoryController\initializeView().

Member Data Documentation

$controllerContext

TYPO3 CMS Extbase Mvc Controller ControllerContext TYPO3\CMS\Fluid\View\AbstractTemplateView::$controllerContext

protected

Definition at line 33 of file AbstractTemplateView.php.

Referenced by TYPO3\CMS\Fluid\View\StandaloneView\__construct(), TYPO3\CMS\Fluid\View\TemplateView\canRender(), and TYPO3\CMS\Fluid\View\AbstractTemplateView\setControllerContext().