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

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\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.     private $token;
  26.     /**
  27.      * Get the token.
  28.      *
  29.      * @return TokenInterface|null
  30.      */
  31.     public function getToken()
  32.     {
  33.         return $this->token;
  34.     }
  36.     public function setToken(TokenInterface $token)
  37.     {
  38.         $this->token = $token;
  39.     }
  41.     /**
  42.      * Returns all the necessary state of the object for serialization purposes.
  43.      *
  44.      * There is no need to serialize any entry, they should be returned as-is.
  45.      * If you extend this method, keep in mind you MUST guarantee parent data is present in the state.
  46.      * Here is an example of how to extend this method:
  47.      * <code>
  48.      *     public function __serialize(): array
  49.      *     {
  50.      *         return [$this->childAttribute, parent::__serialize()];
  51.      *     }
  52.      * </code>
  53.      *
  54.      * @see __unserialize()
  55.      */
  56.     public function __serialize(): array
  57.     {
  58.         return [$this->token, $this->code, $this->message, $this->file, $this->line];
  59.     }
  61.     /**
  62.      * Restores the object state from an array given by __serialize().
  63.      *
  64.      * There is no need to unserialize any entry in $data, they are already ready-to-use.
  65.      * If you extend this method, keep in mind you MUST pass the parent data to its respective class.
  66.      * Here is an example of how to extend this method:
  67.      * <code>
  68.      *     public function __unserialize(array $data): void
  69.      *     {
  70.      *         [$this->childAttribute, $parentData] = $data;
  71.      *         parent::__unserialize($parentData);
  72.      *     }
  73.      * </code>
  74.      *
  75.      * @see __serialize()
  76.      */
  77.     public function __unserialize(array $data): void
  78.     {
  79.         [$this->token, $this->code, $this->message, $this->file, $this->line] = $data;
  80.     }
  82.     /**
  83.      * Message key to be used by the translation component.
  84.      *
  85.      * @return string
  86.      */
  87.     public function getMessageKey()
  88.     {
  89.         return 'An authentication exception occurred.';
  90.     }
  92.     /**
  93.      * Message data to be used by the translation component.
  94.      *
  95.      * @return array
  96.      */
  97.     public function getMessageData()
  98.     {
  99.         return [];
  100.     }
  102.     /**
  103.      * @internal
  104.      */
  105.     public function __sleep(): array
  106.     {
  107.         $this->serialized = $this->__serialize();
  109.         return ['serialized'];
  110.     }
  112.     /**
  113.      * @internal
  114.      */
  115.     public function __wakeup()
  116.     {
  117.         $this->__unserialize($this->serialized);
  118.         unset($this->serialized);
  119.     }
  120. }