Skip to content

Commit 50a75f9

Browse files
nicolas-grekasnicolas-grekas
committed
Merge branch '2.7' into 2.8
* 2.7: [DI] minor docblock fixes
2 parents 8b43eb4 + 2f68b53 commit 50a75f9

34 files changed

+0
-178
lines changed

‎AccessMapInterface.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ interface AccessMapInterface
2525
/**
2626
* Returns security attributes and required channel for the supplied request.
2727
*
28-
* @param Request $request The current request
29-
*
3028
* @return array A tuple of security attributes and the required channel
3129
*/
3230
public function getPatterns(Request $request);

‎Authentication/AuthenticationFailureHandlerInterface.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@ interface AuthenticationFailureHandlerInterface
3131
* called by authentication listeners inheriting from
3232
* AbstractAuthenticationListener.
3333
*
34-
* @param Request $request
35-
* @param AuthenticationException $exception
36-
*
3734
* @return Response The response to return, never null
3835
*/
3936
public function onAuthenticationFailure(Request $request, AuthenticationException $exception);

‎Authentication/AuthenticationSuccessHandlerInterface.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,6 @@ interface AuthenticationSuccessHandlerInterface
3131
* is called by authentication listeners inheriting from
3232
* AbstractAuthenticationListener.
3333
*
34-
* @param Request $request
35-
* @param TokenInterface $token
36-
*
3734
* @return Response never null
3835
*/
3936
public function onAuthenticationSuccess(Request $request, TokenInterface $token);

