Skip to content

[HttpKernel] In DateTimeValueResolver, convert previously defined date attribute to the expected class #48346

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.

Sign up for GitHub

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
Dec 4, 2022
Merged

[HttpKernel] In DateTimeValueResolver, convert previously defined date attribute to the expected class #48346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/Symfony/Component/HttpKernel/Controller/ArgumentResolver/DateTimeValueResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,10 @@ public function supports(Request $request, ArgumentMetadata $argument): bool
public function resolve(Request $request, ArgumentMetadata $argument): iterable
{
$value = $request->attributes->get($argument->getName());
$class = \DateTimeInterface::class === $argument->getType() ? \DateTimeImmutable::class : $argument->getType();

if ($value instanceof \DateTimeInterface) {
yield $value;
yield $value instanceof $class ? $value : $class::createFromInterface($value);

return;
}
Expand All @@ -52,7 +53,6 @@ public function resolve(Request $request, ArgumentMetadata $argument): iterable
return;
}

$class = \DateTimeInterface::class === $argument->getType() ? \DateTimeImmutable::class : $argument->getType();
$format = null;

if ($attributes = $argument->getAttributes(MapDateTime::class, ArgumentMetadata::IS_INSTANCEOF)) {
Expand Down
25 changes: 19 additions & 6 deletions ...fony/Component/HttpKernel/Tests/Controller/ArgumentResolver/DateTimeValueResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

class DateTimeValueResolverTest extends TestCase
{
private $defaultTimezone;
private readonly string $defaultTimezone;
Copy link
Member Author

Choose a reason for hiding this comment

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

This class was introduced in 6.1, I took this PR as an opportunity to improve type definition and make data providers static.


protected function setUp(): void
{
Expand All @@ -32,13 +32,20 @@ protected function tearDown(): void
date_default_timezone_set($this->defaultTimezone);
}

public function getTimeZones()
public static function getTimeZones()
{
yield ['UTC'];
yield ['Etc/GMT+9'];
yield ['Etc/GMT-14'];
}

public static function getClasses()
{
yield [\DateTimeInterface::class];
yield [\DateTime::class];
yield [FooDateTime::class];
}

public function testSupports()
{
$resolver = new DateTimeValueResolver();
Expand Down Expand Up @@ -133,19 +140,25 @@ public function testNow(string $timezone)
$this->assertSame($timezone, $results[0]->getTimezone()->getName(), 'Default timezone');
}

public function testPreviouslyConvertedAttribute()
/**
* @param class-string<\DateTimeInterface> $class
*
* @dataProvider getClasses
*/
public function testPreviouslyConvertedAttribute(string $class)
{
$resolver = new DateTimeValueResolver();

$argument = new ArgumentMetadata('dummy', \DateTime::class, false, false, null, true);
$argument = new ArgumentMetadata('dummy', $class, false, false, null, true);
$request = self::requestWithAttributes(['dummy' => $datetime = new \DateTime()]);

/** @var \Generator $results */
$results = $resolver->resolve($request, $argument);
$results = iterator_to_array($results);

$this->assertCount(1, $results);
$this->assertSame($datetime, $results[0]);
$this->assertEquals($datetime, $results[0], 'The value is the same, but the class can be modified.');
$this->assertInstanceOf($class, $results[0]);
}

public function testCustomClass()
Expand Down Expand Up @@ -209,7 +222,7 @@ public function testWithFormat(string $timezone)
$this->assertEquals('2016-09-08 12:34:56', $results[0]->format('Y-m-d H:i:s'));
}

public function provideInvalidDates()
public static function provideInvalidDates()
{
return [
'invalid date' => [
Expand Down