vendor/symfony/doctrine-bridge/Security/User/EntityUserProvider.php line 49

  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\Bridge\Doctrine\Security\User;
  14. use Doctrine\Persistence\ManagerRegistry;
  15. use Doctrine\Persistence\Mapping\ClassMetadata;
  16. use Doctrine\Persistence\ObjectManager;
  17. use Doctrine\Persistence\ObjectRepository;
  18. use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
  19. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  20. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  21. use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
  22. use Symfony\Component\Security\Core\User\UserInterface;
  23. use Symfony\Component\Security\Core\User\UserProviderInterface;
  25. /**
  26.  * Wrapper around a Doctrine ObjectManager.
  27.  *
  28.  * Provides provisioning for Doctrine entity users.
  29.  *
  30.  * @author Fabien Potencier <fabien@symfony.com>
  31.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  32.  */
  33. class EntityUserProvider implements UserProviderInterface, PasswordUpgraderInterface
  34. {
  35.     private ManagerRegistry $registry;
  36.     private ?string $managerName;
  37.     private string $classOrAlias;
  38.     private string $class;
  39.     private ?string $property;
  41.     public function __construct(ManagerRegistry $registry, string $classOrAlias, string $property = null, string $managerName = null)
  42.     {
  43.         $this->registry = $registry;
  44.         $this->managerName = $managerName;
  45.         $this->classOrAlias = $classOrAlias;
  46.         $this->property = $property;
  47.     }
  49.     public function loadUserByIdentifier(string $identifier): UserInterface
  50.     {
  51.         $repository = $this->getRepository();
  52.         if (null !== $this->property) {
  53.             $user = $repository->findOneBy([$this->property => $identifier]);
  54.         } else {
  55.             if (!$repository instanceof UserLoaderInterface) {
  56.                 throw new \InvalidArgumentException(sprintf('You must either make the "%s" entity Doctrine Repository ("%s") implement "Symfony\Bridge\Doctrine\Security\User\UserLoaderInterface" or set the "property" option in the corresponding entity provider configuration.', $this->classOrAlias, get_debug_type($repository)));
  57.             }
  59.             $user = $repository->loadUserByIdentifier($identifier);
  60.         }
  62.         if (null === $user) {
  63.             $e = new UserNotFoundException(sprintf('User "%s" not found.', $identifier));
  64.             $e->setUserIdentifier($identifier);
  66.             throw $e;
  67.         }
  69.         return $user;
  70.     }
  72.     public function refreshUser(UserInterface $user): UserInterface
  73.     {
  74.         $class = $this->getClass();
  75.         if (!$user instanceof $class) {
  76.             throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.', get_debug_type($user)));
  77.         }
  79.         $repository = $this->getRepository();
  80.         if ($repository instanceof UserProviderInterface) {
  81.             $refreshedUser = $repository->refreshUser($user);
  82.         } else {
  83.             // The user must be reloaded via the primary key as all other data
  84.             // might have changed without proper persistence in the database.
  85.             // That's the case when the user has been changed by a form with
  86.             // validation errors.
  87.             if (!$id = $this->getClassMetadata()->getIdentifierValues($user)) {
  88.                 throw new \InvalidArgumentException('You cannot refresh a user from the EntityUserProvider that does not contain an identifier. The user object has to be serialized with its own identifier mapped by Doctrine.');
  89.             }
  91.             $refreshedUser = $repository->find($id);
  92.             if (null === $refreshedUser) {
  93.                 $e = new UserNotFoundException('User with id '.json_encode($id).' not found.');
  94.                 $e->setUserIdentifier(json_encode($id));
  96.                 throw $e;
  97.             }
  98.         }
  100.         return $refreshedUser;
  101.     }
  103.     public function supportsClass(string $class): bool
  104.     {
  105.         return $class === $this->getClass() || is_subclass_of($class, $this->getClass());
  106.     }
  108.     /**
  109.      * @final
  110.      */
  111.     public function upgradePassword(PasswordAuthenticatedUserInterface $user, string $newHashedPassword): void
  112.     {
  113.         $class = $this->getClass();
  114.         if (!$user instanceof $class) {
  115.             throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.', get_debug_type($user)));
  116.         }
  118.         $repository = $this->getRepository();
  119.         if ($repository instanceof PasswordUpgraderInterface) {
  120.             $repository->upgradePassword($user, $newHashedPassword);
  121.         }
  122.     }
  124.     private function getObjectManager(): ObjectManager
  125.     {
  126.         return $this->registry->getManager($this->managerName);
  127.     }
  129.     private function getRepository(): ObjectRepository
  130.     {
  131.         return $this->getObjectManager()->getRepository($this->classOrAlias);
  132.     }
  134.     private function getClass(): string
  135.     {
  136.         if (!isset($this->class)) {
  137.             $class = $this->classOrAlias;
  139.             if (str_contains($class, ':')) {
  140.                 $class = $this->getClassMetadata()->getName();
  141.             }
  143.             $this->class = $class;
  144.         }
  146.         return $this->class;
  147.     }
  149.     private function getClassMetadata(): ClassMetadata
  150.     {
  151.         return $this->getObjectManager()->getClassMetadata($this->classOrAlias);
  152.     }
  153. }