.. _`TYPO3 Fluid ViewHelper Reference`: TYPO3 Fluid ViewHelper Reference ################################ This reference was automatically generated from code on 2025-02-12 .. _`TYPO3 Fluid ViewHelper Reference: f:alias`: f:alias ------- Declares new variables which are aliases of other variables. Takes a "map"-Parameter which is an associative array which defines the shorthand mapping. The variables are only declared inside the ``...`` tag. After the closing tag, all declared variables are removed again. Using this ViewHelper can be a sign of weak architecture. If you end up using it extensively you might want to fine-tune your "view model" (the data you assign to the view). Examples ======== Single alias ------------ :: {x} Output:: foo Multiple mappings ----------------- :: {x.name} or {y} Output:: [name] or [name] Depending on ``{foo.bar.baz}``. :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\AliasViewHelper Arguments ********* * ``map`` (array): Array that specifies which variables should be mapped to which alias .. _`TYPO3 Fluid ViewHelper Reference: f:cache.disable`: f:cache.disable --------------- ViewHelper to disable template compiling Inserting this ViewHelper at any point in the template, including inside conditions which do not get rendered, will forcibly disable the caching/compiling of the full template file to a PHP class. Use this if for whatever reason your platform is unable to create or load PHP classes (for example on read-only file systems or when using an incompatible default cache backend). Passes through anything you place inside the ViewHelper, so can safely be used as container tag, as self-closing or with inline syntax - all with the same result. Examples ======== Self-closing ------------ :: Inline mode ----------- :: {f:cache.disable()} Container tag ------------- :: Some output or Fluid code Additional output is also not compilable because of the ViewHelper :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Cache\\DisableViewHelper .. _`TYPO3 Fluid ViewHelper Reference: f:cache.static`: f:cache.static -------------- ViewHelper to force compiling to a static string Used around chunks of template code where you want the output of said template code to be compiled to a static string (rather than a collection of compiled nodes, as is the usual behavior). The effect is that none of the child ViewHelpers or nodes used inside this tag will be evaluated when rendering the template once it is compiled. It will essentially replace all logic inside the tag with a plain string output. Works by turning the ``compile`` method into a method that renders the child nodes and returns the resulting content directly as a string variable. You can use this with great effect to further optimise the performance of your templates: in use cases where chunks of template code depend on static variables (like thoese in ``{settings}`` for example) and those variables never change, and the template uses no other dynamic variables, forcing the template to compile that chunk to a static string can save a lot of operations when rendering the compiled template. NB: NOT TO BE USED FOR CACHING ANYTHING OTHER THAN STRING- COMPATIBLE OUTPUT! USE WITH CARE! WILL PRESERVE EVERYTHING RENDERED, INCLUDING POTENTIALLY SENSITIVE DATA CONTAINED IN OUTPUT! Examples ======== Usage and effect ---------------- :: Is always evaluated also when compiled Will only be evaluated once and this output will be cached as a static string with no logic attached. The compiled template will not contain neither the condition ViewHelperNodes or the variable accessor that are used inside this node. This is also evaluated when compiled (static node is closed):: Also evaluated; is outside static node :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Cache\\StaticViewHelper .. _`TYPO3 Fluid ViewHelper Reference: f:cache.warmup`: f:cache.warmup -------------- ViewHelper to insert variables which only apply during cache warmup and only apply if no other variables are specified for the warmup process. If a chunk of template code is impossible to compile without additional variables, for example when rendering sections or partials using dynamic names, you can use this ViewHelper around that chunk and specify a set of variables which will be assigned only while compiling the template and only when this is done as part of cache warmup. The template chunk can then be compiled using those default variables. This does not imply that only those variable values will be used by the compiled template. It only means that DEFAULT values of vital variables will be present during compiling. If you find yourself completely unable to properly warm up a specific template file even with use of this ViewHelper, then you can consider using ``f:cache.disable`` ViewHelper to prevent the template compiler from even attempting to compile it. USE WITH CARE! SOME EDGE CASES OF FOR EXAMPLE VIEWHELPERS WHICH REQUIRE SPECIAL VARIABLE TYPES MAY NOT BE SUPPORTED HERE DUE TO THE RUDIMENTARY NATURE OF VARIABLES YOU DEFINE. Examples ======== Usage and effect ---------------- :: Template code depending on {foo} variable which is not assigned when warming up Fluid's caches. {foo} is only assigned if the variable does not already exist and the assignment only happens if Fluid is in warmup mode. :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Cache\\WarmupViewHelper Arguments ********* * ``variables`` (array, *optional*): Array of variables to assign ONLY when compiling. See main class documentation. .. _`TYPO3 Fluid ViewHelper Reference: f:case`: f:case ------ Case ViewHelper that is only usable within the ``f:switch`` ViewHelper. :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\CaseViewHelper Arguments ********* * ``value`` (mixed): Value to match in this case .. _`TYPO3 Fluid ViewHelper Reference: f:comment`: f:comment --------- This ViewHelper prevents rendering of any content inside the tag. Contents of the comment will still be **parsed** thus throwing an Exception if it contains syntax errors. You can put child nodes in CDATA tags to avoid this. Using this ViewHelper won't have a notable effect on performance, especially once the template is parsed. However it can lead to reduced readability. You can use layouts and partials to split a large template into smaller parts. Using self-descriptive names for the partials can make comments redundant. Examples ======== Commenting out fluid code ------------------------- :: Before This is completely hidden. This does not get rendered After Output:: Before After Prevent parsing --------------- :: ]]> Output: Will be nothing. :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\CommentViewHelper .. _`TYPO3 Fluid ViewHelper Reference: f:count`: f:count ------- This ViewHelper counts elements of the specified array or countable object. Examples ======== Count array elements -------------------- :: Output:: 4 inline notation --------------- :: {objects -> f:count()} Output:: 10 (depending on the number of items in ``{objects}``) :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\CountViewHelper Arguments ********* * ``subject`` (array, *optional*): Countable subject, array or \Countable .. _`TYPO3 Fluid ViewHelper Reference: f:cycle`: f:cycle ------- This ViewHelper cycles through the specified values. This can be often used to specify CSS classes for example. To achieve the "zebra class" effect in a loop you can also use the "iteration" argument of the **for** ViewHelper. Examples ======== These examples could also be achieved using the "iteration" argument of the ForViewHelper. Simple ------ :: {cycle} Output:: foobarbazfoo Alternating CSS class --------------------- ::
  • {foo}
    •
