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

Commit 081c601

Browse filesBrowse files
fabpotfabpot
committed
minor #32257 [Security] [Guard] Removed useless param annotations (thomasbisignani)
This PR was merged into the 3.4 branch. Discussion ---------- [Security] [Guard] Removed useless param annotations | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #32254 (comment) | License | MIT | Doc PR | The PR removes useless `@param` annotation, it is linked with the #32254 (comment) Commits ------- 848e881 [Security] [Guard] Removed useless param annotations
2 parents 6eeec65 + 848e881 commit 081c601
Copy full SHA for 081c601

File tree

5 files changed

+7
-37
lines changed
Filter options

5 files changed

+7
-37
lines changed

‎src/Symfony/Component/Security/Guard/AbstractGuardAuthenticator.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Guard/AbstractGuardAuthenticator.php
+1-2Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,7 @@ public function supports(Request $request)
3636
* Shortcut to create a PostAuthenticationGuardToken for you, if you don't really
3737
* care about which authenticated token you're using.
3838
*
39-
* @param UserInterface $user
40-
* @param string $providerKey
39+
* @param string $providerKey
4140
*
4241
* @return PostAuthenticationGuardToken
4342
*/

‎src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php
+1-3Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,7 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio
5555
/**
5656
* Override to change what happens after successful authentication.
5757
*
58-
* @param Request $request
59-
* @param TokenInterface $token
60-
* @param string $providerKey
58+
* @param string $providerKey
6159
*
6260
* @return RedirectResponse
6361
*/

‎src/Symfony/Component/Security/Guard/AuthenticatorInterface.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Guard/AuthenticatorInterface.php
-4Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ interface AuthenticatorInterface extends GuardAuthenticatorInterface
3030
*
3131
* If this returns false, the authenticator will be skipped.
3232
*
33-
* @param Request $request
34-
*
3533
* @return bool
3634
*/
3735
public function supports(Request $request);
@@ -53,8 +51,6 @@ public function supports(Request $request);
5351
*
5452
* return ['api_key' => $request->headers->get('X-API-TOKEN')];
5553
*
56-
* @param Request $request
57-
*
5854
* @return mixed Any non-null value
5955
*
6056
* @throws \UnexpectedValueException If null is returned

‎src/Symfony/Component/Security/Guard/GuardAuthenticatorHandler.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Guard/GuardAuthenticatorHandler.php
+3-12Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,7 @@ public function authenticateWithToken(TokenInterface $token, Request $request/*,
7070
/**
7171
* Returns the "on success" response for the given GuardAuthenticator.
7272
*
73-
* @param TokenInterface $token
74-
* @param Request $request
75-
* @param AuthenticatorInterface $guardAuthenticator
76-
* @param string $providerKey The provider (i.e. firewall) key
73+
* @param string $providerKey The provider (i.e. firewall) key
7774
*
7875
* @return Response|null
7976
*/
@@ -93,10 +90,7 @@ public function handleAuthenticationSuccess(TokenInterface $token, Request $requ
9390
* Convenience method for authenticating the user and returning the
9491
* Response *if any* for success.
9592
*
96-
* @param UserInterface $user
97-
* @param Request $request
98-
* @param AuthenticatorInterface $authenticator
99-
* @param string $providerKey The provider (i.e. firewall) key
93+
* @param string $providerKey The provider (i.e. firewall) key
10094
*
10195
* @return Response|null
10296
*/
@@ -115,10 +109,7 @@ public function authenticateUserAndHandleSuccess(UserInterface $user, Request $r
115109
* Handles an authentication failure and returns the Response for the
116110
* GuardAuthenticator.
117111
*
118-
* @param AuthenticationException $authenticationException
119-
* @param Request $request
120-
* @param AuthenticatorInterface $guardAuthenticator
121-
* @param string $providerKey The key of the firewall
112+
* @param string $providerKey The provider (i.e. firewall) key
122113
*
123114
* @return Response|null
124115
*/

‎src/Symfony/Component/Security/Guard/GuardAuthenticatorInterface.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Security/Guard/GuardAuthenticatorInterface.php
+2-16Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,6 @@ interface GuardAuthenticatorInterface extends AuthenticationEntryPointInterface
5555
*
5656
* return ['api_key' => $request->headers->get('X-API-TOKEN')];
5757
*
58-
* @param Request $request
59-
*
6058
* @return mixed|null
6159
*/
6260
public function getCredentials(Request $request);
@@ -69,9 +67,6 @@ public function getCredentials(Request $request);
6967
* You may throw an AuthenticationException if you wish. If you return
7068
* null, then a UsernameNotFoundException is thrown for you.
7169
*
72-
* @param mixed $credentials
73-
* @param UserProviderInterface $userProvider
74-
*
7570
* @throws AuthenticationException
7671
*
7772
* @return UserInterface|null
@@ -87,9 +82,6 @@ public function getUser($credentials, UserProviderInterface $userProvider);
8782
*
8883
* The *credentials* are the return value from getCredentials()
8984
*
90-
* @param mixed $credentials
91-
* @param UserInterface $user
92-
*
9385
* @return bool
9486
*
9587
* @throws AuthenticationException
@@ -105,8 +97,7 @@ public function checkCredentials($credentials, UserInterface $user);
10597
*
10698
* @see AbstractGuardAuthenticator
10799
*
108-
* @param UserInterface $user
109-
* @param string $providerKey The provider (i.e. firewall) key
100+
* @param string $providerKey The provider (i.e. firewall) key
110101
*
111102
* @return GuardTokenInterface
112103
*/
@@ -121,9 +112,6 @@ public function createAuthenticatedToken(UserInterface $user, $providerKey);
121112
* If you return null, the request will continue, but the user will
122113
* not be authenticated. This is probably not what you want to do.
123114
*
124-
* @param Request $request
125-
* @param AuthenticationException $exception
126-
*
127115
* @return Response|null
128116
*/
129117
public function onAuthenticationFailure(Request $request, AuthenticationException $exception);
@@ -137,9 +125,7 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio
137125
* If you return null, the current request will continue, and the user
138126
* will be authenticated. This makes sense, for example, with an API.
139127
*
140-
* @param Request $request
141-
* @param TokenInterface $token
142-
* @param string $providerKey The provider (i.e. firewall) key
128+
* @param string $providerKey The provider (i.e. firewall) key
143129
*
144130
* @return Response|null
145131
*/

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.