76 lines
2.0 KiB
PHP
76 lines
2.0 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 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 Ryan Weaver <ryan@knpuniversity.com>
|
||
|
|
*/
|
||
|
|
class CustomUserMessageAuthenticationException extends AuthenticationException
|
||
|
|
{
|
||
|
|
private $messageKey;
|
||
|
|
|
||
|
|
private $messageData = [];
|
||
|
|
|
||
|
|
public function __construct(string $message = '', array $messageData = [], int $code = 0, \Throwable $previous = null)
|
||
|
|
{
|
||
|
|
parent::__construct($message, $code, $previous);
|
||
|
|
|
||
|
|
$this->setSafeMessage($message, $messageData);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set 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 = [])
|
||
|
|
{
|
||
|
|
$this->messageKey = $messageKey;
|
||
|
|
$this->messageData = $messageData;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getMessageKey()
|
||
|
|
{
|
||
|
|
return $this->messageKey;
|
||
|
|
}
|
||
|
|
|
||
|
|
public function getMessageData()
|
||
|
|
{
|
||
|
|
return $this->messageData;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*/
|
||
|
|
public function __serialize(): array
|
||
|
|
{
|
||
|
|
return [parent::__serialize(), $this->messageKey, $this->messageData];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*/
|
||
|
|
public function __unserialize(array $data): void
|
||
|
|
{
|
||
|
|
[$parentData, $this->messageKey, $this->messageData] = $data;
|
||
|
|
$parentData = \is_array($parentData) ? $parentData : unserialize($parentData);
|
||
|
|
parent::__unserialize($parentData);
|
||
|
|
}
|
||
|
|
}
|