vendor/symfony/security-core/Authorization/TraceableAccessDecisionManager.php line 25

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;
  14. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  15. use Symfony\Component\Security\Core\Authorization\Voter\VoterInterface;
  17. /**
  18.  * Decorates the original AccessDecisionManager class to log information
  19.  * about the security voters and the decisions made by them.
  20.  *
  21.  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
  22.  *
  23.  * @internal
  24.  */
  25. class TraceableAccessDecisionManager implements AccessDecisionManagerInterface
  26. {
  27.     private $manager;
  28.     private $strategy;
  29.     private $voters = [];
  30.     private $decisionLog = []; // All decision logs
  31.     private $currentLog = [];  // Logs being filled in
  33.     public function __construct(AccessDecisionManagerInterface $manager)
  34.     {
  35.         $this->manager = $manager;
  37.         if ($this->manager instanceof AccessDecisionManager) {
  38.             // The strategy and voters are stored in a private properties of the decorated service
  39.             $reflection = new \ReflectionProperty(AccessDecisionManager::class, 'strategy');
  40.             $reflection->setAccessible(true);
  41.             $this->strategy = $reflection->getValue($manager);
  42.             $reflection = new \ReflectionProperty(AccessDecisionManager::class, 'voters');
  43.             $reflection->setAccessible(true);
  44.             $this->voters = $reflection->getValue($manager);
  45.         }
  46.     }
  48.     /**
  49.      * {@inheritdoc}
  50.      *
  51.      * @param bool $allowMultipleAttributes Whether to allow passing multiple values to the $attributes array
  52.      */
  53.     public function decide(TokenInterface $token, array $attributes, $object = null/*, bool $allowMultipleAttributes = false*/): bool
  54.     {
  55.         $currentDecisionLog = [
  56.             'attributes' => $attributes,
  57.             'object' => $object,
  58.             'voterDetails' => [],
  59.         ];
  61.         $this->currentLog[] = &$currentDecisionLog;
  63.         $result = $this->manager->decide($token, $attributes, $object, 3 < \func_num_args() && func_get_arg(3));
  65.         $currentDecisionLog['result'] = $result;
  67.         $this->decisionLog[] = array_pop($this->currentLog); // Using a stack since decide can be called by voters
  69.         return $result;
  70.     }
  72.     /**
  73.      * Adds voter vote and class to the voter details.
  74.      *
  75.      * @param array $attributes attributes used for the vote
  76.      * @param int   $vote       vote of the voter
  77.      */
  78.     public function addVoterVote(VoterInterface $voter, array $attributes, int $vote)
  79.     {
  80.         $currentLogIndex = \count($this->currentLog) - 1;
  81.         $this->currentLog[$currentLogIndex]['voterDetails'][] = [
  82.             'voter' => $voter,
  83.             'attributes' => $attributes,
  84.             'vote' => $vote,
  85.         ];
  86.     }
  88.     public function getStrategy(): string
  89.     {
  90.         // The $strategy property is misleading because it stores the name of its
  91.         // method (e.g. 'decideAffirmative') instead of the original strategy name
  92.         // (e.g. 'affirmative')
  93.         return null === $this->strategy ? '-' : strtolower(substr($this->strategy, 6));
  94.     }
  96.     /**
  97.      * @return iterable|VoterInterface[]
  98.      */
  99.     public function getVoters(): iterable
  100.     {
  101.         return $this->voters;
  102.     }
  104.     public function getDecisionLog(): array
  105.     {
  106.         return $this->decisionLog;
  107.     }
  108. }
  110. class_alias(TraceableAccessDecisionManager::class, DebugAccessDecisionManager::class);