PasswordUpgraderInterface.php 884 B

123456789101112131415161718192021222324252627
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Security\Core\User;
  11. /**
  12. * @author Nicolas Grekas <p@tchwork.com>
  13. */
  14. interface PasswordUpgraderInterface
  15. {
  16. /**
  17. * Upgrades the encoded password of a user, typically for using a better hash algorithm.
  18. *
  19. * This method should persist the new password in the user storage and update the $user object accordingly.
  20. * Because you don't want your users not being able to log in, this method should be opportunistic:
  21. * it's fine if it does nothing or if it fails without throwing any exception.
  22. */
  23. public function upgradePassword(UserInterface $user, string $newEncodedPassword): void;
  24. }