vendor/symfony/security-core/Encoder/UserPasswordEncoder.php line 28

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  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\Hasher\UserPasswordHasher;
  15. use Symfony\Component\Security\Core\User\LegacyPasswordAuthenticatedUserInterface;
  16. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  17. use Symfony\Component\Security\Core\User\UserInterface;
  19. trigger_deprecation('symfony/security-core', '5.3', 'The "%s" class is deprecated, use "%s" instead.', UserPasswordEncoder::class, UserPasswordHasher::class);
  21. /**
  22.  * A generic password encoder.
  23.  *
  24.  * @author Ariel Ferrandini <arielferrandini@gmail.com>
  25.  *
  26.  * @deprecated since Symfony 5.3, use {@link UserPasswordHasher} instead
  27.  */
  28. class UserPasswordEncoder implements UserPasswordEncoderInterface
  29. {
  30.     private $encoderFactory;
  32.     public function __construct(EncoderFactoryInterface $encoderFactory)
  33.     {
  34.         $this->encoderFactory = $encoderFactory;
  35.     }
  37.     /**
  38.      * {@inheritdoc}
  39.      */
  40.     public function encodePassword(UserInterface $user, string $plainPassword)
  41.     {
  42.         $encoder = $this->encoderFactory->getEncoder($user);
  44.         if (!$user instanceof PasswordAuthenticatedUserInterface) {
  45.             trigger_deprecation('symfony/password-hasher', '5.3', 'Not implementing the "%s" interface while using "%s" is deprecated, the "%s" class should implement it.', PasswordAuthenticatedUserInterface::class, __CLASS__, get_debug_type($user));
  46.         }
  48.         $salt = $user->getSalt();
  49.         if ($salt && !$user instanceof LegacyPasswordAuthenticatedUserInterface) {
  50.             trigger_deprecation('symfony/password-hasher', '5.3', 'Returning a string from "getSalt()" without implementing the "%s" interface is deprecated, the "%s" class should implement it.', LegacyPasswordAuthenticatedUserInterface::class, get_debug_type($user));
  51.         }
  53.         return $encoder->encodePassword($plainPassword, $user->getSalt());
  54.     }
  56.     /**
  57.      * {@inheritdoc}
  58.      */
  59.     public function isPasswordValid(UserInterface $user, string $raw)
  60.     {
  61.         if (null === $user->getPassword()) {
  62.             return false;
  63.         }
  65.         $encoder = $this->encoderFactory->getEncoder($user);
  67.         return $encoder->isPasswordValid($user->getPassword(), $raw, $user->getSalt());
  68.     }
  70.     /**
  71.      * {@inheritdoc}
  72.      */
  73.     public function needsRehash(UserInterface $user): bool
  74.     {
  75.         if (null === $user->getPassword()) {
  76.             return false;
  77.         }
  79.         $encoder = $this->encoderFactory->getEncoder($user);
  81.         return $encoder->needsRehash($user->getPassword());
  82.     }
  83. }