Surfnet\StepupSelfService\SelfServiceBundle\Value\AvailableTokenCollection

Complexity

Total Complexity

7

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	sortCollection()	0	8	3
A	from()	0	13	3
A	getData()	0	4	1

<?php

declare(strict_types = 1);

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

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\Value;

/**
 * AvailableTokenCollection is used in the display second factor types view to be able to handle GSSP and non GSSP
 * tokens in a more homogeneous manner.
 */

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

class AvailableTokenCollection
{
    /**

Missing short description in doc comment

     * @var AvailableTokenInterface[]
     */
    private array $collection = [];

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

    public static function from(array $builtInTokens, array $gsspTokens): self

Missing doc comment for function from()

    {
        $collection = new self();

        foreach ($builtInTokens as $token) {
            $collection->collection[$token] = BuiltInToken::fromSecondFactorType($token);
        }

        foreach ($gsspTokens as $type => $token) {
            $collection->collection[$type] = GsspToken::fromViewConfig($token, $type);
        }

        return $collection;
    }

    /**
     * Sorts and returns the available tokens
     * @return AvailableTokenInterface[]

There must be exactly one blank line before the tags in a doc comment

     */
    public function getData(): array
    {
        $this->sortCollection();
        return $this->collection;
    }

    private function sortCollection(): void

Private method name "AvailableTokenCollection::sortCollection" must be prefixed with an underscore

Missing doc comment for function sortCollection()

    {
        // The collection is first sorted by LoA level and then in alphabetic order.
        uasort($this->collection, function (AvailableTokenInterface $a, AvailableTokenInterface $b): int {

The opening parenthesis of a multi-line function call should be the last content on the line.

            if ($a->getLoaLevel() === $b->getLoaLevel()) {
                return strcmp((string) $a->getType(), (string) $b->getType());
            }
            return $a->getLoaLevel() > $b->getLoaLevel() ? 1 : -1;
        });

For multi-line function calls, the closing parenthesis should be on a new line.

    }
}