vendor/symfony/security-core/Authentication/Token/Storage/UsageTrackingTokenStorage.php line 24

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\Authentication\Token\Storage;
  14. use Psr\Container\ContainerInterface;
  15. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  16. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  17. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  19. /**
  20.  * A token storage that increments the session usage index when the token is accessed.
  21.  *
  22.  * @author Nicolas Grekas <p@tchwork.com>
  23.  */
  24. final class UsageTrackingTokenStorage implements TokenStorageInterface, ServiceSubscriberInterface
  25. {
  26.     private $storage;
  27.     private $sessionLocator;
  28.     private $enableUsageTracking = false;
  30.     public function __construct(TokenStorageInterface $storage, ContainerInterface $sessionLocator)
  31.     {
  32.         $this->storage = $storage;
  33.         $this->sessionLocator = $sessionLocator;
  34.     }
  36.     /**
  37.      * {@inheritdoc}
  38.      */
  39.     public function getToken(): ?TokenInterface
  40.     {
  41.         if ($this->enableUsageTracking) {
  42.             // increments the internal session usage index
  43.             $this->sessionLocator->get('session')->getMetadataBag();
  44.         }
  46.         return $this->storage->getToken();
  47.     }
  49.     /**
  50.      * {@inheritdoc}
  51.      */
  52.     public function setToken(TokenInterface $token = null): void
  53.     {
  54.         $this->storage->setToken($token);
  56.         if ($token && $this->enableUsageTracking) {
  57.             // increments the internal session usage index
  58.             $this->sessionLocator->get('session')->getMetadataBag();
  59.         }
  60.     }
  62.     public function enableUsageTracking(): void
  63.     {
  64.         $this->enableUsageTracking = true;
  65.     }
  67.     public function disableUsageTracking(): void
  68.     {
  69.         $this->enableUsageTracking = false;
  70.     }
  72.     public static function getSubscribedServices(): array
  73.     {
  74.         return [
  75.             'session' => SessionInterface::class,
  76.         ];
  77.     }
  78. }