diff --git a/Neos.Neos/Documentation/References/CommandReference.rst b/Neos.Neos/Documentation/References/CommandReference.rst index 1e61840ab50..575c19b0042 100644 --- a/Neos.Neos/Documentation/References/CommandReference.rst +++ b/Neos.Neos/Documentation/References/CommandReference.rst @@ -19,7 +19,7 @@ commands that may be available, use:: ./flow help -The following reference was automatically generated from code on 2024-04-05 +The following reference was automatically generated from code on 2024-04-10 .. _`Neos Command Reference: NEOS.FLOW`: @@ -2947,6 +2947,8 @@ Options ``--content-repository-identifier`` contentRepositoryIdentifier +``--force`` + force diff --git a/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst b/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst index bca05330153..13e9e811845 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst @@ -3,7 +3,7 @@ FluidAdaptor ViewHelper Reference ################################# -This reference was automatically generated from code on 2024-04-05 +This reference was automatically generated from code on 2024-04-10 .. _`FluidAdaptor ViewHelper Reference: f:debug`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Form.rst b/Neos.Neos/Documentation/References/ViewHelpers/Form.rst index 4212784083c..4a366e04053 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Form.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Form.rst @@ -3,7 +3,7 @@ Form ViewHelper Reference ######################### -This reference was automatically generated from code on 2024-04-05 +This reference was automatically generated from code on 2024-04-10 .. _`Form ViewHelper Reference: neos.form:form`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Media.rst b/Neos.Neos/Documentation/References/ViewHelpers/Media.rst index a8ea008823e..0484e402b30 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Media.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Media.rst @@ -3,7 +3,7 @@ Media ViewHelper Reference ########################## -This reference was automatically generated from code on 2024-04-05 +This reference was automatically generated from code on 2024-04-10 .. _`Media ViewHelper Reference: neos.media:fileTypeIcon`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst b/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst index 0756579084c..7cc9182c80f 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Neos.rst @@ -3,7 +3,7 @@ Neos ViewHelper Reference ######################### -This reference was automatically generated from code on 2024-04-05 +This reference was automatically generated from code on 2024-04-10 .. _`Neos ViewHelper Reference: neos:backend.authenticationProviderLabel`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst b/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst index 2d5c359b23f..2b210494ac2 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/TYPO3Fluid.rst @@ -3,7 +3,7 @@ TYPO3 Fluid ViewHelper Reference ################################ -This reference was automatically generated from code on 2024-04-05 +This reference was automatically generated from code on 2024-04-10 .. _`TYPO3 Fluid ViewHelper Reference: f:alias`: @@ -430,7 +430,7 @@ Arguments * ``values`` (array, *optional*): The array or object implementing \ArrayAccess (for example \SplObjectStorage) to iterated over -* ``as`` (strong): The name of the iteration variable +* ``as`` (string): The name of the iteration variable @@ -537,6 +537,37 @@ Arguments +.. _`TYPO3 Fluid ViewHelper Reference: f:first`: + +f:first +------- + +The FirstViewHelper returns the first item of an array. + +Example +======== + +:: + + + +.. code-block:: text + + first + +:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\FirstViewHelper + + + + +Arguments +********* + +* ``value`` (array, *optional*) + + + + .. _`TYPO3 Fluid ViewHelper Reference: f:for`: f:for @@ -1371,24 +1402,51 @@ f:if This ViewHelper implements an if/else condition. -Conditions: +Fluid Boolean Rules / Conditions: +================================= + +A condition is evaluated as a boolean value, so you can use any +boolean argument, like a variable. +Alternatively, you can use a full boolean expression. +The entered expression is evaluated as a PHP expression. You can +combine multiple expressions via :php:`&&` (logical AND) and +:php:`||` (logical OR). + +An expression can also be prepended with the :php:`!` ("not") character, +which will negate that expression. + +Have a look into the Fluid section of the "TYPO3 Explained" Documentation +for more details about complex 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 +`is true` variant: `{variable}`:: + + + Will be shown if foo is truthy. + + +or `is false` variant: `!{variable}`:: + + + Will be shown if foo is falsy. + + +or comparisons with expressions:: -Comparator is one of: ==, !=, <, <=, >, >= and % -The % operator converts the result of the % operation to boolean. + XX Comparator YY -XX and YY can be one of: +Comparator is one of: :php:`==, !=, <, <=, >, >=` and :php:`%` +The :php:`%` operator (modulo) converts the result of the operation to +boolean. -- number -- Object Accessor +`XX` and `YY` can be one of: + +- Number +- String +- Object Accessor (`object.property`) - Array - a ViewHelper -- string :: @@ -1401,8 +1459,9 @@ XX and YY can be one of: 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'. + + Will result in true if {object.property}'s represented value + equals 'stringToCompare'. Examples @@ -1438,9 +1497,9 @@ If / then / else Output:: Everything inside the "then" tag is displayed if the condition evaluates to TRUE. - Otherwise, everything inside the "else"-tag is displayed. + Otherwise, everything inside the "else" tag is displayed. -inline notation +Inline notation --------------- :: @@ -1450,7 +1509,30 @@ inline notation 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. + Otherwise, everything the value of the "else" attribute is displayed. + +Combining multiple conditions +----------------------------- + +:: + + + + This is being shown in case both conditions match. + + + This is being displayed in case the first block of the condition evaluates to TRUE and any condition in + the second condition block evaluates to TRUE. + + + This is being displayed when none of the above conditions evaluated to TRUE. + + + +Output:: + + Depending on which expression evaluated to TRUE, that value is displayed. + If no expression matched, the contents inside the final "else" tag are displayed. :Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\IfViewHelper @@ -1507,6 +1589,101 @@ Arguments +.. _`TYPO3 Fluid ViewHelper Reference: f:join`: + +f:join +------ + +The JoinViewHelper combines elements from an array into a single string. +You can specify both a general separator and a special one for the last +element, which serves as the delimiter between the elements. + + +Examples +======== + +Simple join +----------- +:: + + + +.. code-block:: text + + 123 + + +Join with separator +------------------- + +:: + + + +.. code-block:: text + + 1, 2, 3 + + +Join with separator, and special one for the last +------------------------------------------------- + +:: + + + +.. code-block:: text + + 1, 2 and 3 + +:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\JoinViewHelper + + + + +Arguments +********* + +* ``value`` (array, *optional*): An array + +* ``separator`` (string, *optional*): The separator + +* ``separatorLast`` (string, *optional*): The separator for the last pair. + + + + +.. _`TYPO3 Fluid ViewHelper Reference: f:last`: + +f:last +------ + +The LastViewHelper returns the last item of an array. + +Example +======== + +:: + + + +.. code-block:: text + + second + +:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\LastViewHelper + + + + +Arguments +********* + +* ``value`` (array, *optional*) + + + + .. _`TYPO3 Fluid ViewHelper Reference: f:layout`: f:layout @@ -1701,6 +1878,69 @@ Arguments +.. _`TYPO3 Fluid ViewHelper Reference: f:replace`: + +f:replace +--------- + +The ReplaceViewHelper replaces one or multiple strings with other +strings. This ViewHelper mimicks PHP's :php:`str_replace()` function. +However, it's also possible to provide replace pairs as associative array +via the "replace" argument. + + +Examples +======== + +Replace a single string +----------------------- +:: + + + +.. code-block:: text + + Hello Fluid + + +Replace multiple strings +------------------------ +:: + + + +.. code-block:: text + + Hi Fluid + + +Replace multiple strings using associative array +------------------------------------------------ +:: + + + +.. code-block:: text + + Hi Fluid + +:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\ReplaceViewHelper + + + + +Arguments +********* + +* ``value`` (string, *optional*) + +* ``search`` (mixed, *optional*) + +* ``replace`` (mixed) + + + + .. _`TYPO3 Fluid ViewHelper Reference: f:section`: f:section @@ -1807,6 +2047,73 @@ Output:: +.. _`TYPO3 Fluid ViewHelper Reference: f:split`: + +f:split +------- + +The SplitViewHelper splits a string by the specified separator, which +results in an array. The number of values in the resulting array can +be limited with the limit parameter, which results in an array where +the last item contains the remaining unsplit string. + +This ViewHelper mimicks PHP's :php:`explode()` function. + + +Examples +======== + +Split with a separator +----------------------- +:: + + + +.. code-block:: text + + {0: '1', 1: '5', 2: '8'} + + +Split using tag content as value +-------------------------------- + +:: + + 1-5-8 + +.. code-block:: text + + {0: '1', 1: '5', 2: '8'} + + +Split with a limit +------------------- + +:: + + + +.. code-block:: text + + {0: '1', 1: '5,8'} + +:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\SplitViewHelper + + + + +Arguments +********* + +* ``value`` (string, *optional*): The string to explode + +* ``separator`` (string): Separator string to explode with + +* ``limit`` (int, *optional*): If limit is positive, a maximum of $limit items will be returned. If limit is negative, all items except for the last $limit items will be returned. 0 will be treated as 1. + + + + .. _`TYPO3 Fluid ViewHelper Reference: f:switch`: f:switch