Classes List

Symfony\Component\Security\Core\Exception\CustomUserMessageAuthenticationException

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
<?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($messageKeyarray $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);
    }
}