Output::
  • 1
  • 2
  • 3
  • 4
:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\CycleViewHelper Arguments ********* * ``values`` (array, *optional*): The array or object implementing \ArrayAccess (for example \SplObjectStorage) to iterated over * ``as`` (strong): The name of the iteration variable .. _`TYPO3 Fluid ViewHelper Reference: f:debug`: f:debug ------- This ViewHelper is only meant to be used during development. Examples ======== Inline notation and custom title -------------------------------- :: {object -> f:debug(title: 'Custom title')} Output:: all properties of {object} nicely highlighted (with custom title) Only output the type -------------------- :: {object -> f:debug(typeOnly: true)} Output:: the type or class name of {object} :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\DebugViewHelper Arguments ********* * ``typeOnly`` (boolean, *optional*): If TRUE, debugs only the type of variables * ``levels`` (integer, *optional*): Levels to render when rendering nested objects/arrays * ``html`` (boolean, *optional*): Render HTML. If FALSE, output is indented plaintext .. _`TYPO3 Fluid ViewHelper Reference: f:defaultCase`: f:defaultCase ------------- A ViewHelper which specifies the "default" case when used within the ``f:switch`` ViewHelper. :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\DefaultCaseViewHelper .. _`TYPO3 Fluid ViewHelper Reference: f:else`: f:else ------ Else-Branch of a condition. Only has an effect inside of ``f:if``. See the ``f:if`` ViewHelper for documentation. Examples ======== Output content if condition is not met -------------------------------------- :: condition was not true Output:: Everything inside the "else" tag is displayed if the condition evaluates to FALSE. Otherwise nothing is outputted in this example. :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\ElseViewHelper Arguments ********* * ``if`` (boolean, *optional*): Condition expression conforming to Fluid boolean rules .. _`TYPO3 Fluid ViewHelper Reference: f:for`: f:for ----- Loop ViewHelper which can be used to iterate over arrays. Implements what a basic PHP ``foreach()`` does. Examples ======== Simple Loop ----------- :: {foo} Output:: 1234 Output array key ---------------- ::
  • {label}: {fruit}
    •
Output::
  • fruit1: apple
  • fruit2: pear
  • fruit3: banana
  • fruit4: cherry
