Skip to content

[Security] Add missing docblock in PreAuthenticatedToken #15484

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
merged 1 commit into from
Aug 26, 2015

Conversation

tgalopin
Copy link
Contributor

@tgalopin tgalopin commented Aug 7, 2015

Q A
Bug fix? no
New feature? no
BC breaks? no
Deprecations? no
Tests pass? yes
Fixed tickets -
License MIT
Doc PR -

I noticed the PreAuthenticatedToken does not provide any dockblock about its constructor parameters so PHPStorm uses the AbstractToken parameters and think I'm using PreAuthenticatedToken badly.

This fix it by adding the missing docblock and I also added the string[] possibility for roles in AbstractToken as it's present in the code and the exception message.

@patrick-mcdougle
Copy link
Contributor

This has bothered me for years. 👍

@javiereguiluz
Copy link
Member

👍

@tgalopin
Copy link
Contributor Author

What about this PR? Is there a problem with it?

@sstok
Copy link
Contributor

sstok commented Aug 26, 2015

@fabpot ping, this can be merged

@sstok
Copy link
Contributor

sstok commented Aug 26, 2015

Status: Reviewed

@fabpot
Copy link
Member

fabpot commented Aug 26, 2015

Thank you @tgalopin.

@fabpot fabpot merged commit 1dda0a6 into symfony:2.3 Aug 26, 2015
fabpot added a commit that referenced this pull request Aug 26, 2015
… (tgalopin)

This PR was merged into the 2.3 branch.

Discussion
----------

[Security] Add missing docblock in PreAuthenticatedToken

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        | -

I noticed the `PreAuthenticatedToken` does not provide any dockblock about its constructor parameters so PHPStorm uses the `AbstractToken` parameters and think I'm using `PreAuthenticatedToken` badly.

This fix it by adding the missing docblock and I also added the string[] possibility for roles in `AbstractToken` as it's present in the code and the exception message.

Commits
-------

1dda0a6 [Security] Add missing docblock in PreAuthenticatedToken
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.

6 participants