SilverStripe\MFA\MethodRegistrationHandler

Complexity

Total Complexity

5

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	4	1
A	getName()	0	3	1
A	getDescription()	0	3	1
A	start()	0	4	1
A	getSupportLink()	0	3	1

<?php

namespace SilverStripe\MFA;

use SilverStripe\Control\HTTPRequest;
use SilverStripe\MFA\AuthenticationMethod\RegistrationHandlerInterface;

class MethodRegistrationHandler implements RegistrationHandlerInterface
{
    /**
     * Prepare to register this authentication method against a member by initialising state in session and generating
     * details to provide to a frontend React component
     *
     * @param SessionStore $store An object that hold session data (and the Member) that can be mutated
     * @return array Props to be passed to a front-end React component
     */
    public function start(SessionStore $store)
    {
        // stub
        return [];
    }

    /**
     * Confirm that the provided details are valid, and create a new AuthenticationMethod against the member.
     *
     * @param HTTPRequest $request
     * @param SessionStore $store
     * @return bool
     */
    public function register(HTTPRequest $request, SessionStore $store)
    {
        // stub
        return true;
    }

    /**
     * Provide a string (possibly passed through i18n) that names this registration method.
     *
     * eg. "Authenticator app"
     *
     * @return string
     */
    public function getName()
    {
        return 'Basic math test';
    }

    /**
     * Provide a string (possibly passed through i18n) that describes this method.
     *
     * eg. "Verification codes are created by an app on your phone"
     *
     * @return string
     */
    public function getDescription()
    {
        return 'Asks you to add numbers together';
    }

    /**
     * Provide a URL to a support article about this registration method.
     *
     * @return string
     */
    public function getSupportLink()
    {
        return 'https://google.com';
    }
}