src/Symfony/Component/HttpKernel/Tests/Event/ControllerArgumentsEventTest.php - 8.2 - githubmirror/symfony

src/Symfony/Component/HttpKernel/Tests/Event/ControllerArgumentsEventTest.php
157 строк6 KB
Nicolas Grekas
[HttpKernel] Add `ControllerEvent::evaluate()` et al. to help with evaluating expressions or closures in controller attributes
05 фев 2026, 16:36
05 фев 2026, 16:367f261a9
<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symfony\Component\HttpKernel\Tests\Event;

use PHPUnit\Framework\TestCase;
use Symfony\Component\ExpressionLanguage\Expression;
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\ControllerArgumentsEvent;
use Symfony\Component\HttpKernel\Event\ControllerEvent;
use Symfony\Component\HttpKernel\HttpKernelInterface;
use Symfony\Component\HttpKernel\Tests\Fixtures\Attribute\Bar;
use Symfony\Component\HttpKernel\Tests\Fixtures\Attribute\Baz;
use Symfony\Component\HttpKernel\Tests\Fixtures\Controller\AttributeController;
use Symfony\Component\HttpKernel\Tests\TestHttpKernel;

class ControllerArgumentsEventTest extends TestCase
{
    public function testControllerArgumentsEvent()
    {
        $event = new ControllerArgumentsEvent(new TestHttpKernel(), static function () {}, ['test'], new Request(), HttpKernelInterface::MAIN_REQUEST);
        $this->assertSame(['test'], $event->getArguments());
    }

    public function testSetAttributes()
    {
        $controller = static function () {};
        $event = new ControllerArgumentsEvent(new TestHttpKernel(), $controller, ['test'], new Request(), HttpKernelInterface::MAIN_REQUEST);
        $event->setController($controller, []);

        $this->assertSame([], $event->getAttributes());
    }

    public function testGetAttributes()
    {
        $controller = new AttributeController();
        $request = new Request();

        $controllerEvent = new ControllerEvent(new TestHttpKernel(), $controller, $request, HttpKernelInterface::MAIN_REQUEST);

        $event = new ControllerArgumentsEvent(new TestHttpKernel(), $controllerEvent, ['test'], new Request(), HttpKernelInterface::MAIN_REQUEST);

        $expected = [
            Bar::class => [
                new Bar('class'),
                new Bar('method'),
            ],
            Baz::class => [
                new Baz(),
            ],
        ];

        $this->assertEquals($expected, $event->getAttributes());

        $attributes = [
            new Bar('class'),
            new Bar('method'),
            new Bar('foo'),
            new Baz(),
        ];
        $event->setController($controller, $attributes);

        $grouped = [
            Bar::class => [
                new Bar('class'),
                new Bar('method'),
                new Bar('foo'),
            ],
            Baz::class => [
                new Baz(),
            ],
        ];
        $this->assertEquals($grouped, $event->getAttributes());
        $this->assertEquals($attributes, $event->getAttributes('*'));
        $this->assertSame($controllerEvent->getAttributes(), $event->getAttributes());
    }

    public function testGetAttributesByClassName()
    {
        $controller = new AttributeController();
        $request = new Request();

        $controllerEvent = new ControllerEvent(new TestHttpKernel(), $controller, $request, HttpKernelInterface::MAIN_REQUEST);

        $event = new ControllerArgumentsEvent(new TestHttpKernel(), $controllerEvent, ['test'], new Request(), HttpKernelInterface::MAIN_REQUEST);

        $expected = [
            new Bar('class'),
            new Bar('method'),
        ];

        $this->assertEquals($expected, $event->getAttributes(Bar::class));

        // When setting attributes, provide as flat list
        $flatAttributes = [
            new Bar('class'),
            new Bar('method'),
            new Bar('foo'),
        ];
        $event->setController($controller, $flatAttributes);

        $expectedAfterSet = [
            new Bar('class'),
            new Bar('method'),
            new Bar('foo'),
        ];
        $this->assertEquals($expectedAfterSet, $event->getAttributes(Bar::class));
        $this->assertSame($controllerEvent->getAttributes(Bar::class), $event->getAttributes(Bar::class));
    }

    public function testEvaluateWithClosureUsesNamedArguments()
    {
        $request = new Request();
        $controller = [new AttributeController(), 'action'];
        $controllerEvent = new ControllerEvent(new TestHttpKernel(), $controller, $request, HttpKernelInterface::MAIN_REQUEST);
        $event = new ControllerArgumentsEvent(new TestHttpKernel(), $controllerEvent, ['value'], $request, HttpKernelInterface::MAIN_REQUEST);

        $closure = function (array $args, Request $requestArg, ?object $controllerArg) use ($request): string {
            $this->assertSame(['baz' => 'value'], $args);
            $this->assertSame($request, $requestArg);
            $this->assertInstanceOf(AttributeController::class, $controllerArg);

            return 'ok';
        };

        $this->assertSame('ok', $event->evaluate($closure, null));
    }

    public function testEvaluateWithExpressionDelegatesToExpressionLanguage()
    {
        $request = new Request();
        $controller = [new AttributeController(), 'action'];
        $controllerEvent = new ControllerEvent(new TestHttpKernel(), $controller, $request, HttpKernelInterface::MAIN_REQUEST);
        $event = new ControllerArgumentsEvent(new TestHttpKernel(), $controllerEvent, ['value'], $request, HttpKernelInterface::MAIN_REQUEST);

        $expressionLanguage = $this->createMock(ExpressionLanguage::class);
        $expressionLanguage->expects($this->once())
            ->method('evaluate')
            ->with(new Expression('args["baz"]'), [
                'request' => $request,
                'args' => ['baz' => 'value'],
                'this' => $controller[0],
            ])
            ->willReturn('value');

        $this->assertSame('value', $event->evaluate(new Expression('args["baz"]'), $expressionLanguage));
    }
}