Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\CommandHandler\InstitutionConfigurationCommandHandler

Complexity

Total Complexity

10

Size/Duplication

Total Lines	169
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	handleCreateInstitutionConfigurationCommand()	0	17	2
A	handleRemoveInstitutionConfigurationByUnnormalizedIdCommand()	0	13	1
A	handleChangeRaLocationCommand()	0	13	1
A	__construct()	0	2	1
A	loadInstitutionConfigurationFor()	0	17	2
A	handleReconfigureInstitutionConfigurationOptionsCommand()	0	65	1
A	handleRemoveRaLocationCommand()	0	8	1
A	handleAddRaLocationCommand()	0	13	1

<?php

/**
 * Copyright 2016 SURFnet B.V.
 *
 * 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.
 */

Missing @link tag in file comment

namespace Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\CommandHandler;

use Broadway\CommandHandling\SimpleCommandHandler;
use Broadway\Repository\AggregateNotFoundException;
use Broadway\Repository\Repository as RepositoryInterface;
use Surfnet\Stepup\Configuration\InstitutionConfiguration;
use Surfnet\Stepup\Configuration\Value\AllowedSecondFactorList;
use Surfnet\Stepup\Configuration\Value\ContactInformation;
use Surfnet\Stepup\Configuration\Value\Institution;
use Surfnet\Stepup\Configuration\Value\InstitutionAuthorizationOption;
use Surfnet\Stepup\Configuration\Value\InstitutionConfigurationId;
use Surfnet\Stepup\Configuration\Value\InstitutionRole;
use Surfnet\Stepup\Configuration\Value\Location;
use Surfnet\Stepup\Configuration\Value\NumberOfTokensPerIdentityOption;
use Surfnet\Stepup\Configuration\Value\RaLocationId;
use Surfnet\Stepup\Configuration\Value\RaLocationName;
use Surfnet\Stepup\Configuration\Value\SelfAssertedTokensOption;

The type Surfnet\Stepup\Configuration\Value\SelfAssertedTokensOption was not found. Maybe you did not declare it correctly or list all dependencies?

use Surfnet\Stepup\Configuration\Value\SelfVetOption;

The type Surfnet\Stepup\Configuration\Value\SelfVetOption was not found. Maybe you did not declare it correctly or list all dependencies?

use Surfnet\Stepup\Configuration\Value\ShowRaaContactInformationOption;
use Surfnet\Stepup\Configuration\Value\SsoOn2faOption;

The type Surfnet\Stepup\Configuration\Value\SsoOn2faOption was not found. Maybe you did not declare it correctly or list all dependencies?

use Surfnet\Stepup\Configuration\Value\SsoRegistrationBypassOption;

The type Surfnet\Stepup\Configuration\Value\SsoRegistrationBypassOption was not found. Maybe you did not declare it correctly or list all dependencies?

