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

Appearance settings

[HttpFoundation] Adds various return-typed getters to ParameterBag #49972

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

Closed
wants to merge 7 commits into from
Closed

Conversation

mleczakm
Copy link
Contributor

@mleczakm mleczakm commented Apr 7, 2023

Q A
Branch? 6.3
Bug fix? no
New feature? yes
Deprecations? no
Tickets Fix #45775
License MIT
Doc PR symfony/symfony-docs#...

@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 6.3 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@carsonbot carsonbot changed the title Adds various return-typed getters to ParameterBag [HttpFoundation] Adds various return-typed getters to ParameterBag Apr 7, 2023
Copy link
Member

@GromNaN GromNaN left a comment

Choose a reason for hiding this comment

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

Returning null as default or in case of invalid value are 2 distinct features. In 7.0, an exception will be thrown when the value is incompatible with the expected return type, one may prefer this behavior over returning null indistinctly.

Please check issues reported by fabbot.


public function testGetIntOrNull(): void
{
$bag = new ParameterBag(['valid-value' => 1]);
Copy link
Member

Choose a reason for hiding this comment

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

An assertion with an invalid value is necessary, i.e. with a value that cannot be converted to int. Same for Boolean.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've changed it to using native getInt calls etc. so behaviour will be same in both cases.

@@ -155,6 +162,13 @@ public function getInt(string $key, int $default = 0): int
return $this->filter($key, $default, \FILTER_VALIDATE_INT, ['flags' => \FILTER_REQUIRE_SCALAR]) ?: 0;
}

public function getIntOrNull(string $key): ?int
{
return $this->has($key)
Copy link
Member

Choose a reason for hiding this comment

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

Checking if the value is set is not necessary:
filter_var(null, \FILTER_VALIDATE_INT, \FILTER_NULL_ON_FAILURE) returns null.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've changed it to use getInt implementation instead.

@nicolas-grekas
Copy link
Member

I'm sorry but I don't think adding these methods is beneficial. If one wants to check if an entry exists before, using has() works well.

Other issues described in #45775 are solved by #48525 so we can close it IMHO.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add various return-typed getters to ParameterBag
4 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.