Skip to content

[OptionsResolver] Allow deprecations to be overridden with an empty s… #62345

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

Closed
yoeunes wants to merge 1 commit into from
Closed

[OptionsResolver] Allow deprecations to be overridden with an empty s… #62345

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
2 changes: 2 additions & 0 deletions src/Symfony/Component/OptionsResolver/OptionsResolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,6 +447,8 @@ public function setDeprecated(string $option, string $package, string $version,

// ignore if empty string
if ('' === $message) {
unset($this->deprecated[$option]);

return $this;
}

Expand Down
38 changes: 38 additions & 0 deletions src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2566,4 +2566,42 @@ public function testPrototypeDefinition()

$this->assertSame($expectedOptions, $actualOptions);
}

public function testDeprecationCanBeOverriddenWithEmptyString()
{
// 1. Base configuration (e.g., parent class) deprecates "hostname"
$this->resolver
->setDefined(['hostname', 'host'])
->setDeprecated(
'hostname',
'acme/package',
'1.2',
'The option "%name%" is deprecated, use "host" instead.'
);

// 2. Child configuration cancel this deprecation
$this->resolver
->setDeprecated('hostname', 'acme/package', '1.3', '');

$this->assertFalse($this->resolver->isDeprecated('hostname'));

$count = 0;
set_error_handler(function (int $type) use (&$count) {
if (\E_USER_DEPRECATED === $type) {
++$count;
}

return false;
});
$e = error_reporting(0);

try {
$this->resolver->resolve(['hostname' => 'localhost']);
} finally {
error_reporting($e);
restore_error_handler();
}

$this->assertSame(0, $count, 'No \E_USER_DEPRECATED error should have been triggered.');
}
}
Loading