vendor/symfony/security-core/Authorization/Voter/Voter.php line 27

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.  * Voter is an abstract default implementation of a voter.
  18.  *
  19.  * @author Roman Marintšenko <inoryy@gmail.com>
  20.  * @author Grégoire Pineau <lyrixx@lyrixx.info>
  21.  */
  22. abstract class Voter implements VoterInterface, CacheableVoterInterface
  23. {
  24.     /**
  25.      * {@inheritdoc}
  26.      */
  27.     public function vote(TokenInterface $token, $subject, array $attributes)
  28.     {
  29.         // abstain vote by default in case none of the attributes are supported
  30.         $vote = self::ACCESS_ABSTAIN;
  32.         foreach ($attributes as $attribute) {
  33.             try {
  34.                 if (!$this->supports($attribute, $subject)) {
  35.                     continue;
  36.                 }
  37.             } catch (\TypeError $e) {
  38.                 if (\PHP_VERSION_ID < 80000) {
  39.                     if (0 === strpos($e->getMessage(), 'Argument 1 passed to')
  40.                         && false !== strpos($e->getMessage(), '::supports() must be of the type string')) {
  41.                         continue;
  42.                     }
  43.                 } elseif (false !== strpos($e->getMessage(), 'supports(): Argument #1')) {
  44.                     continue;
  45.                 }
  47.                 throw $e;
  48.             }
  50.             // as soon as at least one attribute is supported, default is to deny access
  51.             $vote = self::ACCESS_DENIED;
  53.             if ($this->voteOnAttribute($attribute, $subject, $token)) {
  54.                 // grant access as soon as at least one attribute returns a positive response
  55.                 return self::ACCESS_GRANTED;
  56.             }
  57.         }
  59.         return $vote;
  60.     }
  62.     /**
  63.      * Return false if your voter doesn't support the given attribute. Symfony will cache
  64.      * that decision and won't call your voter again for that attribute.
  65.      */
  66.     public function supportsAttribute(string $attribute): bool
  67.     {
  68.         return true;
  69.     }
  71.     /**
  72.      * Return false if your voter doesn't support the given subject type. Symfony will cache
  73.      * that decision and won't call your voter again for that subject type.
  74.      *
  75.      * @param string $subjectType The type of the subject inferred by `get_class()` or `get_debug_type()`
  76.      */
  77.     public function supportsType(string $subjectType): bool
  78.     {
  79.         return true;
  80.     }
  82.     /**
  83.      * Determines if the attribute and subject are supported by this voter.
  84.      *
  85.      * @param string $attribute An attribute
  86.      * @param mixed  $subject   The subject to secure, e.g. an object the user wants to access or any other PHP type
  87.      *
  88.      * @return bool
  89.      */
  90.     abstract protected function supports(string $attribute, $subject);
  92.     /**
  93.      * Perform a single access check operation on a given attribute, subject and token.
  94.      * It is safe to assume that $attribute and $subject already passed the "supports()" method check.
  95.      *
  96.      * @param mixed $subject
  97.      *
  98.      * @return bool
  99.      */
  100.     abstract protected function voteOnAttribute(string $attribute, $subject, TokenInterface $token);
  101. }