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

  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\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 Doctrine\Persistence\Proxy;
  19. use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
  20. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  21. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  22. use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
  23. use Symfony\Component\Security\Core\User\UserInterface;
  24. use Symfony\Component\Security\Core\User\UserProviderInterface;
  26. /**
  27.  * Wrapper around a Doctrine ObjectManager.
  28.  *
  29.  * Provides provisioning for Doctrine entity users.
  30.  *
  31.  * @author Fabien Potencier <[email protected]>
  32.  * @author Johannes M. Schmitt <[email protected]>
  33.  */
  34. class EntityUserProvider implements UserProviderInterface, PasswordUpgraderInterface
  35. {
  36.     private ManagerRegistry $registry;
  37.     private ?string $managerName;
  38.     private string $classOrAlias;
  39.     private string $class;
  40.     private ?string $property;
  42.     public function __construct(ManagerRegistry $registry, string $classOrAlias, string $property = null, string $managerName = null)
  43.     {
  44.         $this->registry = $registry;
  45.         $this->managerName = $managerName;
  46.         $this->classOrAlias = $classOrAlias;
  47.         $this->property = $property;
  48.     }
  50.     public function loadUserByIdentifier(string $identifier): UserInterface
  51.     {
  52.         $repository = $this->getRepository();
  53.         if (null !== $this->property) {
  54.             $user = $repository->findOneBy([$this->property => $identifier]);
  55.         } else {
  56.             if (!$repository instanceof UserLoaderInterface) {
  57.                 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)));
  58.             }
  60.             $user = $repository->loadUserByIdentifier($identifier);
  61.         }
  63.         if (null === $user) {
  64.             $e = new UserNotFoundException(sprintf('User "%s" not found.', $identifier));
  65.             $e->setUserIdentifier($identifier);
  67.             throw $e;
  68.         }
  70.         return $user;
  71.     }
  73.     public function refreshUser(UserInterface $user): UserInterface
  74.     {
  75.         $class = $this->getClass();
  76.         if (!$user instanceof $class) {
  77.             throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.', get_debug_type($user)));
  78.         }
  80.         $repository = $this->getRepository();
  81.         if ($repository instanceof UserProviderInterface) {
  82.             $refreshedUser = $repository->refreshUser($user);
  83.         } else {
  84.             // The user must be reloaded via the primary key as all other data
  85.             // might have changed without proper persistence in the database.
  86.             // That's the case when the user has been changed by a form with
  87.             // validation errors.
  88.             if (!$id = $this->getClassMetadata()->getIdentifierValues($user)) {
  89.                 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.');
  90.             }
  92.             $refreshedUser = $repository->find($id);
  93.             if (null === $refreshedUser) {
  94.                 $e = new UserNotFoundException('User with id '.json_encode($id).' not found.');
  95.                 $e->setUserIdentifier(json_encode($id));
  97.                 throw $e;
  98.             }
  99.         }
  101.         if ($refreshedUser instanceof Proxy && !$refreshedUser->__isInitialized()) {
  102.             $refreshedUser->__load();
  103.         }
  105.         return $refreshedUser;
  106.     }
  108.     public function supportsClass(string $class): bool
  109.     {
  110.         return $class === $this->getClass() || is_subclass_of($class, $this->getClass());
  111.     }
  113.     /**
  114.      * @final
  115.      */
  116.     public function upgradePassword(PasswordAuthenticatedUserInterface $user, string $newHashedPassword): void
  117.     {
  118.         $class = $this->getClass();
  119.         if (!$user instanceof $class) {
  120.             throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.', get_debug_type($user)));
  121.         }
  123.         $repository = $this->getRepository();
  124.         if ($repository instanceof PasswordUpgraderInterface) {
  125.             $repository->upgradePassword($user, $newHashedPassword);
  126.         }
  127.     }
  129.     private function getObjectManager(): ObjectManager
  130.     {
  131.         return $this->registry->getManager($this->managerName);
  132.     }
  134.     private function getRepository(): ObjectRepository
  135.     {
  136.         return $this->getObjectManager()->getRepository($this->classOrAlias);
  137.     }
  139.     private function getClass(): string
  140.     {
  141.         if (!isset($this->class)) {
  142.             $class = $this->classOrAlias;
  144.             if (str_contains($class, ':')) {
  145.                 $class = $this->getClassMetadata()->getName();
  146.             }
  148.             $this->class = $class;
  149.         }
  151.         return $this->class;
  152.     }
  154.     private function getClassMetadata(): ClassMetadata
  155.     {
  156.         return $this->getObjectManager()->getClassMetadata($this->classOrAlias);
  157.     }
  158. }