AbstractTemplateView extends AbstractTemplateView implements ViewInterface
Abstract Fluid Template View.
Contains the fundamental methods which any Fluid based template view needs.
Tags
Table of Contents
Interfaces
- ViewInterface
- Interface of a view
Properties
Methods
- __construct() : mixed
- canRender() : bool
- Tells if the view implementation can render the view for the given context.
- getLayoutRootPaths() : array<string|int, string>
- Resolves the layout root to be used inside other paths.
- getPartialRootPaths() : array<string|int, string>
- Returns the absolute path to the folder that contains Fluid partial files
- getTemplateRootPaths() : array<string|int, string>
- Resolves the template root to be used inside other paths.
- initializeView() : mixed
- Initializes this view.
- setControllerContext() : mixed
- Sets the current controller context
- setLayoutRootPaths() : mixed
- Set the root path(s) to the layouts.
- setPartialRootPaths() : mixed
- Set the root path(s) to the partials.
- setTemplate() : mixed
- setTemplatePathAndFilename() : mixed
- Sets the path and name of of the template file. Effectively overrides the dynamic resolving of a template file.
- setTemplateRootPaths() : mixed
- Set the root path(s) to the templates.
Properties
$controllerContext
since v11, will be removed with v12.
protected
ControllerContext
$controllerContext
Methods
__construct()
public
__construct([RenderingContextInterface|null $context = null ]) : mixed
Parameters
- $context : RenderingContextInterface|null = null
canRender()
Tells if the view implementation can render the view for the given context.
public
canRender(ControllerContext $controllerContext) : bool
since TYPO3 v11, will be removed in v12. Legacy method, not part of ViewInterface anymore.
By default we assume that the view implementation can handle all kinds of contexts. Override this method if that is not the case.
Parameters
- $controllerContext : ControllerContext
-
Controller context which is available inside the view
Return values
bool —TRUE if the view has something useful to display, otherwise FALSE
getLayoutRootPaths()
Resolves the layout root to be used inside other paths.
public
getLayoutRootPaths() : array<string|int, string>
Tags
Return values
array<string|int, string> —Fluid layout root paths
getPartialRootPaths()
Returns the absolute path to the folder that contains Fluid partial files
public
getPartialRootPaths() : array<string|int, string>
Tags
Return values
array<string|int, string> —Fluid partial root paths
getTemplateRootPaths()
Resolves the template root to be used inside other paths.
public
getTemplateRootPaths() : array<string|int, string>
Return values
array<string|int, string> —Path(s) to template root directory
initializeView()
Initializes this view.
public
initializeView() : mixed
since v11, will be removed with v12. Drop together with removal of extbase ViewInterface.
setControllerContext()
Sets the current controller context
public
setControllerContext(ControllerContext $controllerContext) : mixed
since v11, will be removed with v12.
Parameters
- $controllerContext : ControllerContext
setLayoutRootPaths()
Set the root path(s) to the layouts.
public
setLayoutRootPaths(array<string|int, string> $layoutRootPaths) : mixed
If set, overrides the one determined from $this->layoutRootPathPattern
Parameters
- $layoutRootPaths : array<string|int, string>
-
Root path to the layouts. If set, overrides the one determined from $this->layoutRootPathPattern
setPartialRootPaths()
Set the root path(s) to the partials.
public
setPartialRootPaths(array<string|int, string> $partialRootPaths) : mixed
If set, overrides the one determined from $this->partialRootPathPattern
Parameters
- $partialRootPaths : array<string|int, string>
-
Root paths to the partials. If set, overrides the one determined from $this->partialRootPathPattern
setTemplate()
public
setTemplate(string $templateName) : mixed
Parameters
- $templateName : string
setTemplatePathAndFilename()
Sets the path and name of of the template file. Effectively overrides the dynamic resolving of a template file.
public
setTemplatePathAndFilename(string $templatePathAndFilename) : mixed
Parameters
- $templatePathAndFilename : string
-
Template file path
setTemplateRootPaths()
Set the root path(s) to the templates.
public
setTemplateRootPaths(array<string|int, string> $templateRootPaths) : mixed
If set, overrides the one determined from $this->templateRootPathPattern
Parameters
- $templateRootPaths : array<string|int, string>
-
Root path(s) to the templates. If set, overrides the one determined from $this->templateRootPathPattern