diff --git a/Documentation/ViewHelpers/Fluid.json b/Documentation/ViewHelpers/Fluid.json index 4e8564486..0b7ee93aa 100644 --- a/Documentation/ViewHelpers/Fluid.json +++ b/Documentation/ViewHelpers/Fluid.json @@ -1 +1 @@ -{"viewHelpers":{"alias":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\AliasViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"AliasViewHelper","tagName":"alias","documentation":"Declares new variables which are aliases of other variables.\nTakes a \"map\"-Parameter which is an associative array which defines the shorthand mapping.\n\nThe variables are only declared inside the ``...<\/f:alias>`` tag. After the\nclosing tag, all declared variables are removed again.\n\nUsing this ViewHelper can be a sign of weak architecture. If you end up\nusing it extensively you might want to fine-tune your \"view model\" (the\ndata you assign to the view).\n\nExamples\n========\n\nSingle alias\n------------\n\n::\n\n {x}<\/f:alias>\n\nOutput::\n\n foo\n\nMultiple mappings\n-----------------\n\n::\n\n \n {x.name} or {y}\n <\/f:alias>\n\nOutput::\n\n [name] or [name]\n\nDepending on ``{foo.bar.baz}``.","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-alias"},"argumentDefinitions":{"map":{"name":"map","type":"array","description":"Array that specifies which variables should be mapped to which alias","required":true,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Alias","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Alias"},"argument":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\ArgumentViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"ArgumentViewHelper","tagName":"argument","documentation":"``f:argument`` allows to define requirements and type constraints to variables that\nare provided to templates and partials. This can be very helpful to document how\na template or partial is supposed to be used and which input variables are required.\n\nThese requirements are enforced during rendering of the template or partial:\nIf an argument is defined with this ViewHelper which isn't marked as ``optional``,\nan exception will be thrown if that variable isn't present during rendering.\nIf a variable doesn't match the specified type and can't be converted automatically,\nan exception will be thrown as well.\n\nNote that ``f:argument`` ViewHelpers must be used at the root level of the\ntemplate, and can't be nested into other ViewHelpers. Also, the usage of variables\nin any of its arguments is not possible (e. g. you can't define an argument name\nby using a variable).\n\nRendering of specific sections will not validate argument constraints. They\nwill only be evaluated if the template or partial is rendered directly.\n\nGeneral Example\n===============\n\nFor the following partial:\n\n.. code-block:: xml\n\n \n \n \n\n Title: {title}
\n \n Tags: {tags -> f:join(separator: ', ')}
\n <\/f:if>\n User: {user}\n\nThe following render calls will be successful:\n\n.. code-block:: xml\n\n \n \n \n \n \n \n\nThe following render calls will result in an exception:\n\n.. code-block:: xml\n\n \n \n \n \n\nUnion Types\n===========\n\n.. versionchanged:: Fluid 5.0\n Union types are supported for component arguments.\n\nAn argument can allow multiple multiple types. In that case, the component's implementation\nneeds to make sure that all possible variants are considered. This should be used sparingly\nsince it can complicate the component's implementation code considerably.\n\n.. code-block:: xml\n\n \n ","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-argument"},"argumentDefinitions":{"name":{"name":"name","type":"string","description":"name of the template argument","required":true,"defaultValue":null,"escape":null},"type":{"name":"type","type":"string","description":"type of the template argument","required":true,"defaultValue":null,"escape":null},"description":{"name":"description","type":"string","description":"description of the template argument","required":false,"defaultValue":null,"escape":null},"optional":{"name":"optional","type":"boolean","description":"true if the defined argument should be optional","required":false,"defaultValue":false,"escape":null},"default":{"name":"default","type":"mixed","description":"default value for optional argument","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Argument","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Argument"},"cache.disable":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Cache\\DisableViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Cache\\DisableViewHelper","tagName":"cache.disable","documentation":"ViewHelper to disable template compiling\n\nInserting this ViewHelper at any point in the template,\nincluding inside conditions which do not get rendered,\nwill forcibly disable the caching\/compiling of the full\ntemplate file to a PHP class.\n\nUse this if for whatever reason your platform is unable\nto create or load PHP classes (for example on read-only\nfile systems or when using an incompatible default cache\nbackend).\n\nPasses through anything you place inside the ViewHelper,\nso can safely be used as container tag, as self-closing\nor with inline syntax - all with the same result.\n\nExamples\n========\n\nSelf-closing\n------------\n\n::\n\n \n\nInline mode\n-----------\n\n::\n\n {f:cache.disable()}\n\n\nContainer tag\n-------------\n\n::\n\n \n Some output or Fluid code\n <\/f:cache.disable>\n\nAdditional output is also not compilable because of the ViewHelper","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-cache-disable"},"argumentDefinitions":[],"allowsArbitraryArguments":false,"nameWithoutSuffix":"Cache\\Disable","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Cache\/Disable"},"cache.static":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Cache\\StaticViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Cache\\StaticViewHelper","tagName":"cache.static","documentation":"ViewHelper to force compiling to a static string\n\nUsed around chunks of template code where you want the\noutput of said template code to be compiled to a static\nstring (rather than a collection of compiled nodes, as\nis the usual behavior).\n\nThe effect is that none of the child ViewHelpers or nodes\nused inside this tag will be evaluated when rendering the\ntemplate once it is compiled. It will essentially replace\nall logic inside the tag with a plain string output.\n\nWorks by turning the ``compile`` method into a method that\nrenders the child nodes and returns the resulting content\ndirectly as a string variable.\n\nYou can use this with great effect to further optimise the\nperformance of your templates: in use cases where chunks of\ntemplate code depend on static variables (like thoese in\n``{settings}`` for example) and those variables never change,\nand the template uses no other dynamic variables, forcing\nthe template to compile that chunk to a static string can\nsave a lot of operations when rendering the compiled template.\n\nNB: NOT TO BE USED FOR CACHING ANYTHING OTHER THAN STRING-\nCOMPATIBLE OUTPUT!\n\nUSE WITH CARE! WILL PRESERVE EVERYTHING RENDERED, INCLUDING\nPOTENTIALLY SENSITIVE DATA CONTAINED IN OUTPUT!\n\nExamples\n========\n\nUsage and effect\n----------------\n\n::\n\n Is always evaluated also when compiled<\/f:if>\n \n \n Will only be evaluated once and this output will be\n cached as a static string with no logic attached.\n The compiled template will not contain neither the\n condition ViewHelperNodes or the variable accessor\n that are used inside this node.\n <\/f:if>\n <\/f:cache.static>\n\nThis is also evaluated when compiled (static node is closed)::\n\n Also evaluated; is outside static node<\/f:if>","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-cache-static"},"argumentDefinitions":[],"allowsArbitraryArguments":false,"nameWithoutSuffix":"Cache\\Static","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Cache\/Static"},"case":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\CaseViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"CaseViewHelper","tagName":"case","documentation":"Case ViewHelper that is only usable within the ``f:switch`` ViewHelper.","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-case","@api":""},"argumentDefinitions":{"value":{"name":"value","type":"mixed","description":"Value to match in this case","required":true,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Case","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Case"},"ceil":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\CeilViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"CeilViewHelper","tagName":"ceil","documentation":"The CeilViewHelper rounds up a float value to the next integer.\nThe ViewHelper mimics PHP's :php:`ceil()` function.\n\nExamples\n========\n\nValue argument\n--------------\n::\n\n \n\n.. code-block:: text\n\n 124\n\nTag content as value\n--------------------\n::\n\n 123.456<\/f:ceil>\n\n.. code-block:: text\n\n 124","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-ceil"},"argumentDefinitions":{"value":{"name":"value","type":"float","description":"The number that should be rounded up","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Ceil","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Ceil"},"comment":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\CommentViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"CommentViewHelper","tagName":"comment","documentation":"This ViewHelper prevents rendering of any content inside the tag.\n\nContents of the comment will **not be parsed** thus it can be used to\ncomment out invalid Fluid syntax or non-existent ViewHelpers during\ndevelopment.\n\nUsing this ViewHelper won't have a notable effect on performance,\nespecially once the template is parsed. However, it can lead to reduced\nreadability. You can use layouts and partials to split a large template\ninto smaller parts. Using self-descriptive names for the partials can\nmake comments redundant.\n\nExamples\n========\n\nCommenting out fluid code\n-------------------------\n\n::\n\n Before\n \n This is completely hidden.\n This does not get rendered<\/f:debug>\n <\/f:comment>\n After\n\nOutput::\n\n Before\n After","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-comment"},"argumentDefinitions":[],"allowsArbitraryArguments":false,"nameWithoutSuffix":"Comment","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Comment"},"constant":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\ConstantViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"ConstantViewHelper","tagName":"constant","documentation":"Wrapper for PHPs :php:`constant` function.\nSee https:\/\/www.php.net\/manual\/function.constant.php.\n\nExamples\n========\n\nGet built-in PHP constant\n-------------------------\n\n::\n\n {f:constant(name: 'PHP_INT_MAX')}\n\nOutput::\n\n 9223372036854775807\n (Depending on CPU architecture).\n\nGet class constant\n------------------\n\n::\n\n {f:constant(name: '\\Vendor\\Package\\Class::CONSTANT')}\n\nGet enum case\n-------------\n\n::\n\n {f:constant(name: '\\Vendor\\Package\\Enum::CASE')}","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-constant"},"argumentDefinitions":{"name":{"name":"name","type":"string","description":"String representation of a PHP constant or enum","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Constant","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Constant"},"contains":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\ContainsViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"ContainsViewHelper","tagName":"contains","documentation":"The ContainsViewHelper checks if a provided string or array contains\nthe specified value. Depending on the input, this mimicks PHP's\n:php:`in_array()` or :php:`str_contains()`.\n\n\nExamples\n========\n\nCheck value in array\n--------------------\n\n::\n\n \n\n \n It Works!\n <\/f:contains>\n\nOutput::\n\n It Works!\n\nCheck value in string\n---------------------\n\n::\n\n \n\n \n It Works!\n <\/f:contains>\n\nOutput::\n\n It Works!\n\nA more complex example with inline notation\n-------------------------------------------\n\n::\n\n \n\n \n It Works!\n <\/f:if>\n\nOutput::\n\n It Works!","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-contains"},"argumentDefinitions":{"then":{"name":"then","type":"mixed","description":"Value to be returned if the condition if met.","required":false,"defaultValue":null,"escape":true},"else":{"name":"else","type":"mixed","description":"Value to be returned if the condition if not met.","required":false,"defaultValue":null,"escape":true},"value":{"name":"value","type":"mixed","description":"The value to check for (needle)","required":true,"defaultValue":null,"escape":null},"subject":{"name":"subject","type":"mixed","description":"The string or array that might contain the value (haystack)","required":true,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Contains","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Contains"},"count":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\CountViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"CountViewHelper","tagName":"count","documentation":"This ViewHelper counts elements of the specified array or countable object.\n\nExamples\n========\n\nCount array elements\n--------------------\n\n::\n\n \n\nOutput::\n\n 4\n\ninline notation\n---------------\n\n::\n\n {objects -> f:count()}\n\nOutput::\n\n 10 (depending on the number of items in ``{objects}``)","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-count"},"argumentDefinitions":{"subject":{"name":"subject","type":"array","description":"Countable subject, array or \\Countable","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Count","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Count"},"cycle":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\CycleViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"CycleViewHelper","tagName":"cycle","documentation":"This ViewHelper cycles through the specified values.\nThis can be often used to specify CSS classes for example.\n\nTo achieve the \"zebra class\" effect in a loop you can also use the\n\"iteration\" argument of the **for** ViewHelper.\n\nExamples\n========\n\nThese examples could also be achieved using the \"iteration\" argument\nof the ForViewHelper.\n\nSimple\n------\n\n::\n\n \n \n {cycle}\n <\/f:cycle>\n <\/f:for>\n\nOutput::\n\n foobarbazfoo\n\nAlternating CSS class\n---------------------\n\n::\n\n
    \n \n \n
  • {foo}<\/li>\n <\/f:cycle>\n <\/f:for>\n <\/ul>\n\nOutput::\n\n
      \n
    • 1<\/li>\n
    • 2<\/li>\n
    • 3<\/li>\n
    • 4<\/li>\n <\/ul>","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-cycle"},"argumentDefinitions":{"values":{"name":"values","type":"array","description":"The array or object implementing \\ArrayAccess (for example \\SplObjectStorage) to iterated over","required":false,"defaultValue":null,"escape":null},"as":{"name":"as","type":"string","description":"The name of the iteration variable","required":true,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Cycle","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Cycle"},"debug":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\DebugViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"DebugViewHelper","tagName":"debug","documentation":"This ViewHelper is only meant to be used during development.\n\nExamples\n========\n\nInline notation and custom title\n--------------------------------\n\n::\n\n {object -> f:debug(title: 'Custom title')}\n\nOutput::\n\n all properties of {object} nicely highlighted (with custom title)\n\nOnly output the type\n--------------------\n\n::\n\n {object -> f:debug(typeOnly: true)}\n\nOutput::\n\n the type or class name of {object}","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-debug"},"argumentDefinitions":{"typeOnly":{"name":"typeOnly","type":"boolean","description":"If true, debugs only the type of variables","required":false,"defaultValue":false,"escape":null},"levels":{"name":"levels","type":"integer","description":"Levels to render when rendering nested objects\/arrays","required":false,"defaultValue":5,"escape":null},"html":{"name":"html","type":"boolean","description":"Render HTML. If false, output is indented plaintext","required":false,"defaultValue":false,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Debug","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Debug"},"defaultCase":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\DefaultCaseViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"DefaultCaseViewHelper","tagName":"defaultCase","documentation":"A ViewHelper which specifies the \"default\" case when used within the ``f:switch`` ViewHelper.","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"\\TYPO3Fluid\\Fluid\\ViewHelpers\\SwitchViewHelper"},"argumentDefinitions":[],"allowsArbitraryArguments":false,"nameWithoutSuffix":"DefaultCase","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/DefaultCase"},"else":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\ElseViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"ElseViewHelper","tagName":"else","documentation":"Else-Branch of a condition. Only has an effect inside of ``f:if``.\nSee the ``f:if`` ViewHelper for documentation.\n\nExamples\n========\n\nOutput content if condition is not met\n--------------------------------------\n\n::\n\n \n \n condition was not true\n <\/f:else>\n <\/f:if>\n\nOutput::\n\n Everything inside the \"else\" tag is displayed if the condition evaluates to false.\n Otherwise, nothing is outputted in this example.","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"TYPO3Fluid\\Fluid\\ViewHelpers\\IfViewHelper"},"argumentDefinitions":{"if":{"name":"if","type":"boolean","description":"Condition expression conforming to Fluid boolean rules","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Else","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Else"},"endsWith":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\EndsWithViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"EndsWithViewHelper","tagName":"endsWith","documentation":"EndsWith ViewHelper checks if the subject string ends with a specified string.\nThis ViewHelper implements an if\/else condition.\n\nExamples\n========\n\nRender the body if \"myString\" ends with \"World!\"\n-----------------------------------------------\n\n::\n\n \n This will be rendered if variable \"myString\" ends with \"World!\"<\/f:endsWith>\n\nOutput::\n\n This will be rendered if variable \"myString\" ends with \"World!\"\n\nA more complex example with inline notation\n-----------------------------------------\n\n::\n\n \n \n\n \n It Works!\n <\/f:if>\n\nOutput::\n\n It Works!","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-endswith"},"argumentDefinitions":{"then":{"name":"then","type":"mixed","description":"Value to be returned if the condition if met.","required":false,"defaultValue":null,"escape":true},"else":{"name":"else","type":"mixed","description":"Value to be returned if the condition if not met.","required":false,"defaultValue":null,"escape":true},"subject":{"name":"subject","type":"string","description":"String to search in","required":true,"defaultValue":null,"escape":null},"search":{"name":"search","type":"string","description":"String to search in subject at the beginning","required":true,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"EndsWith","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/EndsWith"},"first":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\FirstViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"FirstViewHelper","tagName":"first","documentation":"The FirstViewHelper returns the first item of an array.\n\nExample\n========\n::\n\n \n\n.. code-block:: text\n\n first","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-first"},"argumentDefinitions":{"value":{"name":"value","type":"array","description":"","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"First","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/First"},"flatten":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\FlattenViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"FlattenViewHelper","tagName":"flatten","documentation":"The FlattenViewHelper flattens a multi-dimensional array into a\nsingle-dimensional array.\n\n\nExample\n========\n\n::\n\n \n\n.. code-block:: text\n\n {0: '1', 1: '2', 2: '3', 3: '4'}","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-flatten"},"argumentDefinitions":{"value":{"name":"value","type":"array","description":"An array","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Flatten","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Flatten"},"floor":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\FloorViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"FloorViewHelper","tagName":"floor","documentation":"The FloorViewHelper rounds down a float value to the next integer.\nThe ViewHelper mimics PHP's :php:`floor()` function.\n\nExamples\n========\n\nValue argument\n--------------\n::\n\n \n\n.. code-block:: text\n\n 123\n\nTag content as value\n--------------------\n::\n\n 123.456<\/f:floor>\n\n.. code-block:: text\n\n 123","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-floor"},"argumentDefinitions":{"value":{"name":"value","type":"float","description":"The number that should be rounded down","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Floor","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Floor"},"for":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\ForViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"ForViewHelper","tagName":"for","documentation":"Loop ViewHelper which can be used to iterate over arrays.\nImplements what a basic PHP ``foreach()`` does.\n\nExamples\n========\n\nSimple Loop\n-----------\n\n::\n\n {foo}<\/f:for>\n\nOutput::\n\n 1234\n\nOutput array key\n----------------\n\n::\n\n
        \n \n
      • {label}: {fruit}<\/li>\n <\/f:for>\n <\/ul>\n\nOutput::\n\n
          \n
        • fruit1: apple<\/li>\n
        • fruit2: pear<\/li>\n
        • fruit3: banana<\/li>\n
        • fruit4: cherry<\/li>\n <\/ul>\n\nIteration information\n---------------------\n\n::\n\n
            \n \n
          • 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')}<\/li>\n <\/f:for>\n <\/ul>\n\nOutput::\n\n
              \n
            • Index: 0 Cycle: 1 Total: 4 Odd First<\/li>\n
            • Index: 1 Cycle: 2 Total: 4 Even<\/li>\n
            • Index: 2 Cycle: 3 Total: 4 Odd<\/li>\n
            • Index: 3 Cycle: 4 Total: 4 Even Last<\/li>\n <\/ul>","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-for"},"argumentDefinitions":{"each":{"name":"each","type":"array","description":"The array or \\SplObjectStorage to iterated over","required":true,"defaultValue":null,"escape":null},"as":{"name":"as","type":"string","description":"The name of the iteration variable","required":true,"defaultValue":null,"escape":null},"key":{"name":"key","type":"string","description":"Variable to assign array key to","required":false,"defaultValue":null,"escape":null},"reverse":{"name":"reverse","type":"boolean","description":"If true, iterates in reverse","required":false,"defaultValue":false,"escape":null},"iteration":{"name":"iteration","type":"string","description":"The name of the variable to store iteration information (index, cycle, total, isFirst, isLast, isEven, isOdd)","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"For","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/For"},"format.case":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\CaseViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Format\\CaseViewHelper","tagName":"format.case","documentation":"Modifies the case of an input string to upper- or lowercase or capitalization.\nThe default transformation will be uppercase as in `mb_convert_case`_.\n\nPossible modes are:\n\n``lower``\n Transforms the input string to lowercase\n Example: \"Hello World\" -> \"hello world\"\n\n``upper``\n Transforms the input string to uppercase\n Example: \"Hello World\" -> \"HELLO WORLD\"\n\n``capital``\n Transforms the first character of the input string to uppercase\n Example: \"hello world\" -> \"Hello world\"\n\n``uncapital``\n Transforms the input string to its first letter lower-cased\n Example: \"Hello World\" -> \"hello World\"\n\n``capitalWords``\n Transforms the input string to capitalize each word\n Example: \"hello world\" -> \"Hello World\"\n\nNote that the behavior will be the same as in the appropriate PHP function `mb_convert_case`_;\nespecially regarding locale and multibyte behavior.\n\n.. _mb_convert_case: https:\/\/www.php.net\/manual\/function.mb-convert-case.php\n\nExamples\n========\n\nDefault\n-------\n\n::\n\n Some Text with miXed case<\/f:format.case>\n\nOutput::\n\n SOME TEXT WITH MIXED CASE\n\nExample with given mode\n-----------------------\n\n::\n\n someString<\/f:format.case>\n\nOutput::\n\n SomeString","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-format-case"},"argumentDefinitions":{"value":{"name":"value","type":"string","description":"The input value. If not given, the evaluated child nodes will be used.","required":false,"defaultValue":null,"escape":null},"mode":{"name":"mode","type":"string","description":"The case to apply, must be one of this' CASE_* constants. Defaults to uppercase application.","required":false,"defaultValue":"upper","escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Format\\Case","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Format\/Case"},"format.cdata":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\CdataViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Format\\CdataViewHelper","tagName":"format.cdata","documentation":"Outputs an argument\/value without any escaping and wraps it with CDATA tags.\n\nPAY SPECIAL ATTENTION TO SECURITY HERE (especially Cross Site Scripting),\nas the output is NOT SANITIZED!\n\nExamples\n========\n\nChild nodes\n-----------\n\n::\n\n {string}<\/f:format.cdata>\n\nOutput::\n\n \n\nValue attribute\n---------------\n\n::\n\n \n\nOutput::\n\n \n\nInline notation\n---------------\n\n::\n\n {string -> f:format.cdata()}\n\nOutput::\n\n ","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-format-cdata"},"argumentDefinitions":{"value":{"name":"value","type":"mixed","description":"The value to output","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Format\\Cdata","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Format\/Cdata"},"format.htmlspecialchars":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\HtmlspecialcharsViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Format\\HtmlspecialcharsViewHelper","tagName":"format.htmlspecialchars","documentation":"Applies PHP ``htmlspecialchars()`` escaping to a value.\n\nSee http:\/\/www.php.net\/manual\/function.htmlspecialchars.php\n\nExamples\n========\n\nDefault notation\n----------------\n\n::\n\n {text}<\/f:format.htmlspecialchars>\n\nOutput::\n\n Text with & \" ' < > * replaced by HTML entities (htmlspecialchars applied).\n\nInline notation\n---------------\n\n::\n\n {text -> f:format.htmlspecialchars(encoding: 'ISO-8859-1')}\n\nOutput::\n\n Text with & \" ' < > * replaced by HTML entities (htmlspecialchars applied).","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-format-htmlspecialchars"},"argumentDefinitions":{"value":{"name":"value","type":"string","description":"Value to format","required":false,"defaultValue":null,"escape":null},"keepQuotes":{"name":"keepQuotes","type":"boolean","description":"If true quotes will not be replaced (ENT_NOQUOTES)","required":false,"defaultValue":false,"escape":null},"encoding":{"name":"encoding","type":"string","description":"Encoding","required":false,"defaultValue":"UTF-8","escape":null},"doubleEncode":{"name":"doubleEncode","type":"boolean","description":"If false, html entities will not be encoded","required":false,"defaultValue":true,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Format\\Htmlspecialchars","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Format\/Htmlspecialchars"},"format.json":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\JsonViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Format\\JsonViewHelper","tagName":"format.json","documentation":"Wrapper for PHPs :php:`json_encode` function.\nSee https:\/\/www.php.net\/manual\/function.json-encode.php.\n\nExamples\n========\n\nEncoding a view variable\n------------------------\n\n::\n\n {someArray -> f:format.json()}\n\n``[\"array\",\"values\"]``\nDepending on the value of ``{someArray}``.\n\nAssociative array\n-----------------\n\n::\n\n {f:format.json(value: {foo: 'bar', bar: 'baz'})}\n\n``{\"foo\":\"bar\",\"bar\":\"baz\"}``\n\nNon associative array with forced object\n----------------------------------------\n\n::\n\n {f:format.json(value: {0: 'bar', 1: 'baz'}, forceObject: true)}\n\n``{\"0\":\"bar\",\"1\":\"baz\"}``","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-format-json"},"argumentDefinitions":{"value":{"name":"value","type":"mixed","description":"The incoming data to convert, or null if VH children should be used","required":false,"defaultValue":null,"escape":null},"forceObject":{"name":"forceObject","type":"bool","description":"Outputs an JSON object rather than an array","required":false,"defaultValue":false,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Format\\Json","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Format\/Json"},"format.nl2br":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\Nl2brViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Format\\Nl2brViewHelper","tagName":"format.nl2br","documentation":"Wrapper for PHPs :php:`nl2br` function.\nSee https:\/\/www.php.net\/manual\/function.nl2br.php.\n\nExamples\n========\n\nDefault\n-------\n\n::\n\n {text_with_linebreaks}<\/f:format.nl2br>\n\nText with line breaks replaced by ``
              ``\n\nInline notation\n---------------\n\n::\n\n {text_with_linebreaks -> f:format.nl2br()}\n\nText with line breaks replaced by ``
              ``","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-format-nl2br"},"argumentDefinitions":{"value":{"name":"value","type":"string","description":"string to format","required":false,"defaultValue":null,"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Format\\Nl2br","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Format\/Nl2br"},"format.number":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\NumberViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Format\\NumberViewHelper","tagName":"format.number","documentation":"Formats a number with custom precision, decimal point and grouped thousands.\nSee https:\/\/www.php.net\/manual\/function.number-format.php.\n\nExamples\n========\n\nDefaults\n--------\n\n::\n\n 423423.234<\/f:format.number>\n\n``423,423.20``\n\nWith all parameters\n-------------------\n\n::\n\n \n 423423.234\n <\/f:format.number>\n\n``423.423,2``","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-format-number"},"argumentDefinitions":{"decimals":{"name":"decimals","type":"int","description":"The number of digits after the decimal point","required":false,"defaultValue":2,"escape":null},"decimalSeparator":{"name":"decimalSeparator","type":"string","description":"The decimal point character","required":false,"defaultValue":".","escape":null},"thousandsSeparator":{"name":"thousandsSeparator","type":"string","description":"The character for grouping the thousand digits","required":false,"defaultValue":",","escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Format\\Number","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Format\/Number"},"format.printf":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\PrintfViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Format\\PrintfViewHelper","tagName":"format.printf","documentation":"A ViewHelper for formatting values with printf. Either supply an array for\nthe arguments or a single value.\n\nSee http:\/\/www.php.net\/manual\/en\/function.sprintf.php\n\nExamples\n========\n\nScientific notation\n-------------------\n\n::\n\n %.3e<\/f:format.printf>\n\nOutput::\n\n 3.625e+8\n\nArgument swapping\n-----------------\n\n::\n\n %2$s is great, TYPO%1$d too. Yes, TYPO%1$d is great and so is %2$s!<\/f:format.printf>\n\nOutput::\n\n Kasper is great, TYPO3 too. Yes, TYPO3 is great and so is Kasper!\n\nSingle argument\n---------------\n\n::\n\n We love %s<\/f:format.printf>\n\n\nOutput::\n\n We love TYPO3\n\nInline notation\n---------------\n\n::\n\n {someText -> f:format.printf(arguments: {1: 'TYPO3'})}\n\n\nOutput::\n\n We love TYPO3","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-format-printf"},"argumentDefinitions":{"value":{"name":"value","type":"string","description":"String to format","required":false,"defaultValue":null,"escape":null},"arguments":{"name":"arguments","type":"array","description":"The arguments for vsprintf","required":false,"defaultValue":[],"escape":null}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Format\\Printf","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Format\/Printf"},"format.raw":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\RawViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Format\\RawViewHelper","tagName":"format.raw","documentation":"Outputs an argument\/value without any escaping. Is normally used to output\nan ObjectAccessor which should not be escaped, but output as-is.\n\nPAY SPECIAL ATTENTION TO SECURITY HERE (especially Cross Site Scripting),\nas the output is NOT SANITIZED!\n\nExamples\n========\n\nChild nodes\n-----------\n\n::\n\n {string}<\/f:format.raw>\n\nOutput::\n\n (Content of ``{string}`` without any conversion\/escaping)\n\nValue attribute\n---------------\n\n::\n\n \n\nOutput::\n\n (Content of ``{string}`` without any conversion\/escaping)\n\nInline notation\n---------------\n\n::\n\n {string -> f:format.raw()}\n\nOutput::\n\n (Content of ``{string}`` without any conversion\/escaping)","xmlNamespace":"http:\/\/typo3.org\/ns\/TYPO3Fluid\/Fluid\/ViewHelpers","docTags":{"@api":"","@see":"https:\/\/docs.typo3.org\/permalink\/fluid:typo3fluid-fluid-format-raw"},"argumentDefinitions":{"value":{"name":"value","type":"mixed","description":"The value to output","required":false,"defaultValue":null,"escape":false}},"allowsArbitraryArguments":false,"nameWithoutSuffix":"Format\\Raw","namespaceWithoutSuffix":"TYPO3Fluid\\Fluid","uri":"Fluid\/Format\/Raw"},"format.stripTags":{"className":"TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\StripTagsViewHelper","namespace":"TYPO3Fluid\\Fluid\\ViewHelpers","name":"Format\\StripTagsViewHelper","tagName":"format.stripTags","documentation":"Removes tags from the given string (applying PHPs :php:`strip_tags()` function)\nSee https:\/\/www.php.net\/manual\/function.strip-tags.php.\n\nExamples\n========\n\nDefault notation\n----------------\n\n::\n\n Some Text with Tags<\/b> and an Ümlaut.<\/f:format.stripTags>\n\nSome Text with Tags and an Ümlaut. :php:`strip_tags()` applied.\n\n.. note::\n Encoded entities are not decoded.\n\nDefault notation with allowedTags\n---------------------------------\n\n::\n\n