Iteration information --------------------- ::
  • Index: {fooIterator.index} Cycle: {fooIterator.cycle} Total: {fooIterator.total}{f:if(condition: fooIterator.isEven, then: ' Even')}{f:if(condition: fooIterator.isOdd, then: ' Odd')}{f:if(condition: fooIterator.isFirst, then: ' First')}{f:if(condition: fooIterator.isLast, then: ' Last')}
    •
Output::
  • Index: 0 Cycle: 1 Total: 4 Odd First
  • Index: 1 Cycle: 2 Total: 4 Even
  • Index: 2 Cycle: 3 Total: 4 Odd
  • Index: 3 Cycle: 4 Total: 4 Even Last
:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\ForViewHelper Arguments ********* * ``each`` (array): The array or \SplObjectStorage to iterated over * ``as`` (string): The name of the iteration variable * ``key`` (string, *optional*): Variable to assign array key to * ``reverse`` (boolean, *optional*): If TRUE, iterates in reverse * ``iteration`` (string, *optional*): The name of the variable to store iteration information (index, cycle, isFirst, isLast, isEven, isOdd) .. _`TYPO3 Fluid ViewHelper Reference: f:format.cdata`: f:format.cdata -------------- Outputs an argument/value without any escaping and wraps it with CDATA tags. PAY SPECIAL ATTENTION TO SECURITY HERE (especially Cross Site Scripting), as the output is NOT SANITIZED! Examples ======== Child nodes ----------- :: {string} Output:: Value attribute --------------- :: Output:: Inline notation --------------- :: {string -> f:format.cdata()} Output:: :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\CdataViewHelper Arguments ********* * ``value`` (mixed, *optional*): The value to output .. _`TYPO3 Fluid ViewHelper Reference: f:format.htmlspecialchars`: f:format.htmlspecialchars ------------------------- Applies PHP ``htmlspecialchars()`` escaping to a value. See http://www.php.net/manual/function.htmlspecialchars.php Examples ======== Default notation ---------------- :: {text} Output:: Text with & " ' < > * replaced by HTML entities (htmlspecialchars applied). Inline notation --------------- :: {text -> f:format.htmlspecialchars(encoding: 'ISO-8859-1')} Output:: Text with & " ' < > * replaced by HTML entities (htmlspecialchars applied). :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\HtmlspecialcharsViewHelper Arguments ********* * ``value`` (string, *optional*): Value to format * ``keepQuotes`` (boolean, *optional*): If TRUE quotes will not be replaced (ENT_NOQUOTES) * ``encoding`` (string, *optional*): Encoding * ``doubleEncode`` (boolean, *optional*): If FALSE html entities will not be encoded .. _`TYPO3 Fluid ViewHelper Reference: f:format.printf`: f:format.printf --------------- A ViewHelper for formatting values with printf. Either supply an array for the arguments or a single value. See http://www.php.net/manual/en/function.sprintf.php Examples ======== Scientific notation ------------------- :: %.3e Output:: 3.625e+8 Argument swapping ----------------- :: %2$s is great, TYPO%1$d too. Yes, TYPO%1$d is great and so is %2$s! Output:: Kasper is great, TYPO3 too. Yes, TYPO3 is great and so is Kasper! Single argument --------------- :: We love %s Output:: We love TYPO3 Inline notation --------------- :: {someText -> f:format.printf(arguments: {1: 'TYPO3'})} Output:: We love TYPO3 :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\PrintfViewHelper Arguments ********* * ``value`` (string, *optional*): String to format * ``arguments`` (array, *optional*): The arguments for vsprintf .. _`TYPO3 Fluid ViewHelper Reference: f:format.raw`: f:format.raw ------------ Outputs an argument/value without any escaping. Is normally used to output an ObjectAccessor which should not be escaped, but output as-is. PAY SPECIAL ATTENTION TO SECURITY HERE (especially Cross Site Scripting), as the output is NOT SANITIZED! Examples ======== Child nodes ----------- :: {string} Output:: (Content of ``{string}`` without any conversion/escaping) Value attribute --------------- :: Output:: (Content of ``{string}`` without any conversion/escaping) Inline notation --------------- :: {string -> f:format.raw()} Output:: (Content of ``{string}`` without any conversion/escaping) :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\RawViewHelper Arguments ********* * ``value`` (mixed, *optional*): The value to output .. _`TYPO3 Fluid ViewHelper Reference: f:groupedFor`: f:groupedFor ------------ Grouped loop ViewHelper. Loops through the specified values. The groupBy argument also supports property paths. Using this ViewHelper can be a sign of weak architecture. If you end up using it extensively you might want to fine-tune your "view model" (the data you assign to the view). Examples ======== Simple ------ :: {fruit.name} Output:: apple cherry strawberry banana Two dimensional list -------------------- ::
  • {color} fruits:
    • {label}: {fruit.name}
      •
