Mbarbey\U2fSecurityBundle\Event\Authentication\U2fAuthenticationFailureEvent

Complexity

Total Complexity

5

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	getError()	0	3	1
A	__construct()	0	5	1
A	getUser()	0	3	1
A	getFailureCounter()	0	3	1

<?php

/*
 * This file is part of the U2F Security bundle.
 *
 * (c) Michael Barbey <michael@barbey-family.ch>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Mbarbey\U2fSecurityBundle\Event\Authentication;

use Symfony\Component\EventDispatcher\Event;
use Mbarbey\U2fSecurityBundle\Model\User\U2fUserInterface;

/**
 * U2F authentication failure event
 *
 * An event dispatched when a user fail to authenticate with it U2F security key.
 *
 * This event contain the user, an error message and the number of time the user failed to authenticate consecutively.
 *
 * @author Michael Barbey <michael@barbey-family.ch>
 */
class U2fAuthenticationFailureEvent extends Event
{
    private $user;
    private $error;
    private $failureCounter;

    /**
     * Return the name of the event to use when dispatching this event.
     *
     * @return string
     */
    public static function getName()
    {
        return 'u2f.authentication.failure';
    }

    /**
     * @param U2fUserInterface $user    The user who failed to authenticate
     * @param \Exception $error         The exception which triggered the failure
     * @param int $failureCounter       The number of consecutive fails of this user
     */
    public function __construct(U2fUserInterface $user, \Exception $error, $failureCounter = 1)
    {
        $this->user = $user;
        $this->error = $error;
        $this->failureCounter = $failureCounter;
    }

    /**
     * Return the user who failed to authenticate.
     *
     * @return U2fUserInterface
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * Return the exception which triggered the failure
     *
     * @return \Exception
     */
    public function getError()
    {
        return $this->error;
    }

    /**
     * Return the number of consecutive times the user failed to authenticate.
     *
     * @return int
     */
    public function getFailureCounter()
    {
        return $this->failureCounter;
    }
}