Surfnet\StepupMiddleware\ApiBundle\Doctrine\Type\SsoRegistrationBypassOptionType

Complexity

Total Complexity

10

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	convertToDatabaseValue()	0	18	4
A	getSQLDeclaration()	0	3	1
A	convertToPHPValue()	0	19	3
A	getName()	0	3	1
A	requiresSQLCommentHint()	0	3	1

<?php

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

namespace Surfnet\StepupMiddleware\ApiBundle\Doctrine\Type;

use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Types\ConversionException;
use Doctrine\DBAL\Types\IntegerType;
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 TypeError;

/**
 * Custom Type for the SsoRegistrationBypassOption Value Object
 *
 * This option enables and disables the "GSSP fallback" option in the Stepup-Gateway for an institution.
 * "GSSP fallback" forwards the second factor authentications at LoA 1.5 to the fallback GSSP when a user does not have
 * any active tokens
 */
class SsoRegistrationBypassOptionType extends IntegerType
{
    public const NAME = 'stepup_sso_registration_bypass_option';

    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
    {
        return $platform->getIntegerTypeDeclarationSQL($column);
    }

    public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): ?int
    {
        if (is_null($value)) {
            return null;
        }

        if (!$value instanceof SsoRegistrationBypassOption) {
            throw new ConversionException(
                sprintf(
                    "Encountered illegal sso registration bypass option %s '%s', expected a 
                    SsoRegistrationBypassOption instance",
                    get_debug_type($value),
                    is_scalar($value) ? (string)$value : '',
                ),
            );
        }

        return (int)$value->isEnabled();
    }

    public function convertToPHPValue($value, AbstractPlatform $platform): ?SsoRegistrationBypassOption
    {
        if (is_null($value)) {
            return null;
        }

        try {
            $ssoRegistrationBypassOption = new SsoRegistrationBypassOption((bool)$value);
        } catch (TypeError $e) {
            // get nice standard message, so we can throw it keeping the exception chain
            $doctrineExceptionMessage = ConversionException::conversionFailed(
                $value,
                $this->getName(),
            )->getMessage();

            throw new ConversionException($doctrineExceptionMessage, 0, $e);
        }

        return $ssoRegistrationBypassOption;
    }

    public function getName(): string
    {
        return self::NAME;
    }

    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
    {
        return false;
    }
}