Surfnet\StepupMiddleware\ApiBundle\Doctrine\Type\ConfigurationInstitutionType

Complexity

Total Complexity

11

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

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

<?php

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

namespace Surfnet\StepupMiddleware\ApiBundle\Doctrine\Type;

use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Types\ConversionException;
use Doctrine\DBAL\Types\Type;
use Surfnet\Stepup\Configuration\Value\Institution;
use Surfnet\Stepup\Exception\InvalidArgumentException;

/**
 * Custom Type for the Institution Value Object for the Configuration domain
 */
class ConfigurationInstitutionType extends Type
{
    public const NAME = 'stepup_configuration_institution';

    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
    {
        if (!isset($column['length'])) {
            $column['length'] = 255;
        }

        return $platform->getStringTypeDeclarationSQL($column);
    }

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

        if (!$value instanceof Institution) {
            throw new ConversionException(
                sprintf(
                    "Encountered illegal institution of type %s '%s', expected an Institution instance",
                    get_debug_type($value),
                    is_scalar($value) ? (string)$value : '',
                ),
            );
        }

        return $value->getInstitution();
    }

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

        try {
            $institution = new Institution($value);
        } catch (InvalidArgumentException $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 $institution;
    }

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

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