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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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 <[email protected]>
  20.  * @author Alexander <[email protected]>
  21.  */
  22. class AuthenticationException extends RuntimeException
  23. {
  24.     /** @internal */
  25.     protected $serialized;
  27.     private $token;
  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.     /**
  36.      * @return TokenInterface|null
  37.      */
  38.     public function getToken()
  39.     {
  40.         return $this->token;
  41.     }
  43.     public function setToken(TokenInterface $token)
  44.     {
  45.         $this->token = $token;
  46.     }
  48.     /**
  49.      * Returns all the necessary state of the object for serialization purposes.
  50.      *
  51.      * There is no need to serialize any entry, they should be returned as-is.
  52.      * If you extend this method, keep in mind you MUST guarantee parent data is present in the state.
  53.      * Here is an example of how to extend this method:
  54.      * <code>
  55.      *     public function __serialize(): array
  56.      *     {
  57.      *         return [$this->childAttribute, parent::__serialize()];
  58.      *     }
  59.      * </code>
  60.      *
  61.      * @see __unserialize()
  62.      */
  63.     public function __serialize(): array
  64.     {
  65.         return [$this->token, $this->code, $this->message, $this->file, $this->line];
  66.     }
  68.     /**
  69.      * Restores the object state from an array given by __serialize().
  70.      *
  71.      * There is no need to unserialize any entry in $data, they are already ready-to-use.
  72.      * If you extend this method, keep in mind you MUST pass the parent data to its respective class.
  73.      * Here is an example of how to extend this method:
  74.      * <code>
  75.      *     public function __unserialize(array $data): void
  76.      *     {
  77.      *         [$this->childAttribute, $parentData] = $data;
  78.      *         parent::__unserialize($parentData);
  79.      *     }
  80.      * </code>
  81.      *
  82.      * @see __serialize()
  83.      */
  84.     public function __unserialize(array $data): void
  85.     {
  86.         [$this->token, $this->code, $this->message, $this->file, $this->line] = $data;
  87.     }
  89.     /**
  90.      * Message key to be used by the translation component.
  91.      *
  92.      * @return string
  93.      */
  94.     public function getMessageKey()
  95.     {
  96.         return 'An authentication exception occurred.';
  97.     }
  99.     /**
  100.      * Message data to be used by the translation component.
  101.      *
  102.      * @return array
  103.      */
  104.     public function getMessageData()
  105.     {
  106.         return [];
  107.     }
  109.     /**
  110.      * @internal
  111.      */
  112.     public function __sleep(): array
  113.     {
  114.         $this->serialized = $this->__serialize();
  116.         return ['serialized'];
  117.     }
  119.     /**
  120.      * @internal
  121.      */
  122.     public function __wakeup(): void
  123.     {
  124.         $this->__unserialize($this->serialized);
  125.         unset($this->serialized);
  126.     }
  127. }