‎Authentication/AuthenticationUtils.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,8 @@
2323
*/
2424
class AuthenticationUtils
2525
{
26-
/**
27-
* @var RequestStack
28-
*/
2926
private $requestStack;
3027

31-
/**
32-
* @param RequestStack $requestStack
33-
*/
3428
public function __construct(RequestStack $requestStack)
3529
{
3630
$this->requestStack = $requestStack;

‎Authentication/DefaultAuthenticationFailureHandler.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,6 @@ public function getOptions()
6666
return $this->options;
6767
}
6868

69-
/**
70-
* Sets the options.
71-
*
72-
* @param array $options An array of options
73-
*/
7469
public function setOptions(array $options)
7570
{
7671
$this->options = array_merge($this->defaultOptions, $options);

‎Authentication/DefaultAuthenticationSuccessHandler.php

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,6 @@ public function getOptions()
6464
return $this->options;
6565
}
6666

67-
/**
68-
* Sets the options.
69-
*
70-
* @param array $options An array of options
71-
*/
7267
public function setOptions(array $options)
7368
{
7469
$this->options = array_merge($this->defaultOptions, $options);
@@ -97,8 +92,6 @@ public function setProviderKey($providerKey)
9792
/**
9893
* Builds the target URL according to the defined options.
9994
*
100-
* @param Request $request
101-
*
10295
* @return string
10396
*/
10497
protected function determineTargetUrl(Request $request)

‎Authorization/AccessDeniedHandlerInterface.php

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,6 @@ interface AccessDeniedHandlerInterface
2626
/**
2727
* Handles an access denied failure.
2828
*
29-
* @param Request $request
30-
* @param AccessDeniedException $accessDeniedException
31-
*
3229
* @return Response may return null
3330
*/
3431
public function handle(Request $request, AccessDeniedException $accessDeniedException);

‎Event/InteractiveLoginEvent.php

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,6 @@ class InteractiveLoginEvent extends Event
2323
private $request;
2424
private $authenticationToken;
2525

26-
/**
27-
* @param Request $request A Request instance
28-
* @param TokenInterface $authenticationToken A TokenInterface instance
29-
*/
3026
public function __construct(Request $request, TokenInterface $authenticationToken)
3127
{
3228
$this->request = $request;

‎Firewall.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,13 @@ class Firewall implements EventSubscriberInterface
3333
private $dispatcher;
3434
private $exceptionListeners;
3535

36-
/**
37-
* @param FirewallMapInterface $map A FirewallMapInterface instance
38-
* @param EventDispatcherInterface $dispatcher An EventDispatcherInterface instance
39-
*/
4036
public function __construct(FirewallMapInterface $map, EventDispatcherInterface $dispatcher)
4137
{
4238
$this->map = $map;
4339
$this->dispatcher = $dispatcher;
4440
$this->exceptionListeners = new \SplObjectStorage();
4541
}
4642

47-
/**
48-
* Handles security.
49-
*
50-
* @param GetResponseEvent $event An GetResponseEvent instance
51-
*/
5243
public function onKernelRequest(GetResponseEvent $event)
5344
{
5445
if (!$event->isMasterRequest()) {

‎Firewall/AbstractAuthenticationListener.php

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,6 @@ public function __construct(TokenStorageInterface $tokenStorage, AuthenticationM
108108

109109
/**
110110
* Sets the RememberMeServices implementation to use.
111-
*
112-
* @param RememberMeServicesInterface $rememberMeServices
113111
*/
114112
public function setRememberMeServices(RememberMeServicesInterface $rememberMeServices)
115113
{
@@ -119,8 +117,6 @@ public function setRememberMeServices(RememberMeServicesInterface $rememberMeSer
119117
/**
120118
* Handles form based authentication.
121119
*
122-
* @param GetResponseEvent $event A GetResponseEvent instance
123-
*
124120
* @throws \RuntimeException
125121
* @throws SessionUnavailableException
126122
*/
@@ -168,8 +164,6 @@ final public function handle(GetResponseEvent $event)
168164
* but a subclass could change this to only authenticate requests where a
169165
* certain parameters is present.
170166
*
171-
* @param Request $request
172-
*
173167
* @return bool
174168
*/
175169
protected function requiresAuthentication(Request $request)
@@ -180,8 +174,6 @@ protected function requiresAuthentication(Request $request)
180174
/**
181175
* Performs authentication.
182176
*
183-
* @param Request $request A Request instance
184-
*
185177
* @return TokenInterface|Response|null The authenticated token, null if full authentication is not possible, or a Response
186178
*
187179
* @throws AuthenticationException if the authentication fails

‎Firewall/AbstractPreAuthenticatedListener.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,6 @@ public function __construct(TokenStorageInterface $tokenStorage, AuthenticationM
4949

5050
/**
5151
* Handles pre-authentication.
52-
*
53-
* @param GetResponseEvent $event A GetResponseEvent instance
5452
*/
5553
final public function handle(GetResponseEvent $event)
5654
{
@@ -97,8 +95,6 @@ final public function handle(GetResponseEvent $event)
9795

9896
/**
9997
* Clears a PreAuthenticatedToken for this provider (if present).
100-
*
101-
* @param AuthenticationException $exception
10298
*/
10399
private function clearToken(AuthenticationException $exception)
104100
{
@@ -115,8 +111,6 @@ private function clearToken(AuthenticationException $exception)
115111
/**
116112
* Gets the user and credentials from the Request.
117113
*
118-
* @param Request $request A Request instance
119-
*
120114
* @return array An array composed of the user and the credentials
121115
*/
122116
abstract protected function getPreAuthenticatedData(Request $request);

‎Firewall/AccessListener.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,6 @@ public function __construct(TokenStorageInterface $tokenStorage, AccessDecisionM
4242
/**
4343
* Handles access authorization.
4444
*
45-
* @param GetResponseEvent $event A GetResponseEvent instance
46-
*
4745
* @throws AccessDeniedException
4846
* @throws AuthenticationCredentialsNotFoundException
4947
*/

‎Firewall/AnonymousAuthenticationListener.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ public function __construct(TokenStorageInterface $tokenStorage, $secret, Logger
4141

4242
/**
4343
* Handles anonymous authentication.
44-
*
45-
* @param GetResponseEvent $event A GetResponseEvent instance
4644
*/
4745
public function handle(GetResponseEvent $event)
4846
{

‎Firewall/BasicAuthenticationListener.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,6 @@ public function __construct(TokenStorageInterface $tokenStorage, AuthenticationM
4949

5050
/**
5151
* Handles basic authentication.
52-
*
53-
* @param GetResponseEvent $event A GetResponseEvent instance
5452
*/
5553
public function handle(GetResponseEvent $event)
5654
{

‎Firewall/ChannelListener.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ public function __construct(AccessMapInterface $map, AuthenticationEntryPointInt
3737

3838
/**
3939
* Handles channel management.
40-
*
41-
* @param GetResponseEvent $event A GetResponseEvent instance
4240
*/
4341
public function handle(GetResponseEvent $event)
4442
{

‎Firewall/ContextListener.php

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,6 @@ public function __construct(TokenStorageInterface $tokenStorage, array $userProv
6060

6161
/**
6262
* Reads the Security Token from the session.
63-
*
64-
* @param GetResponseEvent $event A GetResponseEvent instance
6563
*/
6664
public function handle(GetResponseEvent $event)
6765
{
@@ -100,8 +98,6 @@ public function handle(GetResponseEvent $event)
10098

10199
/**
102100
* Writes the security token into the session.
103-
*
104-
* @param FilterResponseEvent $event A FilterResponseEvent instance
105101
*/
106102
public function onKernelResponse(FilterResponseEvent $event)
107103
{
@@ -135,8 +131,6 @@ public function onKernelResponse(FilterResponseEvent $event)
135131
/**
136132
* Refreshes the user by reloading it from the user provider.
137133
*
138-
* @param TokenInterface $token
139-
*
140134
* @return TokenInterface|null
141135
*
142136
* @throws \RuntimeException

‎Firewall/DigestAuthenticationListener.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,6 @@ public function __construct(TokenStorageInterface $tokenStorage, UserProviderInt
5353
/**
5454
* Handles digest authentication.
5555
*
56-
* @param GetResponseEvent $event A GetResponseEvent instance
57-
*
5856
* @throws AuthenticationServiceException
5957
*/
6058
public function handle(GetResponseEvent $event)

‎Firewall/ExceptionListener.php

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ public function __construct(TokenStorageInterface $tokenStorage, AuthenticationT
6464

6565
/**
6666
* Registers a onKernelException listener to take care of security exceptions.
67-
*
68-
* @param EventDispatcherInterface $dispatcher An EventDispatcherInterface instance
6967
*/
7068
public function register(EventDispatcherInterface $dispatcher)
7169
{
@@ -74,8 +72,6 @@ public function register(EventDispatcherInterface $dispatcher)
7472

7573
/**
7674
* Unregisters the dispatcher.
77-
*
78-
* @param EventDispatcherInterface $dispatcher An EventDispatcherInterface instance
7975
*/
8076
public function unregister(EventDispatcherInterface $dispatcher)
8177
{
@@ -84,8 +80,6 @@ public function unregister(EventDispatcherInterface $dispatcher)
8480

8581
/**
8682
* Handles security related exceptions.
87-
*
88-
* @param GetResponseForExceptionEvent $event An GetResponseForExceptionEvent instance
8983
*/
9084
public function onKernelException(GetResponseForExceptionEvent $event)
9185
{
@@ -170,9 +164,6 @@ private function handleLogoutException(LogoutException $exception)
170164
}
171165

172166
/**
173-
* @param Request $request
174-
* @param AuthenticationException $authException
175-
*
176167
* @return Response
177168
*
178169
* @throws AuthenticationException
@@ -203,9 +194,6 @@ private function startAuthentication(Request $request, AuthenticationException $
203194
return $this->authenticationEntryPoint->start($request, $authException);
204195
}
205196

206-
/**
207-
* @param Request $request
208-
*/
209197
protected function setTargetPath(Request $request)
210198
{
211199
// session isn't required when using HTTP basic authentication mechanism for example

‎Firewall/ListenerInterface.php

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,5 @@
2020
*/
2121
interface ListenerInterface
2222
{
23-
/**
24-
* This interface must be implemented by firewall listeners.
25-
*
26-
* @param GetResponseEvent $event
27-
*/
2823
public function handle(GetResponseEvent $event);
2924
}

‎Firewall/LogoutListener.php

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,6 @@ public function __construct(TokenStorageInterface $tokenStorage, HttpUtils $http
7777
$this->handlers = array();
7878
}
7979

80-
/**
81-
* Adds a logout handler.
82-
*
83-
* @param LogoutHandlerInterface $handler
84-
*/
8580
public function addHandler(LogoutHandlerInterface $handler)
8681
{
8782
$this->handlers[] = $handler;
@@ -93,8 +88,6 @@ public function addHandler(LogoutHandlerInterface $handler)
9388
* If a CsrfTokenManagerInterface instance is available, it will be used to
9489
* validate the request.
9590
*
96-
* @param GetResponseEvent $event A GetResponseEvent instance
97-
*
9891
* @throws LogoutException if the CSRF token is invalid
9992
* @throws \RuntimeException if the LogoutSuccessHandlerInterface instance does not return a response
10093
*/
@@ -138,8 +131,6 @@ public function handle(GetResponseEvent $event)
138131
* but a subclass could change this to logout requests where
139132
* certain parameters is present.
140133
*
141-
* @param Request $request
142-
*
143134
* @return bool
144135
*/
145136
protected function requiresLogout(Request $request)

‎Firewall/RememberMeListener.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,6 @@ public function __construct(TokenStorageInterface $tokenStorage, RememberMeServi
6060

6161
/**
6262
* Handles remember-me cookie based authentication.
63-
*
64-
* @param GetResponseEvent $event A GetResponseEvent instance
6563
*/
6664
public function handle(GetResponseEvent $event)
6765
{

‎Firewall/SimplePreAuthenticationListener.php

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,6 @@ public function __construct(TokenStorageInterface $tokenStorage, AuthenticationM
6363

6464
/**
6565
* Handles basic authentication.
66-
*
67-
* @param GetResponseEvent $event A GetResponseEvent instance
6866
*/
6967
public function handle(GetResponseEvent $event)
7068
{

‎Firewall/SwitchUserListener.php

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,6 @@ public function __construct(TokenStorageInterface $tokenStorage, UserProviderInt
6868
/**
6969
* Handles the switch to another user.
7070
*
71-
* @param GetResponseEvent $event A GetResponseEvent instance
72-
*
7371
* @throws \LogicException if switching to a user failed
7472
*/
7573
public function handle(GetResponseEvent $event)
@@ -101,8 +99,6 @@ public function handle(GetResponseEvent $event)
10199
/**
102100
* Attempts to switch to another user.
103101
*
104-
* @param Request $request A Request instance
105-
*
106102
* @return TokenInterface|null The new TokenInterface if successfully switched, null otherwise
107103
*
108104
* @throws \LogicException
@@ -150,8 +146,6 @@ private function attemptSwitchUser(Request $request)
150146
/**
151147
* Attempts to exit from an already switched user.
152148
*
153-
* @param Request $request A Request instance
154-
*
155149
* @return TokenInterface The original TokenInterface instance
156150
*
157151
* @throws AuthenticationCredentialsNotFoundException
@@ -174,8 +168,6 @@ private function attemptExitUser(Request $request)
174168
/**
175169
* Gets the original Token from a switched one.
176170
*
177-
* @param TokenInterface $token A switched TokenInterface instance
178-
*
179171
* @return TokenInterface|false The original TokenInterface instance, false if the current TokenInterface is not switched
180172
*/
181173
private function getOriginalToken(TokenInterface $token)

0 commit comments

Comments
 (0)