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

Open in your IDE?
  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\Bridge\Doctrine\Security\User;
  11. use Doctrine\Persistence\ManagerRegistry;
  12. use Doctrine\Persistence\Mapping\ClassMetadata;
  13. use Doctrine\Persistence\ObjectManager;
  14. use Doctrine\Persistence\ObjectRepository;
  15. use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
  16. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  17. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  18. use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
  19. use Symfony\Component\Security\Core\User\UserInterface;
  20. use Symfony\Component\Security\Core\User\UserProviderInterface;
  21. /**
  22.  * Wrapper around a Doctrine ObjectManager.
  23.  *
  24.  * Provides provisioning for Doctrine entity users.
  25.  *
  26.  * @author Fabien Potencier <fabien@symfony.com>
  27.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  28.  */
  29. class EntityUserProvider implements UserProviderInterfacePasswordUpgraderInterface
  30. {
  31.     private ManagerRegistry $registry;
  32.     private ?string $managerName;
  33.     private string $classOrAlias;
  34.     private string $class;
  35.     private ?string $property;
  36.     public function __construct(ManagerRegistry $registrystring $classOrAliasstring $property nullstring $managerName null)
  37.     {
  38.         $this->registry $registry;
  39.         $this->managerName $managerName;
  40.         $this->classOrAlias $classOrAlias;
  41.         $this->property $property;
  42.     }
  43.     public function loadUserByIdentifier(string $identifier): UserInterface
  44.     {
  45.         $repository $this->getRepository();
  46.         if (null !== $this->property) {
  47.             $user $repository->findOneBy([$this->property => $identifier]);
  48.         } else {
  49.             if (!$repository instanceof UserLoaderInterface) {
  50.                 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->classOrAliasget_debug_type($repository)));
  51.             }
  52.             $user $repository->loadUserByIdentifier($identifier);
  53.         }
  54.         if (null === $user) {
  55.             $e = new UserNotFoundException(sprintf('User "%s" not found.'$identifier));
  56.             $e->setUserIdentifier($identifier);
  57.             throw $e;
  58.         }
  59.         return $user;
  60.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function refreshUser(UserInterface $user): UserInterface
  65.     {
  66.         $class $this->getClass();
  67.         if (!$user instanceof $class) {
  68.             throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.'get_debug_type($user)));
  69.         }
  70.         $repository $this->getRepository();
  71.         if ($repository instanceof UserProviderInterface) {
  72.             $refreshedUser $repository->refreshUser($user);
  73.         } else {
  74.             // The user must be reloaded via the primary key as all other data
  75.             // might have changed without proper persistence in the database.
  76.             // That's the case when the user has been changed by a form with
  77.             // validation errors.
  78.             if (!$id $this->getClassMetadata()->getIdentifierValues($user)) {
  79.                 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.');
  80.             }
  81.             $refreshedUser $repository->find($id);
  82.             if (null === $refreshedUser) {
  83.                 $e = new UserNotFoundException('User with id '.json_encode($id).' not found.');
  84.                 $e->setUserIdentifier(json_encode($id));
  85.                 throw $e;
  86.             }
  87.         }
  88.         return $refreshedUser;
  89.     }
  90.     /**
  91.      * {@inheritdoc}
  92.      */
  93.     public function supportsClass(string $class): bool
  94.     {
  95.         return $class === $this->getClass() || is_subclass_of($class$this->getClass());
  96.     }
  97.     /**
  98.      * {@inheritdoc}
  99.      *
  100.      * @final
  101.      */
  102.     public function upgradePassword(PasswordAuthenticatedUserInterface $userstring $newHashedPassword): void
  103.     {
  104.         $class $this->getClass();
  105.         if (!$user instanceof $class) {
  106.             throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.'get_debug_type($user)));
  107.         }
  108.         $repository $this->getRepository();
  109.         if ($repository instanceof PasswordUpgraderInterface) {
  110.             $repository->upgradePassword($user$newHashedPassword);
  111.         }
  112.     }
  113.     private function getObjectManager(): ObjectManager
  114.     {
  115.         return $this->registry->getManager($this->managerName);
  116.     }
  117.     private function getRepository(): ObjectRepository
  118.     {
  119.         return $this->getObjectManager()->getRepository($this->classOrAlias);
  120.     }
  121.     private function getClass(): string
  122.     {
  123.         if (!isset($this->class)) {
  124.             $class $this->classOrAlias;
  125.             if (str_contains($class':')) {
  126.                 $class $this->getClassMetadata()->getName();
  127.             }
  128.             $this->class $class;
  129.         }
  130.         return $this->class;
  131.     }
  132.     private function getClassMetadata(): ClassMetadata
  133.     {
  134.         return $this->getObjectManager()->getClassMetadata($this->classOrAlias);
  135.     }
  136. }