Mbarbey\U2fSecurityBundle\Event\Authentication\U2fAuthenticationSuccessEvent

Complexity

Total Complexity

4

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getKey()	0	3	1
A	__construct()	0	4	1
A	getUser()	0	3	1
A	getName()	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;
use Mbarbey\U2fSecurityBundle\Model\Key\U2fKeyInterface;

/**
 * U2F authentication success event
 *
 * An event dispatched when a user successfully authenticate with it U2F security key.
 *
 * This event contain the user and the key used to authenticate. The counter of the key has already been updated.
 *
 * @author Michael Barbey <michael@barbey-family.ch>
 */
class U2fAuthenticationSuccessEvent extends Event
{
    private $user;
    private $key;

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

    /**
     * @param U2fUserInterface $user    The user who successfully authenticated
     * @param U2fKeyInterface $key      The security key used during the authentication
     */
    public function __construct(U2fUserInterface $user, U2fKeyInterface $key)
    {
        $this->user = $user;
        $this->key = $key;
    }

    /**
     * Return the user who successfully authenticated with it U2F key.
     *
     * @return U2fUserInterface
     */
    public function getUser()
    {
        return $this->user;
    }

    /**
     * Return the key used to authenticate. The counter of the key has already been updated.
     *
     * @return U2fKeyInterface
     */
    public function getKey()
    {
        return $this->key;
    }
}