IBX-3035 [Twig] Allowed passing parameters to `ibexa render` function #674

vidarl · 2025-11-03T14:05:24Z

🎫 Issue	IBX-3035

Description:

When using render(controller('ibexa_content::viewAction')), you can send parameters to the controller which will be available in the template.

Example:

    <h2>render controller</h2>
    {{ render(controller('ibexa_content::viewAction', {
        'contentId': content.id,
        'viewType': 'line',
        'params':
            { 'my_param': 'custom_data', }
    })) }}

    <h2>render_esi controller</h2>
    {{ render_esi(controller('ibexa_content::viewAction', {
        'contentId': content.id,
        'viewType': 'line',
        'params':
            { 'my_param': 'custom_data', }
    })) }}

This PR adds the same possibility when using ibexa_render() :

    <h2>direct</h2>
    {{ ibexa_render(content,
        {
            'viewType': 'line',
            'method': 'direct',
            'params': {
                'my_param': 'custom_data'
            }
        })
    }} <br/>

    {{ ibexa_render(location,
        {
            'viewType': 'line',
            'method': 'direct',
            'params': {
            'my_param': 'custom_data'
        }
        })
    }} <br/>

    <h2>inline</h2>
    {{ ibexa_render(content,
        {
            'viewType': 'line',
            'method': 'inline',
            'params': {
                'my_param': 'custom_data'
            }
        })
    }} <br/>

    {{ ibexa_render(location,
        {
            'viewType': 'line',
            'method': 'inline',
            'params': {
                'my_param': 'custom_data'
            }
        })
    }} <br/>


    <h2>esi</h2>
    {{ ibexa_render(content,
        {
            'viewType': 'line',
            'method': 'esi',
            'params': {
                'my_param': 'custom_data'
            }
        })
    }} <br/>

    {{ ibexa_render(location,
        {
            'viewType': 'line',
            'method': 'esi',
            'params': {
                'my_param': 'custom_data'
            }
        })
    }} <br/>

For QA:

Documentation:

vidarl · 2025-11-04T15:12:23Z

tests/lib/MVC/Symfony/Templating/RenderContentStrategyTest.php

+        );
+    }
+
+    public static function forwardOptionsToFragmentRenderer(MockObject $fragmentRendererMock, MockObject $valueObjectMock, string $renderStrategyClass): void


This abstractions is made to avoid cut&paste of code for similar test in RenderLocationStrategyTest

This abstractions is made to avoid cut&paste of code for similar test in RenderLocationStrategyTest

But does it have to be static?

Yes, it needs to be static in order for RenderLocationStrategyTest to re-use the method

I have now replaced the static method with a trait

alongosz · 2025-11-05T10:33:00Z

src/bundle/Core/Fragment/InlineFragmentRenderer.php

            if ($request->attributes->has('viewParametersString')) {
                $uri->attributes['viewParametersString'] = $request->attributes->get('viewParametersString');
            }
+            if ($options['params'] ?? false) {


Please refactor this so you don't rely on true-ish expression inside of the if statement. This works because of implicit cast which can lead to some bugs under some circumstances. What is the real condition making this usable? !is_empty && is_array?

I have rewritten and simplified the approach. Instead of adding the params parameters in the *FragmentRenders, I have instead fixed it so that the RenderStrategy object instead injects the params parameters into the ControllerReference. This is in line with what happens when render(controller()) is used

src/bundle/Core/Fragment/InlineFragmentRenderer.php

src/lib/MVC/Symfony/Templating/RenderContentStrategy.php

alongosz · 2025-11-05T10:41:34Z

tests/lib/MVC/Symfony/Templating/RenderContentStrategyTest.php

+        );
+    }
+
+    public static function forwardOptionsToFragmentRenderer(MockObject $fragmentRendererMock, MockObject $valueObjectMock, string $renderStrategyClass): void


This abstractions is made to avoid cut&paste of code for similar test in RenderLocationStrategyTest

But does it have to be static?

tests/lib/MVC/Symfony/Templating/RenderContentStrategyTest.php

konradoboza · 2025-12-16T11:14:32Z

@vidarl please make sure all the suggestions are adressed, CI lits green and the PR is rebased.

…ibexa_render Twig function

… using ibexa_render Twig function

This reverts commit 15bedfa.

…egy static This reverts commit 15bedfa.

…trait

sonarqubecloud · 2025-12-16T13:28:29Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

mikadamczyk · 2025-12-16T13:56:31Z

tests/lib/MVC/Symfony/Templating/ForwardParamOptionsToFragmentRendererTrait.php

