vendor/symfony/security/Core/Authorization/Voter/RoleVoter.php line 22

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\Authorization\Voter;
  14. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  15. use Symfony\Component\Security\Core\Role\Role;
  17. /**
  18.  * RoleVoter votes if any attribute starts with a given prefix.
  19.  *
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  */
  22. class RoleVoter implements VoterInterface
  23. {
  24.     private $prefix;
  26.     public function __construct(string $prefix = 'ROLE_')
  27.     {
  28.         $this->prefix = $prefix;
  29.     }
  31.     /**
  32.      * {@inheritdoc}
  33.      */
  34.     public function vote(TokenInterface $token, $subject, array $attributes)
  35.     {
  36.         $result = VoterInterface::ACCESS_ABSTAIN;
  37.         $roles = $this->extractRoles($token);
  39.         foreach ($attributes as $attribute) {
  40.             if ($attribute instanceof Role) {
  41.                 $attribute = $attribute->getRole();
  42.             }
  44.             if (!\is_string($attribute) || !str_starts_with($attribute, $this->prefix)) {
  45.                 continue;
  46.             }
  48.             $result = VoterInterface::ACCESS_DENIED;
  49.             foreach ($roles as $role) {
  50.                 if ($attribute === $role) {
  51.                     return VoterInterface::ACCESS_GRANTED;
  52.                 }
  53.             }
  54.         }
  56.         return $result;
  57.     }
  59.     protected function extractRoles(TokenInterface $token)
  60.     {
  61.         if (method_exists($token, 'getRoleNames')) {
  62.             return $token->getRoleNames();
  63.         }
  65.         @trigger_error(sprintf('Not implementing the "%s::getRoleNames()" method in "%s" is deprecated since Symfony 4.3.', TokenInterface::class, \get_class($token)), \E_USER_DEPRECATED);
  67.         return array_map(function (Role $role) { return $role->getRole(); }, $token->getRoles(false));
  68.     }
  69. }