vendor/symfony/security-core/Exception/CustomUserMessageAuthenticationException.php line 23

  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. /**
  15.  * An authentication exception where you can control the message shown to the user.
  16.  *
  17.  * Be sure that the message passed to this exception is something that
  18.  * can be shown safely to your user. In other words, avoid catching
  19.  * other exceptions and passing their message directly to this class.
  20.  *
  21.  * @author Ryan Weaver <ryan@knpuniversity.com>
  22.  */
  23. class CustomUserMessageAuthenticationException extends AuthenticationException
  24. {
  25.     private string $messageKey;
  26.     private array $messageData = [];
  28.     public function __construct(string $message = '', array $messageData = [], int $code = 0, \Throwable $previous = null)
  29.     {
  30.         parent::__construct($message, $code, $previous);
  32.         $this->setSafeMessage($message, $messageData);
  33.     }
  35.     /**
  36.      * Set a message that will be shown to the user.
  37.      *
  38.      * @param string $messageKey  The message or message key
  39.      * @param array  $messageData Data to be passed into the translator
  40.      */
  41.     public function setSafeMessage(string $messageKey, array $messageData = [])
  42.     {
  43.         $this->messageKey = $messageKey;
  44.         $this->messageData = $messageData;
  45.     }
  47.     public function getMessageKey(): string
  48.     {
  49.         return $this->messageKey;
  50.     }
  52.     public function getMessageData(): array
  53.     {
  54.         return $this->messageData;
  55.     }
  57.     public function __serialize(): array
  58.     {
  59.         return [parent::__serialize(), $this->messageKey, $this->messageData];
  60.     }
  62.     public function __unserialize(array $data): void
  63.     {
  64.         [$parentData, $this->messageKey, $this->messageData] = $data;
  65.         $parentData = \is_array($parentData) ? $parentData : unserialize($parentData);
  66.         parent::__unserialize($parentData);
  67.     }
  68. }