+            )
+            ->willReturn(new Response('fragment_render_mock_rendered'));
+
+        $renderContentStrategy = self::createRenderStrategy(


createRenderStrategy is not a static method. Calling it statically will raise the PHP 7.4 "non-static method called statically". It could be declared as an abstract requirement in the trait to make the dependency explicit.

konradoboza · 2025-12-16T14:00:44Z

tests/lib/MVC/Symfony/Templating/ForwardParamOptionsToFragmentRendererTrait.php

+        $fragmentRendererMock->expects(self::once())
+            ->method('render')
+            ->with(
+                self::callback(static function ($controllerReference) use ($params) {


Suggested change

self::callback(static function ($controllerReference) use ($params) {

self::callback(static function ($controllerReference) use ($params): bool {

konradoboza · 2025-12-16T14:09:05Z

tests/lib/MVC/Symfony/Templating/ForwardParamOptionsToFragmentRendererTrait.php

+            'param2' => 'value2',
+        ];
+
+        $fragmentRendererMock


Suggested change

$fragmentRendererMock

$fragmentRendererMock

->expects(self::once())

konradoboza · 2025-12-16T14:09:59Z

tests/lib/MVC/Symfony/Templating/RenderContentStrategyTest.php

-            $this->assertInstanceOf(ControllerReference::class, $controllerReference);
-            $this->assertEquals('ibexa_content::viewAction', $controllerReference->controller);
-            $this->assertSame([
+        $controllerReferenceCallback = $this->callback(static function (ControllerReference $controllerReference) {


Suggested change

$controllerReferenceCallback = $this->callback(static function (ControllerReference $controllerReference) {

$controllerReferenceCallback = $this->callback(static function (ControllerReference $controllerReference): bool {

konradoboza · 2025-12-16T14:10:51Z

tests/lib/MVC/Symfony/Templating/RenderContentStrategyTest.php


 class RenderContentStrategyTest extends BaseRenderStrategyTest
 {
+    use ForwardParamOptionsToFragmentRendererTrait;


Does it necessarily needs to be a Trait? Why not putting related code into BaseRenderStrategyTest?

github-actions bot assigned mikadamczyk, alongosz and tischsoic Nov 3, 2025

mnocon added the Doc needed The changes require some documentation label Nov 4, 2025

vidarl force-pushed the IBX-3035_As_a_developer_I_want_to_pass_extra_atrributes_when_using_ibexa_render_Twig_function branch 3 times, most recently from 1bb7be8 to 2a1ab1c Compare November 4, 2025 15:06

vidarl added the Ready for review label Nov 4, 2025

vidarl commented Nov 4, 2025

View reviewed changes

alongosz reviewed Nov 5, 2025

View reviewed changes

alongosz changed the title ~~IBX-3035 as a developer i want to pass extra atrributes when using ibexa render_twig() function~~ IBX-3035: [Twig] Allowed passing parameters to ibexa render function Nov 5, 2025

vidarl force-pushed the IBX-3035_As_a_developer_I_want_to_pass_extra_atrributes_when_using_ibexa_render_Twig_function branch 2 times, most recently from 099a520 to a0ddb17 Compare December 1, 2025 14:55

vidarl requested a review from alongosz December 2, 2025 08:07

vidarl force-pushed the IBX-3035_As_a_developer_I_want_to_pass_extra_atrributes_when_using_ibexa_render_Twig_function branch from a0ddb17 to 988d77f Compare December 2, 2025 08:10

ibexa-yuna changed the title ~~IBX-3035: [Twig] Allowed passing parameters to ibexa render function~~ IBX-3035 [Twig] Allowed passing parameters to ibexa render function Dec 16, 2025

vidarl added 10 commits December 16, 2025 14:24

IBX-3035: As a developer, I want to pass extra atrributes when using …

b8e7872

…ibexa_render Twig function

fixup! IBX-3035: As a developer, I want to pass extra atrributes when…

1c020fb

… using ibexa_render Twig function

Added tests for IBX-3035

59bd8e6

Revert "Added tests for IBX-3035"

edc5bf4

This reverts commit 15bedfa.

fixup! Added tests for IBX-3035

5695842

fixup! Added tests for IBX-3035

c73648c

Revert "Added tests for IBX-3035" - Reverted Making createRenderStrat…

d1b51a5

…egy static This reverts commit 15bedfa.

Transformed static method forwardParamOptionsToFragmentRenderer to a …

5490ae1

…trait

fixup! Added tests for IBX-3035

1a8644a

fixup! Added tests for IBX-3035

5e212bb

vidarl force-pushed the IBX-3035_As_a_developer_I_want_to_pass_extra_atrributes_when_using_ibexa_render_Twig_function branch from 3c65ba0 to 5e212bb Compare December 16, 2025 13:24

mikadamczyk reviewed Dec 16, 2025

View reviewed changes

konradoboza reviewed Dec 16, 2025

View reviewed changes

	self::callback(static function ($controllerReference) use ($params) {
	self::callback(static function ($controllerReference) use ($params): bool {

	$fragmentRendererMock
	$fragmentRendererMock
	->expects(self::once())

	$controllerReferenceCallback = $this->callback(static function (ControllerReference $controllerReference) {
	$controllerReferenceCallback = $this->callback(static function (ControllerReference $controllerReference): bool {

IBX-3035 [Twig] Allowed passing parameters to ibexa render function #674

Are you sure you want to change the base?

IBX-3035 [Twig] Allowed passing parameters to ibexa render function #674

Uh oh!

Conversation

vidarl commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

For QA:

Documentation:

Uh oh!

vidarl Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vidarl Dec 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

konradoboza commented Dec 16, 2025

Uh oh!

sonarqubecloud bot commented Dec 16, 2025

Quality Gate passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

IBX-3035 [Twig] Allowed passing parameters to `ibexa render` function #674

IBX-3035 [Twig] Allowed passing parameters to `ibexa render` function #674

vidarl commented Nov 3, 2025 •

edited

Loading

vidarl Nov 4, 2025 •

edited

Loading

vidarl Dec 2, 2025 •

edited

Loading