FluidTemplateContentObject
class \
- Extends
- AbstractContentObject
Contains FLUIDTEMPLATE class object
Table of Contents
Properties
- $cObj : ContentObjectRenderer|null
- $request : ServerRequestInterface
- Always set via setRequest() by ContentObjectFactory after instantiation
Methods
- __construct() : mixed
- getContentObjectRenderer() : ContentObjectRenderer
- render() : string
- Rendering the cObject, FLUIDTEMPLATE
- setContentObjectRenderer() : void
- setRequest() : void
- applyStandardWrapToFluidPaths() : array
- buildExtbaseRequestIfNeeded() : ServerRequestInterface
- getContentObjectVariables() : array
- Compile rendered content objects in variables array ready to assign to the view.
- getLayoutRootPaths() : array|null
- getPageRenderer() : PageRenderer
- getPageRepository() : PageRepository
- getPartialRootPaths() : array|null
- renderFluidTemplateAssetsIntoPageRenderer() : void
- Attempts to render HeaderAssets and FooterAssets sections from the Fluid template, then adds each (if not empty) to either header or footer, as appropriate, using PageRenderer.
Properties
$cObj
protected
ContentObjectRenderer|null
$cObj
= null
$request
Always set via setRequest() by ContentObjectFactory after instantiation
protected
ServerRequestInterface
$request
Methods
__construct()
public
__construct(ContentDataProcessor $contentDataProcessor, TypoScriptService $typoScriptService, ViewFactoryInterface $viewFactory, PageRenderer $pageRenderer) : mixed
Parameters
- $contentDataProcessor : ContentDataProcessor
- $typoScriptService : TypoScriptService
- $viewFactory : ViewFactoryInterface
- $pageRenderer : PageRenderer
getContentObjectRenderer()
public
getContentObjectRenderer() : ContentObjectRenderer
Return values
ContentObjectRendererrender()
Rendering the cObject, FLUIDTEMPLATE
public
render([mixed $conf = [] ]) : string
Configuration properties:
- file string+stdWrap The FLUID template file
- layoutRootPaths array of filepath+stdWrap Root paths to layouts (fallback)
- partialRootPaths array of filepath+stdWrap Root paths to partials (fallback)
- variable array of cObjects, the keys are the variable names in fluid
- dataProcessing array of data processors which are classes to manipulate $data
- extbase.pluginName
- extbase.controllerExtensionName
- extbase.controllerName
- extbase.controllerActionName
Example: 10 = FLUIDTEMPLATE 10.templateName = MyTemplate 10.templateRootPaths.10 = EXT:site_configuration/Resources/Private/Templates/ 10.partialRootPaths.10 = EXT:site_configuration/Resources/Private/Partials/ 10.layoutRootPaths.10 = EXT:site_configuration/Resources/Private/Layouts/ 10.variables { mylabel = TEXT mylabel.value = Label from TypoScript coming }
Parameters
- $conf : mixed = []
-
Array of TypoScript properties (marked as "mixed" currently because we don't know what we're receiving)
Return values
stringsetContentObjectRenderer()
public
setContentObjectRenderer(ContentObjectRenderer $cObj) : void
Parameters
- $cObj : ContentObjectRenderer
setRequest()
public
setRequest(ServerRequestInterface $request) : void
Parameters
- $request : ServerRequestInterface
applyStandardWrapToFluidPaths()
protected
applyStandardWrapToFluidPaths(array $paths) : array
Parameters
- $paths : array
Return values
arraybuildExtbaseRequestIfNeeded()
protected
buildExtbaseRequestIfNeeded(ServerRequestInterface $request, array $conf) : ServerRequestInterface
Parameters
- $request : ServerRequestInterface
- $conf : array
Tags
Return values
ServerRequestInterfacegetContentObjectVariables()
Compile rendered content objects in variables array ready to assign to the view.
protected
getContentObjectVariables(array $conf) : array
Parameters
- $conf : array
Return values
arraygetLayoutRootPaths()
protected
getLayoutRootPaths(array $conf) : array|null
Parameters
- $conf : array
Return values
array|nullgetPageRenderer()
protected
getPageRenderer() : PageRenderer
Deprecated
since TYPO3 v14, will be removed in TYPO3 v15.
Return values
PageRenderergetPageRepository()
protected
getPageRepository() : PageRepository
Return values
PageRepositorygetPartialRootPaths()
protected
getPartialRootPaths(array $conf) : array|null
Parameters
- $conf : array
Return values
array|nullrenderFluidTemplateAssetsIntoPageRenderer()
Attempts to render HeaderAssets and FooterAssets sections from the Fluid template, then adds each (if not empty) to either header or footer, as appropriate, using PageRenderer.
protected
renderFluidTemplateAssetsIntoPageRenderer(FluidViewAdapter $view, array $variables) : void
Parameters
- $view : FluidViewAdapter
- $variables : array