vendor/symfony/security-core/Authorization/Voter/RoleVoter.php line 21

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;
  16. /**
  17.  * RoleVoter votes if any attribute starts with a given prefix.
  18.  *
  19.  * @author Fabien Potencier <fabien@symfony.com>
  20.  */
  21. class RoleVoter implements CacheableVoterInterface
  22. {
  23.     private $prefix;
  25.     public function __construct(string $prefix = 'ROLE_')
  26.     {
  27.         $this->prefix = $prefix;
  28.     }
  30.     /**
  31.      * {@inheritdoc}
  32.      */
  33.     public function vote(TokenInterface $token, $subject, array $attributes)
  34.     {
  35.         $result = VoterInterface::ACCESS_ABSTAIN;
  36.         $roles = $this->extractRoles($token);
  38.         foreach ($attributes as $attribute) {
  39.             if (!\is_string($attribute) || !str_starts_with($attribute, $this->prefix)) {
  40.                 continue;
  41.             }
  43.             if ('ROLE_PREVIOUS_ADMIN' === $attribute) {
  44.                 trigger_deprecation('symfony/security-core', '5.1', 'The ROLE_PREVIOUS_ADMIN role is deprecated and will be removed in version 6.0, use the IS_IMPERSONATOR attribute instead.');
  45.             }
  47.             $result = VoterInterface::ACCESS_DENIED;
  48.             foreach ($roles as $role) {
  49.                 if ($attribute === $role) {
  50.                     return VoterInterface::ACCESS_GRANTED;
  51.                 }
  52.             }
  53.         }
  55.         return $result;
  56.     }
  58.     public function supportsAttribute(string $attribute): bool
  59.     {
  60.         return str_starts_with($attribute, $this->prefix);
  61.     }
  63.     public function supportsType(string $subjectType): bool
  64.     {
  65.         return true;
  66.     }
  68.     protected function extractRoles(TokenInterface $token)
  69.     {
  70.         return $token->getRoleNames();
  71.     }
  72. }