Output::
  • green fruits
    • 0: apple
  • red fruits
    • 1: cherry
    • 3: strawberry
  • yellow fruits
    • 2: banana
:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\GroupedForViewHelper Arguments ********* * ``each`` (array): The array or \SplObjectStorage to iterated over * ``as`` (string): The name of the iteration variable * ``groupBy`` (string): Group by this property * ``groupKey`` (string, *optional*): The name of the variable to store the current group .. _`TYPO3 Fluid ViewHelper Reference: f:if`: f:if ---- This ViewHelper implements an if/else condition. Conditions: As a condition is a boolean value, you can just use a boolean argument. Alternatively, you can write a boolean expression there. Boolean expressions have the following form: XX Comparator YY Comparator is one of: ==, !=, <, <=, >, >= and % The % operator converts the result of the % operation to boolean. XX and YY can be one of: - number - Object Accessor - Array - a ViewHelper - string :: Will be shown if rank is > 100 Will be shown if rank % 2 != 0. Checks if rank is equal to the result of the ViewHelper "k:bar" Will result in true if {foo.bar}'s represented value equals 'stringToCompare'. Examples ======== Basic usage ----------- :: This is being shown in case the condition matches Output:: Everything inside the tag is being displayed if the condition evaluates to TRUE. If / then / else ---------------- :: This is being shown in case the condition matches. This is being displayed in case the condition evaluates to FALSE. Output:: Everything inside the "then" tag is displayed if the condition evaluates to TRUE. Otherwise, everything inside the "else"-tag is displayed. inline notation --------------- :: {f:if(condition: someCondition, then: 'condition is met', else: 'condition is not met')} Output:: The value of the "then" attribute is displayed if the condition evaluates to TRUE. Otherwise, everything the value of the "else"-attribute is displayed. :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\IfViewHelper Arguments ********* * ``then`` (mixed, *optional*): Value to be returned if the condition if met. * ``else`` (mixed, *optional*): Value to be returned if the condition if not met. * ``condition`` (boolean, *optional*): Condition expression conforming to Fluid boolean rules .. _`TYPO3 Fluid ViewHelper Reference: f:inline`: f:inline -------- Inline Fluid rendering ViewHelper Renders Fluid code stored in a variable, which you normally would have to render before assigning it to the view. Instead you can do the following (note, extremely simplified use case):: $view->assign('variable', 'value of my variable'); $view->assign('code', 'My variable: {variable}'); And in the template:: {code -> f:inline()} Which outputs:: My variable: value of my variable You can use this to pass smaller and dynamic pieces of Fluid code to templates, as an alternative to creating new partial templates. :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\InlineViewHelper Arguments ********* * ``code`` (string, *optional*): Fluid code to be rendered as if it were part of the template rendering it. Can be passed as inline argument or tag content .. _`TYPO3 Fluid ViewHelper Reference: f:layout`: f:layout -------- With this tag, you can select a layout to be used for the current template. Examples ======== :: Output:: (no output) :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\LayoutViewHelper Arguments ********* * ``name`` (string, *optional*): Name of layout to use. If none given, "Default" is used. .. _`TYPO3 Fluid ViewHelper Reference: f:or`: f:or ---- If content is empty use alternative text :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\OrViewHelper Arguments ********* * ``content`` (mixed, *optional*): Content to check if empty * ``alternative`` (mixed, *optional*): Alternative if content is empty * ``arguments`` (array, *optional*): Arguments to be replaced in the resulting string, using sprintf .. _`TYPO3 Fluid ViewHelper Reference: f:render`: f:render -------- A ViewHelper to render a section, a partial, a specified section in a partial or a delegate ParsedTemplateInterface implementation. Examples ======== Rendering partials ------------------ :: Output:: the content of the partial "SomePartial". The content of the variable {someVariable} will be available in the partial as {foo} Rendering sections ------------------ :: This is a section. {foo} Output:: the content of the section "someSection". The content of the variable {someVariable} will be available in the partial as {foo} Rendering recursive sections ---------------------------- ::
  • {menuItem.text}
