vendor/symfony/security-core/Encoder/PasswordEncoderInterface.php line 17

Open in your IDE?
  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <[email protected]>
  7. *
  8. * For the full copyright and license information, please view the LICENSE
  9. * file that was distributed with this source code.
  10. */
  12. namespace Symfony\Component\Security\Core\Encoder;
  14. use Symfony\Component\PasswordHasher\PasswordHasherInterface;
  15. use Symfony\Component\Security\Core\Exception\BadCredentialsException;
  17. trigger_deprecation('symfony/security-core', '5.3', 'The "%s" class is deprecated, use "%s" instead.', PasswordEncoderInterface::class, PasswordHasherInterface::class);
  19. /**
  20. * PasswordEncoderInterface is the interface for all encoders.
  21. *
  22. * @author Fabien Potencier <[email protected]>
  23. *
  24. * @deprecated since Symfony 5.3, use {@link PasswordHasherInterface} instead
  25. */
  26. interface PasswordEncoderInterface
  27. {
  28. /**
  29. * Encodes the raw password.
  30. *
  31. * @return string
  32. *
  33. * @throws BadCredentialsException If the raw password is invalid, e.g. excessively long
  34. * @throws \InvalidArgumentException If the salt is invalid
  35. */
  36. public function encodePassword(string $raw, ?string $salt);
  38. /**
  39. * Checks a raw password against an encoded password.
  40. *
  41. * @param string $encoded An encoded password
  42. * @param string $raw A raw password
  43. * @param string|null $salt The salt
  44. *
  45. * @return bool
  46. *
  47. * @throws \InvalidArgumentException If the salt is invalid
  48. */
  49. public function isPasswordValid(string $encoded, string $raw, ?string $salt);
  51. /**
  52. * Checks if an encoded password would benefit from rehashing.
  53. */
  54. public function needsRehash(string $encoded): bool;
  55. }