Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

[HttpKernel] Adding new#[MapRequestHeader] attribute and resolver#51379

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
StevenRenaux wants to merge1 commit intosymfony:7.4
base:7.4
Choose a base branch
Loading
fromStevenRenaux:map-request-header-attribute
Open
Show file tree
Hide file tree
Changes fromall 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
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\DefaultValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\QueryParameterValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestAttributeValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestHeaderValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestPayloadValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ServiceValueResolver;
Expand DownExpand Up@@ -101,6 +102,9 @@
->set('argument_resolver.query_parameter_value_resolver', QueryParameterValueResolver::class)
->tag('controller.targeted_value_resolver', ['name' => QueryParameterValueResolver::class])

->set('argument_resolver.header_value_resolver', RequestHeaderValueResolver::class)
->tag('controller.targeted_value_resolver', ['name' => RequestHeaderValueResolver::class])

->set('response_listener', ResponseListener::class)
->args([
param('kernel.charset'),
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
<?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\Attribute;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestHeaderValueResolver;

#[\Attribute(\Attribute::TARGET_PARAMETER)]
class MapRequestHeader extends ValueResolver
{
/**
* @param string|null $name The name of the header parameter; if null, the name of the argument in the controller will be used
* @param string $resolver The class name of the resolver to use
* @param int $validationFailedStatusCode The HTTP code to return if the validation fails
*/
public function __construct(
public readonly ?string $name = null,
string $resolver = RequestHeaderValueResolver::class,
public readonly int $validationFailedStatusCode = Response::HTTP_BAD_REQUEST,
) {
parent::__construct($resolver);
}
}
1 change: 1 addition & 0 deletionssrc/Symfony/Component/HttpKernel/CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,7 @@ CHANGELOG
* Add argument `$buildDir` to `WarmableInterface`
* Add argument `$filter` to `Profiler::find()` and `FileProfilerStorage::find()`
* Add `ControllerResolver::allowControllers()` to define which callables are legit controllers when the `_check_controller_is_allowed` request attribute is set
* Add `#[MapRequestHeader]` to map header from `Request::$headers`

6.3
---
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
<?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\Controller\ArgumentResolver;

use Symfony\Component\HttpFoundation\AcceptHeader;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Attribute\MapRequestHeader;
use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
use Symfony\Component\HttpKernel\Exception\HttpException;

class RequestHeaderValueResolver implements ValueResolverInterface
{
public function resolve(Request $request, ArgumentMetadata $argument): iterable
{
if (!$attribute = $argument->getAttributesOfType(MapRequestHeader::class)[0] ?? null) {
return [];
}

$type = $argument->getType();

if (!\in_array($type, ['string', 'array', AcceptHeader::class])) {
throw new \LogicException(\sprintf('Could not resolve the argument typed "%s". Valid values types are "array", "string" or "%s".', $type, AcceptHeader::class));
}

$name = $attribute->name ?? $argument->getName();
$value = null;

if ($request->headers->has($name)) {
$value = match ($type) {
'string' => $request->headers->get($name),
'array' => match (strtolower($name)) {
'accept' => $request->getAcceptableContentTypes(),
'accept-charset' => $request->getCharsets(),
'accept-language' => $request->getLanguages(),
'accept-encoding' => $request->getEncodings(),
default => [$request->headers->get($name)],
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change
default =>[$request->headers->get($name)],
default =>$request->headers->all($name),

},
default => AcceptHeader::fromString($request->headers->get($name)),
};
}

if (null === $value && $argument->hasDefaultValue()) {
$value = $argument->getDefaultValue();
}

if (null === $value && !$argument->isNullable()) {
throw new HttpException($attribute->validationFailedStatusCode, \sprintf('Missing header "%s".', $name));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think if type is array we could return an empty array

}

return [$value];
}
}
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
<?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\Controller\ArgumentResolver;

use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\AcceptHeader;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Attribute\MapRequestHeader;
use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestHeaderValueResolver;
use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
use Symfony\Component\HttpKernel\Exception\HttpException;

class RequestHeaderValueResolverTest extends TestCase
{
public static function provideHeaderValueWithStringType(): iterable
{
yield 'with accept' => ['accept', 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8'];
yield 'with accept-language' => ['accept-language', 'en-us,en;q=0.5'];
yield 'with host' => ['host', 'localhost'];
yield 'with user-agent' => ['user-agent', 'Symfony'];
}

public static function provideHeaderValueWithArrayType(): iterable
{
yield 'with accept' => [
'accept',
'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
[
[
'text/html',
'application/xhtml+xml',
'application/xml',
'*/*',
],
],
];
yield 'with accept-language' => [
'accept-language',
'en-us,en;q=0.5',
[
[
'en_US',
'en',
],
],
];
yield 'with host' => [
'host',
'localhost',
[
['localhost'],
],
];
yield 'with user-agent' => [
'user-agent',
'Symfony',
[
['Symfony'],
],
];
}

public static function provideHeaderValueWithAcceptHeaderType(): iterable
{
yield 'with accept' => [
'accept',
'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8',
[AcceptHeader::fromString('text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8')],
];
yield 'with accept-language' => [
'accept-language',
'en-us,en;q=0.5',
[AcceptHeader::fromString('en-us,en;q=0.5')],
];
yield 'with host' => [
'host',
'localhost',
[AcceptHeader::fromString('localhost')],
];
yield 'with user-agent' => [
'user-agent',
'Symfony',
[AcceptHeader::fromString('Symfony')],
];
}

public static function provideHeaderValueWithDefaultAndNull(): iterable
{
yield 'with hasDefaultValue' => [true, 'foo', false, 'foo'];
yield 'with no isNullable' => [false, null, true, null];
}

public function testWrongType()
{
$this->expectException(\LogicException::class);

$metadata = new ArgumentMetadata('accept', 'int', false, false, null, false, [
MapRequestHeader::class => new MapRequestHeader(),
]);

$request = Request::create('/');

$resolver = new RequestHeaderValueResolver();
$resolver->resolve($request, $metadata);
}

/**
* @dataProvider provideHeaderValueWithStringType
*/
public function testWithStringType(string $parameter, string $value)
{
$resolver = new RequestHeaderValueResolver();

$metadata = new ArgumentMetadata('variableName', 'string', false, false, null, false, [
MapRequestHeader::class => new MapRequestHeader($parameter),
]);

$request = Request::create('/');
$request->headers->set($parameter, $value);

$arguments = $resolver->resolve($request, $metadata);

self::assertEquals([$value], $arguments);
}

/**
* @dataProvider provideHeaderValueWithArrayType
*/
public function testWithArrayType(string $parameter, string $value, array $expected)
{
$resolver = new RequestHeaderValueResolver();

$metadata = new ArgumentMetadata('variableName', 'array', false, false, null, false, [
MapRequestHeader::class => new MapRequestHeader($parameter),
]);

$request = Request::create('/');
$request->headers->set($parameter, $value);

$arguments = $resolver->resolve($request, $metadata);

self::assertEquals($expected, $arguments);
}

/**
* @dataProvider provideHeaderValueWithAcceptHeaderType
*/
public function testWithAcceptHeaderType(string $parameter, string $value, array $expected)
{
$resolver = new RequestHeaderValueResolver();

$metadata = new ArgumentMetadata('variableName', AcceptHeader::class, false, false, null, false, [
MapRequestHeader::class => new MapRequestHeader($parameter),
]);

$request = Request::create('/');
$request->headers->set($parameter, $value);

$arguments = $resolver->resolve($request, $metadata);

self::assertEquals($expected, $arguments);
}

/**
* @dataProvider provideHeaderValueWithDefaultAndNull
*/
public function testWithDefaultValueAndNull(bool $hasDefaultValue, ?string $defaultValue, bool $isNullable, ?string $expected)
{
$metadata = new ArgumentMetadata('wrong-header', 'string', false, $hasDefaultValue, $defaultValue, $isNullable, [
MapRequestHeader::class => new MapRequestHeader(),
]);

$request = Request::create('/');

$resolver = new RequestHeaderValueResolver();
$arguments = $resolver->resolve($request, $metadata);

self::assertEquals([$expected], $arguments);
}

public function testWithNoDefaultAndNotNullable()
{
$this->expectException(HttpException::class);
$this->expectExceptionMessage('Missing header "variableName".');

$metadata = new ArgumentMetadata('variableName', 'string', false, false, null, false, [
MapRequestHeader::class => new MapRequestHeader(),
]);

$resolver = new RequestHeaderValueResolver();
$resolver->resolve(Request::create('/'), $metadata);
}
}
Loading
[8]ページ先頭
©2009-2025 Movatter.jp