vendor/symfony/security-core/Authentication/Token/NullToken.php line 44

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;
  14. /**
  15.  * @author Wouter de Jong <wouter@wouterj.nl>
  16.  */
  17. class NullToken implements TokenInterface
  18. {
  19.     public function __toString(): string
  20.     {
  21.         return '';
  22.     }
  24.     public function getRoleNames(): array
  25.     {
  26.         return [];
  27.     }
  29.     public function getCredentials()
  30.     {
  31.         return '';
  32.     }
  34.     public function getUser()
  35.     {
  36.         return null;
  37.     }
  39.     public function setUser($user)
  40.     {
  41.         throw new \BadMethodCallException('Cannot set user on a NullToken.');
  42.     }
  44.     public function getUsername()
  45.     {
  46.         trigger_deprecation('symfony/security-core', '5.3', 'Method "%s()" is deprecated, use getUserIdentifier() instead.', __METHOD__);
  48.         return '';
  49.     }
  51.     public function getUserIdentifier(): string
  52.     {
  53.         return '';
  54.     }
  56.     /**
  57.      * @deprecated since Symfony 5.4
  58.      */
  59.     public function isAuthenticated()
  60.     {
  61.         if (0 === \func_num_args() || func_get_arg(0)) {
  62.             trigger_deprecation('symfony/security-core', '5.4', 'Method "%s()" is deprecated, return null from "getUser()" instead when a token is not authenticated.', __METHOD__);
  63.         }
  65.         return true;
  66.     }
  68.     /**
  69.      * @deprecated since Symfony 5.4
  70.      */
  71.     public function setAuthenticated(bool $isAuthenticated)
  72.     {
  73.         throw new \BadMethodCallException('Cannot change authentication state of NullToken.');
  74.     }
  76.     public function eraseCredentials()
  77.     {
  78.     }
  80.     public function getAttributes()
  81.     {
  82.         return [];
  83.     }
  85.     public function setAttributes(array $attributes)
  86.     {
  87.         throw new \BadMethodCallException('Cannot set attributes of NullToken.');
  88.     }
  90.     public function hasAttribute(string $name)
  91.     {
  92.         return false;
  93.     }
  95.     public function getAttribute(string $name)
  96.     {
  97.         return null;
  98.     }
  100.     public function setAttribute(string $name, $value)
  101.     {
  102.         throw new \BadMethodCallException('Cannot add attribute to NullToken.');
  103.     }
  105.     public function __serialize(): array
  106.     {
  107.         return [];
  108.     }
  110.     public function __unserialize(array $data): void
  111.     {
  112.     }
  114.     /**
  115.      * @return string
  116.      *
  117.      * @internal in 5.3
  118.      *
  119.      * @final in 5.3
  120.      */
  121.     public function serialize()
  122.     {
  123.         return '';
  124.     }
  126.     /**
  127.      * @return void
  128.      *
  129.      * @internal in 5.3
  130.      *
  131.      * @final in 5.3
  132.      */
  133.     public function unserialize($serialized)
  134.     {
  135.     }
  136. }