.. include:: /Includes.rst.txt .. index:: Content objects; FLUIDTEMPLATE FLUIDTEMPLATE .. _cobj-fluidtemplate: .. _cobj-template: ============= FLUIDTEMPLATE ============= An object of type FLUIDTEMPLATE combines TypoScript with the Fluid templating engine. .. versionchanged:: 11.0 The content object FLUIDTEMPLATE has replaced `TEMPLATE `__ which was removed with version 11.0. FLUIDTEMPLATE generates content using Fluid templates. It can be used in :ref:`content elements ` or to generate content within the top-level object page (see :ref:`the example on this page `). The functionality can be further augmented and customized with :ref:`data processors `. .. contents:: On this page: :local: :depth: 1 .. toctree:: :hidden: DataProcessing .. index:: FLUIDTEMPLATE; Properties .. _cobj-fluidtemplate-properties: Properties ========== .. contents:: :local: :depth: 1 .. index:: FLUIDTEMPLATE; dataProcessing .. _fluidtemplate-dataProcessing: dataProcessing -------------- .. rst-class:: dl-parameters dataProcessing :sep:`|` :aspect:`Data type:` array of class references by full namespace :sep:`|` Add one or multiple processors to manipulate the :php:`$data` variable of the currently rendered content object, like tt_content or page. The sub- property :typoscript:`options` can be used to pass parameters to the processor class. .. note:: The content was moved to the subpage :ref:`dataProcessing`. .. index:: FLUIDTEMPLATE; extbase.controllerActionName .. _cobj-fluidtemplate-properties-extbase-controlleractionname: extbase.controllerActionName ---------------------------- .. rst-class:: dl-parameters extbase.controllerActionName :sep:`|` :aspect:`Data type:` string /:ref:`stdWrap ` :sep:`|` Sets the name of the action. .. index:: FLUIDTEMPLATE; extbase.controllerExtensionName .. _cobj-fluidtemplate-properties-extbase-controllerextensionname: extbase.controllerExtensionName ------------------------------- .. rst-class:: dl-parameters extbase.controllerExtensionName :sep:`|` :aspect:`Data type:` string /:ref:`stdWrap ` :sep:`|` Sets the extension name of the controller. **Important:** This is for example essential if you have translations at the usual paths in your extension and want to use them right away in your template via ``. .. index:: FLUIDTEMPLATE; extbase.controllerName .. _cobj-fluidtemplate-properties-extbase-controllername: extbase.controllerName ---------------------- .. rst-class:: dl-parameters extbase.controllerName :sep:`|` :aspect:`Data type:` string /:ref:`stdWrap ` :sep:`|` Sets the name of the controller. .. index:: FLUIDTEMPLATE; extbase.pluginName .. _cobj-fluidtemplate-properties-extbase-pluginname: extbase.pluginName ------------------ .. rst-class:: dl-parameters extbase.pluginName :sep:`|` :aspect:`Data type:` string /:ref:`stdWrap ` :sep:`|` Sets variables for initializing extbase. .. index:: FLUIDTEMPLATE; file .. _cobj-fluidtemplate-properties-file: file ---- .. rst-class:: dl-parameters file :sep:`|` :aspect:`Data type:` string /:ref:`stdWrap ` :sep:`|` The fluid template file. It is an alternative to ".template" and is used only, if ".template" is not set. **Example:** .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript page = PAGE page { 10 = FLUIDTEMPLATE 10 { file = EXT:site_package/Resources/Private/Templates/Page/MyTemplate.html } } .. index:: FLUIDTEMPLATE; format .. _cobj-fluidtemplate-properties-format: format ------ .. rst-class:: dl-parameters format :sep:`|` :aspect:`Data type:` keyword /:ref:`stdWrap ` :sep:`|` :aspect:`Default:` html :sep:`|` :typoscript:`format` sets the format of the current request. It can be something like "html", "xml", "png", "json". And it can even come in the form of "rss.xml" or alike. .. index:: FLUIDTEMPLATE; layoutRootPath .. _cobj-fluidtemplate-properties-layoutrootpath: layoutRootPath -------------- .. rst-class:: dl-parameters layoutRootPath :sep:`|` :aspect:`Data type:` file path /:ref:`stdWrap ` :sep:`|` Sets a specific layout path, usually :file:`EXT:some_extension/Resources/Private/Layouts/` or a folder below that path. .. note:: It is recommended to use :ref:`cobj-fluidtemplate-properties-layoutrootpaths` (mind the plural "s") as it can be easily extended by custom templates provided by the sitepackage. .. index:: FLUIDTEMPLATE; layoutRootPaths .. _cobj-fluidtemplate-properties-layoutrootpaths: layoutRootPaths --------------- .. rst-class:: dl-parameters layoutRootPaths :sep:`|` :aspect:`Data type:` array of file paths with :ref:`stdWrap ` :sep:`|` .. note:: Mind the plural -s in "layoutRootPaths"! Used to define several paths for layouts, which will be tried in reversed order (the paths are searched from bottom to top). The first folder where the desired layout is found, is used. If the array keys are numeric, they are first sorted and then tried in reversed order. **Example:** .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript page { 10 = FLUIDTEMPLATE 10 { file = EXT:site_default/Resources/Private/Templates/Main.html layoutRootPaths { 10 = EXT:site_default/Resources/Private/Layouts 20 = EXT:site_modification/Resources/Private/Layouts } } } If property :ref:`layoutRootPath ` (singular) is also used, it will be placed as the first option in the list of fall back paths. .. index:: FLUIDTEMPLATE; partialRootPath .. _cobj-fluidtemplate-properties-partialrootpath: partialRootPath --------------- .. rst-class:: dl-parameters partialRootPath :sep:`|` :aspect:`Data type:` file path /:ref:`stdWrap ` :sep:`|` Sets a specific partial path, usually :file:`EXT:some_extension/Resources/Private/Partials/` or a folder below that path. .. note:: It is recommended to use :ref:`cobj-fluidtemplate-properties-partialrootpaths` (mind the plural "s") as it can be easily extended by custom templates provided by the sitepackage. .. index:: FLUIDTEMPLATE; partialRootPaths .. _cobj-fluidtemplate-properties-partialrootpaths: partialRootPaths ---------------- .. rst-class:: dl-parameters partialRootPaths :sep:`|` :aspect:`Data type:` array of file paths with :ref:`stdWrap ` :sep:`|` .. note:: Mind the plural -s in "partialRootPaths"! Used to define several paths for partials, which will be tried in reversed order. The first folder where the desired partial is found, is used. The keys of the array define the order. See :ref:`layoutRootPaths ` for more details. .. index:: FLUIDTEMPLATE; settings .. _cobj-fluidtemplate-properties-settings: settings -------- .. rst-class:: dl-parameters settings :sep:`|` :aspect:`Data type:` array of keys :sep:`|` Sets the given settings array in the fluid template. In the view, the value can then be used. **Example:** .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript page = PAGE page { 10 = FLUIDTEMPLATE 10 { file = EXT:site_default/Resources/Private/Templates/MyTemplate.html settings { copyrightYear = 2013 } } } To access copyrightYear in the template file use this: .. code-block:: html {settings.copyrightYear} Apart from setting a key-value pair as done in the example, you can also reference objects or access constants as well. .. index:: FLUIDTEMPLATE; stdWrap .. _cobj-fluidtemplate-properties-stdwrap: stdWrap ------- .. rst-class:: dl-parameters stdWrap :sep:`|` :aspect:`Data type:` :ref:`->stdWrap ` :sep:`|` Offers the usual stdWrap functionality. .. index:: FLUIDTEMPLATE; template .. _cobj-fluidtemplate-properties-template: template -------- .. rst-class:: dl-parameters template :sep:`|` :aspect:`Data type:` :ref:`cObject ` :sep:`|` Use this property to define a content object, which should be used as template file. It is an alternative to ".file"; if ".template" is set, it takes precedence. .. warning:: The :typoscript:`FILE` object type has been removed in TYPO3 v10. As the :typoscript:`.template` property used :typoscript:`FILE`, you should generally check your code if using this and switch to using :ref:`.templateName ` with :ref:`.templateRootPaths ` or use :ref:`.file `. .. index:: FLUIDTEMPLATE; templateName .. _cobj-fluidtemplate-properties-templatename: templateName ------------ .. rst-class:: dl-parameters templateName :sep:`|` :aspect:`Data type:` string /:ref:`stdWrap ` :sep:`|` This name is used together with the set format to find the template in the given templateRootPaths. Use this property to define a content object, which should be used as template file. It is an alternative to :typoscript:`.file`. If `.templateName` is set, it takes precedence. **Example 1:** .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript lib.stdContent = FLUIDTEMPLATE lib.stdContent { templateName = Default layoutRootPaths { 10 = EXT:frontend/Resources/Private/Layouts 20 = EXT:sitemodification/Resources/Private/Layouts } partialRootPaths { 10 = EXT:frontend/Resources/Private/Partials 20 = EXT:sitemodification/Resources/Private/Partials } templateRootPaths { 10 = EXT:frontend/Resources/Private/Templates 20 = EXT:sitemodification/Resources/Private/Templates } variables { foo = TEXT foo.value = bar } } **Example 2:** .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript lib.stdContent = FLUIDTEMPLATE lib.stdContent { templateName = TEXT templateName.stdWrap { cObject = TEXT cObject { data = levelfield:-2,backend_layout_next_level,slide override.field = backend_layout split { token = frontend__ 1.current = 1 1.wrap = | } } ifEmpty = Default } layoutRootPaths { 10 = EXT:frontend/Resources/Private/Layouts 20 = EXT:sitemodification/Resources/Private/Layouts } partialRootPaths { 10 = EXT:frontend/Resources/Private/Partials 20 = EXT:sitemodification/Resources/Private/Partials } templateRootPaths { 10 = EXT:frontend/Resources/Private/Templates 20 = EXT:sitemodification/Resources/Private/Templates } variables { foo = bar } } .. index:: FLUIDTEMPLATE; templateRootPath .. _cobj-fluidtemplate-properties-templaterootpath: templateRootPath ---------------- .. rst-class:: dl-parameters templateRootPath :sep:`|` :aspect:`Data type:` file path /:ref:`stdWrap ` :sep:`|` Sets a specific template path, usually :file:`EXT:some_extension/Resources/Private/Templates/` or a folder below that path. .. note:: It is recommended to use :ref:`cobj-fluidtemplate-properties-templaterootpaths` (mind the plural "s") as it can be easily extended by custom templates provided by the sitepackage. .. index:: FLUIDTEMPLATE; templateRootPaths .. _cobj-fluidtemplate-properties-templaterootpaths: templateRootPaths ----------------- .. rst-class:: dl-parameters templateRootPaths :sep:`|` :aspect:`Data type:` array of file paths with :ref:`stdWrap ` :sep:`|` .. note:: Mind the plural -s in "templateRootPaths"! Used to define several paths for templates, which will be tried in reversed order (the paths are searched from bottom to top). The first folder where the desired layout is found, is used. If the array keys are numeric, they are first sorted and then tried in reversed order. Useful in combination with the :ref:`templateName ` property. **Example:** .. code-block:: typoscript :caption: EXT:site_package/Configuration/TypoScript/setup.typoscript page { 10 = FLUIDTEMPLATE 10 { templateName = Default templateRootPaths { 10 = EXT:sitedesign/Resources/Private/Templates 20 = EXT:sitemodification/Resources/Private/Templates } } } .. index:: FLUIDTEMPLATE; variables .. _cobj-fluidtemplate-properties-variables: variables --------- .. rst-class:: dl-parameters variables :sep:`|` :aspect:`Data type:` *(array of cObjects)* :sep:`|` Sets variables that should be available in the fluid template. The keys are the variable names in Fluid. Reserved variables are "data" and "current", which are filled automatically with the current data set. .. _cobj-fluidtemplate-examples: Example ======= The Fluid template in :file:`EXT:site_default/Resources/Private/Templates/MyTemplate.html` could look like this: .. code-block:: html

{data.title}, {data.subtitle}

{mylabel}

{data.bodytext}

© {settings.copyrightYear}

You could use it with a TypoScript code like this: .. code-block:: typoscript page = PAGE page.10 = FLUIDTEMPLATE page.10 { templateName = MyTemplate templateRootPaths { 10 = EXT:site_default/Resources/Private/Templates } partialRootPaths { 10 = EXT:site_default/Resources/Private/Partials } variables { mylabel = TEXT mylabel.value = Label coming from TypoScript! } settings { # Get the copyright year from a TypoScript constant. copyrightYear = {$year} } } As a result the page title and the label from TypoScript will be inserted as headlines. The copyright year will be taken from the TypoScript constant "year". .. seealso:: * :ref:`dataProcessing` examples * :ref:`t3coreapi:adding-your-own-content-elements` * :doc:`t3sitepackage:Index`