vendor/symfony/security-core/Exception/AuthenticationException.php line 29

  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\Exception;
  14. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  16. /**
  17.  * AuthenticationException is the base class for all authentication exceptions.
  18.  *
  19.  * @author Fabien Potencier <fabien@symfony.com>
  20.  * @author Alexander <iam.asm89@gmail.com>
  21.  */
  22. class AuthenticationException extends RuntimeException
  23. {
  24.     /** @internal */
  25.     protected $serialized;
  27.     private ?TokenInterface $token = null;
  29.     public function __construct(string $message = '', int $code = 0, \Throwable $previous = null)
  30.     {
  31.         unset($this->serialized);
  32.         parent::__construct($message, $code, $previous);
  33.     }
  35.     public function getToken(): ?TokenInterface
  36.     {
  37.         return $this->token;
  38.     }
  40.     public function setToken(TokenInterface $token)
  41.     {
  42.         $this->token = $token;
  43.     }
  45.     /**
  46.      * Returns all the necessary state of the object for serialization purposes.
  47.      *
  48.      * There is no need to serialize any entry, they should be returned as-is.
  49.      * If you extend this method, keep in mind you MUST guarantee parent data is present in the state.
  50.      * Here is an example of how to extend this method:
  51.      * <code>
  52.      *     public function __serialize(): array
  53.      *     {
  54.      *         return [$this->childAttribute, parent::__serialize()];
  55.      *     }
  56.      * </code>
  57.      *
  58.      * @see __unserialize()
  59.      */
  60.     public function __serialize(): array
  61.     {
  62.         return [$this->token, $this->code, $this->message, $this->file, $this->line];
  63.     }
  65.     /**
  66.      * Restores the object state from an array given by __serialize().
  67.      *
  68.      * There is no need to unserialize any entry in $data, they are already ready-to-use.
  69.      * If you extend this method, keep in mind you MUST pass the parent data to its respective class.
  70.      * Here is an example of how to extend this method:
  71.      * <code>
  72.      *     public function __unserialize(array $data): void
  73.      *     {
  74.      *         [$this->childAttribute, $parentData] = $data;
  75.      *         parent::__unserialize($parentData);
  76.      *     }
  77.      * </code>
  78.      *
  79.      * @see __serialize()
  80.      */
  81.     public function __unserialize(array $data): void
  82.     {
  83.         [$this->token, $this->code, $this->message, $this->file, $this->line] = $data;
  84.     }
  86.     /**
  87.      * Message key to be used by the translation component.
  88.      *
  89.      * @return string
  90.      */
  91.     public function getMessageKey()
  92.     {
  93.         return 'An authentication exception occurred.';
  94.     }
  96.     /**
  97.      * Message data to be used by the translation component.
  98.      */
  99.     public function getMessageData(): array
  100.     {
  101.         return [];
  102.     }
  104.     /**
  105.      * @internal
  106.      */
  107.     public function __sleep(): array
  108.     {
  109.         $this->serialized = $this->__serialize();
  111.         return ['serialized'];
  112.     }
  114.     /**
  115.      * @internal
  116.      */
  117.     public function __wakeup(): void
  118.     {
  119.         $this->__unserialize($this->serialized);
  120.         unset($this->serialized);
  121.     }
  122. }