Output::
  • menu1
    • menu1a
    • menu1b
    • [...] (depending on the value of {menu}) Passing all variables to a partial ---------------------------------- :: Output:: the content of the partial "somePartial". Using the reserved keyword "_all", all available variables will be passed along to the partial Rendering via a delegate ParsedTemplateInterface implementation w/ custom arguments ----------------------------------------------------------------------------------- :: This will output whichever output was generated by calling ``My\Special\ParsedTemplateImplementation->render()`` with cloned RenderingContextInterface $renderingContext as only argument and content of arguments assigned in VariableProvider of cloned context. Supports all other input arguments including recursive rendering, contentAs argument, default value etc. Note that while ParsedTemplateInterface supports returning a Layout name, this Layout will not be respected when rendering using this method. Only the ``render()`` method will be called! :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\RenderViewHelper Arguments ********* * ``section`` (string, *optional*): Section to render - combine with partial to render section in partial * ``partial`` (string, *optional*): Partial to render, with or without section * ``delegate`` (string, *optional*): Optional PHP class name of a permanent, included-in-app ParsedTemplateInterface implementation to override partial/section * ``renderable`` (TYPO3Fluid\Fluid\Core\Rendering\RenderableInterface, *optional*): Instance of a RenderableInterface implementation to be rendered * ``arguments`` (array, *optional*): Array of variables to be transferred. Use {_all} for all variables * ``optional`` (boolean, *optional*): If TRUE, considers the *section* optional. Partial never is. * ``default`` (mixed, *optional*): Value (usually string) to be displayed if the section or partial does not exist * ``contentAs`` (string, *optional*): If used, renders the child content and adds it as a template variable with this name for use in the partial/section .. _`TYPO3 Fluid ViewHelper Reference: f:section`: f:section --------- A ViewHelper to declare sections in templates for later use with e.g. the ``f:render`` ViewHelper. Examples ======== Rendering sections ------------------ :: This is a section. {foo} Output:: the content of the section "someSection". The content of the variable {someVariable} will be available in the partial as {foo} Rendering recursive sections ---------------------------- ::
    • {menuItem.text}
    Output::
    • menu1
      • menu1a
      • menu1b
      • [...] (depending on the value of {menu}) :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\SectionViewHelper Arguments ********* * ``name`` (string): Name of the section .. _`TYPO3 Fluid ViewHelper Reference: f:spaceless`: f:spaceless ----------- Space Removal ViewHelper Removes redundant spaces between HTML tags while preserving the whitespace that may be inside HTML tags. Trims the final result before output. Heavily inspired by Twig's corresponding node type. Usage of f:spaceless ==================== ::
      text text
       Output::
      text text
      :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\SpacelessViewHelper .. _`TYPO3 Fluid ViewHelper Reference: f:switch`: f:switch -------- Switch ViewHelper which can be used to render content depending on a value or expression. Implements what a basic PHP ``switch()`` does. An optional default case can be specified which is rendered if none of the ``case`` conditions matches. Using this ViewHelper can be a sign of weak architecture. If you end up using it extensively you might want to consider restructuring your controllers/actions and/or use partials and sections. E.g. the above example could be achieved with :html:`` and the partials "title.male.html", "title.female.html", ... Depending on the scenario this can be easier to extend and possibly contains less duplication. Examples ======== Simple Switch statement ----------------------- :: Mr. Mrs. Mr. / Mrs. Output:: "Mr.", "Mrs." or "Mr. / Mrs." (depending on the value of {person.gender}) :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\SwitchViewHelper Arguments ********* * ``expression`` (mixed): Expression to switch .. _`TYPO3 Fluid ViewHelper Reference: f:then`: f:then ------ ``f:then`` only has an effect inside of ``f:if``. See the ``f:if`` ViewHelper for documentation. :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\ThenViewHelper .. _`TYPO3 Fluid ViewHelper Reference: f:variable`: f:variable ---------- Variable assigning ViewHelper Assigns one template variable which will exist also after the ViewHelper is done rendering, i.e. adds template variables. If you require a variable assignment which does not exist in the template after a piece of Fluid code is rendered, consider using ``f:alias`` ViewHelper instead. Usages: :: {f:variable(name: 'myvariable', value: 'some value')} some value {oldvariable -> f:format.htmlspecialchars() -> f:variable(name: 'newvariable')} {oldvariable} :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\VariableViewHelper Arguments ********* * ``value`` (mixed, *optional*): Value to assign. If not in arguments then taken from tag content * ``name`` (string): Name of variable to create