vendor/symfony/security-core/User/ChainUserProvider.php line 84

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\User;
  14. use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
  15. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  17. /**
  18. * Chain User Provider.
  19. *
  20. * This provider calls several leaf providers in a chain until one is able to
  21. * handle the request.
  22. *
  23. * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  24. */
  25. class ChainUserProvider implements UserProviderInterface, PasswordUpgraderInterface
  26. {
  27. private $providers;
  29. /**
  30. * @param iterable<array-key, UserProviderInterface> $providers
  31. */
  32. public function __construct(iterable $providers)
  33. {
  34. $this->providers = $providers;
  35. }
  37. /**
  38. * @return UserProviderInterface[]
  39. */
  40. public function getProviders()
  41. {
  42. if ($this->providers instanceof \Traversable) {
  43. return iterator_to_array($this->providers);
  44. }
  46. return $this->providers;
  47. }
  49. /**
  50. * {@inheritdoc}
  51. */
  52. public function loadUserByUsername(string $username)
  53. {
  54. trigger_deprecation('symfony/security-core', '5.3', 'Method "%s()" is deprecated, use loadUserByIdentifier() instead.', __METHOD__);
  56. return $this->loadUserByIdentifier($username);
  57. }
  59. public function loadUserByIdentifier(string $identifier): UserInterface
  60. {
  61. foreach ($this->providers as $provider) {
  62. try {
  63. // @deprecated since Symfony 5.3, change to $provider->loadUserByIdentifier() in 6.0
  64. if (!method_exists($provider, 'loadUserByIdentifier')) {
  65. trigger_deprecation('symfony/security-core', '5.3', 'Not implementing method "loadUserByIdentifier()" in user provider "%s" is deprecated. This method will replace "loadUserByUsername()" in Symfony 6.0.', get_debug_type($provider));
  67. return $provider->loadUserByUsername($identifier);
  68. }
  70. return $provider->loadUserByIdentifier($identifier);
  71. } catch (UserNotFoundException $e) {
  72. // try next one
  73. }
  74. }
  76. $ex = new UserNotFoundException(sprintf('There is no user with identifier "%s".', $identifier));
  77. $ex->setUserIdentifier($identifier);
  78. throw $ex;
  79. }
  81. /**
  82. * {@inheritdoc}
  83. */
  84. public function refreshUser(UserInterface $user)
  85. {
  86. $supportedUserFound = false;
  88. foreach ($this->providers as $provider) {
  89. try {
  90. if (!$provider->supportsClass(get_debug_type($user))) {
  91. continue;
  92. }
  94. return $provider->refreshUser($user);
  95. } catch (UnsupportedUserException $e) {
  96. // try next one
  97. } catch (UserNotFoundException $e) {
  98. $supportedUserFound = true;
  99. // try next one
  100. }
  101. }
  103. if ($supportedUserFound) {
  104. // @deprecated since Symfony 5.3, change to $user->getUserIdentifier() in 6.0
  105. $username = method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername();
  106. $e = new UserNotFoundException(sprintf('There is no user with name "%s".', $username));
  107. $e->setUserIdentifier($username);
  108. throw $e;
  109. } else {
  110. throw new UnsupportedUserException(sprintf('There is no user provider for user "%s". Shouldn\'t the "supportsClass()" method of your user provider return true for this classname?', get_debug_type($user)));
  111. }
  112. }
  114. /**
  115. * {@inheritdoc}
  116. */
  117. public function supportsClass(string $class)
  118. {
  119. foreach ($this->providers as $provider) {
  120. if ($provider->supportsClass($class)) {
  121. return true;
  122. }
  123. }
  125. return false;
  126. }
  128. /**
  129. * @param PasswordAuthenticatedUserInterface $user
  130. *
  131. * {@inheritdoc}
  132. */
  133. public function upgradePassword($user, string $newHashedPassword): void
  134. {
  135. if (!$user instanceof PasswordAuthenticatedUserInterface) {
  136. trigger_deprecation('symfony/security-core', '5.3', 'The "%s::upgradePassword()" method expects an instance of "%s" as first argument, the "%s" class should implement it.', PasswordUpgraderInterface::class, PasswordAuthenticatedUserInterface::class, get_debug_type($user));
  138. if (!$user instanceof UserInterface) {
  139. throw new \TypeError(sprintf('The "%s::upgradePassword()" method expects an instance of "%s" as first argument, "%s" given.', static::class, PasswordAuthenticatedUserInterface::class, get_debug_type($user)));
  140. }
  141. }
  143. foreach ($this->providers as $provider) {
  144. if ($provider instanceof PasswordUpgraderInterface) {
  145. try {
  146. $provider->upgradePassword($user, $newHashedPassword);
  147. } catch (UnsupportedUserException $e) {
  148. // ignore: password upgrades are opportunistic
  149. }
  150. }
  151. }
  152. }
  153. }