Fix deprecation messages

fabpot · fabpot · commit 64e759a1c6f8 · 2021-08-13T17:54:02.000+02:00
diff --git a/Authentication/AuthenticatorManager.php b/Authentication/AuthenticatorManager.php
@@ -75,7 +75,7 @@ public function __construct(iterable $authenticators, TokenStorageInterface $tok
     public function authenticateUser(UserInterface $user, AuthenticatorInterface $authenticator, Request $request, array $badges = []): ?Response
     {
         // create an authenticated token for the User
-        // @deprecated since 5.3, change to $user->getUserIdentifier() in 6.0
+        // @deprecated since Symfony 5.3, change to $user->getUserIdentifier() in 6.0
         $token = $authenticator->createAuthenticatedToken($passport = new SelfValidatingPassport(new UserBadge(method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername(), function () use ($user) { return $user; }), $badges), $this->firewallName);
 
         // announce the authenticated token
@@ -229,7 +229,7 @@ private function executeAuthenticator(AuthenticatorInterface $authenticator, Req
 
     private function handleAuthenticationSuccess(TokenInterface $authenticatedToken, PassportInterface $passport, Request $request, AuthenticatorInterface $authenticator): ?Response
     {
-        // @deprecated since 5.3
+        // @deprecated since Symfony 5.3
         $user = $authenticatedToken->getUser();
         if ($user instanceof UserInterface && !method_exists($user, 'getUserIdentifier')) {
             trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "getUserIdentifier(): string" in user class "%s" is deprecated. This method will replace "getUsername()" in Symfony 6.0.', get_debug_type($authenticatedToken->getUser()));
diff --git a/Authentication/DefaultAuthenticationSuccessHandler.php b/Authentication/DefaultAuthenticationSuccessHandler.php
@@ -30,7 +30,7 @@ class DefaultAuthenticationSuccessHandler implements AuthenticationSuccessHandle
 
     protected $httpUtils;
     protected $options;
-    /** @deprecated since 5.2, use $firewallName instead */
+    /** @deprecated since Symfony 5.2, use $firewallName instead */
     protected $providerKey;
     protected $firewallName;
     protected $defaultOptions = [
@@ -78,7 +78,7 @@ public function setOptions(array $options)
      *
      * @return string
      *
-     * @deprecated since 5.2, use getFirewallName() instead
+     * @deprecated since Symfony 5.2, use getFirewallName() instead
      */
     public function getProviderKey()
     {
diff --git a/Authenticator/AbstractPreAuthenticatedAuthenticator.php b/Authenticator/AbstractPreAuthenticatedAuthenticator.php
@@ -86,7 +86,7 @@ public function supports(Request $request): ?bool
 
     public function authenticate(Request $request): PassportInterface
     {
-        // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
+        // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
         $method = 'loadUserByIdentifier';
         if (!method_exists($this->userProvider, 'loadUserByIdentifier')) {
             trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($this->userProvider));
diff --git a/Authenticator/FormLoginAuthenticator.php b/Authenticator/FormLoginAuthenticator.php
@@ -81,7 +81,7 @@ public function authenticate(Request $request): PassportInterface
     {
         $credentials = $this->getCredentials($request);
 
-        // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
+        // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
         $method = 'loadUserByIdentifier';
         if (!method_exists($this->userProvider, 'loadUserByIdentifier')) {
             trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($this->userProvider));
diff --git a/Authenticator/HttpBasicAuthenticator.php b/Authenticator/HttpBasicAuthenticator.php
@@ -64,7 +64,7 @@ public function authenticate(Request $request): PassportInterface
         $username = $request->headers->get('PHP_AUTH_USER');
         $password = $request->headers->get('PHP_AUTH_PW', '');
 
-        // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
+        // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
         $method = 'loadUserByIdentifier';
         if (!method_exists($this->userProvider, 'loadUserByIdentifier')) {
             trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($this->userProvider));
diff --git a/Authenticator/JsonLoginAuthenticator.php b/Authenticator/JsonLoginAuthenticator.php
@@ -91,7 +91,7 @@ public function authenticate(Request $request): PassportInterface
             throw $e;
         }
 
-        // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
+        // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
         $method = 'loadUserByIdentifier';
         if (!method_exists($this->userProvider, 'loadUserByIdentifier')) {
             trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($this->userProvider));
diff --git a/EventListener/UserProviderListener.php b/EventListener/UserProviderListener.php
@@ -45,7 +45,7 @@ public function checkPassport(CheckPassportEvent $event): void
             return;
         }
 
-        // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
+        // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
         if (method_exists($this->userProvider, 'loadUserByIdentifier')) {
             $badge->setUserLoader([$this->userProvider, 'loadUserByIdentifier']);
         } else {
diff --git a/Firewall/AbstractAuthenticationListener.php b/Firewall/AbstractAuthenticationListener.php
@@ -199,7 +199,7 @@ private function onFailure(Request $request, AuthenticationException $failed): R
     private function onSuccess(Request $request, TokenInterface $token): Response
     {
         if (null !== $this->logger) {
-            // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0
+            // @deprecated since Symfony 5.3, change to $token->getUserIdentifier() in 6.0
             $this->logger->info('User has been authenticated successfully.', ['username' => method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getUsername()]);
         }
 
diff --git a/Firewall/AbstractPreAuthenticatedListener.php b/Firewall/AbstractPreAuthenticatedListener.php
@@ -87,7 +87,7 @@ public function authenticate(RequestEvent $event)
         }
 
         if (null !== $token = $this->tokenStorage->getToken()) {
-            // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0
+            // @deprecated since Symfony 5.3, change to $token->getUserIdentifier() in 6.0
             if ($token instanceof PreAuthenticatedToken && $this->providerKey == $token->getFirewallName() && $token->isAuthenticated() && (method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getUsername()) === $user) {
                 return;
             }
diff --git a/Firewall/BasicAuthenticationListener.php b/Firewall/BasicAuthenticationListener.php
@@ -77,7 +77,7 @@ public function authenticate(RequestEvent $event)
         }
 
         if (null !== $token = $this->tokenStorage->getToken()) {
-            // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0
+            // @deprecated since Symfony 5.3, change to $token->getUserIdentifier() in 6.0
             if ($token instanceof UsernamePasswordToken && $token->isAuthenticated() && (method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getUsername()) === $username) {
                 return;
             }
diff --git a/Firewall/ContextListener.php b/Firewall/ContextListener.php
@@ -234,7 +234,7 @@ protected function refreshUser(TokenInterface $token): ?TokenInterface
                     $userDeauthenticated = true;
 
                     if (null !== $this->logger) {
-                        // @deprecated since 5.3, change to $refreshedUser->getUserIdentifier() in 6.0
+                        // @deprecated since Symfony 5.3, change to $refreshedUser->getUserIdentifier() in 6.0
                         $this->logger->debug('Cannot refresh token because user has changed.', ['username' => method_exists($refreshedUser, 'getUserIdentifier') ? $refreshedUser->getUserIdentifier() : $refreshedUser->getUsername(), 'provider' => \get_class($provider)]);
                     }
 
@@ -244,11 +244,11 @@ protected function refreshUser(TokenInterface $token): ?TokenInterface
                 $token->setUser($refreshedUser);
 
                 if (null !== $this->logger) {
-                    // @deprecated since 5.3, change to $refreshedUser->getUserIdentifier() in 6.0
+                    // @deprecated since Symfony 5.3, change to $refreshedUser->getUserIdentifier() in 6.0
                     $context = ['provider' => \get_class($provider), 'username' => method_exists($refreshedUser, 'getUserIdentifier') ? $refreshedUser->getUserIdentifier() : $refreshedUser->getUsername()];
 
                     if ($token instanceof SwitchUserToken) {
-                        // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0
+                        // @deprecated since Symfony 5.3, change to $token->getUserIdentifier() in 6.0
                         $context['impersonator_username'] = method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getOriginalToken()->getUsername();
                     }
 
diff --git a/Firewall/SwitchUserListener.php b/Firewall/SwitchUserListener.php
@@ -140,7 +140,7 @@ private function attemptSwitchUser(Request $request, string $username): ?TokenIn
         $originalToken = $this->getOriginalToken($token);
 
         if (null !== $originalToken) {
-            // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0
+            // @deprecated since Symfony 5.3, change to $token->getUserIdentifier() in 6.0
             if ((method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getUsername()) === $username) {
                 return $token;
             }
@@ -149,7 +149,7 @@ private function attemptSwitchUser(Request $request, string $username): ?TokenIn
             $token = $this->attemptExitUser($request);
         }
 
-        // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0
+        // @deprecated since Symfony 5.3, change to $token->getUserIdentifier() in 6.0
         $currentUsername = method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getUsername();
         $nonExistentUsername = '_'.md5(random_bytes(8).$username);
 
diff --git a/Firewall/UsernamePasswordJsonAuthenticationListener.php b/Firewall/UsernamePasswordJsonAuthenticationListener.php
@@ -153,7 +153,7 @@ public function authenticate(RequestEvent $event)
     private function onSuccess(Request $request, TokenInterface $token): ?Response
     {
         if (null !== $this->logger) {
-            // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0
+            // @deprecated since Symfony 5.3, change to $token->getUserIdentifier() in 6.0
             $this->logger->info('User has been authenticated successfully.', ['username' => method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getUsername()]);
         }
 
diff --git a/LoginLink/LoginLinkHandler.php b/LoginLink/LoginLinkHandler.php
@@ -50,7 +50,7 @@ public function createLoginLink(UserInterface $user, Request $request = null): L
 
         $expires = $expiresAt->format('U');
         $parameters = [
-            // @deprecated since 5.3, change to $user->getUserIdentifier() in 6.0
+            // @deprecated since Symfony 5.3, change to $user->getUserIdentifier() in 6.0
             'user' => method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername(),
             'expires' => $expires,
             'hash' => $this->signatureHashUtil->computeSignatureHash($user, $expires),
@@ -85,7 +85,7 @@ public function consumeLoginLink(Request $request): UserInterface
         $userIdentifier = $request->get('user');
 
         try {
-            // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
+            // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
             if (method_exists($this->userProvider, 'loadUserByIdentifier')) {
                 $user = $this->userProvider->loadUserByIdentifier($userIdentifier);
             } else {
diff --git a/RememberMe/AbstractRememberMeHandler.php b/RememberMe/AbstractRememberMeHandler.php
@@ -63,7 +63,7 @@ abstract protected function processRememberMe(RememberMeDetails $rememberMeDetai
     public function consumeRememberMeCookie(RememberMeDetails $rememberMeDetails): UserInterface
     {
         try {
-            // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
+            // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0
             $method = 'loadUserByIdentifier';
             if (!method_exists($this->userProvider, 'loadUserByIdentifier')) {
                 trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($this->userProvider));
diff --git a/RememberMe/PersistentTokenBasedRememberMeServices.php b/RememberMe/PersistentTokenBasedRememberMeServices.php
@@ -94,7 +94,7 @@ protected function processAutoLoginCookie(array $cookieParts, Request $request)
         );
 
         $userProvider = $this->getUserProvider($persistentToken->getClass());
-        // @deprecated since 5.3, change to $persistentToken->getUserIdentifier() in 6.0
+        // @deprecated since Symfony 5.3, change to $persistentToken->getUserIdentifier() in 6.0
         if (method_exists($persistentToken, 'getUserIdentifier')) {
             $userIdentifier = $persistentToken->getUserIdentifier();
         } else {
@@ -103,7 +103,7 @@ protected function processAutoLoginCookie(array $cookieParts, Request $request)
             $userIdentifier = $persistentToken->getUsername();
         }
 
-        // @deprecated since 5.3, change to $userProvider->loadUserByIdentifier() in 6.0
+        // @deprecated since Symfony 5.3, change to $userProvider->loadUserByIdentifier() in 6.0
         if (method_exists($userProvider, 'loadUserByIdentifier')) {
             return $userProvider->loadUserByIdentifier($userIdentifier);
         } else {
@@ -124,7 +124,7 @@ protected function onLoginSuccess(Request $request, Response $response, TokenInt
         $this->tokenProvider->createNewToken(
             new PersistentToken(
                 \get_class($user = $token->getUser()),
-                // @deprecated since 5.3, change to $user->getUserIdentifier() in 6.0
+                // @deprecated since Symfony 5.3, change to $user->getUserIdentifier() in 6.0
                 method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername(),
                 $series,
                 $this->generateHash($tokenValue),
diff --git a/RememberMe/TokenBasedRememberMeServices.php b/RememberMe/TokenBasedRememberMeServices.php
@@ -41,7 +41,7 @@ protected function processAutoLoginCookie(array $cookieParts, Request $request)
         }
         try {
             $userProvider = $this->getUserProvider($class);
-            // @deprecated since 5.3, change to $userProvider->loadUserByIdentifier() in 6.0
+            // @deprecated since Symfony 5.3, change to $userProvider->loadUserByIdentifier() in 6.0
             if (method_exists($userProvider, 'loadUserByIdentifier')) {
                 $user = $userProvider->loadUserByIdentifier($userIdentifier);
             } else {
@@ -79,7 +79,7 @@ protected function onLoginSuccess(Request $request, Response $response, TokenInt
     {
         $user = $token->getUser();
         $expires = time() + $this->options['lifetime'];
-        // @deprecated since 5.3, change to $user->getUserIdentifier() in 6.0
+        // @deprecated since Symfony 5.3, change to $user->getUserIdentifier() in 6.0
         $value = $this->generateCookieValue(\get_class($user), method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername(), $expires, $user->getPassword());
 
         $response->headers->setCookie(

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class DefaultAuthenticationSuccessHandler implements AuthenticationSuccessHandle`
`30`	`30`
`31`	`31`	`protected $httpUtils;`
`32`	`32`	`protected $options;`
`33`		`- /** @deprecated since 5.2, use $firewallName instead */`
	`33`	`+ /** @deprecated since Symfony 5.2, use $firewallName instead */`
`34`	`34`	`protected $providerKey;`
`35`	`35`	`protected $firewallName;`
`36`	`36`	`protected $defaultOptions = [`
`@@ -78,7 +78,7 @@ public function setOptions(array $options)`
`78`	`78`	`*`
`79`	`79`	`* @return string`
`80`	`80`	`*`
`81`		`- * @deprecated since 5.2, use getFirewallName() instead`
	`81`	`+ * @deprecated since Symfony 5.2, use getFirewallName() instead`
`82`	`82`	`*/`
`83`	`83`	`public function getProviderKey()`
`84`	`84`	`{`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public function supports(Request $request): ?bool`
`86`	`86`
`87`	`87`	`public function authenticate(Request $request): PassportInterface`
`88`	`88`	`{`
`89`		`- // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0`
	`89`	`+ // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0`
`90`	`90`	`$method = 'loadUserByIdentifier';`
`91`	`91`	`if (!method_exists($this->userProvider, 'loadUserByIdentifier')) {`
`92`	`92`	`trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($this->userProvider));`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public function authenticate(Request $request): PassportInterface`
`81`	`81`	`{`
`82`	`82`	`$credentials = $this->getCredentials($request);`
`83`	`83`
`84`		`- // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0`
	`84`	`+ // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0`
`85`	`85`	`$method = 'loadUserByIdentifier';`
`86`	`86`	`if (!method_exists($this->userProvider, 'loadUserByIdentifier')) {`
`87`	`87`	`trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($this->userProvider));`
Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ public function authenticate(Request $request): PassportInterface`
`91`	`91`	`throw $e;`
`92`	`92`	`}`
`93`	`93`
`94`		`- // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0`
	`94`	`+ // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0`
`95`	`95`	`$method = 'loadUserByIdentifier';`
`96`	`96`	`if (!method_exists($this->userProvider, 'loadUserByIdentifier')) {`
`97`	`97`	`trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($this->userProvider));`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public function checkPassport(CheckPassportEvent $event): void`
`45`	`45`	`return;`
`46`	`46`	`}`
`47`	`47`
`48`		`- // @deprecated since 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0`
	`48`	`+ // @deprecated since Symfony 5.3, change to $this->userProvider->loadUserByIdentifier() in 6.0`
`49`	`49`	`if (method_exists($this->userProvider, 'loadUserByIdentifier')) {`
`50`	`50`	`$badge->setUserLoader([$this->userProvider, 'loadUserByIdentifier']);`
`51`	`51`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -199,7 +199,7 @@ private function onFailure(Request $request, AuthenticationException $failed): R`
`199`	`199`	`private function onSuccess(Request $request, TokenInterface $token): Response`
`200`	`200`	`{`
`201`	`201`	`if (null !== $this->logger) {`
`202`		`- // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0`
	`202`	`+ // @deprecated since Symfony 5.3, change to $token->getUserIdentifier() in 6.0`
`203`	`203`	`$this->logger->info('User has been authenticated successfully.', ['username' => method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getUsername()]);`
`204`	`204`	`}`
`205`	`205`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ public function authenticate(RequestEvent $event)`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`if (null !== $token = $this->tokenStorage->getToken()) {`
`90`		`- // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0`
	`90`	`+ // @deprecated since Symfony 5.3, change to $token->getUserIdentifier() in 6.0`
`91`	`91`	`if ($token instanceof PreAuthenticatedToken && $this->providerKey == $token->getFirewallName() && $token->isAuthenticated() && (method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getUsername()) === $user) {`
`92`	`92`	`return;`
`93`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public function authenticate(RequestEvent $event)`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`if (null !== $token = $this->tokenStorage->getToken()) {`
`80`		`- // @deprecated since 5.3, change to $token->getUserIdentifier() in 6.0`
	`80`	`+ // @deprecated since Symfony 5.3, change to $token->getUserIdentifier() in 6.0`
`81`	`81`	`if ($token instanceof UsernamePasswordToken && $token->isAuthenticated() && (method_exists($token, 'getUserIdentifier') ? $token->getUserIdentifier() : $token->getUsername()) === $username) {`
`82`	`82`	`return;`
`83`	`83`	`}`