vendor/pimcore/pimcore/lib/Security/User/ObjectUserProvider.php line 74

Open in your IDE?
  1. <?php
  3. /**
  4. * Pimcore
  5. *
  6. * This source file is available under two different licenses:
  7. * - GNU General Public License version 3 (GPLv3)
  8. * - Pimcore Commercial License (PCL)
  9. * Full copyright and license information is available in
  10. * LICENSE.md which is distributed with this source code.
  11. *
  12. * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13. * @license http://www.pimcore.org/license GPLv3 and PCL
  14. */
  16. namespace Pimcore\Security\User;
  18. use Pimcore\Model\DataObject\AbstractObject;
  19. use Symfony\Component\Security\Core\Exception\InvalidArgumentException;
  20. use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
  21. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  22. use Symfony\Component\Security\Core\User\UserInterface;
  23. use Symfony\Component\Security\Core\User\UserProviderInterface;
  25. /**
  26. * @internal
  27. *
  28. * User provider loading users from pimcore objects. To load users, the provider needs
  29. * to know which kind of users to load (className) and which field to query for the
  30. * username (usernameField).
  31. *
  32. * Example DI configuration loading from the App\Model\DataObject\User class and searching by username:
  33. *
  34. * website_demo.security.user_provider:
  35. * class: Pimcore\Security\User\ObjectUserProvider
  36. * arguments: ['App\Model\DataObject\User', 'username']
  37. */
  38. class ObjectUserProvider implements UserProviderInterface
  39. {
  40. /**
  41. * The pimcore class name to be used. Needs to be a fully qualified class
  42. * name (e.g. Pimcore\Model\DataObject\User or your custom user class extending
  43. * the generated one.
  44. *
  45. * @var string
  46. */
  47. protected $className;
  49. /**
  50. * @var string
  51. */
  52. protected $usernameField = 'username';
  54. /**
  55. * @param string $className
  56. * @param string $usernameField
  57. */
  58. public function __construct($className, $usernameField = 'username')
  59. {
  60. $this->setClassName($className);
  62. $this->usernameField = $usernameField;
  63. }
  65. /**
  66. * @param string $className
  67. */
  68. protected function setClassName($className)
  69. {
  70. if (empty($className)) {
  71. throw new InvalidArgumentException('Object class name is empty');
  72. }
  74. if (!class_exists($className)) {
  75. throw new InvalidArgumentException(sprintf('User class %s does not exist', $className));
  76. }
  78. $reflector = new \ReflectionClass($className);
  79. if (!$reflector->isSubclassOf(AbstractObject::class)) {
  80. throw new InvalidArgumentException(sprintf('User class %s must be a subclass of %s', $className, AbstractObject::class));
  81. }
  83. $this->className = $className;
  84. }
  86. /**
  87. * {@inheritdoc}
  88. */
  89. public function loadUserByIdentifier(string $username)
  90. {
  91. $getter = sprintf('getBy%s', ucfirst($this->usernameField));
  93. // User::getByUsername($username, 1);
  94. $user = call_user_func_array([$this->className, $getter], [$username, 1]);
  95. if ($user && $user instanceof $this->className) {
  96. return $user;
  97. }
  99. throw new UserNotFoundException(sprintf('User %s was not found', $username));
  100. }
  102. /**
  103. * {@inheritdoc}
  104. *
  105. * @deprecated use loadUserByIdentifier() instead.
  106. */
  107. public function loadUserByUsername($username)
  108. {
  109. return $this->loadUserByIdentifier($username);
  110. }
  112. /**
  113. * {@inheritdoc}
  114. */
  115. public function refreshUser(UserInterface $user)
  116. {
  117. if (!$user instanceof $this->className || !$user instanceof AbstractObject) {
  118. throw new UnsupportedUserException();
  119. }
  121. $refreshedUser = call_user_func_array([$this->className, 'getById'], [$user->getId()]);
  123. return $refreshedUser;
  124. }
  126. /**
  127. * {@inheritdoc}
  128. */
  129. public function supportsClass($class)
  130. {
  131. return $class === $this->className;
  132. }
  133. }