Surfnet\StepupSelfService\SelfServiceBundle\Service\SelfAssertedTokens\Dto\SafeStoreSecret

Complexity

Total Complexity

2

Size/Duplication

Total Lines	22
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	display()	0	4	1
A	__construct()	0	3	1

<?php

declare(strict_types = 1);

/**
 * Copyright 2022 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\SelfAssertedTokens\Dto;

use Surfnet\StepupBundle\Security\OtpGenerator;

class SafeStoreSecret

Missing doc comment for class SafeStoreSecret

{
    private readonly string $secret;

Private member variable "secret" must be prefixed with an underscore

    /**
     * Length of the secret
     */
    private const LENGTH = 12;

    public function __construct()

Missing doc comment for function __construct()

    {
        $this->secret = OtpGenerator::generate(self::LENGTH);

The property secret is declared read-only in Surfnet\StepupSelfService\SelfServiceBundle\Service\SelfAssertedTokens\Dto\SafeStoreSecret.

    }

    /**
     * The output format, %s-%s-%s results in something like:
     * 3K1A-5CQ9-YCPE
     */

Missing @return tag in function comment

    public function display(): string
    {
        $split = chunk_split($this->secret, 4, '-');
        return substr($split, 0, -1);
    }
}