use Surfnet\Stepup\Configuration\Value\UseRaLocationsOption;
use Surfnet\Stepup\Configuration\Value\VerifyEmailOption;
use Surfnet\StepupBundle\Value\SecondFactorType;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\AddRaLocationCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\ChangeRaLocationCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\CreateInstitutionConfigurationCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\ReconfigureInstitutionConfigurationOptionsCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\RemoveInstitutionConfigurationByUnnormalizedIdCommand;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\RemoveRaLocationCommand;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects) Value objects
 */

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 InstitutionConfigurationCommandHandler extends SimpleCommandHandler
{
    public function __construct(private readonly RepositoryInterface $repository)
    {
    }

    public function handleCreateInstitutionConfigurationCommand(CreateInstitutionConfigurationCommand $command): void
    {
        $institution = new Institution($command->institution);
        $institutionConfigurationId = InstitutionConfigurationId::normalizedFrom($institution);

        try {
            /** @var InstitutionConfiguration $institutionConfiguration */

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

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

            $institutionConfiguration = $this->repository->load(
                $institutionConfigurationId->getInstitutionConfigurationId(),
            );

            $institutionConfiguration->rebuild();
        } catch (AggregateNotFoundException) {
            $institutionConfiguration = InstitutionConfiguration::create($institutionConfigurationId, $institution);
        }

        $this->repository->save($institutionConfiguration);
    }

    public function handleReconfigureInstitutionConfigurationOptionsCommand(
        ReconfigureInstitutionConfigurationOptionsCommand $command,
    ): void {
        $institution = new Institution($command->institution);

        $allowedSecondFactors = array_map(
            fn($allowedSecondFactor): SecondFactorType => new SecondFactorType($allowedSecondFactor),
            $command->allowedSecondFactors,
        );


        $institutionConfiguration = $this->loadInstitutionConfigurationFor($institution);

The function Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\CommandHandler\InstitutionConfigurationCommandHandler::loadInstitutionConfigurationFor() has been deprecated: Should be used until existing institution configurations have been migrated to using normalized ids

        $institutionConfiguration->configureUseRaLocationsOption(
            new UseRaLocationsOption($command->useRaLocationsOption),
        );
        $institutionConfiguration->configureVerifyEmailOption(
            new VerifyEmailOption($command->verifyEmailOption),
        );
        $institutionConfiguration->configureNumberOfTokensPerIdentityOption(
            new NumberOfTokensPerIdentityOption($command->numberOfTokensPerIdentityOption),
        );
        $institutionConfiguration->configureShowRaaContactInformationOption(
            new ShowRaaContactInformationOption($command->showRaaContactInformationOption),
        );

        // Configure the authorization options on the aggregate
        $institutionConfiguration->updateUseRaOption(
            InstitutionAuthorizationOption::fromInstitutionConfig(
                InstitutionRole::useRa(),
                $command->useRaOption,
            ),
        );
        $institutionConfiguration->updateUseRaaOption(
            InstitutionAuthorizationOption::fromInstitutionConfig(
                InstitutionRole::useRaa(),
                $command->useRaaOption,
            ),
        );
        $institutionConfiguration->updateSelectRaaOption(
            InstitutionAuthorizationOption::fromInstitutionConfig(
                InstitutionRole::selectRaa(),
                $command->selectRaaOption,
            ),
        );

        $institutionConfiguration->updateAllowedSecondFactorList(
            AllowedSecondFactorList::ofTypes($allowedSecondFactors),
        );

        // Handle optional options
        $selfVetOptionValue = $command->selfVetOption ?? SelfVetOption::getDefault()->isEnabled();
        $institutionConfiguration->configureSelfVetOption(new SelfVetOption($selfVetOptionValue));

        $ssoOn2faOptionValue = $command->ssoOn2faOption ?? SsoOn2faOption::getDefault()->isEnabled();
        $institutionConfiguration->configureSsoOn2faOption(new SsoOn2faOption($ssoOn2faOptionValue));

        $ssoRegistrationBypassOptionValue = $command->ssoRegistrationBypassOption ?? SsoRegistrationBypassOption::getDefault()->isEnabled();
        $institutionConfiguration->configureSsoRegistrationBypassOption(new SsoRegistrationBypassOption($ssoRegistrationBypassOptionValue));

        $satOption = $command->selfAssertedTokensOption ?? SelfAssertedTokensOption::getDefault()->isEnabled();
        $institutionConfiguration->configureSelfAssertedTokensOption(
            new SelfAssertedTokensOption($satOption),
        );

        $this->repository->save($institutionConfiguration);
    }

    public function handleAddRaLocationCommand(AddRaLocationCommand $command): void
    {
        $institution = new Institution($command->institution);

        $institutionConfiguration = $this->loadInstitutionConfigurationFor($institution);

The function Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\CommandHandler\InstitutionConfigurationCommandHandler::loadInstitutionConfigurationFor() has been deprecated: Should be used until existing institution configurations have been migrated to using normalized ids

        $institutionConfiguration->addRaLocation(
            new RaLocationId($command->raLocationId),
            new RaLocationName($command->raLocationName),
            new Location($command->location),
            new ContactInformation($command->contactInformation),
        );

        $this->repository->save($institutionConfiguration);
    }

    public function handleChangeRaLocationCommand(ChangeRaLocationCommand $command): void
    {
        $institution = new Institution($command->institution);

        $institutionConfiguration = $this->loadInstitutionConfigurationFor($institution);

The function Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\CommandHandler\InstitutionConfigurationCommandHandler::loadInstitutionConfigurationFor() has been deprecated: Should be used until existing institution configurations have been migrated to using normalized ids

        $institutionConfiguration->changeRaLocation(
            new RaLocationId($command->raLocationId),
            new RaLocationName($command->raLocationName),
            new Location($command->location),
            new ContactInformation($command->contactInformation),
        );

        $this->repository->save($institutionConfiguration);
    }

    public function handleRemoveRaLocationCommand(RemoveRaLocationCommand $command): void
    {
        $institution = new Institution($command->institution);

        $institutionConfiguration = $this->loadInstitutionConfigurationFor($institution);

The function Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\CommandHandler\InstitutionConfigurationCommandHandler::loadInstitutionConfigurationFor() has been deprecated: Should be used until existing institution configurations have been migrated to using normalized ids

        $institutionConfiguration->removeRaLocation(new RaLocationId($command->raLocationId));

        $this->repository->save($institutionConfiguration);
    }

    public function handleRemoveInstitutionConfigurationByUnnormalizedIdCommand(
        RemoveInstitutionConfigurationByUnnormalizedIdCommand $command,
    ): void {
        $institution = new Institution($command->institution);

        $institutionConfigurationId = InstitutionConfigurationId::normalizedFrom($institution);
        /** @var InstitutionConfiguration $institutionConfiguration */

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

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

        $institutionConfiguration = $this->repository->load(
            $institutionConfigurationId->getInstitutionConfigurationId(),
        );
        $institutionConfiguration->destroy();

        $this->repository->save($institutionConfiguration);
    }

    /**

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

     * @return InstitutionConfiguration

Tag value for @return tag indented incorrectly; expected 5 spaces but found 1

     * @deprecated Should be used until existing institution configurations have been migrated to using normalized ids
     *
     */

Additional blank lines found at end of doc comment

    private function loadInstitutionConfigurationFor(Institution $institution): InstitutionConfiguration

Private method name "InstitutionConfigurationCommandHandler::loadInstitutionConfigurationFor" must be prefixed with an underscore

    {
        try {
            $institutionConfigurationId = InstitutionConfigurationId::normalizedFrom($institution);
            /** @var InstitutionConfiguration $institutionConfiguration */

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

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

            $institutionConfiguration = $this->repository->load(
                $institutionConfigurationId->getInstitutionConfigurationId(),
            );
        } catch (AggregateNotFoundException) {
            $institutionConfigurationId = InstitutionConfigurationId::from($institution);

The function Surfnet\Stepup\Configuration\Value\InstitutionConfigurationId::from() has been deprecated: To be removed in next release; use normalizedFrom method to account for case-(in)sensitivity issues

            /** @var InstitutionConfiguration $institutionConfiguration */

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

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

            $institutionConfiguration = $this->repository->load(
                $institutionConfigurationId->getInstitutionConfigurationId(),
            );
        }

        return $institutionConfiguration;
    }
}