SmsSecondFactorServiceInterface::clearSmsVerificationState() - Code Metrics - OpenConext/Stepup-bundle - Measure and Improve Code Quality continuously with Scrutinizer

clearSmsVerificationState()
last analyzed 2021-03-18 12:56 UTC

↳ Parent: SmsSecondFactorServiceInterface

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
c	0
b	0
f	0

<?php

/**
 * Copyright 2018 SURFnet bv
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupBundle\Service;

use Surfnet\StepupBundle\Command\SendSmsChallengeCommand;
use Surfnet\StepupBundle\Command\VerifyPossessionOfPhoneCommand;
use Surfnet\StepupBundle\Service\SmsSecondFactor\OtpVerification;

interface SmsSecondFactorServiceInterface
{
    /**
     * The remaining number of requests as an integer value.
     * @return int
     */
    public function getOtpRequestsRemainingCount();

    /**
     * Return the number of OTP requests that can be taken as an integer value.
     * @return int
     */
    public function getMaximumOtpRequestsCount();

    /**
     * Tests if this session has made prior requests
     * @return bool
     */
    public function hasSmsVerificationState();

    /**
     * Clears the verification state, forget this user has performed SMS requests.
     * @return mixed
     */
    public function clearSmsVerificationState();

    /**
     * Send an SMS OTP challenge
     *
     * This challenge gets sent to the recipient whose information can be found in the SendSmsChallengeCommand.
     * This method will return a boolean which indicates if the challenge was sent successfully.
     *
     * When the MaximumOtpRequestsCount is reached, this method should throw the TooManyChallengesRequestedException
     *
     * @param SendSmsChallengeCommand $command
     * @return bool
     */
    public function sendChallenge(SendSmsChallengeCommand $command);

    /**
     * Verify the SMS OTP
     *
     * Proving possession by verifying the OTP, the recipient received and typed in a web form, matches the OTP that was
     * sent. Various results can be returned in the form of a ProofOfPossessionResult.
     *
     * @param VerifyPossessionOfPhoneCommand $challengeCommand
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return OtpVerification
     */
    public function verifyPossession(VerifyPossessionOfPhoneCommand $command);
}


1			<?php
2
3			/**
4			* Copyright 2018 SURFnet bv
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace Surfnet\StepupBundle\Service;
20
21			use Surfnet\StepupBundle\Command\SendSmsChallengeCommand;
22			use Surfnet\StepupBundle\Command\VerifyPossessionOfPhoneCommand;
23			use Surfnet\StepupBundle\Service\SmsSecondFactor\OtpVerification;
24
25			interface SmsSecondFactorServiceInterface
26			{
27			/**
28			* The remaining number of requests as an integer value.
29			* @return int
30			*/
31			public function getOtpRequestsRemainingCount();
32
33			/**
34			* Return the number of OTP requests that can be taken as an integer value.
35			* @return int
36			*/
37			public function getMaximumOtpRequestsCount();
38
39			/**
40			* Tests if this session has made prior requests
41			* @return bool
42			*/
43			public function hasSmsVerificationState();
44
45			/**
46			* Clears the verification state, forget this user has performed SMS requests.
47			* @return mixed
48			*/
49			public function clearSmsVerificationState();
50
51			/**
52			* Send an SMS OTP challenge
53			*
54			* This challenge gets sent to the recipient whose information can be found in the SendSmsChallengeCommand.
55			* This method will return a boolean which indicates if the challenge was sent successfully.
56			*
57			* When the MaximumOtpRequestsCount is reached, this method should throw the TooManyChallengesRequestedException
58			*
59			* @param SendSmsChallengeCommand $command
60			* @return bool
61			*/
62			public function sendChallenge(SendSmsChallengeCommand $command);
63
64			/**
65			* Verify the SMS OTP
66			*
67			* Proving possession by verifying the OTP, the recipient received and typed in a web form, matches the OTP that was
68			* sent. Various results can be returned in the form of a ProofOfPossessionResult.
69			*
70			* @param VerifyPossessionOfPhoneCommand $challengeCommand
			0 ignored issues – show Documentation introduced 2018-09-13 12:28 UTC by Report Bug Copy Issue Report There is no parameter named `$challengeCommand`. Did you maybe mean `$command`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
71			* @return OtpVerification
72			*/
73			public function verifyPossession(VerifyPossessionOfPhoneCommand $command);
74			}
75

OpenConext / Stepup-bundle

GitHub Access Token became invalid

clearSmsVerificationState() last analyzed 2021-03-18 12:56 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

clearSmsVerificationState()
last analyzed 2021-03-18 12:56 UTC