.. include:: /Includes.rst.txt
.. highlight:: xml
.. _fluid-syntax:
============
Fluid syntax
============
.. _fluid-variables:
Variables
=========
Assign a variable in PHP:
.. code-block:: php
$this->view->assign('title', 'An example title');
Output it in a Fluid template::
{title}
The result::
An example title
In the template's HTML code, simply wrap the variable name into curly
braces to output it:
.. _fluid-arrays:
Arrays and objects
------------------
Assign an array in PHP:
.. code-block:: php
$this->view->assign('data', ['Low', 'High']);
Use the dot ``.`` to access array keys:
.. code-block:: html
:caption: EXT:site_package/Resources/Private/Templates/SomeTemplate.html
{data.0}, {data.1}
This also works for object properties:
.. code-block:: php
:caption: EXT:site_package/Classes/Controller/SomeController.php
$this->view->assign('product', $myProduct);
Use it like this:
.. code-block:: html
:caption: EXT:site_package/Resources/Private/Templates/SomeTemplate.html
{product.name}: {product.price}
Accessing dynamic keys/properties
---------------------------------
It is possible to access array or object values by a dynamic index:
.. code-block:: html
:caption: EXT:site_package/Resources/Private/Templates/SomeTemplate.html
myArray.{myIndex}
.. _fluid-syntax-viewhelpers:
ViewHelpers
===========
ViewHelpers are special tags in the template which provide more complex
functionality such as loops or generating links.
The functionality of the ViewHelper is implemented in PHP, every ViewHelper has
its own PHP class.
See the :doc:`Fluid Viewhelper Reference ` for a complete
list of all available ViewHelpers.
Within Fluid, the ViewHelper is used as a special HTML element with a namespace
prefix, for example the namespace prefix "f" is used for ViewHelpers from the
Fluid namespace:
.. code-block:: html
:caption: Fluid example with for ViewHelper
{result.title}
The "f" namespace is already defined, but can be explicitly specified to
improve IDE autocompletion.
Fluid example with custom ViewHelper "custom" in namespace "blog":
.. code-block:: html
:caption: EXT:blog_example/Resources/Private/Templates/SomeTemplate.html
Here, we are using a custom ViewHelper within the namespace "blog". The namespace
must be registered explicitly, see the next section.
.. _fluid-syntax-viewhelpers-import-namespaces:
Import ViewHelper namespaces
----------------------------
There are 3 ways to import ViewHelper namespaces in TYPO3. In all three examples
`blog` is the namespace available within the Fluid template and
`MyVendor\BlogExample\ViewHelpers` is the PHP namespace to import into Fluid.
1. Use an :html:`` tag with xmlns
.. code-block:: html
:caption: EXT:blog_example/Resources/Private/Templates/SomeTemplate.html
If the attribute :html:`data-namespace-typo3-fluid="true"` is specified on the
:html:`html` element, the HTML element itself won’t be rendered. This is useful
for various IDEs and HTML auto-completion.
2. Local namespace import via curly braces {}-syntax
.. code-block:: html
:caption: EXT:blog_example/Resources/Private/Templates/SomeTemplate.html
{namespace blog=MyVendor\BlogExample\ViewHelpers}
Each of the rows will result in a blank line. Multiple import statements can go
into a single or multiple lines.
3. Global namespace import
Fluid allows to register global namespaces. This is already done for
`typo3/cms-fluid` and `typo3fluid/fluid` ViewHelpers. Therefore they are always
available via the `f` namespace.
Custom ViewHelpers, for example for a site package, can be registered the same way.
Namespaces are registered within
:php:`$GLOBALS['TYPO3_CONF_VARS']['SYS']['fluid']['namespaces']`, for example:
.. code-block:: php
:caption: EXT:blog_example/ext_localconf.php
$GLOBALS['TYPO3_CONF_VARS']['SYS']['fluid']['namespaces']['blog'] = [
'MyVendor\BlogExample\ViewHelpers',
];
Viewhelper attributes
---------------------
Simple
~~~~~~
Variables can be inserted into ViewHelper attributes by putting them in
curly braces:
.. code-block:: html
:caption: EXT:site_package/Resources/Private/Templates/SomeTemplate.html
Now it is: {date}
.. _fluid-inline-notation:
Fluid inline notation
=====================
.. tip::
There is an online converter from tag-based syntax to inline syntax:
`Fluid Converter `__
An alternative to the tag based notation used above is inline notation. For
example, compare the 2 identical Fluid constructs:
.. code-block:: html
:caption: EXT:my_extensions/Resources/Private/Templates/Something.html
{f:translate(key: 'LLL:EXT:core/Resources/Private/Language/locallang_misc.xlf:bookmark_inactive')}
Tag based notation and inline notation can be freely mixed within one Fluid
template.
Inline notation is often a better choice if HTML tags are nested, for example:
.. code-block:: html
:caption: EXT:my_extensions/Resources/Private/Templates/Something.html
<-- inline notation -->
More complex example with chaining:
.. code-block:: html
:caption: EXT:my_extensions/Resources/Private/Templates/Something.html
{post.date}
{post.date -> f:format.date(format: 'Y-m-d') -> f:format.padding(padLength: 40)}
.. _fluid-syntax-boolean-conditions:
Boolean conditions
==================
Boolean conditions are expressions that evaluate to true or false.
Boolean conditions can be used as ViewHelper arguments, whenever the datatype
:html:`boolean` is given, e.g. in the
:ref:`if ViewHelper ` :html:`condition` argument.
1. The expression can be a variable which is evaluated as follows:
* number: evaluates to :php:`true`, if > 0.
* array: evaluates to :php:`true` if it contains at least one element
2. The expression can be a statement consisting of: term1 operator term2, for
example :html:`{variable} > 3`
* The ooperator can be one of :html:`>`, :html:`>=`, :html:`<`, :html:`<=`,
:html:`==`, :html:`!=` or :html:`%`,
3. The previous expressions can be combined with :html:`||` (or) or :html:`&&`
(and).
Examples:
.. code-block:: none
...
...
...
...
Example using the inline notation:
.. code-block:: html
...
.. _fluid-comments:
Comments
========
As the Fluid syntax is basically XML, you can use CDATA tags to comment
out parts of your template:
.. code-block:: html
:caption: EXT:my_extension/Resources/Private/Templates/SomeTemplate.html
If you want to hide the contents from the browser, you can additionally
encapsulate the part in HTML comments:
.. code-block:: html
:caption: EXT:my_extension/Resources/Private/Templates/SomeTemplate.html
Note: This way the content will still be transferred to the browser! If
you want to completely skip parts of your template, you can make use of
the **f:comment** view helper. To disable parsing you best combine it
with CDATA tags:
.. code-block:: html
:caption: EXT:my_extension/Resources/Private/Templates/SomeTemplate.html