Surfnet\StepupSelfService\SelfServiceBundle\Service\SmsSecondFactor\ProofOfPossessionResult

Complexity

Total Complexity

15

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	wereTooManyAttemptsMade()	0	3	1
A	secondFactorCreated()	0	7	2
A	tooManyAttempts()	0	3	1
A	proofOfPossessionCommandFailed()	0	3	1
A	isSuccessful()	0	3	2
A	wasIncorrectChallengeResponseGiven()	0	3	1
A	didProofOfPossessionFail()	0	3	2
A	hasChallengeExpired()	0	3	1
A	getSecondFactorId()	0	3	1
A	incorrectChallenge()	0	3	1
A	__construct()	0	2	1
A	challengeExpired()	0	3	1

<?php

declare(strict_types = 1);

/**
 * Copyright 2014 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.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Surfnet\StepupSelfService\SelfServiceBundle\Service\SmsSecondFactor;

use Surfnet\StepupSelfService\SelfServiceBundle\Exception\InvalidArgumentException;

/**

Missing short description in doc comment

 * @SuppressWarnings(PHPMD.TooManyMethods)
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

final class ProofOfPossessionResult
{
    public const STATUS_CHALLENGE_OK = 0;
    public const STATUS_INCORRECT_CHALLENGE = 1;
    public const STATUS_CHALLENGE_EXPIRED = 2;
    public const STATUS_TOO_MANY_ATTEMPTS = 3;

    /**

Missing short description in doc comment

     * @param int $status One of

Expected 9 spaces after parameter type; 1 found

Expected 9 spaces after parameter name; 1 found

     * @param string|null $secondFactorId

Missing parameter comment

     */
    private function __construct(private $status, private $secondFactorId = null)
    {
    }

    /**

Missing short description in doc comment

     * @return ProofOfPossessionResult
     */
    public static function challengeExpired(): self
    {
        return new self(self::STATUS_CHALLENGE_EXPIRED);
    }

    /**

Missing short description in doc comment

     * @return ProofOfPossessionResult
     */
    public static function incorrectChallenge(): self
    {
        return new self(self::STATUS_INCORRECT_CHALLENGE);
    }

    /**

Missing short description in doc comment

     * @return ProofOfPossessionResult
     */
    public static function proofOfPossessionCommandFailed(): self
    {
        return new self(self::STATUS_CHALLENGE_OK);
    }

    /**

Missing short description in doc comment

     * @param string $secondFactorId

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return ProofOfPossessionResult

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public static function secondFactorCreated($secondFactorId): self
    {
        if (!is_string($secondFactorId)) {

The condition is_string($secondFactorId) is always true.

            throw InvalidArgumentException::invalidType('string', 'secondFactorId', $secondFactorId);
        }

        return new self(self::STATUS_CHALLENGE_OK, $secondFactorId);
    }

    /**

Missing short description in doc comment

     * @return ProofOfPossessionResult
     */
    public static function tooManyAttempts(): self
    {
        return new self(self::STATUS_TOO_MANY_ATTEMPTS);
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function isSuccessful(): bool
    {
        return $this->status === self::STATUS_CHALLENGE_OK && $this->secondFactorId !== null;
    }

    /**

Missing short description in doc comment

     * @return null|string
     */
    public function getSecondFactorId()
    {
        return $this->secondFactorId;
    }

    public function didProofOfPossessionFail(): bool

Missing doc comment for function didProofOfPossessionFail()

    {
        return $this->status === self::STATUS_CHALLENGE_OK && $this->secondFactorId === null;
    }

    /**

Missing short description in doc comment

     * @return boolean
     */
    public function wasIncorrectChallengeResponseGiven(): bool
    {
        return $this->status === self::STATUS_INCORRECT_CHALLENGE;
    }

    /**

Missing short description in doc comment

     * @return boolean
     */
    public function hasChallengeExpired(): bool
    {
        return $this->status === self::STATUS_CHALLENGE_EXPIRED;
    }

    /**

Missing short description in doc comment

     * @return boolean
     */
    public function wereTooManyAttemptsMade(): bool
    {
        return $this->status === self::STATUS_TOO_MANY_ATTEMPTS;
    }
}