Backport #979
Backport #979
Conversation
Previously, `CompileWithContentArgumentAndRenderStatic` could
be used to create ViewHelpers that can get their default input both
from their child content and from a defined argument. This feature
has now been integrated into AbstractViewHelper. To use it, the
ViewHelper class needs to override the method
`getContentArgumentName()` and return the name of the
argument to be used.
Example:
```
public function initializeArguments(): void
{
$this->registerArgument('value', 'string', '');
}
public function getContentArgumentName(): string
{
return 'value';
}
```
`$this->renderChildren()` can then be used to get either the
defined argument or as fallback the ViewHelper's child content.
With this definition, the ViewHelper can be used in the following
ways:
```
<my:viewhelper value="test" />
<my:viewhelper>test</my:viewhelper>
{myInput -> my:viewhelper()}
```
Since it's no longer necessary, the trait is now deprecated and
will be removed with Fluid v5. There will be a soft deprecation
in Fluid v2 to let users know that this API will no longer be available
with Fluid v5 and will throw a deprecation error in v4.
All ViewHelpers still using the trait have been migrated to
`CompileWithRenderStatic`, which has been modified to support
the new implementation.
With the introduction of the new `getContentArgumentName()` API for ViewHelpers, there has been an oversight in `TemplateParser`: It had special handling for the old method name `resolveContentArgumentName()`, which is now deprecated. Since `resolveContentArgumentName()` is now called by the new API `getContentArgumentName()`, we can just call the new API in the `TemplateParser` now, without special handling for the deprecated trait. As a consequence, we need to adjust some tests and fixtures. Also, we add more dedicated test cases to our new test file. In the future, there needs to be a cleanup of `AbstractViewHelper` and `ViewHelperInterface`, since internal classes depend on API only defined in `AbstractViewHelper`. In fact, we arguably made things a bit worse now, but this is a topic for Fluid v5. # Conflicts: # phpstan-baseline.neon # src/Core/ViewHelper/Traits/CompileWithContentArgumentAndRenderStatic.php
|
FYI: This change broke most of the Fluid adapter tests in Flow because mocking like $this->viewHelper->expects(self::once())->method('renderChildren')->will(self::returnValue('some text'));won't work any longer and, worse, because executing the tests leads to an exception We're investigating how to fix this on our side |
|
Very sorry about that! If it helps, you can contact me directly and we can have a look at it together. |
|
@s2b No need to be sorry, it was just a FYI. I think we "fixed" the issue with neos/flow-development-collection#3390 |
|
Quick note. |
No description provided.