Skip to content

Easier Custom Authentication errors #15882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 28, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<?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 = array();

public function __construct($message = '', array $messageData = array(), $code = 0, \Exception $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($messageKey, array $messageData = array())
{
$this->messageKey = $messageKey;
$this->messageData = $messageData;
}

public function getMessageKey()
{
return $this->messageKey;
}

public function getMessageData()
{
return $this->messageData;
}

/**
* {@inheritdoc}
*/
public function serialize()
{
return serialize(array(
parent::serialize(),
$this->messageKey,
$this->messageData,
));
}

/**
* {@inheritdoc}
*/
public function unserialize($str)
{
list($parentData, $this->messageKey, $this->messageData) = unserialize($str);

parent::unserialize($parentData);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?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\Tests\Exception;

use Symfony\Component\Security\Core\Exception\CustomUserMessageAuthenticationException;

class CustomUserMessageAuthenticationExceptionTest extends \PHPUnit_Framework_TestCase
{
public function testConstructWithSAfeMessage()
{
$e = new CustomUserMessageAuthenticationException('SAFE MESSAGE', array('foo' => true));

$this->assertEquals('SAFE MESSAGE', $e->getMessageKey());
$this->assertEquals(array('foo' => true), $e->getMessageData());
$this->assertEquals('SAFE MESSAGE', $e->getMessage());
}
}