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

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\Bridge\Doctrine\Security\User;
  14. use Doctrine\Common\Persistence\ManagerRegistry;
  15. use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
  16. use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
  17. use Symfony\Component\Security\Core\User\UserInterface;
  18. use Symfony\Component\Security\Core\User\UserProviderInterface;
  20. /**
  21.  * Wrapper around a Doctrine ObjectManager.
  22.  *
  23.  * Provides easy to use provisioning for Doctrine entity users.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  27.  */
  28. class EntityUserProvider implements UserProviderInterface
  29. {
  30.     private $registry;
  31.     private $managerName;
  32.     private $classOrAlias;
  33.     private $class;
  34.     private $property;
  36.     public function __construct(ManagerRegistry $registry, string $classOrAlias, string $property = null, string $managerName = null)
  37.     {
  38.         $this->registry = $registry;
  39.         $this->managerName = $managerName;
  40.         $this->classOrAlias = $classOrAlias;
  41.         $this->property = $property;
  42.     }
  44.     /**
  45.      * {@inheritdoc}
  46.      */
  47.     public function loadUserByUsername($username)
  48.     {
  49.         $repository = $this->getRepository();
  50.         if (null !== $this->property) {
  51.             $user = $repository->findOneBy([$this->property => $username]);
  52.         } else {
  53.             if (!$repository instanceof UserLoaderInterface) {
  54.                 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_class($repository)));
  55.             }
  57.             $user = $repository->loadUserByUsername($username);
  58.         }
  60.         if (null === $user) {
  61.             throw new UsernameNotFoundException(sprintf('User "%s" not found.', $username));
  62.         }
  64.         return $user;
  65.     }
  67.     /**
  68.      * {@inheritdoc}
  69.      */
  70.     public function refreshUser(UserInterface $user)
  71.     {
  72.         $class = $this->getClass();
  73.         if (!$user instanceof $class) {
  74.             throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.', \get_class($user)));
  75.         }
  77.         $repository = $this->getRepository();
  78.         if ($repository instanceof UserProviderInterface) {
  79.             $refreshedUser = $repository->refreshUser($user);
  80.         } else {
  81.             // The user must be reloaded via the primary key as all other data
  82.             // might have changed without proper persistence in the database.
  83.             // That's the case when the user has been changed by a form with
  84.             // validation errors.
  85.             if (!$id = $this->getClassMetadata()->getIdentifierValues($user)) {
  86.                 throw new \InvalidArgumentException('You cannot refresh a user '.
  87.                     'from the EntityUserProvider that does not contain an identifier. '.
  88.                     'The user object has to be serialized with its own identifier '.
  89.                     'mapped by Doctrine.'
  90.                 );
  91.             }
  93.             $refreshedUser = $repository->find($id);
  94.             if (null === $refreshedUser) {
  95.                 throw new UsernameNotFoundException(sprintf('User with id %s not found', json_encode($id)));
  96.             }
  97.         }
  99.         return $refreshedUser;
  100.     }
  102.     /**
  103.      * {@inheritdoc}
  104.      */
  105.     public function supportsClass($class)
  106.     {
  107.         return $class === $this->getClass() || is_subclass_of($class, $this->getClass());
  108.     }
  110.     private function getObjectManager()
  111.     {
  112.         return $this->registry->getManager($this->managerName);
  113.     }
  115.     private function getRepository()
  116.     {
  117.         return $this->getObjectManager()->getRepository($this->classOrAlias);
  118.     }
  120.     private function getClass()
  121.     {
  122.         if (null === $this->class) {
  123.             $class = $this->classOrAlias;
  125.             if (false !== strpos($class, ':')) {
  126.                 $class = $this->getClassMetadata()->getName();
  127.             }
  129.             $this->class = $class;
  130.         }
  132.         return $this->class;
  133.     }
  135.     private function getClassMetadata()
  136.     {
  137.         return $this->getObjectManager()->getClassMetadata($this->classOrAlias);
  138.     }
  139. }