Adjust the phpDoc deprecations

contao · Nov 12, 2021 · c6a4781 · c6a4781
1 parent 365aa32
commit c6a4781
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 7 deletions.
diff --git a/core-bundle/src/Resources/contao/library/Contao/User.php b/core-bundle/src/Resources/contao/library/Contao/User.php
@@ -455,10 +455,11 @@ public function getRoles()
 	 * @return User
 	 *
 	 * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
+	 *             Use Contao\User::loadUserByIdentifier() instead.
 	 */
 	public static function loadUserByUsername($username)
 	{
-		trigger_deprecation('contao/core-bundle', '4.13', 'Using "Contao\User::loadUserByUsername()" has been deprecated and will no longer work in Contao 5.0. Use Contao\User::loadUserByIdentifier() instead.');
+		trigger_deprecation('contao/core-bundle', '4.13', 'Using "Contao\User::loadUserByUsername()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\User::loadUserByIdentifier()" instead.');
 
 		return self::loadUserByIdentifier($username);
 	}
@@ -507,10 +508,11 @@ public static function loadUserByIdentifier(string $identifier): ?self
 	 * {@inheritdoc}
 	 *
 	 * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
+	 *             Use Contao\User::getUserIdentifier() instead.
 	 */
 	public function getUsername()
 	{
-		trigger_deprecation('contao/core-bundle', '4.13', 'Using "Contao\User::getUsername()" has been deprecated and will no longer work in Contao 5.0. Use Contao\User::getUserIdentifier() instead.');
+		trigger_deprecation('contao/core-bundle', '4.13', 'Using "Contao\User::getUsername()" has been deprecated and will no longer work in Contao 5.0. Use "Contao\User::getUserIdentifier()" instead.');
 
 		return $this->getUserIdentifier();
 	}

diff --git a/core-bundle/src/Security/User/ContaoUserProvider.php b/core-bundle/src/Security/User/ContaoUserProvider.php
@@ -50,11 +50,12 @@ public function __construct(ContaoFramework $framework, SessionInterface $sessio
     }
 
     /**
-     * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0.
+     * @deprecated Deprecated since Contao 4.13, to be removed in Contao 5.0;
+     *             use ContaoUserProvider::loadUserByIdentifier() instead
      */
     public function loadUserByUsername($username): User
     {
-        trigger_deprecation('contao/core-bundle', '4.13', 'Using "ContaoUserProvider::loadUserByUsername()" has been deprecated and will no longer work in Contao 5.0. Use ContaoUserProvider::loadUserByIdentifier() instead.');
+        trigger_deprecation('contao/core-bundle', '4.13', 'Using "ContaoUserProvider::loadUserByUsername()" has been deprecated and will no longer work in Contao 5.0. Use "ContaoUserProvider::loadUserByIdentifier()" instead.');
 
         return $this->loadUserByIdentifier($username);
     }

diff --git a/core-bundle/tests/Fixtures/src/Security/User/ForwardCompatibilityTokenInterface.php b/core-bundle/tests/Fixtures/src/Security/User/ForwardCompatibilityTokenInterface.php
@@ -15,7 +15,7 @@
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 
 /**
- * Can't add methods to existing interface, see https://github.com/sebastianbergmann/phpunit/issues/4732.
+ * @see https://github.com/sebastianbergmann/phpunit/issues/4732
  */
 interface ForwardCompatibilityTokenInterface extends TokenInterface
 {

diff --git a/core-bundle/tests/Fixtures/src/Security/User/ForwardCompatibilityUserInterface.php b/core-bundle/tests/Fixtures/src/Security/User/ForwardCompatibilityUserInterface.php
@@ -15,7 +15,7 @@
 use Symfony\Component\Security\Core\User\UserInterface;
 
 /**
- * Can't add methods to existing interface, see https://github.com/sebastianbergmann/phpunit/issues/4732.
+ * @see https://github.com/sebastianbergmann/phpunit/issues/4732
  */
 interface ForwardCompatibilityUserInterface extends UserInterface
 {

diff --git a/core-bundle/tests/Fixtures/src/Security/User/ForwardCompatibilityUserProviderInterface.php b/core-bundle/tests/Fixtures/src/Security/User/ForwardCompatibilityUserProviderInterface.php
@@ -16,7 +16,7 @@
 use Symfony\Component\Security\Core\User\UserProviderInterface;
 
 /**
- * Can't add methods to existing interface, see https://github.com/sebastianbergmann/phpunit/issues/4732.
+ * @see https://github.com/sebastianbergmann/phpunit/issues/4732
  */
 interface ForwardCompatibilityUserProviderInterface extends UserProviderInterface
 {