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

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.      * {@inheritdoc}
  63.      *
  64.      * @final since Symfony 4.3, use __serialize() instead
  65.      *
  66.      * @internal since Symfony 4.3, use __serialize() instead
  67.      */
  68.     public function serialize()
  69.     {
  70.         $serialized = $this->__serialize();
  72.         if (null === $isCalledFromOverridingMethod = \func_num_args() ? func_get_arg(0) : null) {
  73.             $trace = debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT, 2);
  74.             $isCalledFromOverridingMethod = isset($trace[1]['function'], $trace[1]['object']) && 'serialize' === $trace[1]['function'] && $this === $trace[1]['object'];
  75.         }
  77.         return $isCalledFromOverridingMethod ? $serialized : serialize($serialized);
  78.     }
  80.     /**
  81.      * Restores the object state from an array given by __serialize().
  82.      *
  83.      * There is no need to unserialize any entry in $data, they are already ready-to-use.
  84.      * If you extend this method, keep in mind you MUST pass the parent data to its respective class.
  85.      * Here is an example of how to extend this method:
  86.      * <code>
  87.      *     public function __unserialize(array $data): void
  88.      *     {
  89.      *         [$this->childAttribute, $parentData] = $data;
  90.      *         parent::__unserialize($parentData);
  91.      *     }
  92.      * </code>
  93.      *
  94.      * @see __serialize()
  95.      */
  96.     public function __unserialize(array $data): void
  97.     {
  98.         [$this->token, $this->code, $this->message, $this->file, $this->line] = $data;
  99.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      *
  104.      * @final since Symfony 4.3, use __unserialize() instead
  105.      *
  106.      * @internal since Symfony 4.3, use __unserialize() instead
  107.      */
  108.     public function unserialize($serialized)
  109.     {
  110.         $this->__unserialize(\is_array($serialized) ? $serialized : unserialize($serialized));
  111.     }
  113.     /**
  114.      * @internal
  115.      */
  116.     public function __sleep()
  117.     {
  118.         if (__CLASS__ !== $c = (new \ReflectionMethod($this, 'serialize'))->getDeclaringClass()->name) {
  119.             @trigger_error(sprintf('Implementing the "%s::serialize()" method is deprecated since Symfony 4.3, implement the __serialize() and __unserialize() methods instead.', $c), E_USER_DEPRECATED);
  120.             $this->serialized = $this->serialize();
  121.         } else {
  122.             $this->serialized = $this->__serialize();
  123.         }
  125.         return ['serialized'];
  126.     }
  128.     /**
  129.      * @internal
  130.      */
  131.     public function __wakeup()
  132.     {
  133.         if (__CLASS__ !== $c = (new \ReflectionMethod($this, 'unserialize'))->getDeclaringClass()->name) {
  134.             @trigger_error(sprintf('Implementing the "%s::unserialize()" method is deprecated since Symfony 4.3, implement the __serialize() and __unserialize() methods instead.', $c), E_USER_DEPRECATED);
  135.             $this->unserialize($this->serialized);
  136.         } else {
  137.             $this->__unserialize($this->serialized);
  138.         }
  140.         unset($this->serialized);
  141.     }
  143.     /**
  144.      * Message key to be used by the translation component.
  145.      *
  146.      * @return string
  147.      */
  148.     public function getMessageKey()
  149.     {
  150.         return 'An authentication exception occurred.';
  151.     }
  153.     /**
  154.      * Message data to be used by the translation component.
  155.      *
  156.      * @return array
  157.      */
  158.     public function getMessageData()
  159.     {
  160.         return [];
  161.     }
  162. }