Skip to content

Implement ValueResolverInterface #119

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
Jul 25, 2023
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
11 changes: 10 additions & 1 deletion ArgumentValueResolver/PsrServerRequestResolver.php
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
use Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
use Symfony\Component\HttpKernel\Controller\ValueResolverInterface as BaseValueResolverInterface;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;

/**
Expand All @@ -25,7 +26,7 @@
* @author Iltar van der Berg <[email protected]>
* @author Alexander M. Turek <[email protected]>
*/
final class PsrServerRequestResolver implements ArgumentValueResolverInterface
final class PsrServerRequestResolver implements ArgumentValueResolverInterface, ValueResolverInterface
{
private const SUPPORTED_TYPES = [
ServerRequestInterface::class => true,
Expand All @@ -45,6 +46,10 @@ public function __construct(HttpMessageFactoryInterface $httpMessageFactory)
*/
public function supports(Request $request, ArgumentMetadata $argument): bool
{
if ($this instanceof BaseValueResolverInterface) {
trigger_deprecation('symfony/psr-http-message-bridge', '2.3', 'Method "%s" is deprecated, call "resolve()" without calling "supports()" first.', __METHOD__);
}

return self::SUPPORTED_TYPES[$argument->getType()] ?? false;
}

Expand All @@ -53,6 +58,10 @@ public function supports(Request $request, ArgumentMetadata $argument): bool
*/
public function resolve(Request $request, ArgumentMetadata $argument): \Traversable
{
if (!isset(self::SUPPORTED_TYPES[$argument->getType()])) {
return;
}

yield $this->httpMessageFactory->createRequest($request);
}
}
26 changes: 26 additions & 0 deletions ArgumentValueResolver/ValueResolverInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?php

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

namespace Symfony\Bridge\PsrHttpMessage\ArgumentValueResolver;

use Symfony\Component\HttpKernel\Controller\ValueResolverInterface as BaseValueResolverInterface;

if (interface_exists(BaseValueResolverInterface::class)) {
/** @internal */
interface ValueResolverInterface extends BaseValueResolverInterface
{
}
} else {
/** @internal */
interface ValueResolverInterface
{
}
}
20 changes: 20 additions & 0 deletions Tests/ArgumentValueResolver/PsrServerRequestResolverTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,21 @@
use Psr\Http\Message\MessageInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ServerRequestInterface;
use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
use Symfony\Bridge\PsrHttpMessage\ArgumentValueResolver\PsrServerRequestResolver;
use Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;

/**
* @author Alexander M. Turek <[email protected]>
*/
final class PsrServerRequestResolverTest extends TestCase
{
use ExpectDeprecationTrait;

public function testServerRequest()
{
$symfonyRequest = $this->createMock(Request::class);
Expand Down Expand Up @@ -55,6 +60,21 @@ public function testMessage()
self::assertSame([$psrRequest], $resolver->getArguments($symfonyRequest, static function (MessageInterface $request): void {}));
}

/**
* @group legacy
*/
public function testDeprecatedSupports()
{
if (!interface_exists(ValueResolverInterface::class)) {
$this->markTestSkipped('Requires symfony/http-kernel 6.2.');
}

$resolver = new PsrServerRequestResolver($this->createStub(HttpMessageFactoryInterface::class));

$this->expectDeprecation('Since symfony/psr-http-message-bridge 2.3: Method "Symfony\Bridge\PsrHttpMessage\ArgumentValueResolver\PsrServerRequestResolver::supports" is deprecated, call "resolve()" without calling "supports()" first.');
$resolver->supports($this->createStub(Request::class), $this->createStub(ArgumentMetadata::class));
}

private function bootstrapResolver(Request $symfonyRequest, ServerRequestInterface $psrRequest): ArgumentResolver
{
$messageFactory = $this->createMock(HttpMessageFactoryInterface::class);
Expand Down
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"require": {
"php": ">=7.2.5",
"psr/http-message": "^1.0 || ^2.0",
"symfony/deprecation-contracts": "^2.5 || ^3.0",
"symfony/http-foundation": "^5.4 || ^6.0"
},
"require-dev": {
Expand All @@ -41,7 +42,7 @@
},
"extra": {
"branch-alias": {
"dev-main": "2.2-dev"
"dev-main": "2.3-dev"
}
}
}