Skip to content

[SecurityGuard] Deprecate returning non-boolean values from checkCredentials() #33308

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

Conversation

derrabus
Copy link
Member

@derrabus derrabus commented Aug 23, 2019

Q A
Branch? 4.4
Bug fix? no
New feature? no
BC breaks? no
Deprecations? yes
Tests pass? yes
Fixed tickets prepares #33228
License MIT
Doc PR symfony/symfony-docs#12234

This PR suggests to deprecate implementations of Symfony\Component\Security\Guard\AuthenticatorInterface::checkCredentials() that return non-boolean values. This will allow us to add bool as return type declaration in the future.

nicolas-grekas#26 (comment)

/cc @nicolas-grekas @weaverryan

Copy link
Member

@chalasr chalasr left a comment

Choose a reason for hiding this comment

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

CHANGELOG/UPGRADE files need to be updated

@nicolas-grekas nicolas-grekas added this to the next milestone Aug 23, 2019
@derrabus derrabus force-pushed the improvement/guard-deprecate-non-boolean-return branch 2 times, most recently from 4a0869d to 0db0ac1 Compare August 23, 2019 18:42
@derrabus derrabus force-pushed the improvement/guard-deprecate-non-boolean-return branch from 0db0ac1 to a0ca3af Compare August 23, 2019 18:43
@derrabus
Copy link
Member Author

Status: Needs Review

@fabpot
Copy link
Member

fabpot commented Aug 25, 2019

Thank you @derrabus.

fabpot added a commit that referenced this pull request Aug 25, 2019
… from checkCredentials() (derrabus)

This PR was merged into the 4.4 branch.

Discussion
----------

[SecurityGuard] Deprecate returning non-boolean values from checkCredentials()

| Q             | A
| ------------- | ---
| Branch?       | 4.4
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | yes
| Tests pass?   | yes
| Fixed tickets | prepares #33228
| License       | MIT
| Doc PR        | TODO

This PR suggests to deprecate implementations of `Symfony\Component\Security\Guard\AuthenticatorInterface::checkCredentials()` that return non-boolean values. This will allow us to add `bool` as return type declaration in the future.

nicolas-grekas#26 (comment)

/cc @nicolas-grekas @weaverryan

Commits
-------

a0ca3af Deprecate returning non-boolean values from checkCredentials().
@fabpot fabpot merged commit a0ca3af into symfony:4.4 Aug 25, 2019
@derrabus derrabus deleted the improvement/guard-deprecate-non-boolean-return branch August 25, 2019 07:00
OskarStark added a commit to symfony/symfony-docs that referenced this pull request Aug 28, 2019
This PR was merged into the 4.4 branch.

Discussion
----------

Document the changes to checkCredentials()

This PR fixes #12233 by documenting symfony/symfony#33308.

Commits
-------

d3d7bc2 Document the changes to checkCredentials()
@nicolas-grekas nicolas-grekas modified the milestones: next, 4.4 Oct 27, 2019
This was referenced Nov 12, 2019
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.

5 participants