Surfnet\StepupSelfService\SelfServiceBundle\Controller\Registration\Gssf\GssfStatusController

Complexity

Total Complexity

3

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	renderStatusForm()	0	26	1
A	__construct()	0	6	1
A	status()	0	15	1

<?php

declare(strict_types = 1);

/**
 * Copyright 2023 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\Controller\Registration\Gssf;

use JMS\TranslationBundle\Annotation\Ignore;
use Psr\Log\LoggerInterface;
use Surfnet\SamlBundle\Http\PostBinding;
use Surfnet\SamlBundle\Http\RedirectBinding;
use Surfnet\SamlBundle\Http\XMLResponse;
use Surfnet\SamlBundle\SAML2\Attribute\AttributeDictionary;
use Surfnet\SamlBundle\SAML2\AuthnRequestFactory;
use Surfnet\StepupBundle\Value\Provider\ViewConfigCollection;
use Surfnet\StepupSelfService\SamlStepupProviderBundle\Provider\MetadataFactoryCollection;
use Surfnet\StepupSelfService\SamlStepupProviderBundle\Provider\Provider;
use Surfnet\StepupSelfService\SamlStepupProviderBundle\Provider\ProviderRepository;
use Surfnet\StepupSelfService\SamlStepupProviderBundle\Provider\ViewConfig;
use Surfnet\StepupSelfService\SelfServiceBundle\Controller\Controller;
use Surfnet\StepupSelfService\SelfServiceBundle\Form\Type\StatusGssfType;
use Surfnet\StepupSelfService\SelfServiceBundle\Service\GssfService;

The type Surfnet\StepupSelfService\SelfServiceBundle\Service\GssfService was not found. Maybe you did not declare it correctly or list all dependencies?

use Surfnet\StepupSelfService\SelfServiceBundle\Service\GsspUserAttributeService;

The type Surfnet\StepupSelfService\SelfServiceBundle\Service\GsspUserAttributeService was not found. Maybe you did not declare it correctly or list all dependencies?

use Surfnet\StepupSelfService\SelfServiceBundle\Service\InstitutionConfigurationOptionsService;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;

/**
 * Controls registration with Generic SAML Stepup Providers (GSSPs), yielding Generic SAML Second Factors (GSSFs).
 */

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 GssfStatusController extends Controller
{
    public function __construct(

Missing doc comment for function __construct()

        LoggerInterface           $logger,
        InstitutionConfigurationOptionsService     $configurationOptionsService,
        private readonly ViewConfigCollection      $viewConfigCollection
    ) {
        parent::__construct($logger, $configurationOptionsService);
    }

    /**

Parameter $request should have a doc-comment as per coding-style.

Parameter $provider should have a doc-comment as per coding-style.

     * Render the status form.
     *
     * This action has two parameters:
     *
     * - authenticationFailed (default false), will trigger an error message
     *   and is used when a SAML failure response was received, for example
     *   when the users cancelled the registration
     *
     * - proofOfPossessionFailed (default false), will trigger an error message
     *   when possession was not proven, but the SAML response was successful
     */

Missing @return tag in function comment

    #[Route(
        path: '/registration/gssf/{provider}/status',
        name: 'ss_registration_gssf_status_report',
        defaults: ['authenticationFailed' => false, 'proofOfPossessionFailed'=> false ],
        methods: ['GET'],
    )]
    public function status(Request $request, string $provider): Response
    {
        $this->assertSecondFactorEnabled($provider);

        return $this->renderStatusForm(
            $provider,
            [
                'authenticationFailed' => (bool) $request->query->get('authenticationFailed'),
                'proofOfPossessionFailed' => (bool) $request->query->get('proofOfPossessionFailed'),
            ]
        );
    }

    private function renderStatusForm(string $provider, array $parameters = []): Response

Private method name "GssfStatusController::renderStatusForm" must be prefixed with an underscore

Missing doc comment for function renderStatusForm()

    {
        /** @var ViewConfig $secondFactorConfig */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $secondFactorConfig = $this->viewConfigCollection->getByIdentifier($provider);

        $form = $this->createForm(
            StatusGssfType::class,
            null,
            [
                'provider' => $provider,
                /** @Ignore from translation message extraction */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                'label' => $secondFactorConfig->getInitiateButton()
            ]
        );
        $templateParameters = array_merge(
            $parameters,
            [
                'form' => $form->createView(),
                'provider' => $provider,
                'secondFactorConfig' => $secondFactorConfig,
                'verifyEmail' => $this->emailVerificationIsRequired(),
            ]
        );
        return $this->render(
            'registration/gssf/status.html.twig',
            $templateParameters
        );
    }
}