Skip to content

Add support for single action controllers, with __invoke method #645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions src/EventListener/AttributesListener.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,16 @@ public function onKernelRequest(RequestEvent $event): void
$request = $event->getRequest();
$controller = $this->controllerResolver->getController($request);

if (!is_array($controller) || 2 !== count($controller)) {
if (true === \is_object($controller)) {
$class = new \ReflectionClass($controller);
$method = $class->getMethod('__invoke');
} elseif (true === \is_array($controller) && 2 === \count($controller)) {
$class = new \ReflectionClass($controller[0]);
$method = $class->getMethod($controller[1]);
} else {
return;
}

$class = new \ReflectionClass($controller[0]);
$method = $class->getMethod($controller[1]);
$attributes = [];
$addAttributes = static function ($instance) use (&$attributes) {
if ($key = match (get_class($instance)) {
Expand Down
15 changes: 15 additions & 0 deletions tests/Resources/Fixtures/InvokableController.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

declare(strict_types=1);

namespace FOS\HttpCacheBundle\Tests\Resources\Fixtures;

use FOS\HttpCacheBundle\Configuration\Tag;

final class InvokableController
{
#[Tag('invoke-tag')]
public function __invoke(): void
{
}
}
15 changes: 15 additions & 0 deletions tests/Resources/Fixtures/MethodController.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

declare(strict_types=1);

namespace FOS\HttpCacheBundle\Tests\Resources\Fixtures;

use FOS\HttpCacheBundle\Configuration\Tag;

final class MethodController
{
#[Tag('method-tag')]
public function showAction(): void
{
}
}
21 changes: 21 additions & 0 deletions tests/Resources/TestCase/StubControllerResolver.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

declare(strict_types=1);

namespace FOS\HttpCacheBundle\Tests\Resources\TestCase;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;

final class StubControllerResolver implements ControllerResolverInterface
{
/** @param callable|false $controller */
public function __construct(private readonly object|array|false $controller)
{
}

public function getController(Request $request): callable|false
{
return $this->controller;
}
}
68 changes: 68 additions & 0 deletions tests/Unit/EventListener/AttributesListenerTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?php

declare(strict_types=1);

namespace FOS\HttpCacheBundle\Tests\Unit\EventListener;

use FOS\HttpCacheBundle\Configuration\Tag;
use FOS\HttpCacheBundle\EventListener\AttributesListener;
use FOS\HttpCacheBundle\Tests\Resources\Fixtures\InvokableController;
use FOS\HttpCacheBundle\Tests\Resources\Fixtures\MethodController;
use FOS\HttpCacheBundle\Tests\Resources\TestCase\StubControllerResolver;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\HttpKernelInterface;

final class AttributesListenerTest extends TestCase
{
/** @param string[] $expectedTags */
#[DataProvider('supportedControllersProvider')]
public function testSupportedControllers(callable|false $controller, array $expectedTags): void
{
$controllerResolver = new StubControllerResolver($controller);
$listener = new AttributesListener($controllerResolver);
$request = Request::create('/');
$requestEvent = new RequestEvent(
$this->createStub(HttpKernelInterface::class),
$request,
HttpKernelInterface::MAIN_REQUEST,
);

$listener->onKernelRequest($requestEvent);

$this->assertRequestTags($request, $expectedTags);
}

/** @return iterable<string, array{callable|false, string[]}> */
public static function supportedControllersProvider(): iterable
{
yield 'false' => [
false,
[],
];

yield 'invoke' => [
new InvokableController(),
['invoke-tag'],
];

yield 'methode' => [
[new MethodController(), 'showAction'],
['method-tag'],
];
}

/** @param string[] $expectedTags */
private function assertRequestTags(Request $request, array $expectedTags): void
{
$this->assertSame(
$expectedTags,
\array_map(
static fn (Tag $tag): string => \implode($tag->getTags()),
$request->attributes->get('_tag', []),
),
);
}
}
Loading