From 207a86d9025ff26c669c678f11e75463075e213f Mon Sep 17 00:00:00 2001 From: Jenkins Date: Wed, 29 Nov 2023 15:03:04 +0000 Subject: [PATCH] TASK: Update references [skip ci] --- .../References/CommandReference.rst | 2 +- .../FlowQueryOperationReference.rst | 2 +- .../References/Signals/ContentRepository.rst | 2 +- .../Documentation/References/Signals/Flow.rst | 2 +- .../References/Signals/Media.rst | 2 +- .../Documentation/References/Signals/Neos.rst | 2 +- .../References/Validators/Flow.rst | 2 +- .../References/Validators/Media.rst | 2 +- .../References/Validators/Party.rst | 2 +- .../ViewHelpers/ContentRepository.rst | 2 +- .../References/ViewHelpers/FluidAdaptor.rst | 2 +- .../References/ViewHelpers/Form.rst | 2 +- .../References/ViewHelpers/Fusion.rst | 2 +- .../References/ViewHelpers/Media.rst | 2 +- .../References/ViewHelpers/Neos.rst | 2 +- .../References/ViewHelpers/TYPO3Fluid.rst | 404 +++++++++++++++++- 16 files changed, 418 insertions(+), 16 deletions(-) diff --git a/Neos.Neos/Documentation/References/CommandReference.rst b/Neos.Neos/Documentation/References/CommandReference.rst index e76a09d89e9..2b5816559c1 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 2023-11-26 +The following reference was automatically generated from code on 2023-11-29 .. _`Neos Command Reference: NEOS.FLOW`: diff --git a/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst b/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst index 31f97a3a4a4..281627e7744 100644 --- a/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst +++ b/Neos.Neos/Documentation/References/FlowQueryOperationReference.rst @@ -3,7 +3,7 @@ FlowQuery Operation Reference ============================= -This reference was automatically generated from code on 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`FlowQuery Operation Reference: add`: diff --git a/Neos.Neos/Documentation/References/Signals/ContentRepository.rst b/Neos.Neos/Documentation/References/Signals/ContentRepository.rst index 188ace2459e..d39e82b3489 100644 --- a/Neos.Neos/Documentation/References/Signals/ContentRepository.rst +++ b/Neos.Neos/Documentation/References/Signals/ContentRepository.rst @@ -3,5 +3,5 @@ Content Repository Signals Reference ==================================== -This reference was automatically generated from code on 2023-11-26 +This reference was automatically generated from code on 2023-11-29 diff --git a/Neos.Neos/Documentation/References/Signals/Flow.rst b/Neos.Neos/Documentation/References/Signals/Flow.rst index dc5cb3af122..5d5848ae4f3 100644 --- a/Neos.Neos/Documentation/References/Signals/Flow.rst +++ b/Neos.Neos/Documentation/References/Signals/Flow.rst @@ -3,7 +3,7 @@ Flow Signals Reference ====================== -This reference was automatically generated from code on 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`Flow Signals Reference: AbstractAdvice (``Neos\Flow\Aop\Advice\AbstractAdvice``)`: diff --git a/Neos.Neos/Documentation/References/Signals/Media.rst b/Neos.Neos/Documentation/References/Signals/Media.rst index 9a09a5ceb4d..2633ca046b3 100644 --- a/Neos.Neos/Documentation/References/Signals/Media.rst +++ b/Neos.Neos/Documentation/References/Signals/Media.rst @@ -3,7 +3,7 @@ Media Signals Reference ======================= -This reference was automatically generated from code on 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`Media Signals Reference: AssetCollectionController (``Neos\Media\Browser\Controller\AssetCollectionController``)`: diff --git a/Neos.Neos/Documentation/References/Signals/Neos.rst b/Neos.Neos/Documentation/References/Signals/Neos.rst index 800bd36ac60..71ad3d27cf5 100644 --- a/Neos.Neos/Documentation/References/Signals/Neos.rst +++ b/Neos.Neos/Documentation/References/Signals/Neos.rst @@ -3,7 +3,7 @@ Neos Signals Reference ====================== -This reference was automatically generated from code on 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`Neos Signals Reference: AbstractModuleController (``Neos\Neos\Controller\Module\AbstractModuleController``)`: diff --git a/Neos.Neos/Documentation/References/Validators/Flow.rst b/Neos.Neos/Documentation/References/Validators/Flow.rst index 9a0886bea1a..080c2c6b814 100644 --- a/Neos.Neos/Documentation/References/Validators/Flow.rst +++ b/Neos.Neos/Documentation/References/Validators/Flow.rst @@ -3,7 +3,7 @@ Flow Validator Reference ======================== -This reference was automatically generated from code on 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`Flow Validator Reference: AggregateBoundaryValidator`: diff --git a/Neos.Neos/Documentation/References/Validators/Media.rst b/Neos.Neos/Documentation/References/Validators/Media.rst index 97f79e73665..1608721ce9d 100644 --- a/Neos.Neos/Documentation/References/Validators/Media.rst +++ b/Neos.Neos/Documentation/References/Validators/Media.rst @@ -3,7 +3,7 @@ Media Validator Reference ========================= -This reference was automatically generated from code on 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`Media Validator Reference: ImageOrientationValidator`: diff --git a/Neos.Neos/Documentation/References/Validators/Party.rst b/Neos.Neos/Documentation/References/Validators/Party.rst index dca52d93d50..28d97b24f84 100644 --- a/Neos.Neos/Documentation/References/Validators/Party.rst +++ b/Neos.Neos/Documentation/References/Validators/Party.rst @@ -3,7 +3,7 @@ Party Validator Reference ========================= -This reference was automatically generated from code on 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`Party Validator Reference: AimAddressValidator`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst b/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst index 20b3fecaa21..a348273fe9e 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/ContentRepository.rst @@ -3,6 +3,6 @@ Content Repository ViewHelper Reference ####################################### -This reference was automatically generated from code on 2023-11-26 +This reference was automatically generated from code on 2023-11-29 diff --git a/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst b/Neos.Neos/Documentation/References/ViewHelpers/FluidAdaptor.rst index 183f204a437..04fe5fa91c6 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 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`FluidAdaptor ViewHelper Reference: f:debug`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Form.rst b/Neos.Neos/Documentation/References/ViewHelpers/Form.rst index b7f0694f3f6..897728c34b4 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 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`Form ViewHelper Reference: neos.form:form`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst b/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst index 359649c64ef..435a1b21c9a 100644 --- a/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst +++ b/Neos.Neos/Documentation/References/ViewHelpers/Fusion.rst @@ -3,7 +3,7 @@ Fusion ViewHelper Reference ########################### -This reference was automatically generated from code on 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`Fusion ViewHelper Reference: fusion:render`: diff --git a/Neos.Neos/Documentation/References/ViewHelpers/Media.rst b/Neos.Neos/Documentation/References/ViewHelpers/Media.rst index 1683498c565..effc2b37fa4 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 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`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 1648e1811a0..019fbecc3ad 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 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`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 a75a6520b2c..923bb1d5c72 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 2023-11-26 +This reference was automatically generated from code on 2023-11-29 .. _`TYPO3 Fluid ViewHelper Reference: f:alias`: @@ -622,6 +622,76 @@ Arguments +.. _`TYPO3 Fluid ViewHelper Reference: f:format.case`: + +f:format.case +------------- + +Modifies the case of an input string to upper- or lowercase or capitalization. +The default transformation will be uppercase as in `mb_convert_case`_. + +Possible modes are: + +``lower`` + Transforms the input string to its lowercase representation + +``upper`` + Transforms the input string to its uppercase representation + +``capital`` + Transforms the input string to its first letter upper-cased, i.e. capitalization + +``uncapital`` + Transforms the input string to its first letter lower-cased, i.e. uncapitalization + +``capitalWords`` + Not supported yet: Transforms the input string to each containing word being capitalized + +Note that the behavior will be the same as in the appropriate PHP function `mb_convert_case`_; +especially regarding locale and multibyte behavior. + +.. _mb_convert_case: https://www.php.net/manual/function.mb-convert-case.php + +Examples +======== + +Default +------- + +:: + + Some Text with miXed case + +Output:: + + SOME TEXT WITH MIXED CASE + +Example with given mode +----------------------- + +:: + + someString + +Output:: + + SomeString + +:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\CaseViewHelper + + + + +Arguments +********* + +* ``value`` (string, *optional*): The input value. If not given, the evaluated child nodes will be used. + +* ``mode`` (string, *optional*): The case to apply, must be one of this' CASE_* constants. Defaults to uppercase application. + + + + .. _`TYPO3 Fluid ViewHelper Reference: f:format.cdata`: f:format.cdata @@ -734,6 +804,150 @@ Arguments +.. _`TYPO3 Fluid ViewHelper Reference: f:format.json`: + +f:format.json +------------- + +Wrapper for PHPs :php:`json_encode` function. +See https://www.php.net/manual/function.json-encode.php. + +Examples +======== + +Encoding a view variable +------------------------ + +:: + + {someArray -> f:format.json()} + +``["array","values"]`` +Depending on the value of ``{someArray}``. + +Associative array +----------------- + +:: + + {f:format.json(value: {foo: 'bar', bar: 'baz'})} + +``{"foo":"bar","bar":"baz"}`` + +Non associative array with forced object +---------------------------------------- + +:: + + {f:format.json(value: {0: 'bar', 1: 'baz'}, forceObject: true)} + +``{"0":"bar","1":"baz"}`` + +:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\JsonViewHelper + + + + +Arguments +********* + +* ``value`` (mixed, *optional*): The incoming data to convert, or null if VH children should be used + +* ``forceObject`` (bool, *optional*): Outputs an JSON object rather than an array + + + + +.. _`TYPO3 Fluid ViewHelper Reference: f:format.nl2br`: + +f:format.nl2br +-------------- + +Wrapper for PHPs :php:`nl2br` function. +See https://www.php.net/manual/function.nl2br.php. + +Examples +======== + +Default +------- + +:: + + {text_with_linebreaks} + +Text with line breaks replaced by ``
`` + +Inline notation +--------------- + +:: + + {text_with_linebreaks -> f:format.nl2br()} + +Text with line breaks replaced by ``
`` + +:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\Nl2brViewHelper + + + + +Arguments +********* + +* ``value`` (string, *optional*): string to format + + + + +.. _`TYPO3 Fluid ViewHelper Reference: f:format.number`: + +f:format.number +--------------- + +Formats a number with custom precision, decimal point and grouped thousands. +See https://www.php.net/manual/function.number-format.php. + +Examples +======== + +Defaults +-------- + +:: + + 423423.234 + +``423,423.20`` + +With all parameters +------------------- + +:: + + + 423423.234 + + +``423.423,2`` + +:Implementation: TYPO3Fluid\\Fluid\\ViewHelpers\\Format\\NumberViewHelper + + + + +Arguments +********* + +* ``decimals`` (int, *optional*): The number of digits after the decimal point + +* ``decimalSeparator`` (string, *optional*): The decimal point character + +* ``thousandsSeparator`` (string, *optional*): The character for grouping the thousand digits + + + + .. _`TYPO3 Fluid ViewHelper Reference: f:format.printf`: f:format.printf @@ -868,6 +1082,194 @@ Arguments +.. _`TYPO3 Fluid ViewHelper Reference: f:format.stripTags`: + +f:format.stripTags +------------------ + +Removes tags from the given string (applying PHPs :php:`strip_tags()` function) +See https://www.php.net/manual/function.strip-tags.php. + +Examples +======== + +Default notation +---------------- + +:: + + Some Text with Tags and an Ümlaut. + +Some Text with Tags and an Ümlaut. :php:`strip_tags()` applied. + +.. note:: + Encoded entities are not decoded. + +Default notation with allowedTags +--------------------------------- + +:: + + +

paragraph

span
divider
+ + +Output:: + +

paragraph

span
divider
iframe + +Inline notation +--------------- + +:: + + {text -> f:format.stripTags()} + +Text without tags :php:`strip_tags()` applied. + +Inline notation with allowedTags +-------------------------------- + +:: + + {text -> f:format.stripTags(allowedTags: "