FestinHegre/vendor/symfony/security-core/Exception/CustomUserMessageAccountStatusException.php
2024-09-26 17:26:04 +02:00

69 lines
1.9 KiB
PHP

<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Security\Core\Exception;
/**
* An authentication exception caused by the user account status
* where you can control the message shown to the user.
*
* Be sure that the message passed to this exception is something that
* can be shown safely to your user. In other words, avoid catching
* other exceptions and passing their message directly to this class.
*
* @author Vincent Langlet <vincentlanglet@github.com>
*/
class CustomUserMessageAccountStatusException extends AccountStatusException
{
private string $messageKey;
private array $messageData = [];
public function __construct(string $message = '', array $messageData = [], int $code = 0, ?\Throwable $previous = null)
{
parent::__construct($message, $code, $previous);
$this->setSafeMessage($message, $messageData);
}
/**
* Sets a message that will be shown to the user.
*
* @param string $messageKey The message or message key
* @param array $messageData Data to be passed into the translator
*/
public function setSafeMessage(string $messageKey, array $messageData = []): void
{
$this->messageKey = $messageKey;
$this->messageData = $messageData;
}
public function getMessageKey(): string
{
return $this->messageKey;
}
public function getMessageData(): array
{
return $this->messageData;
}
public function __serialize(): array
{
return [parent::__serialize(), $this->messageKey, $this->messageData];
}
public function __unserialize(array $data): void
{
[$parentData, $this->messageKey, $this->messageData] = $data;
parent::__unserialize($parentData);
}
}